Quick Save

rsdoiel · May 20, 2024 · 605c7d6 · 605c7d6
1 parent cf91847
commit 605c7d6
Show file tree

Hide file tree

Showing 22 changed files with 799 additions and 114 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -15,6 +15,6 @@ maintainers:
     orcid: ""
 
 repository-code: "https://github.com/rsdoiel/fdx"
-version: 1.0.2
+version: 1.0.3
 license-url: "https://rsdoiel.github.io/fdx/LICENSE"
 keywords: [ "GitHub", "text markup", "screen play" ]
diff --git a/INSTALL.html b/INSTALL.html
@@ -28,9 +28,11 @@
 <!--  <h1>INSTALL</h1> -->
 
 <h2 id="installation">Installation</h2>
-<p>This project is experimental. Get the latest release from <a href="https://github.com/rsdoiel/fdx/releases/">GitHub</a>.</p>
+<p>This project is experimental. Get the latest release from <a
+href="https://github.com/rsdoiel/fdx/releases/">GitHub</a>.</p>
 <h2 id="quick-install-with-curl">Quick install with curl</h2>
-<p>If you are using macOS or Linux you maybe able to install fdx using the following curl command.</p>
+<p>If you are using macOS or Linux you maybe able to install fdx using
+the following curl command.</p>
 <pre class="shell"><code>curl https://rsdoiel.github.io/fdx/installer.sh | sh</code></pre>
 <h2 id="install-from-source">Install from source</h2>
 <h2 id="requirements">Requirements</h2>
@@ -44,17 +46,21 @@ <h2 id="steps">Steps</h2>
 <ol type="1">
 <li>Clone the Git repository for the project</li>
 <li>change directory into the cloned project</li>
-<li>Run <code>make</code>, <code>make test</code> and <code>make install</code></li>
+<li>Run <code>make</code>, <code>make test</code> and
+<code>make install</code></li>
 </ol>
 <p>Here’s what that looks like for me.</p>
 <pre><code>git clone https://github.com/rsdoiel/fdx src/github.com/rsdoiel/fdx
 cd src/github.com/rsdoiel/fdx
 make
 make test
 make install</code></pre>
-<p>By default it will install the programs in <code>$HOME/bin</code>. <code>$HOME/bin</code> needs to be included in your <code>PATH</code>. E.g.</p>
+<p>By default it will install the programs in <code>$HOME/bin</code>.
+<code>$HOME/bin</code> needs to be included in your <code>PATH</code>.
+E.g.</p>
 <pre><code>export PATH=&quot;$HOME/bin:$PATH&quot;</code></pre>
-<p>Can be added to your <code>.profile</code>, <code>.bashrc</code> or <code>.zshrc</code> file depending on your system’s shell.</p>
+<p>Can be added to your <code>.profile</code>, <code>.bashrc</code> or
+<code>.zshrc</code> file depending on your system’s shell.</p>
 </section>
 
 <footer>

diff --git a/TODO.html b/TODO.html
@@ -31,52 +31,55 @@ <h1 id="action-items">Action Items</h1>
 <h2 id="bugs">Bugs</h2>
 <h2 id="next">Next</h2>
 <ul class="task-list">
-<li><input type="checkbox" disabled="" checked="" />
-Remove dependency on caltechlibrary/cli</li>
-<li><input type="checkbox" disabled="" checked="" />
-Update Makefile to generate version.go with Version, LicenseText and ReleaseDate (the date version.go was created)</li>
-<li><input type="checkbox" disabled="" checked="" />
-Update Makefile so installer.sh and uninstaller.sh is created</li>
-<li><input type="checkbox" disabled="" checked="" />
-Update codemeta-installer.sh to include Man pages</li>
-<li><input type="checkbox" disabled="" checked="" />
-Generate individual man pages from -help</li>
-<li><input type="checkbox" disabled="" checked="" />
-Update website build process to use website.mak</li>
-<li><input type="checkbox" disabled="" checked="" />
-Add user-manual.md with links to documentation</li>
-<li><input type="checkbox" disabled="" checked="" />
-Update INSTALL.md to include “Quick install with curl”</li>
-<li><input type="checkbox" disabled="" />
-Review XML output from ToXML() after a FromFountain() call, see where I need to add mapping for Text elements and embedded styling</li>
-<li><input type="checkbox" disabled="" />
-validate that I am producing fdx files that Final Draft, FadeIn and Trelby can read</li>
-<li><input type="checkbox" disabled="" />
-Add support to render as YAML</li>
+<li><label><input type="checkbox" checked="" />Remove dependency on
+caltechlibrary/cli</label></li>
+<li><label><input type="checkbox" checked="" />Update Makefile to
+generate version.go with Version, LicenseText and ReleaseDate (the date
+version.go was created)</label></li>
+<li><label><input type="checkbox" checked="" />Update Makefile so
+installer.sh and uninstaller.sh is created</label></li>
+<li><label><input type="checkbox" checked="" />Update
+codemeta-installer.sh to include Man pages</label></li>
+<li><label><input type="checkbox" checked="" />Generate individual man
+pages from -help</label></li>
+<li><label><input type="checkbox" checked="" />Update website build
+process to use website.mak</label></li>
+<li><label><input type="checkbox" checked="" />Add user-manual.md with
+links to documentation</label></li>
+<li><label><input type="checkbox" checked="" />Update INSTALL.md to
+include “Quick install with curl”</label></li>
+<li><label><input type="checkbox" />Review XML output from ToXML() after
+a FromFountain() call, see where I need to add mapping for Text elements
+and embedded styling</label></li>
+<li><label><input type="checkbox" />validate that I am producing fdx
+files that Final Draft, FadeIn and Trelby can read</label></li>
+<li><label><input type="checkbox" />Add support to render as
+YAML</label></li>
 </ul>
 <h2 id="someday-maybe">Someday, Maybe</h2>
 <ul class="task-list">
-<li><input type="checkbox" disabled="" />
-Add fdx2json, json2fdx</li>
-<li><input type="checkbox" disabled="" />
-Add fdx2yaml, yaml2fdx</li>
-<li><input type="checkbox" disabled="" />
-Write and fdx2html using <a href="https://fountain.io/scrippets">scrippets</a> approach</li>
-<li><input type="checkbox" disabled="" />
-Left/Right alignment should be respected based based on Paragraph Type</li>
-<li><input type="checkbox" disabled="" />
-Plaintext formatting needs to be pickup and respected from whole FinalDraft document (e.g. respect definitions, Layout, etc)</li>
-<li><input type="checkbox" disabled="" />
-Screen Headers and Footers can have Text, Dynamic, SceneProperties in any order, right now converting back to XML renders them in fixed order because they are ignored when rendering and plaintext</li>
+<li><label><input type="checkbox" />Add fdx2json, json2fdx</label></li>
+<li><label><input type="checkbox" />Add fdx2yaml, yaml2fdx</label></li>
+<li><label><input type="checkbox" />Write and fdx2html using <a
+href="https://fountain.io/scrippets">scrippets</a> approach</label></li>
+<li><label><input type="checkbox" />Left/Right alignment should be
+respected based based on Paragraph Type</label></li>
+<li><label><input type="checkbox" />Plaintext formatting needs to be
+pickup and respected from whole FinalDraft document (e.g. respect
+definitions, Layout, etc)</label></li>
+<li><label><input type="checkbox" />Screen Headers and Footers can have
+Text, Dynamic, SceneProperties in any order, right now converting back
+to XML renders them in fixed order because they are ignored when
+rendering and plaintext</label></li>
 </ul>
 <h2 id="completed">Completed</h2>
 <ul class="task-list">
-<li><input type="checkbox" disabled="" checked="" />
-Add ParseFile() to fdx.go</li>
-<li><input type="checkbox" disabled="" checked="" />
-String() Paragraph needs to handle trailing new lines based on Paragraph Type</li>
-<li><input type="checkbox" disabled="" checked="" />
-write tests that validate the source FDX content in <em>testout</em> version</li>
+<li><label><input type="checkbox" checked="" />Add ParseFile() to
+fdx.go</label></li>
+<li><label><input type="checkbox" checked="" />String() Paragraph needs
+to handle trailing new lines based on Paragraph Type</label></li>
+<li><label><input type="checkbox" checked="" />write tests that validate
+the source FDX content in <em>testout</em> version</label></li>
 </ul>
 </section>
 

diff --git a/about.html b/about.html
@@ -28,7 +28,7 @@
 <!--  <h1>about</h1> -->
 
 <h1 id="about-this-software">About this software</h1>
-<h2 id="fdx-1.0.1">fdx 1.0.1</h2>
+<h2 id="fdx-1.0.3">fdx 1.0.3</h2>
 <h3 id="authors">Authors</h3>
 <ul>
 <li>Robert Doiel</li>
@@ -37,11 +37,15 @@ <h3 id="maintainers">Maintainers</h3>
 <ul>
 <li></li>
 </ul>
-<p>A Go package and command line programs for working with fdx XML files used by Screen Writing software.</p>
+<p>A Go package and command line programs for working with fdx XML files
+used by Screen Writing software.</p>
 <ul>
-<li>License: <a href="https://rsdoiel.github.io/fdx/LICENSE" class="uri">https://rsdoiel.github.io/fdx/LICENSE</a></li>
-<li>GitHub: <a href="https://github.com/rsdoiel/fdx" class="uri">https://github.com/rsdoiel/fdx</a></li>
-<li>Issues: <a href="https://github.com/rsdoiel/fdx/issues" class="uri">https://github.com/rsdoiel/fdx/issues</a></li>
+<li>License: <a href="https://rsdoiel.github.io/fdx/LICENSE"
+class="uri">https://rsdoiel.github.io/fdx/LICENSE</a></li>
+<li>GitHub: <a href="https://github.com/rsdoiel/fdx"
+class="uri">https://github.com/rsdoiel/fdx</a></li>
+<li>Issues: <a href="https://github.com/rsdoiel/fdx/issues"
+class="uri">https://github.com/rsdoiel/fdx/issues</a></li>
 </ul>
 <h3 id="programming-languages">Programming languages</h3>
 <ul>

diff --git a/about.md b/about.md
@@ -11,7 +11,7 @@ authors:
     orcid: "https://orcid.org/0000-0003-0900-6903"
 
 repository-code: "https://github.com/rsdoiel/fdx"
-version: 1.0.2
+version: 1.0.3
 license-url: "https://rsdoiel.github.io/fdx/LICENSE"
 keywords: [ "GitHub", "text markup", "screen play" ]
 
@@ -20,7 +20,7 @@ keywords: [ "GitHub", "text markup", "screen play" ]
 About this software
 ===================
 
-## fdx 1.0.2
+## fdx 1.0.3
 
 ### Authors
 

diff --git a/fdx2txt.1.html b/fdx2txt.1.html
@@ -32,26 +32,33 @@ <h1 id="name">NAME</h1>
 <h1 id="synopsis">SYNOPSIS</h1>
 <p>fdx2txt <a href="#options">OPTIONS</a></p>
 <h1 id="description">DESCRIPTION</h1>
-<p>fdx2txt is a command line program that reads an fdx file and returns plain text</p>
+<p>fdx2txt is a command line program that reads an fdx file and returns
+plain text</p>
 <h1 id="options">OPTIONS</h1>
 <dl>
 <dt>-help</dt>
-<dd>display help
+<dd>
+display help
 </dd>
 <dt>-license</dt>
-<dd>display license
+<dd>
+display license
 </dd>
 <dt>-version</dt>
-<dd>display version
+<dd>
+display version
 </dd>
 <dt>-i</dt>
-<dd>read input from file
+<dd>
+read input from file
 </dd>
 <dt>-o</dt>
-<dd>write output to file
+<dd>
+write output to file
 </dd>
 <dt>-newline</dt>
-<dd>add a trailing newline
+<dd>
+add a trailing newline
 </dd>
 </dl>
 <h1 id="examples">EXAMPLES</h1>

diff --git a/fdx2txt.1.md b/fdx2txt.1.md
@@ -1,6 +1,6 @@
-%fdx2txt(1) | version 1.0.2 62e2565
+%fdx2txt(1) | version 1.0.3 cf91847
 % R. S. Doiel
-% 2024-03-11 
+% 2024-05-20 
 
 # NAME
 

diff --git a/index.html b/index.html
@@ -27,9 +27,21 @@
 <section>
 <!--  <h1>README</h1> -->
 
-<p><a href="https://www.repostatus.org/#inactive"><img src="https://www.repostatus.org/badges/latest/inactive.svg" alt="Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows." /></a></p>
+<p><a href="https://www.repostatus.org/#inactive"><img
+src="https://www.repostatus.org/badges/latest/inactive.svg"
+alt="Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows." /></a></p>
 <h1 id="fdx">fdx</h1>
-<p><em>fdx</em> is a Golang package for working with XML files produced by many script writing programs (e.g. <a href="http://www.trelby.org/">Trelby</a>, <a href="https://storywriter.amazon.com">Amazon Storywriter</a>, <a href="https://www.celtx.com/index.html">Celtx</a>, <a href="https://www.fadeinpro.com/">Fade In</a> and of course recent versions of <a href="https://www.finaldraft.com/">Final Draft</a>). This package also includes a demonstration command line program called <a href="docs/">fdx2txt</a> which will read an <em>fdx</em> file and render plain text in a <a href="https://fountain.io">Fountain</a> like format.</p>
+<p><em>fdx</em> is a Golang package for working with XML files produced
+by many script writing programs (e.g. <a
+href="http://www.trelby.org/">Trelby</a>, <a
+href="https://storywriter.amazon.com">Amazon Storywriter</a>, <a
+href="https://www.celtx.com/index.html">Celtx</a>, <a
+href="https://www.fadeinpro.com/">Fade In</a> and of course recent
+versions of <a href="https://www.finaldraft.com/">Final Draft</a>). This
+package also includes a demonstration command line program called <a
+href="docs/">fdx2txt</a> which will read an <em>fdx</em> file and render
+plain text in a <a href="https://fountain.io">Fountain</a> like
+format.</p>
 </section>
 
 <footer>

diff --git a/installer.sh b/installer.sh
@@ -4,7 +4,7 @@
 # Set the package name and version to install
 #
 PACKAGE="fdx"
-VERSION="1.0.2"
+VERSION="1.0.3"
 GIT_GROUP="rsdoiel"
 RELEASE="https://github.com/$GIT_GROUP/$PACKAGE/releases/tag/v$VERSION"
 

diff --git a/pagefind/fragment/en_9b3bb1d.pf_fragment b/pagefind/fragment/en_9b3bb1d.pf_fragment
diff --git a/pagefind/fragment/en_b695cd6.pf_fragment b/pagefind/fragment/en_b695cd6.pf_fragment
diff --git a/pagefind/index/en_c661727.pf_index b/pagefind/index/en_c661727.pf_index
diff --git a/pagefind/pagefind-entry.json b/pagefind/pagefind-entry.json
@@ -1 +1 @@
-{"version":"1.0.4","languages":{"en":{"hash":"en_4e3e661e24","wasm":"en","page_count":9}}}
+{"version":"1.1.0","languages":{"en":{"hash":"en_fe2dbaa848","wasm":"en","page_count":9}}}
diff --git a/pagefind/pagefind-ui.js b/pagefind/pagefind-ui.js
diff --git a/pagefind/pagefind.en_fe2dbaa848.pf_meta b/pagefind/pagefind.en_fe2dbaa848.pf_meta
diff --git a/pagefind/pagefind.js b/pagefind/pagefind.js
diff --git a/pagefind/wasm.en.pagefind b/pagefind/wasm.en.pagefind
diff --git a/pagefind/wasm.unknown.pagefind b/pagefind/wasm.unknown.pagefind
diff --git a/testdata.html b/testdata.html
@@ -28,24 +28,40 @@
 <!--  <h1>testdata</h1> -->
 
 <h1 id="about-the-test-data">About the test data</h1>
-<p>The <a href="fountain.io">fountain</a> website has some good files for reviewing formatting difference between fountain, fdx and PDF. Some are referenced in the test programs but they are optional. It is not clear to me the licensing arrangements for the text so I have not included them in this repository.</p>
-<p>If you want to include them in the test sequence go to the fountain website and download them and place them in the <em>testdata</em> directory. When you run <code>go test</code> they will be found and included in the basic test process.</p>
+<p>The <a href="fountain.io">fountain</a> website has some good files
+for reviewing formatting difference between fountain, fdx and PDF. Some
+are referenced in the test programs but they are optional. It is not
+clear to me the licensing arrangements for the text so I have not
+included them in this repository.</p>
+<p>If you want to include them in the test sequence go to the fountain
+website and download them and place them in the <em>testdata</em>
+directory. When you run <code>go test</code> they will be found and
+included in the basic test process.</p>
 <h2 id="optional-test-fdx-files">Optional test FDX files</h2>
 <ul>
-<li><a href="https://fountain.io/_downloads/Big%20Fish.fountain">Big Fish</a>
+<li><a href="https://fountain.io/_downloads/Big%20Fish.fountain">Big
+Fish</a>
 <ul>
 <li><a href="https://fountain.io/_downloads/Big%20Fish.fdx">fdx</a></li>
 <li><a href="https://fountain.io/_downloads/Big%20Fish.pdf">pdf</a></li>
 </ul></li>
-<li><a href="https://fountain.io/_downloads/Brick%20&amp;%20Steel.fountain">Brick &amp; Stell</a>
+<li><a
+href="https://fountain.io/_downloads/Brick%20&amp;%20Steel.fountain">Brick
+&amp; Stell</a>
 <ul>
-<li><a href="https://fountain.io/_downloads/Brick%20&amp;%20Steel.fdx">fdx</a></li>
-<li><a href="https://fountain.io/_downloads/Brick%20&amp;%20Steel.pdf">pdf</a></li>
+<li><a
+href="https://fountain.io/_downloads/Brick%20&amp;%20Steel.fdx">fdx</a></li>
+<li><a
+href="https://fountain.io/_downloads/Brick%20&amp;%20Steel.pdf">pdf</a></li>
 </ul></li>
-<li><a href="https://fountain.io/_downloads/The%20Last%20Birthday%20Card.fountain">Birthday Card</a>
+<li><a
+href="https://fountain.io/_downloads/The%20Last%20Birthday%20Card.fountain">Birthday
+Card</a>
 <ul>
-<li><a href="https://fountain.io/_downloads/The%20Last%20Birthday%20Card.fdx">fdx</a></li>
-<li><a href="https://fountain.io/_downloads/The%20Last%20Birthday%20Card.pdf">pdf</a></li>
+<li><a
+href="https://fountain.io/_downloads/The%20Last%20Birthday%20Card.fdx">fdx</a></li>
+<li><a
+href="https://fountain.io/_downloads/The%20Last%20Birthday%20Card.pdf">pdf</a></li>
 </ul></li>
 </ul>
 </section>

diff --git a/txt2fdx.1.html b/txt2fdx.1.html
@@ -32,26 +32,33 @@ <h1 id="name">NAME</h1>
 <h1 id="synopsis">SYNOPSIS</h1>
 <p>txt2fdx <a href="#options">OPTIONS</a></p>
 <h1 id="description">DESCRIPTION</h1>
-<p>txt2fdx is a command line program that reads a plain text file file and returns a fdx file.</p>
+<p>txt2fdx is a command line program that reads a plain text file file
+and returns a fdx file.</p>
 <h1 id="options">OPTIONS</h1>
 <dl>
 <dt>-help</dt>
-<dd>display help
+<dd>
+display help
 </dd>
 <dt>-license</dt>
-<dd>display license
+<dd>
+display license
 </dd>
 <dt>-version</dt>
-<dd>display version
+<dd>
+display version
 </dd>
 <dt>-i</dt>
-<dd>read input for filename
+<dd>
+read input for filename
 </dd>
 <dt>-o</dt>
-<dd>write output to filename
+<dd>
+write output to filename
 </dd>
 <dt>-newline</dt>
-<dd>add a trailing newline
+<dd>
+add a trailing newline
 </dd>
 </dl>
 <h1 id="examples">EXAMPLES</h1>

diff --git a/txt2fdx.1.md b/txt2fdx.1.md
@@ -1,6 +1,6 @@
-%txt2fdx(1) | 1.0.2 62e2565
+%txt2fdx(1) | 1.0.3 cf91847
 % R. S. Doiel
-% 2024-03-11
+% 2024-05-20
 
 # NAME
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"version":"1.0.4","languages":{"en":{"hash":"en_4e3e661e24","wasm":"en","page_count":9}}}
		{"version":"1.1.0","languages":{"en":{"hash":"en_fe2dbaa848","wasm":"en","page_count":9}}}