Skip to content

Commit

Permalink
commiting to main
Browse files Browse the repository at this point in the history
  • Loading branch information
@rsdoiel
rsdoiel committed Feb 18, 2021
1 parent a5eb7ba commit ed37802
Show file tree
Hide file tree
Showing 11 changed files with 716 additions and 455 deletions.
14 changes: 8 additions & 6 deletions INSTALL.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "fountain, a Go package for working with Fountain screenplay format"
+++
{
"title": "fountain, a Go package for working with Fountain screenplay format"
}


Installation
Expand Down Expand Up @@ -36,15 +36,16 @@ For all the released version go to the project page on Github and click latest r
| Pine64 | fountain-VERSION_NUMBER-linux-arm64.zip |


## The basic recipe
The basic recipe
----------------

+ Find the Zip file listed matching the architecture you're running and download it
+ (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).
+ Download the zip file and unzip the file.
+ Copy the contents of the folder named "bin" to a folder that is in your path
+ (e.g. "$HOME/bin" is common).
+ Adjust your PATH if needed
+ (e.g. `export PATH="$HOME/bin:$PATH"`)
+ (e.g. export PATH="$HOME/bin:$PATH")
+ Test


Expand Down Expand Up @@ -130,7 +131,8 @@ downloading the zip file.
```


## Compiling from source
Compiling from source
---------------------

The _fountain_ command line programs are "go gettable". Use the "go get" command to download the dependant packages
as well as source code.
Expand Down
152 changes: 101 additions & 51 deletions TODO.html
View file
Original file line number Diff line number Diff line change
@@ -1,73 +1,123 @@
<!DOCTYPE html>
<html>
<head>
<title><no value></title>
<title>…</title>
<link href="/css/site.css" rel="stylesheet" />
</head>
<body>
<header>
<no value>
…
</header>
<section>
<h1>Action Items</h1>

<h2>Bugs</h2>

<h1 id="action-items">
Action Items
</h1>
<h2 id="bugs">
Bugs
</h2>
<ul class="task-list">
<li>
<input type="checkbox" disabled="" checked="" /> Transition follow by transition at end of script treats the second transition as action, see sample-05.fountain, noticed in HTML output
<ul>
<li>[x] Transition follow by transition at end of script treats the second transition as action, see sample-05.fountain, noticed in HTML output

<ul>
<li>A: OK, the line begins with &ldquo;!&rdquo; so it should be &ldquo;Action&rdquo;</li>
</ul></li>
<li>[ ] sample-05.fountain has the character &ldquo;DOG&rdquo; line identified as &ldquo;dialogue&rdquo;</li>
<li>[ ] sample-07.fountain (charade) has parenthiticals sprinkled in the dialogue, need to support this. It meakes some dialog show up as Action in the JSON stream.</li>
<li>
A: OK, the line begins with “!” so it should be “Action”
</li>
</ul>

<h2>Next (v0.1.0)</h2>

<ul>
<li>[ ] Add test to check to validate parse structure of each <code>testdata/*.fountain</code> file</li>
<li>[ ] Add demo of using <strong>fountain2json</strong> for creating a script report</li>
<li>[ ] Improve <strong>fountainfmt</strong> pretty print options</li>
<li>[ ] handle unlabeled title pages</li>
<li>[x] Write and <strong>fountain2html</strong></li>
<li>[ ] Add CSS dump option for <strong>fountain2html</strong></li>
<li>[ ] Add option to render <a href="https://fountain.io/scrippets">scrippets</a> compatible HTML and CSS</li>
</li>
<li>
<input type="checkbox" disabled="" /> sample-05.fountain has the character “DOG” line identified as “dialogue”
</li>
<li>
<input type="checkbox" disabled="" /> sample-07.fountain (charade) has parenthiticals sprinkled in the dialogue, need to support this. It meakes some dialog show up as Action in the JSON stream.
</li>
</ul>

<h2>Someday, Maybe</h2>

<ul>
<li>[ ] Add support for Markdown front matter for additiona metadata processing</li>
<li>[ ] handle general text (outside of notes, boneyard)

<ul>
<li>this could be handled like front matter in Markdown</li>
</ul></li>
<li>[ ] definable heading prefixes</li>
<li>[ ] reports on screenplay</li>
<li>[ ] fountain2pdf</li>
<h2 id="next-v0.1.0">
Next (v0.1.0)
</h2>
<ul class="task-list">
<li>
<input type="checkbox" disabled="" /> Add test to check to validate parse structure of each <code>testdata/*.fountain</code> file
</li>
<li>
<input type="checkbox" disabled="" /> Add demo of using <strong>fountain2json</strong> for creating a script report
</li>
<li>
<input type="checkbox" disabled="" /> Improve <strong>fountainfmt</strong> pretty print options
</li>
<li>
<input type="checkbox" disabled="" /> handle unlabeled title pages
</li>
<li>
<input type="checkbox" disabled="" checked="" /> Write and <strong>fountain2html</strong>
</li>
<li>
<input type="checkbox" disabled="" /> Add CSS dump option for <strong>fountain2html</strong>
</li>
<li>
<input type="checkbox" disabled="" /> Add option to render <a href="https://fountain.io/scrippets">scrippets</a> compatible HTML and CSS
</li>
</ul>

<h2>Completed</h2>

<h2 id="someday-maybe">
Someday, Maybe
</h2>
<ul class="task-list">
<li>
<input type="checkbox" disabled="" /> Add support for Markdown front matter for additiona metadata processing
</li>
<li>
<input type="checkbox" disabled="" /> handle general text (outside of notes, boneyard)
<ul>
<li>[x] Write Parse(src []byte) returning a Fountain Struct and error</li>
<li>[x] word wrap for dialogue</li>
<li>
this could be handled like front matter in Markdown
</li>
</ul>
</li>
<li>
<input type="checkbox" disabled="" /> definable heading prefixes
</li>
<li>
<input type="checkbox" disabled="" /> reports on screenplay
</li>
<li>
<input type="checkbox" disabled="" /> fountain2pdf
</li>
</ul>
<h2 id="completed">
Completed
</h2>
<ul class="task-list">
<li>
<input type="checkbox" disabled="" checked="" /> Write Parse(src []byte) returning a Fountain Struct and error
</li>
<li>
<input type="checkbox" disabled="" checked="" /> word wrap for dialogue
</li>
</ul>

</section>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="./">README</a></li>
<li><a href="license.html">LICENSE</a></li>
<li><a href="install.html">INSTALL</a></li>
<li><a href="docs/">Documentation</a></li>
<li><a href="testdata.html">Test Data</a></li>
<li><a href="https://github.com/rsdoiel/fountain">GitHub</a></li>
<li>
<a href="/">Home</a>
</li>
<li>
<a href="./">README</a>
</li>
<li>
<a href="license.html">LICENSE</a>
</li>
<li>
<a href="install.html">INSTALL</a>
</li>
<li>
<a href="docs/">Documentation</a>
</li>
<li>
<a href="testdata.html">Test Data</a>
</li>
<li>
<a href="https://github.com/rsdoiel/fountain">GitHub</a>
</li>
</ul>

</nav>
<footer>
copyright (c) 2019 all rights reserved.
Expand Down
94 changes: 54 additions & 40 deletions docs/fountain2html.html
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,30 @@
<!DOCTYPE html>
<html>
<head>
<title><no value></title>
<title>…</title>
<link href="/css/site.css" rel="stylesheet" />
</head>
<body>
<header>
<no value>
…
</header>
<section>
<h1>USAGE</h1>

<pre><code>fountain2html [OPTIONS]
</code></pre>

<h2>DESCRIPTION</h2>

<p>fountain2html is a command line program that reads an fountain document and writes out HTML.</p>

<h2>OPTIONS</h2>

<p>Below are a set of options available.</p>

<h1 id="usage">
USAGE
</h1>
<pre><code>fountain2html [OPTIONS]</code></pre>
<h2 id="description">
DESCRIPTION
</h2>
<p>
fountain2html is a command line program that reads an fountain document and writes out HTML.
</p>
<h2 id="options">
OPTIONS
</h2>
<p>
Below are a set of options available.
</p>
<pre><code> -css Add link for CSS
-generate-manpage generate man page
-generate-markdown generate Markdown documentation
Expand All @@ -34,35 +37,46 @@ <h2>OPTIONS</h2>
-o, -output set the output filename
-quiet suppress error messages
-v, -version display version
-w, -width set the width for the text
</code></pre>

<h2>EXAMPLES</h2>

<p>Convert a <em>screenplay.fountain</em> to <em>screenplay.html</em>.</p>

<pre><code>fountain2html -i screenplay.foutnain -o screenplay.html
</code></pre>

<p>Or alternatively</p>

<pre><code>cat screenplay.fountain | foutnain2html &gt; screenplay.html
</code></pre>

<p>fountain2html v0.0.2</p>

-w, -width set the width for the text</code></pre>
<h2 id="examples">
EXAMPLES
</h2>
<p>
Convert a <em>screenplay.fountain</em> to <em>screenplay.html</em>.
</p>
<pre><code>fountain2html -i screenplay.foutnain -o screenplay.html</code></pre>
<p>
Or alternatively
</p>
<pre><code>cat screenplay.fountain | foutnain2html &gt; screenplay.html</code></pre>
<p>
fountain2html v0.0.2
</p>
</section>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="../">README</a></li>
<li><a href="../license.html">LICENSE</a></li>
<li><a href="../install.html">INSTALL</a></li>
<li><a href="./">Documentation</a></li>
<li><a href="../testdata.html">Test Data</a></li>
<li><a href="https://github.com/rsdoiel/fountain">Github</a></li>
<li>
<a href="/">Home</a>
</li>
<li>
<a href="../">README</a>
</li>
<li>
<a href="../license.html">LICENSE</a>
</li>
<li>
<a href="../install.html">INSTALL</a>
</li>
<li>
<a href="./">Documentation</a>
</li>
<li>
<a href="../testdata.html">Test Data</a>
</li>
<li>
<a href="https://github.com/rsdoiel/fountain">Github</a>
</li>
</ul>

</nav>
<footer>
copyright (c) 2019 all rights reserved.
Expand Down
Loading

0 comments on commit ed37802

Please sign in to comment.