-
Notifications
You must be signed in to change notification settings - Fork 5
/
scripttool.1.html
226 lines (221 loc) · 6.06 KB
/
scripttool.1.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="language" content="EN">
<title>R. S. Doiel, Software Engineer/Analyst - scripttool.1</title>
<link rel="stylesheet" type="text/css" href="/printfonts/print.css" media="print" />
<link rel="stylesheet" type="text/css" href="/webfonts/fonts.css" media="screen" />
<link rel="stylesheet" type="text/css" href="/css/site.css" media="screen" />
<link title="RSS feed for rsdoiel's blog" rel="alternate" type="application/rss+xml" href="https://rsdoiel.github.io/rss.xml" />
<link title="markdown source for page" rel="alternative" type="application/markdown" href="scripttool.1.md">
</head>
<body>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="./">README</a></li>
<li><a href="user_manual.html">User Manual</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="about.html">About</a></li>
<li><a href="INSTALL.html">Install</a></li>
<li><a href="https://github.com/rsdoiel/scripttool">GitHub</a></li>
</ul>
</nav>
<section>
<!-- <h1>scripttool.1</h1> -->
<h1 id="name">NAME</h1>
<p>scripttool</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>scripttool [-help,-version,-license] VERB <a
href="#options">OPTIONS</a> [VERB PARAMETERS]</p>
<h1 id="description">DESCRIPTION</h1>
<p><em>scripttool</em> a program for converting between screenplay
formats (e.g. .fdx, .fadein, .fountain)</p>
<p><em>scripttool</em> converts screen play file formats. Supported
formats include FileDraft’s XML format, FadeIn’s zipped XML format,
Fountain formatted plain text as the Open Screenplay Format XML
documents. The command line program is based on a Go package also called
scripttool. The Go package can be compiled to a shared library and
integrated with Python via the ctypes package.</p>
<p>Internally <em>scripttool</em> works with Fountain formatter files
for reporting purposes. You can use the <code>fountain2json</code> verb
to see the data structure represented as JSON for reports.</p>
<h1 id="verbs">verbs</h1>
<p>Like many recent command line tools running under POSIX
<em>scripttool</em> uses a
<code>CMD VERB [INPUT_FILENAME] [OUTPUT_FILENAME]</code> scheme. The
following verbs are provided. Each “verb” may also have related
options.</p>
<h2 id="convert-fadein-files">Convert FadeIn files</h2>
<dl>
<dt>fadein2fdx</dt>
<dd>
Converts a FadeIn file to Final Draft XML
</dd>
<dt>fadein2fountain</dt>
<dd>
Converts a FadeIn file to fountain screenplay format
</dd>
<dt>fadein2json</dt>
<dd>
Convert a FadeIn file to JSON format
</dd>
<dt>fadein2osf</dt>
<dd>
Convert a FadeIn file to Open Screenplay Format 2.0
</dd>
</dl>
<h2 id="convert-final-draft-xml">Convert Final Draft XML</h2>
<dl>
<dt>fdx2fadein</dt>
<dd>
Convert from Final Draft XML (“*.fdx” files) to FadeIn format
</dd>
<dt>fdx2fountain</dt>
<dd>
Convert from Final Draft XML (“*.fdx” files) to Fountain screenplay
format)
</dd>
<dt>fdx2json</dt>
<dd>
Convert from Final Draft XML (“*.fdx” files) to JSON
</dd>
<dt>fdx2osf</dt>
<dd>
Convert from Final Draft XML (“*.fdx” files) to Open Screenplay Format
2.0
</dd>
</dl>
<h2 id="convert-open-screenplay-format-2.0">Convert Open Screenplay
Format 2.0</h2>
<dl>
<dt>osf2fadein</dt>
<dd>
Convert from Open Screenplay Format 2.0 to FadeIn
</dd>
<dt>osf2fdx</dt>
<dd>
Convert from Open Screenplay Format 2.0 to Final Draft XML
</dd>
<dt>osf2fountain</dt>
<dd>
Convert from Open Screenplay Format 2.0 to Fountain screenplay format
</dd>
<dt>osf2json</dt>
<dd>
Convert from Open Screenplay Format 2.0 to JSON
</dd>
</dl>
<h2 id="convert-fountain-fomat">Convert Fountain fomat</h2>
<dl>
<dt>fountain2fadein</dt>
<dd>
Converts a fountain screenplay formatted file to FadeIn formatted file.
</dd>
<dt>fountain2fdx</dt>
<dd>
Convert a Fountain screenplay formatted file to Final Draft XML
</dd>
<dt>fountain2json</dt>
<dd>
Convert a Fountain screenplay formatted file to JSON
</dd>
<dt>fountain2osf</dt>
<dd>
Convert a Fountain screenplay formatted file to Open Screenplay Format
2.0
</dd>
<dt>fountainfmt</dt>
<dd>
Pretty print a fountain screenplay format
</dd>
<dt>characters</dt>
<dd>
Provide a character list from a fountain formatted file. Internally the
fountain file is parse and resulting JSON structure is analyzed to
produce the count of character references in the elements of the file.
</dd>
</dl>
<h1 id="options">OPTIONS</h1>
<p>Below are a set of options available.</p>
<dl>
<dt>-help</dt>
<dd>
display help
</dd>
<dt>-license</dt>
<dd>
display license
</dd>
<dt>-version</dt>
<dd>
display version number
</dd>
</dl>
<h1 id="verb-options">VERB OPTIONS</h1>
<dl>
<dt>-i</dt>
<dd>
set input filename
</dd>
<dt>-o</dt>
<dd>
set output filename
</dd>
<dt>-notes</dt>
<dd>
include notes in output
</dd>
<dt>-synopsis</dt>
<dd>
include synopsis in output
</dd>
<dt>-section</dt>
<dd>
include section headings in output
</dd>
<dt>-width</dt>
<dd>
set max width in integers
</dd>
<dt>-html</dt>
<dd>
output full HTML page
</dd>
<dt>-inline-css</dt>
<dd>
include inline CSS (works with -html option)
</dd>
<dt>-link-css</dt>
<dd>
include CSS link (works with -html option)
</dd>
<dt>-pretty</dt>
<dd>
pretty print output
</dd>
<dt>-alpha</dt>
<dd>
sort characters alphabetically instead of appearence order
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
<p>Converting <em>screenplay.fdx</em> to <em>screenplay.fountain</em> (2
examples)</p>
<pre class="shell"><code> scripttool fdx2fountain screenplay.fdx screenplay.fountain
scripttool fdx2fountain -i screenplay.fdx -o screenplay.fountain</code></pre>
<p>Converting <em>screenplay.fountain</em> to <em>screenplay.fdx</em> (2
examples)</p>
<pre class="shell"><code> scripttool fountain2fdx screenplay.fountain screenplay.fdx
scripttool fountain2fdx -i screenplay.fountain -o screenplay.fdx</code></pre>
<p>Listing characters from a <em>screenplay.fountain</em>. First list is
order of appearence and the second set is characters sorted
alphabetically using the “-alpha” option.</p>
<pre class="shell"><code> scripttool characters screenplay.fountain
scripttool characters -alpha screenplay.fountain</code></pre>
</section>
<footer>
</footer>
</body>
</html>