Skip to content

Commit 605c7d6

Browse files
author
R. S. Doiel
committed
Quick Save
1 parent cf91847 commit 605c7d6

22 files changed

+799
-114
lines changed

‎CITATION.cff‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ maintainers:
1515
orcid: ""
1616

1717
repository-code: "https://github.com/rsdoiel/fdx"
18-
version: 1.0.2
18+
version: 1.0.3
1919
license-url: "https://rsdoiel.github.io/fdx/LICENSE"
2020
keywords: [ "GitHub", "text markup", "screen play" ]

‎INSTALL.html‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@
2828
<!-- <h1>INSTALL</h1> -->
2929

3030
<h2 id="installation">Installation</h2>
31-
<p>This project is experimental. Get the latest release from <a href="https://github.com/rsdoiel/fdx/releases/">GitHub</a>.</p>
31+
<p>This project is experimental. Get the latest release from <a
32+
href="https://github.com/rsdoiel/fdx/releases/">GitHub</a>.</p>
3233
<h2 id="quick-install-with-curl">Quick install with curl</h2>
33-
<p>If you are using macOS or Linux you maybe able to install fdx using the following curl command.</p>
34+
<p>If you are using macOS or Linux you maybe able to install fdx using
35+
the following curl command.</p>
3436
<pre class="shell"><code>curl https://rsdoiel.github.io/fdx/installer.sh | sh</code></pre>
3537
<h2 id="install-from-source">Install from source</h2>
3638
<h2 id="requirements">Requirements</h2>
@@ -44,17 +46,21 @@ <h2 id="steps">Steps</h2>
4446
<ol type="1">
4547
<li>Clone the Git repository for the project</li>
4648
<li>change directory into the cloned project</li>
47-
<li>Run <code>make</code>, <code>make test</code> and <code>make install</code></li>
49+
<li>Run <code>make</code>, <code>make test</code> and
50+
<code>make install</code></li>
4851
</ol>
4952
<p>Here’s what that looks like for me.</p>
5053
<pre><code>git clone https://github.com/rsdoiel/fdx src/github.com/rsdoiel/fdx
5154
cd src/github.com/rsdoiel/fdx
5255
make
5356
make test
5457
make install</code></pre>
55-
<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>
58+
<p>By default it will install the programs in <code>$HOME/bin</code>.
59+
<code>$HOME/bin</code> needs to be included in your <code>PATH</code>.
60+
E.g.</p>
5661
<pre><code>export PATH=&quot;$HOME/bin:$PATH&quot;</code></pre>
57-
<p>Can be added to your <code>.profile</code>, <code>.bashrc</code> or <code>.zshrc</code> file depending on your system’s shell.</p>
62+
<p>Can be added to your <code>.profile</code>, <code>.bashrc</code> or
63+
<code>.zshrc</code> file depending on your system’s shell.</p>
5864
</section>
5965

6066
<footer>

‎TODO.html‎

Lines changed: 43 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -31,52 +31,55 @@ <h1 id="action-items">Action Items</h1>
3131
<h2 id="bugs">Bugs</h2>
3232
<h2 id="next">Next</h2>
3333
<ul class="task-list">
34-
<li><input type="checkbox" disabled="" checked="" />
35-
Remove dependency on caltechlibrary/cli</li>
36-
<li><input type="checkbox" disabled="" checked="" />
37-
Update Makefile to generate version.go with Version, LicenseText and ReleaseDate (the date version.go was created)</li>
38-
<li><input type="checkbox" disabled="" checked="" />
39-
Update Makefile so installer.sh and uninstaller.sh is created</li>
40-
<li><input type="checkbox" disabled="" checked="" />
41-
Update codemeta-installer.sh to include Man pages</li>
42-
<li><input type="checkbox" disabled="" checked="" />
43-
Generate individual man pages from -help</li>
44-
<li><input type="checkbox" disabled="" checked="" />
45-
Update website build process to use website.mak</li>
46-
<li><input type="checkbox" disabled="" checked="" />
47-
Add user-manual.md with links to documentation</li>
48-
<li><input type="checkbox" disabled="" checked="" />
49-
Update INSTALL.md to include “Quick install with curl”</li>
50-
<li><input type="checkbox" disabled="" />
51-
Review XML output from ToXML() after a FromFountain() call, see where I need to add mapping for Text elements and embedded styling</li>
52-
<li><input type="checkbox" disabled="" />
53-
validate that I am producing fdx files that Final Draft, FadeIn and Trelby can read</li>
54-
<li><input type="checkbox" disabled="" />
55-
Add support to render as YAML</li>
34+
<li><label><input type="checkbox" checked="" />Remove dependency on
35+
caltechlibrary/cli</label></li>
36+
<li><label><input type="checkbox" checked="" />Update Makefile to
37+
generate version.go with Version, LicenseText and ReleaseDate (the date
38+
version.go was created)</label></li>
39+
<li><label><input type="checkbox" checked="" />Update Makefile so
40+
installer.sh and uninstaller.sh is created</label></li>
41+
<li><label><input type="checkbox" checked="" />Update
42+
codemeta-installer.sh to include Man pages</label></li>
43+
<li><label><input type="checkbox" checked="" />Generate individual man
44+
pages from -help</label></li>
45+
<li><label><input type="checkbox" checked="" />Update website build
46+
process to use website.mak</label></li>
47+
<li><label><input type="checkbox" checked="" />Add user-manual.md with
48+
links to documentation</label></li>
49+
<li><label><input type="checkbox" checked="" />Update INSTALL.md to
50+
include “Quick install with curl”</label></li>
51+
<li><label><input type="checkbox" />Review XML output from ToXML() after
52+
a FromFountain() call, see where I need to add mapping for Text elements
53+
and embedded styling</label></li>
54+
<li><label><input type="checkbox" />validate that I am producing fdx
55+
files that Final Draft, FadeIn and Trelby can read</label></li>
56+
<li><label><input type="checkbox" />Add support to render as
57+
YAML</label></li>
5658
</ul>
5759
<h2 id="someday-maybe">Someday, Maybe</h2>
5860
<ul class="task-list">
59-
<li><input type="checkbox" disabled="" />
60-
Add fdx2json, json2fdx</li>
61-
<li><input type="checkbox" disabled="" />
62-
Add fdx2yaml, yaml2fdx</li>
63-
<li><input type="checkbox" disabled="" />
64-
Write and fdx2html using <a href="https://fountain.io/scrippets">scrippets</a> approach</li>
65-
<li><input type="checkbox" disabled="" />
66-
Left/Right alignment should be respected based based on Paragraph Type</li>
67-
<li><input type="checkbox" disabled="" />
68-
Plaintext formatting needs to be pickup and respected from whole FinalDraft document (e.g. respect definitions, Layout, etc)</li>
69-
<li><input type="checkbox" disabled="" />
70-
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>
61+
<li><label><input type="checkbox" />Add fdx2json, json2fdx</label></li>
62+
<li><label><input type="checkbox" />Add fdx2yaml, yaml2fdx</label></li>
63+
<li><label><input type="checkbox" />Write and fdx2html using <a
64+
href="https://fountain.io/scrippets">scrippets</a> approach</label></li>
65+
<li><label><input type="checkbox" />Left/Right alignment should be
66+
respected based based on Paragraph Type</label></li>
67+
<li><label><input type="checkbox" />Plaintext formatting needs to be
68+
pickup and respected from whole FinalDraft document (e.g. respect
69+
definitions, Layout, etc)</label></li>
70+
<li><label><input type="checkbox" />Screen Headers and Footers can have
71+
Text, Dynamic, SceneProperties in any order, right now converting back
72+
to XML renders them in fixed order because they are ignored when
73+
rendering and plaintext</label></li>
7174
</ul>
7275
<h2 id="completed">Completed</h2>
7376
<ul class="task-list">
74-
<li><input type="checkbox" disabled="" checked="" />
75-
Add ParseFile() to fdx.go</li>
76-
<li><input type="checkbox" disabled="" checked="" />
77-
String() Paragraph needs to handle trailing new lines based on Paragraph Type</li>
78-
<li><input type="checkbox" disabled="" checked="" />
79-
write tests that validate the source FDX content in <em>testout</em> version</li>
77+
<li><label><input type="checkbox" checked="" />Add ParseFile() to
78+
fdx.go</label></li>
79+
<li><label><input type="checkbox" checked="" />String() Paragraph needs
80+
to handle trailing new lines based on Paragraph Type</label></li>
81+
<li><label><input type="checkbox" checked="" />write tests that validate
82+
the source FDX content in <em>testout</em> version</label></li>
8083
</ul>
8184
</section>
8285

‎about.html‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<!-- <h1>about</h1> -->
2929

3030
<h1 id="about-this-software">About this software</h1>
31-
<h2 id="fdx-1.0.1">fdx 1.0.1</h2>
31+
<h2 id="fdx-1.0.3">fdx 1.0.3</h2>
3232
<h3 id="authors">Authors</h3>
3333
<ul>
3434
<li>Robert Doiel</li>
@@ -37,11 +37,15 @@ <h3 id="maintainers">Maintainers</h3>
3737
<ul>
3838
<li></li>
3939
</ul>
40-
<p>A Go package and command line programs for working with fdx XML files used by Screen Writing software.</p>
40+
<p>A Go package and command line programs for working with fdx XML files
41+
used by Screen Writing software.</p>
4142
<ul>
42-
<li>License: <a href="https://rsdoiel.github.io/fdx/LICENSE" class="uri">https://rsdoiel.github.io/fdx/LICENSE</a></li>
43-
<li>GitHub: <a href="https://github.com/rsdoiel/fdx" class="uri">https://github.com/rsdoiel/fdx</a></li>
44-
<li>Issues: <a href="https://github.com/rsdoiel/fdx/issues" class="uri">https://github.com/rsdoiel/fdx/issues</a></li>
43+
<li>License: <a href="https://rsdoiel.github.io/fdx/LICENSE"
44+
class="uri">https://rsdoiel.github.io/fdx/LICENSE</a></li>
45+
<li>GitHub: <a href="https://github.com/rsdoiel/fdx"
46+
class="uri">https://github.com/rsdoiel/fdx</a></li>
47+
<li>Issues: <a href="https://github.com/rsdoiel/fdx/issues"
48+
class="uri">https://github.com/rsdoiel/fdx/issues</a></li>
4549
</ul>
4650
<h3 id="programming-languages">Programming languages</h3>
4751
<ul>

‎about.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ authors:
1111
orcid: "https://orcid.org/0000-0003-0900-6903"
1212

1313
repository-code: "https://github.com/rsdoiel/fdx"
14-
version: 1.0.2
14+
version: 1.0.3
1515
license-url: "https://rsdoiel.github.io/fdx/LICENSE"
1616
keywords: [ "GitHub", "text markup", "screen play" ]
1717

@@ -20,7 +20,7 @@ keywords: [ "GitHub", "text markup", "screen play" ]
2020
About this software
2121
===================
2222

23-
## fdx 1.0.2
23+
## fdx 1.0.3
2424

2525
### Authors
2626

‎fdx2txt.1.html‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,26 +32,33 @@ <h1 id="name">NAME</h1>
3232
<h1 id="synopsis">SYNOPSIS</h1>
3333
<p>fdx2txt <a href="#options">OPTIONS</a></p>
3434
<h1 id="description">DESCRIPTION</h1>
35-
<p>fdx2txt is a command line program that reads an fdx file and returns plain text</p>
35+
<p>fdx2txt is a command line program that reads an fdx file and returns
36+
plain text</p>
3637
<h1 id="options">OPTIONS</h1>
3738
<dl>
3839
<dt>-help</dt>
39-
<dd>display help
40+
<dd>
41+
display help
4042
</dd>
4143
<dt>-license</dt>
42-
<dd>display license
44+
<dd>
45+
display license
4346
</dd>
4447
<dt>-version</dt>
45-
<dd>display version
48+
<dd>
49+
display version
4650
</dd>
4751
<dt>-i</dt>
48-
<dd>read input from file
52+
<dd>
53+
read input from file
4954
</dd>
5055
<dt>-o</dt>
51-
<dd>write output to file
56+
<dd>
57+
write output to file
5258
</dd>
5359
<dt>-newline</dt>
54-
<dd>add a trailing newline
60+
<dd>
61+
add a trailing newline
5562
</dd>
5663
</dl>
5764
<h1 id="examples">EXAMPLES</h1>

‎fdx2txt.1.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
%fdx2txt(1) | version 1.0.2 62e2565
1+
%fdx2txt(1) | version 1.0.3 cf91847
22
% R. S. Doiel
3-
% 2024-03-11
3+
% 2024-05-20
44

55
# NAME
66

‎index.html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,21 @@
2727
<section>
2828
<!-- <h1>README</h1> -->
2929

30-
<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>
30+
<p><a href="https://www.repostatus.org/#inactive"><img
31+
src="https://www.repostatus.org/badges/latest/inactive.svg"
32+
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>
3133
<h1 id="fdx">fdx</h1>
32-
<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>
34+
<p><em>fdx</em> is a Golang package for working with XML files produced
35+
by many script writing programs (e.g. <a
36+
href="http://www.trelby.org/">Trelby</a>, <a
37+
href="https://storywriter.amazon.com">Amazon Storywriter</a>, <a
38+
href="https://www.celtx.com/index.html">Celtx</a>, <a
39+
href="https://www.fadeinpro.com/">Fade In</a> and of course recent
40+
versions of <a href="https://www.finaldraft.com/">Final Draft</a>). This
41+
package also includes a demonstration command line program called <a
42+
href="docs/">fdx2txt</a> which will read an <em>fdx</em> file and render
43+
plain text in a <a href="https://fountain.io">Fountain</a> like
44+
format.</p>
3345
</section>
3446

3547
<footer>

‎installer.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Set the package name and version to install
55
#
66
PACKAGE="fdx"
7-
VERSION="1.0.2"
7+
VERSION="1.0.3"
88
GIT_GROUP="rsdoiel"
99
RELEASE="https://github.com/$GIT_GROUP/$PACKAGE/releases/tag/v$VERSION"
1010

‎pagefind/fragment/en_9b3bb1d.pf_fragment‎

253 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)