Skip to content
Permalink
Browse files

Update README example links, delete screenshots/01.png

  • Loading branch information
rnkn committed May 21, 2019
1 parent eef014a commit a017347d29975bd032f22feb923d874d7d89c5e8
Showing with 67 additions and 95 deletions.
  1. 0 LICENSE.txt → LICENSE
  2. +33 −53 README.md
  3. +34 −42 fountain-mode.el
  4. BIN screenshots/01.png
File renamed without changes.
@@ -1,81 +1,61 @@
Fountain Mode
=============
# Fountain Mode #

Fountain Mode is a screenwriting environment for GNU Emacs using the Fountain
markup format. For more information on the Fountain markup format, visit
<http://fountain.io>.
Fountain Mode is a screenwriting environment for GNU Emacs using the
Fountain markup format. For more information on the Fountain markup
format, visit http://fountain.io.

![screenshot](https://github.com/rnkn/fountain-mode/raw/master/screenshots/01.png)
Screenshot: https://f002.backblazeb2.com/file/pwr-share/fountain-mode.png

Pictured: *The Abductors* by Paul W. Rankin in Fountain Mode (using [imenu-list] and
[Olivetti] minor modes)

[imenu-list]: https://github.com/bmag/imenu-list "imenu-list"
[olivetti]: https://github.com/rnkn/olivetti "Olivetti"

Features
--------
## Features ##

- Support for Fountain 1.1 specification
- WYSIWYG auto-align elements (display only, does not modify file contents)
specific to script format, e.g. screenplay, stageplay or user-defined format
- Traditional <kbd>TAB</kbd> writing style for auto-upcasing character names
(see [Do What I Mean])
- Navigation by section, scene, character name, or page
- 3 levels of syntax highlighting
- Integration with outline to fold/cycle visibility of sections and scenes
- Integration with imenu (sections, scene headings, notes)
- Intergration with auto-insert for title page metadata
- Traditional TAB auto-completion writing style
- Automatically add/remove character "(CONT'D)"
- Export to plain text, HTML, LaTeX, Final Draft (FDX), or Fountain
- Export to standalone document or snippet
- Optionally show approximate page count (current page of total pages) in
mode-line
- Include external files with `{{ include: FILENAME }}`
- Integration with `outline` to fold/cycle visibility of sections and scenes
(see [Outlining])
- Integration with `imenu` (sections, scene headings, notes)
- Intergration with `auto-insert` for title page metadata
- Add/remove automatic continuation string to successively speaking characters
- Navigation by section, scene, character name, or page
- Emphasis (bold, italic, underlined text)
- Include external files with {{ include: FILENAME }}
- Optionally display scene numbers in the right margin
- Intelligent insertion of a page breaks
- 3 levels of element syntax highlighting
- Automatic loading for `*.fountain` files
- Automatic loading for *.fountain files
- Include or omit a title page
- Emphasis (bold, italic, underlined text)
- Toggle visibility of emphasis delimiters and syntax characters
- Everything is customizable
Check out the Nicholl Fellowship sample script exported from Fountain Mode to:
- [Plain text](https://gist.github.com/rnkn/edd4fd20e0f6ce2ca1f75e37496e38c9/raw/)
- [HTML](https://rawgit.com/rnkn/mcqueen/master/sample/sample.html)
- [LaTeX](https://www.sharelatex.com/project/54ed9180966959cb7fdbde8e)
- [Final Draft](https://gist.github.com/rnkn/f56934ac723d43c5dec63952dd99dcfd/raw/)

Most common features are accessible from the menu. For a full list of functions
and key-bindings, type <kbd>C-h m</kbd>.
- Plain text: https://paste.sr.ht/blob/930557283847c35cafbba81cf34f389980b35b3c
- HTML: https://f002.backblazeb2.com/file/pwr-share/fountain-export.html
- Final Draft: https://f002.backblazeb2.com/file/pwr-share/fountain-export.fdx
- LaTeX: https://www.overleaf.com/project/54ed9180966959cb7fdbde8e
[Do What I Mean]: https://github.com/rnkn/fountain-mode/wiki/Do-What-I-Mean
[Outlining]: https://github.com/rnkn/fountain-mode/wiki/Outlining
Most common features are accessible from the menu. For a full list of
functions and key-bindings, type C-h m.
For more, see the [Wiki](https://github.com/rnkn/fountain-mode/wiki).

Requirements
------------
## Requirements ##
- Emacs 24.5
- LaTeX packages for PDF export: `geometry` `fontspec` `titling` `fancyhdr`
`marginnote` `ulem` `xstring` `oberdiek`
- LaTeX packages for PDF export: geometry fontspec titling fancyhdr
marginnote ulem xstring oberdiek
Installation
------------
## Installation ##
Fountain Mode is now part of GNU ELPA and can be installed with `M-x
package-install RET fountain-mode RET`.
Fountain Mode is now part of GNU ELPA and can be installed with M-x
package-install RET fountain-mode RET.
History
-------
## History ##
See: <https://git.sr.ht/~pwr/fountain-mode/refs>
See: https://git.sr.ht/~pwr/fountain-mode/refs
Contributing
------------
## Contributing ##
To report bugs, please use `M-x report-emacs-bug RET` or send an email to
To report bugs, please use M-x report-emacs-bug RET or send an email to
<bug-gnu-emacs@gnu.org>. Please include "fountain" in the subject.
@@ -1,6 +1,6 @@
;;; fountain-mode.el --- Major mode for screenwriting in Fountain markup -*- lexical-binding: t; -*-

;; Copyright (c) 2014-2019 Free Software Foundation, Inc.
;; Copyright (c) 2014-2019 Free Software Foundation, Inc.

;; Author: Paul Rankin <hello@paulwrankin.com>
;; Keywords: wp, text
@@ -24,73 +24,65 @@

;;; Commentary:

;; Fountain Mode
;; =============
;; # Fountain Mode #

;; Fountain Mode is a screenwriting environment for GNU Emacs using the Fountain
;; markup format. For more information on the Fountain markup format, visit
;; <http://fountain.io>.
;; Fountain Mode is a screenwriting environment for GNU Emacs using the
;; Fountain markup format. For more information on the Fountain markup
;; format, visit http://fountain.io.

;; Features
;; --------
;; Screenshot: https://f002.backblazeb2.com/file/pwr-share/fountain-mode.png

;; ## Features ##

;; - Support for Fountain 1.1 specification
;; - WYSIWYG auto-align elements (display only, does not modify file contents)
;; specific to script format, e.g. screenplay, stageplay or user-defined format
;; - Traditional TAB writing style for auto-upcasing character names
;; (see [Do What I Mean])
;; - Navigation by section, scene, character name, or page
;; - 3 levels of syntax highlighting
;; - Integration with outline to fold/cycle visibility of sections and scenes
;; - Integration with imenu (sections, scene headings, notes)
;; - Intergration with auto-insert for title page metadata
;; - Traditional TAB auto-completion writing style
;; - Automatically add/remove character "(CONT'D)"
;; - Export to plain text, HTML, LaTeX, Final Draft (FDX), or Fountain
;; - Export to standalone document or snippet
;; - Optionally show approximate page count (current page of total pages) in
;; mode-line
;; - Include external files with `{{ include: FILENAME }}`
;; - Integration with `outline` to fold/cycle visibility of sections and scenes
;; (see [Outlining])
;; - Integration with `imenu` (sections, scene headings, notes)
;; - Intergration with `auto-insert` for title page metadata
;; - Add/remove automatic continuation string to successively speaking characters
;; - Navigation by section, scene, character name, or page
;; - Emphasis (bold, italic, underlined text)
;; - Include external files with {{ include: FILENAME }}
;; - Optionally display scene numbers in the right margin
;; - Intelligent insertion of a page breaks
;; - 3 levels of element syntax highlighting
;; - Automatic loading for `*.fountain` files
;; - Automatic loading for *.fountain files
;; - Include or omit a title page
;; - Emphasis (bold, italic, underlined text)
;; - Toggle visibility of emphasis delimiters and syntax characters
;; - Everything is customizable

;; Check out the Nicholl Fellowship sample script exported from Fountain Mode to:

;; - [Plain text](https://gist.github.com/rnkn/edd4fd20e0f6ce2ca1f75e37496e38c9/raw/)
;; - [HTML](https://rawgit.com/rnkn/mcqueen/master/sample/sample.html)
;; - [LaTeX](https://www.sharelatex.com/project/54ed9180966959cb7fdbde8e)
;; - [Final Draft](https://gist.github.com/rnkn/f56934ac723d43c5dec63952dd99dcfd/raw/)
;; - Plain text: https://paste.sr.ht/blob/930557283847c35cafbba81cf34f389980b35b3c
;; - HTML: https://f002.backblazeb2.com/file/pwr-share/fountain-export.html
;; - Final Draft: https://f002.backblazeb2.com/file/pwr-share/fountain-export.fdx
;; - LaTeX: https://www.overleaf.com/project/54ed9180966959cb7fdbde8e

;; Most common features are accessible from the menu. For a full list of functions
;; and key-bindings, type C-h m.
;; Most common features are accessible from the menu. For a full list of
;; functions and key-bindings, type C-h m.

;; [Do What I Mean]: https://github.com/rnkn/fountain-mode/wiki/Do-What-I-Mean
;; [Outlining]: https://github.com/rnkn/fountain-mode/wiki/Outlining

;; For more, see the [Wiki](https://github.com/rnkn/fountain-mode/wiki).

;; Requirements
;; ------------
;; ## Requirements ##

;; - Emacs 24.5
;; - LaTeX packages for PDF export: geometry fontspec titling fancyhdr
;; marginnote ulem xstring oberdiek

;; Installation
;; ------------
;; ## Installation ##

;; Fountain Mode is now part of GNU ELPA and can be installed with M-x
;; package-install RET fountain-mode RET.

;; ## History ##

;; Fountain Mode is now part of GNU ELPA and can be installed with `M-x
;; package-install RET fountain-mode RET`.
;; See: https://git.sr.ht/~pwr/fountain-mode/refs

;; Reporting Bugs
;; --------------
;; ## Contributing ##

;; To report bugs, please use `M-x report-emacs-bug RET` or send an email to
;; To report bugs, please use M-x report-emacs-bug RET or send an email to
;; <bug-gnu-emacs@gnu.org>. Please include "fountain" in the subject.


BIN -927 KB screenshots/01.png
Binary file not shown.

0 comments on commit a017347

Please sign in to comment.
You can’t perform that action at this time.