Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added initial version of fountaincvt utility #4

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

added initial version of fountaincvt utility #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 54 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A [custom pandoc reader] for [Fountain] screenplay markup.

## Basic Usage

To convert from Fountain to HTML:

```
Expand Down Expand Up @@ -30,6 +32,57 @@ pandoc -f fountain.lua sample.fountain -s -t html5 \
--css fountain.css --template ./fountain.html5 -o sample.pdf
```

## The `fountaincvt` Utility

The `fountaincvt` utility is a shell script wrapper around the foregoing
code samples. Its help message, which explains usage, is reproduced
below:

```text
******************************************************************************
***** Pandoc Fountain Conversion Wrapper 1.00 *****
***** Tammy Cravit / [email protected] / tammymakesthings.com *****
******************************************************************************

******************************************************************************
***** Pandoc Fountain Conversion Wrapper 1.00 *****
***** Tammy Cravit / [email protected] / tammymakesthings.com *****
******************************************************************************

Usage: fountaincvt -h
fountaincvt [ -v ] [ -d ] [ -q ] [-o output_file] [-x extra_opts] <input_file> <output_format>

Command-Line Options:
-v Enable debugging messages.
-d Skip tools checks.
-q Quiet mode (less verbose output).
-o <output_file> Override the automatically set output file.
-x <extra_options> Add extra options to Pandoc. See below for
an important note if using this option.

Environment Variables:
PANDOC Location of the 'pandoc' binary.
Searched for in the path if not set.
Current Value: /opt/homebrew/bin/pandoc
PANDOC_FOUNTAIN Location of the 'pandoc-fountain' files.
Defaults to '/Users/tammycravit/projects/pandoc-fountain'.
Current Value: /Users/tammycravit/projects/pandoc-fountain
PANDOC_PDF_EXTRA_OPTS Extra options for pandoc for PDF conversion.
Current Value: <none>
PANDOC_HTML_EXTRA_OPTS Extra options for pandoc for HTML conversion.
Current Value: <none>
PANDOC_EPUB_EXTRA_OPTS Extra options for pandoc for EPUB conversion.
Current Value: <none>
PANDOC_DOCX_EXTRA_OPTS Extra options for pandoc for DOCX conversion.
Current Value: <none>

NOTE: If any of the PANDOC_*_EXTRA_OPTS variables are set, those options
will be applied IN ADDITION TO options specified with the '-x'
flag.

Version: 1.00, 2023-05-08
https://github.com/tammymakesthings/pandoc-fountain
```

[Fountain]: https://fountain.io/
[custom pandoc reader]: https://pandoc.org/custom-readers.html

Loading