Skip to content

Commit

Permalink
Quick Save
Browse files Browse the repository at this point in the history
  • Loading branch information
rsdoiel committed Aug 7, 2022
1 parent 4db5544 commit bd5f490
Show file tree
Hide file tree
Showing 17 changed files with 448 additions and 270 deletions.
2 changes: 1 addition & 1 deletion TODO.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<li><a href="user-manual.html">User Manual</a></li>
<li><a href="license.html">LICENSE</a></li>
<li><a href="about.html">About</a></li>
<li><a href="https://github.com/rsdoiel/pdtk">GitHub</a></li>
<li><a href="https://github.com/rsdoiel/osf">GitHub</a></li>
</ul>
</nav>

Expand Down
51 changes: 51 additions & 0 deletions about.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="language" content="EN">
<title>R. S. Doiel, Software Engineer/Analyst - about</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="about.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.html">LICENSE</a></li>
<li><a href="about.html">About</a></li>
<li><a href="https://github.com/rsdoiel/osf">GitHub</a></li>
</ul>
</nav>

<section>
<!-- <h1>about</h1> -->

<h1 id="about-this-software">About this software</h1>
<h2 id="osf-0.0.4">osf 0.0.4</h2>
<h3 id="authors">Authors</h3>
<ul>
<li>Robert Doiel</li>
</ul>
<p>A library and command line programs for working with FadeIn and Open Screenplay Format (osf) files.</p>
<ul>
<li>License: https://rsdoiel.github.io/osf/license.html</li>
<li>GitHub: https://github.com/rsdoiel/osf</li>
<li>Issues: https://github.com/rsdoiel/osf/issues</li>
</ul>
<h3 id="programming-languages">Programming languages</h3>
<ul>
<li>Go</li>
</ul>
</section>

<footer>
</footer>

</body>
</html>
73 changes: 0 additions & 73 deletions docs/fadein2osf.html

This file was deleted.

51 changes: 36 additions & 15 deletions docs/fadein2osf.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,57 @@
%fadein2osf(1) fadein2osf user manual
% R. S. Doiel
% August 7, 2022

# USAGE
# NAME

fadein2osf [OPTIONS]
fadein2osd

## SYNOPSIS
# SYNOPSIS

fadein2osf [OPTIONS]

# DESCRIPTION

fadein2osf is a command line program that reads an ".fadein" file
and write outs a OSF 2.0 XML.


## OPTIONS
# OPTIONS

-h, -help
: display help

-i, -input
: set the input filename

-l, -license
: display license

-nl, -newline
: add a trailing newline

-o, -output
: set the output filename

-quiet
: suppress error messages

```
-generate-markdown-docs generate Markdown documentation
-h, -help display help
-i, -input set the input filename
-l, -license display license
-nl, -newline add a trailing newline
-o, -output set the output filename
-quiet suppress error messages
-v, -version display version
```
-v, -version:
display version


## EXAMPLES
# EXAMPLES

Convert *screenplay.fadein* into *screenplay.osf*.

~~~shell
fadein2osf -i screenplay.fadein -o screenplay.osf
~~~

Display converted OSF 2.0 XML to the console

~~~shell
fadein2osf -i screenplay.fadein
~~~


73 changes: 0 additions & 73 deletions docs/osf2txt.html

This file was deleted.

52 changes: 37 additions & 15 deletions docs/osf2txt.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,58 @@
% osf2txt(1) osf2txt user manual
% R. S. Doiel
% August 7, 2022

# USAGE
# NAME

osf2txt [OPTIONS]
osf2txt

## SYNOPSIS
# SYNOPSIS

osf2txt [OPTIONS]

# DESCRIPTION

osf2txt is a command line program that reads an osf file
and returns plain text


## OPTIONS
# OPTIONS

-h, -help
: display help

-i, -input
: set the input filename

-l, -license
: display license

```
-generate-markdown-docs generate Markdown documentation
-h, -help display help
-i, -input set the input filename
-l, -license display license
-nl, -newline add a trailing newline
-o, -output set the output filename
-quiet suppress error messages
-v, -version display version
```
-nl, -newline
: add a trailing newline

-o, -output
: set the output filename

## EXAMPLES
-quiet
: suppress error messages

-v, -version
: display version


# EXAMPLES

Cervert *screenplay.osf* into *screenplay.txt*.

~~~shell
osf2txt -i screenplay.osf -o screenplay.txt
~~~

Or alternatively

~~~shell
cat screenplay.osf | osf2txt > screenplay.txt
~~~



Loading

0 comments on commit bd5f490

Please sign in to comment.