Skip to content

Commit

Permalink
Quick Save
Browse files Browse the repository at this point in the history
  • Loading branch information
@rsdoiel
rsdoiel committed Aug 9, 2022
1 parent e536ddc commit 5de4cbd
Show file tree
Hide file tree
Showing 10 changed files with 290 additions and 154 deletions.
10 changes: 7 additions & 3 deletions NOTES.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,13 @@

<h1 id="misc-dev-notes">Misc dev notes</h1>
<ul>
<li><a href="https://quoteunquoteapps.com/courierprime/">Courier Prime</a> -</li>
<li><a href="https://wordpress.org/plugins/wp-scrippets/">Scrippets</a> - a WP plugin for fountain fragments</li>
<li>John Augusts’s Scrippets <a href="https://johnaugust.com/2008/scrippets-php-and-a-call-to-coders">Call to Coders</a></li>
<li><a href="https://quoteunquoteapps.com/courierprime/">Courier
Prime</a> -</li>
<li><a href="https://wordpress.org/plugins/wp-scrippets/">Scrippets</a>
- a WP plugin for fountain fragments</li>
<li>John Augusts’s Scrippets <a
href="https://johnaugust.com/2008/scrippets-php-and-a-call-to-coders">Call
to Coders</a></li>
</ul>
</section>

Expand Down
40 changes: 28 additions & 12 deletions TODO.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ <h1 id="action-items">Action Items</h1>
<h2 id="bugs">Bugs</h2>
<ul class="task-list">
<li><input type="checkbox" disabled="" />
fountain parser is miss-identifying some elements as character when they are things like scene headings. This should up in JSON output and characters report, see testdata/sample-07.fountain for example of bug<ul>
fountain parser is miss-identifying some elements as character when they
are things like scene headings. This should up in JSON output and
characters report, see testdata/sample-07.fountain for example of
bug<ul>
<li><code>scripttool fountain2json testdata/sample-07.fountain</code></li>
<li><code>scripttool characters testdata/sample-07.fountain</code></li>
</ul></li>
Expand All @@ -48,7 +51,9 @@ <h2 id="next">Next</h2>
<li><input type="checkbox" disabled="" checked="" />
fountain2osf (Fountain to Open Screenplay Format 1.2,2.0)</li>
<li><input type="checkbox" disabled="" checked="" />
fdx2fountain (build on fdx2txt in <a href="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/rsdoiel/fdx">fdx</a>, handle TitlePage better)</li>
fdx2fountain (build on fdx2txt in <a
href="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/rsdoiel/fdx">fdx</a>, handle TitlePage
better)</li>
<li><input type="checkbox" disabled="" checked="" />
fdx2osf (Final Draft XML to Open Screenplay Format 1.2,2.0 XML)</li>
<li><input type="checkbox" disabled="" checked="" />
Expand All @@ -58,7 +63,8 @@ <h2 id="next">Next</h2>
<li><input type="checkbox" disabled="" checked="" />
fountain2fadein, fadein2fountain</li>
<li><input type="checkbox" disabled="" />
edit (simple line oriented editor with colorization for Fountain/Markdown)<ul>
edit (simple line oriented editor with colorization for
Fountain/Markdown)<ul>
<li>auto-convert to/fountain on open</li>
<li>auto-convert from fountain to origin version on save</li>
<li>timed-autosave</li>
Expand All @@ -83,22 +89,26 @@ <h2 id="next">Next</h2>
<li><input type="checkbox" disabled="" />
Story timeline (using stn) for temporal story outlines</li>
<li><input type="checkbox" disabled="" />
Scene beat report, sumaries per scene happenings (who speaks, description, estimated running time)</li>
Scene beat report, sumaries per scene happenings (who speaks,
description, estimated running time)</li>
<li><input type="checkbox" disabled="" />
Search/indexing for script and related assets</li>
</ul>
<h2 id="someday-maybe">Someday, Maybe</h2>
<ul class="task-list">
<li><input type="checkbox" disabled="" />
GUI for managing a screenplay project (like Scrivener but GTK based so as can running under Linux)</li>
GUI for managing a screenplay project (like Scrivener but GTK based so
as can running under Linux)</li>
<li><input type="checkbox" disabled="" />
PDF generation from various formats (possibly via Pandoc)</li>
<li><input type="checkbox" disabled="" />
write and fountain2html, fdx2html, osf2html, fadein2html using <a href="https://fountain.io/scrippets">scrippets</a> approach</li>
write and fountain2html, fdx2html, osf2html, fadein2html using <a
href="https://fountain.io/scrippets">scrippets</a> approach</li>
<li><input type="checkbox" disabled="" />
Create a fountain text to speach script reader<ul class="task-list">
<li><input type="checkbox" disabled="" />
Should support configuration for assigning voices to different characters</li>
Should support configuration for assigning voices to different
characters</li>
</ul></li>
<li><input type="checkbox" disabled="" />
fountain2trelby</li>
Expand All @@ -115,12 +125,18 @@ <h2 id="someday-maybe">Someday, Maybe</h2>
</ul>
<h2 id="reference-links">Reference Links</h2>
<ul>
<li><a href="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/jung-kurt/gofpdf">gofpdf</a> - Kurt Jung’s Go implementation of fpdf</li>
<li><a href="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/jung-kurt/gofpdf">gofpdf</a> - Kurt
Jung’s Go implementation of fpdf</li>
<li><a href="https://fountain.io">Fountain</a></li>
<li><a href="https://sourceforge.net/projects/openscrfmt/">Open Screenplay Format 2.0</a></li>
<li><a href="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/severdia/Open-Screenplay-Format">Open Screenplay Format 2.1</a></li>
<li><a href="https://johnaugust.com/2004/screenbox">Screenbox HTML and CSS</a> is some CSS for marking up HTML classes hand presenting a script section in an HTML page</li>
<li><a href="https://wordpress.org/plugins/wp-scrippets/">scrippets Wordpress Plugin</a>, scrippets.org website appears gone.</li>
<li><a href="https://sourceforge.net/projects/openscrfmt/">Open
Screenplay Format 2.0</a></li>
<li><a href="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/severdia/Open-Screenplay-Format">Open
Screenplay Format 2.1</a></li>
<li><a href="https://johnaugust.com/2004/screenbox">Screenbox HTML and
CSS</a> is some CSS for marking up HTML classes hand presenting a script
section in an HTML page</li>
<li><a href="https://wordpress.org/plugins/wp-scrippets/">scrippets
Wordpress Plugin</a>, scrippets.org website appears gone.</li>
</ul>
</section>

Expand Down
3 changes: 2 additions & 1 deletion about.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ <h3 id="authors">Authors</h3>
<ul>
<li>Robert Doiel</li>
</ul>
<p>A library and command line program for working with fdx (Final Draft XML), osf, Fade In and Fountain formatted Screen Play files.</p>
<p>A library and command line program for working with fdx (Final Draft
XML), osf, Fade In and Fountain formatted Screen Play files.</p>
<ul>
<li>License: https://rsdoiel.github.io/scripttool/license.html</li>
<li>GitHub: https://github.com/rsdoiel/scripttool</li>
Expand Down
3 changes: 2 additions & 1 deletion about.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ scripttool 0.0.8

- Robert Doiel

A library and command line program for working with fdx (Final Draft XML), osf, Fade In and Fountain formatted Screen Play files.
A library and command line program for working with fdx (Final Draft
XML), osf, Fade In and Fountain formatted Screen Play files.


- License: https://rsdoiel.github.io/scripttool/license.html
Expand Down
36 changes: 25 additions & 11 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,31 +27,45 @@
<section>
<!-- <h1>README</h1> -->

<p><a href="https://www.repostatus.org/#active"><img src="https://www.repostatus.org/badges/latest/active.svg" alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed." /></a></p>
<p><a href="https://snapcraft.io/scripttool"><img src="https://snapcraft.io/static/images/badges/en/snap-store-white.svg" alt="Get it from the Snap Store" /></a></p>
<p><a href="https://www.repostatus.org/#active"><img
src="https://www.repostatus.org/badges/latest/active.svg"
alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed." /></a></p>
<p><a href="https://snapcraft.io/scripttool"><img
src="https://snapcraft.io/static/images/badges/en/snap-store-white.svg"
alt="Get it from the Snap Store" /></a></p>
<h1 id="scripttool">scripttool</h1>
<p>A tool for working with screenplay file formats (e.g. fdx, fountain, osf, FadeIn).</p>
<h2 id="converting-to-fountain-format">Converting to fountain format</h2>
<p>Convert from <em>screenplay.fdx</em> to <em>screenplay.fountain</em></p>
<p>A tool for working with screenplay file formats (e.g. fdx, fountain,
osf, FadeIn).</p>
<h2 id="converting-to-fountain-format">Converting to fountain
format</h2>
<p>Convert from <em>screenplay.fdx</em> to
<em>screenplay.fountain</em></p>
<pre class="shell"><code> scripttool fdx2fountain screenplay.fdx screenplay.fountain</code></pre>
<p>Convert from <em>screenplay.fadein</em> to <em>screenplay.fountain</em></p>
<p>Convert from <em>screenplay.fadein</em> to
<em>screenplay.fountain</em></p>
<pre class="shell"><code> scripttool fadein2fountain screenplay.fadein screenplay.fountain</code></pre>
<p>Convert from <em>screenplay.osf</em> to <em>screenplay.fountain</em></p>
<p>Convert from <em>screenplay.osf</em> to
<em>screenplay.fountain</em></p>
<pre class="shell"><code> scripttool osf2fountain screenplay.osf screenplay.fountain</code></pre>
<h2 id="working-with-fountain-files">Working with fountain files</h2>
<p>Pretty print fountain files</p>
<pre class="shell"><code> scripttool fountainfmt screenplay.fountain</code></pre>
<p>Render a fountain file as JSON</p>
<pre class="shell"><code> scripttool fountain2json screenplay.fountain</code></pre>
<h2 id="convert-from-fountain-format">Convert from fountain format</h2>
<p>Convert from <em>screenplay.fountain</em> to <em>screenplay.fdx</em></p>
<p>Convert from <em>screenplay.fountain</em> to
<em>screenplay.fdx</em></p>
<pre class="shell"><code> scripttool fountain2fdx screenplay.fountain screenplay.fdx</code></pre>
<p>Convert from <em>screenplay.fountain</em> to <em>screenplay.fadein</em></p>
<p>Convert from <em>screenplay.fountain</em> to
<em>screenplay.fadein</em></p>
<pre class="shell"><code> scripttool fountain2fadein screenplay.fountain screenplay.fadein</code></pre>
<p>Convert from <em>screenplay.fountain</em> to <em>screenplay.osf</em></p>
<p>Convert from <em>screenplay.fountain</em> to
<em>screenplay.osf</em></p>
<pre class="shell"><code> scripttool fountain2osf screenplay.fountain screenplay.osf</code></pre>
<h2 id="script-reports">Script Reports</h2>
<p>NOTE: Currently only fountain documents are supported for reporting. Currently the character list report is implemented as a proof of concept.</p>
<p>NOTE: Currently only fountain documents are supported for reporting.
Currently the character list report is implemented as a proof of
concept.</p>
<p>List the characters in <em>screenplay.fountain</em></p>
<pre class="shell"><code> scripttool characters screenplay.fountain</code></pre>
</section>
Expand Down
48 changes: 33 additions & 15 deletions install.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,28 @@
<li><a href="user-manual.html">User Manual</a></li>
<li><a href="license.html">LICENSE</a></li>
<li><a href="about.html">About</a></li>
<li><a href="INSTALL.html">Install</a></li>
<li><a href="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/rsdoiel/scripttool">GitHub</a></li>
</ul>
</nav>

<section>
<!-- <h1>INSTALL</h1> -->

<p>{ “title”: “scripttool, a program for converting screen play formats” }</p>
<h1 id="installation">Installation</h1>
<p><em>scripttool</em> is a command line program run from a shell like Bash. You can find compiled version in the <a href="https://github.com/rsdoiel/scripttool/releases/latest">releases</a></p>
<p><em>scripttool</em> is a command line program run from a shell like
Bash. You can find compiled version in the <a
href="https://github.com/rsdoiel/scripttool/releases/latest">releases</a></p>
<h2 id="compiled-version">Compiled version</h2>
<p>This is generalized instructions for a release.</p>
<p>Compiled versions are available for Mac OS X (amd64 and M1 processor, macos-amd64, macos-arm64), Linux (amd64 process, linux-amd64), Windows (amd64 processor, windows-amd64), Rapsberry Pi (arm7 processor, raspbian-arm7) and Pine64 (arm64 processor, linux-arm64)</p>
<p>VERSION_NUMBER is a <a href="http:https://semver.org/">symantic version number</a> (e.g. v0.1.2)</p>
<p>For all the released version go to the project page on Github and click latest release</p>
<p>Compiled versions are available for Mac OS X (amd64 and M1 processor,
macos-amd64, macos-arm64), Linux (amd64 process, linux-amd64), Windows
(amd64 processor, windows-amd64), Rapsberry Pi (arm7 processor,
raspbian-arm7) and Pine64 (arm64 processor, linux-arm64)</p>
<p>VERSION_NUMBER is a <a href="http:https://semver.org/">symantic version
number</a> (e.g. v0.1.2)</p>
<p>For all the released version go to the project page on Github and
click latest release</p>
<blockquote>
<p>https://github.com/rsdoiel/scripttool/releases/latest</p>
</blockquote>
Expand Down Expand Up @@ -73,19 +80,23 @@ <h2 id="compiled-version">Compiled version</h2>
</table>
<h2 id="the-basic-recipe">The basic recipe</h2>
<ul>
<li>Find the Zip file listed matching the architecture you’re running and download it
<li>Find the Zip file listed matching the architecture you’re running
and download it
<ul>
<li>(e.g. if you’re on a Windows 10 laptop/Surface with a amd64 style CPU you’d choose the Zip file with “windows-amd64” in the name).</li>
<li>(e.g. if you’re on a Windows 10 laptop/Surface with a amd64 style
CPU you’d choose the Zip file with “windows-amd64” in the name).</li>
</ul></li>
<li>Download the zip file and unzip the file.<br />
</li>
<li>Copy the contents of the folder named “bin” to a folder that is in your path
<li>Copy the contents of the folder named “bin” to a folder that is in
your path
<ul>
<li>(e.g. “$HOME/bin” is common).</li>
</ul></li>
<li>Adjust your PATH if needed
<ul>
<li>(e.g. export PATH=“<span class="math inline"><em>H</em><em>O</em><em>M</em><em>E</em>/<em>b</em><em>i</em><em>n</em>:</span>PATH”)</li>
<li>(e.g. export PATH=“<span
class="math inline"><em>H</em><em>O</em><em>M</em><em>E</em>/<em>b</em><em>i</em><em>n</em>:</span>PATH”)</li>
</ul></li>
<li>Test</li>
</ul>
Expand All @@ -97,7 +108,8 @@ <h3 id="mac-os-x">Mac OS X</h3>
<li>Make sure the new location in in our path</li>
<li>Test</li>
</ol>
<p>Here’s an example of the commands run in the Terminal App after downloading the zip file.</p>
<p>Here’s an example of the commands run in the Terminal App after
downloading the zip file.</p>
<pre class="shell"><code> cd Downloads/
unzip scripttool-*-macos-amd64.zip
mkdir -p $HOME/bin
Expand All @@ -111,7 +123,8 @@ <h3 id="windows">Windows</h3>
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
<li>Test</li>
</ol>
<p>Here’s an example of the commands run in from the Bash shell on Windows 10 after downloading the zip file.</p>
<p>Here’s an example of the commands run in from the Bash shell on
Windows 10 after downloading the zip file.</p>
<pre class="shell"><code> cd Downloads/
unzip scripttool-*-windows-amd64.zip
mkdir -p $HOME/bin
Expand All @@ -125,30 +138,35 @@ <h3 id="linux">Linux</h3>
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
<li>Test</li>
</ol>
<p>Here’s an example of the commands run in from the Bash shell after downloading the zip file.</p>
<p>Here’s an example of the commands run in from the Bash shell after
downloading the zip file.</p>
<pre class="shell"><code> cd Downloads/
unzip scripttool-*-linux-amd64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
scripttool -version</code></pre>
<h3 id="raspberry-pi">Raspberry Pi</h3>
<p>Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support).</p>
<p>Released version is for a Raspberry Pi 2 or later use (i.e. requires
ARM 7 support).</p>
<ol type="1">
<li>Download the zip file</li>
<li>Unzip the zip file</li>
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
<li>Test</li>
</ol>
<p>Here’s an example of the commands run in from the Bash shell after downloading the zip file.</p>
<p>Here’s an example of the commands run in from the Bash shell after
downloading the zip file.</p>
<pre class="shell"><code> cd Downloads/
unzip scripttool-*-raspbian-arm7.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
scripttool -version</code></pre>
<h2 id="compiling-from-source">Compiling from source</h2>
<p><em>scripttool</em> is “go gettable”. Use the “go get” command to download the dependant packages as well as <em>scripttool</em>’s source code.</p>
<p><em>scripttool</em> is “go gettable”. Use the “go get” command to
download the dependant packages as well as <em>scripttool</em>’s source
code.</p>
<pre class="shell"><code> go get -u github.com/rsdoiel/scripttool/...</code></pre>
<p>Or clone the repstory and then compile</p>
<pre class="shell"><code> cd
Expand Down
Loading

0 comments on commit 5de4cbd

Please sign in to comment.