branch: externals/fountain-mode
commit a017347d29975bd032f22feb923d874d7d89c5e8
Author: Paul W. Rankin <he...@paulwrankin.com>
Commit: Paul W. Rankin <he...@paulwrankin.com>
Update README example links, delete screenshots/01.png
---
LICENSE.txt => LICENSE | 0
README.md | 86 +++++++++++++++++++------------------------------
fountain-mode.el | 76 +++++++++++++++++++------------------------
screenshots/01.png | Bin 949424 -> 0 bytes
4 files changed, 67 insertions(+), 95 deletions(-)
diff --git a/LICENSE.txt b/LICENSE
similarity index 100%
rename from LICENSE.txt
rename to LICENSE
diff --git a/README.md b/README.md
index c7f7e57..7b02b0e 100644
--- a/README.md
+++ b/README.md
@@ -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://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-em...@gnu.org>. Please include "fountain" in the subject.
+
diff --git a/fountain-mode.el b/fountain-mode.el
index 84ffb48..b79cba4 100644
--- a/fountain-mode.el
+++ b/fountain-mode.el
@@ -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 <he...@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-em...@gnu.org>. Please include "fountain" in the subject.
diff --git a/screenshots/01.png b/screenshots/01.png
deleted file mode 100644
index 5c5d853..0000000
Binary files a/screenshots/01.png and /dev/null differ
![[elpa] externals/fountain-mode a017347 1/4: Update README example links, delete screenshots/01.png](/search?l=emacs-elpa-diffs@gnu.org&q=subject:%22%5C%5Belpa%5C%5D+externals%5C%2Ffountain%5C-mode+a017347+1%5C%2F4%5C%3A+Update+README+example%09links%2C+delete+screenshots%5C%2F01.png%22&o=newest){kind=link}
