Skip to content

Commit

Permalink
Quick Save
Browse files Browse the repository at this point in the history
  • Loading branch information
@rsdoiel
rsdoiel committed Jun 20, 2023
1 parent d1435ae commit eb1d4d1
Show file tree
Hide file tree
Showing 16 changed files with 172 additions and 323 deletions.
4 changes: 1 addition & 3 deletions CITATION.cff
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
title: "scripttool"
abstract: "A library and command line program for working with fdx
(Final Draft XML), osf, Fade In and Fountain formatted Screen Play
files."
abstract: "A library and command line program for working with fdx (Final Draft XML), osf, Fade In and Fountain formatted Screen Play files."
authors:
- family-names: Doiel
given-names: Robert
Expand Down
50 changes: 15 additions & 35 deletions INSTALL.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,15 @@
<!-- <h1>INSTALL</h1> -->

<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="quick-install-via-curl">Quick install via curl</h2>
<p>This project can be installed via curl and sh for POSIX compatible
systems. Enter the following in your shell.</p>
<p>This project can be installed via curl and sh for POSIX compatible systems. Enter the following in your shell.</p>
<pre><code>curl https://rsdoiel.github.io/scripttool/installer.sh | sh</code></pre>
<h2 id="compiled-version">Compiled version</h2>
<p>This is generalized instructions for a release.</p>
<p>Compiled versions are available for Mac OS (Intel and M1/M2
processor, macOS-x86_64, macOS-arm64), Linux (Intel process,
linux-x86_64), Windows (Intel processor, Windows-x86_64), Rapsberry Pi
OS (arm7 processor, RaspberryPiOS-arm7) and Pine64 (arm64 processor,
Linux-aarch64)</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 (Intel and M1/M2 processor, macOS-x86_64, macOS-arm64), Linux (Intel process, linux-x86_64), Windows (Intel processor, Windows-x86_64), Rapsberry Pi OS (arm7 processor, RaspberryPiOS-arm7) and Pine64 (arm64 processor, Linux-aarch64)</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 @@ -85,23 +76,19 @@ <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 @@ -113,8 +100,7 @@ <h3 id="mac-os">Mac OS</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-x86_64.zip
mkdir -p $HOME/bin
Expand All @@ -128,8 +114,7 @@ <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-x86_64.zip
mkdir -p $HOME/bin
Expand All @@ -143,35 +128,30 @@ <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-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
scripttool -version</code></pre>
<h3 id="raspberry-pi-os">Raspberry Pi OS</h3>
<p>Released version is for a Raspberry Pi 3 or later use (i.e. requires
ARM 7 support).</p>
<p>Released version is for a Raspberry Pi 3 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-*-RaspberryPiOS-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 repository and then compile</p>
<pre class="shell"><code> cd
Expand Down
10 changes: 3 additions & 7 deletions NOTES.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,9 @@

<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
143 changes: 71 additions & 72 deletions TODO.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,97 +31,96 @@
<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>
<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>
<li><code>scripttool fountain2json testdata/sample-07.fountain</code></li>
<li><code>scripttool characters testdata/sample-07.fountain</code></li>
</ul></li>
</ul>
<h2 id="next">Next</h2>
<ul class="task-list">
<li><input type="checkbox" disabled="" checked="" />fountain2html</li>
<li><input type="checkbox" disabled="" checked="" />fountain2json</li>
<li><input type="checkbox" disabled="" checked="" />fountain2fdx
(Fountain to Final Draft XML)</li>
<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>
<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="" />osf2fdx (Open
Screenplay Format 1.2,2.0 XML to Final Draft XML)</li>
<li><input type="checkbox" disabled="" checked="" />osf2fountain (Open
Screenplay Format 1.2,2.0 XML to Fountain)</li>
<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>
<li><input type="checkbox" disabled="" checked="" />
fountain2html</li>
<li><input type="checkbox" disabled="" checked="" />
fountain2json</li>
<li><input type="checkbox" disabled="" checked="" />
fountain2fdx (Fountain to Final Draft XML)</li>
<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>
<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="" />
osf2fdx (Open Screenplay Format 1.2,2.0 XML to Final Draft XML)</li>
<li><input type="checkbox" disabled="" checked="" />
osf2fountain (Open Screenplay Format 1.2,2.0 XML to Fountain)</li>
<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>
<li>auto-convert to/fountain on open</li>
<li>auto-convert from fountain to origin version on save</li>
<li>timed-autosave</li>
<li>backup original files</li>
</ul></li>
<li><input type="checkbox" disabled="" />headings - report the headings
as a outline</li>
<li><input type="checkbox" disabled="" />scenes - report the number of
scenes, order and estimate time</li>
<li><input type="checkbox" disabled="" />lines - report line count</li>
<li><input type="checkbox" disabled="" />words - report word count</li>
<li><input type="checkbox" disabled="" />character - report character
count</li>
<li><input type="checkbox" disabled="" />outline (OPML) to
scenes/chapters</li>
<li><input type="checkbox" disabled="" />notes, sections and
synopsis</li>
<li><input type="checkbox" disabled="" />eprints like metadata for the
script</li>
<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>
<li><input type="checkbox" disabled="" />Search/indexing for script and
related assets</li>
<li><input type="checkbox" disabled="" />
headings - report the headings as a outline</li>
<li><input type="checkbox" disabled="" />
scenes - report the number of scenes, order and estimate time</li>
<li><input type="checkbox" disabled="" />
lines - report line count</li>
<li><input type="checkbox" disabled="" />
words - report word count</li>
<li><input type="checkbox" disabled="" />
character - report character count</li>
<li><input type="checkbox" disabled="" />
outline (OPML) to scenes/chapters</li>
<li><input type="checkbox" disabled="" />
notes, sections and synopsis</li>
<li><input type="checkbox" disabled="" />
eprints like metadata for the script</li>
<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>
<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>
<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>
<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>
<li><input type="checkbox" disabled="" />
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>
<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>
</ul></li>
<li><input type="checkbox" disabled="" />fountain2trelby</li>
<li><input type="checkbox" disabled="" />osf2trelby</li>
<li><input type="checkbox" disabled="" />fdx2trelby</li>
<li><input type="checkbox" disabled="" />trelby2fdx</li>
<li><input type="checkbox" disabled="" />trelby2fountain</li>
<li><input type="checkbox" disabled="" />trelby2osf</li>
<li><input type="checkbox" disabled="" />
fountain2trelby</li>
<li><input type="checkbox" disabled="" />
osf2trelby</li>
<li><input type="checkbox" disabled="" />
fdx2trelby</li>
<li><input type="checkbox" disabled="" />
trelby2fdx</li>
<li><input type="checkbox" disabled="" />
trelby2fountain</li>
<li><input type="checkbox" disabled="" />
trelby2osf</li>
</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
12 changes: 4 additions & 8 deletions about.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,11 @@ <h3 id="maintainers">Maintainers</h3>
<ul>
<li></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: <a href="https://rsdoiel.github.io/scripttool/license.html"
class="uri">https://rsdoiel.github.io/scripttool/license.html</a></li>
<li>GitHub: <a href="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/rsdoiel/scripttool"
class="uri">https://github.com/rsdoiel/scripttool</a></li>
<li>Issues: <a href="https://github.com/rsdoiel/scripttool/issues"
class="uri">https://github.com/rsdoiel/scripttool/issues</a></li>
<li>License: <a href="https://rsdoiel.github.io/scripttool/license.html" class="uri">https://rsdoiel.github.io/scripttool/license.html</a></li>
<li>GitHub: <a href="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/rsdoiel/scripttool" class="uri">https://github.com/rsdoiel/scripttool</a></li>
<li>Issues: <a href="https://github.com/rsdoiel/scripttool/issues" class="uri">https://github.com/rsdoiel/scripttool/issues</a></li>
</ul>
<h3 id="programming-languages">Programming languages</h3>
<ul>
Expand Down
7 changes: 2 additions & 5 deletions about.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
title: "scripttool"
abstract: "A library and command line program for working with fdx
(Final Draft XML), osf, Fade In and Fountain formatted Screen Play
files."
abstract: "A library and command line program for working with fdx (Final Draft XML), osf, Fade In and Fountain formatted Screen Play files."
authors:
- family-names: Doiel
given-names: Robert
Expand All @@ -32,8 +30,7 @@ About this software

-

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>
- GitHub: <https://github.com/rsdoiel/scripttool>
Expand Down
Loading

0 comments on commit eb1d4d1

Please sign in to comment.