This is a SublimeText 4 plug-in (package) that enhances the experience of writing prose (fiction or non) using the AsciiDoc markup language (the AsciiDoctor flavor in particular).
|
Note
|
This package is intended to supplement another general-purpose AsciiDoc package called ST4-Asciidoctor, which provides syntax highlighting, dozens of snippets and commands, and other basics for working with AsciiDoc). |
Here is a summary of the main features of this package. See the user guide for details on these, as well as a full list of secondary features not highlighted here.
First off, we introduce a number of “Daily Shortcuts” for working with small amounts of selected text:
-
Transpose selected text. For example,
Janet gave the basket to GeorgebecomesGeorge gave the basket to Janet, orhalf-rightbecomesright-half. -
Create AsciiDoc links around selected text. For example,
Star Warsbecomes<<star-wars,Star Wars>>. -
Create AsciiDoc index notation around selected text. For example,
Star Warsbecomes. -
Convert the selected text from CamelCase to snake_case and vice versa.
-
Convert an inline quotation to an AsciiDoc quote block, e.g.
Eureka! — Archimedesbecomes[quote, Archimedes.]\nEureka!.
We also have a number of “Power Tools” for working with large amounts of selected text:
-
Fix up text that has been converted to AsciiDoc (e.g. via Pandoc) in 20 different ways, e.g. converting dumb quotes to typographical quotes, and separating sentences each to its own line.
-
Renumber chapters. For example,
== Chapter One…== Chapter 1.5…== Chapter Twobecomes== Chapter One…== Chapter Two…== Chapter Three. -
Update old-style AsciiDoc to AsciiDoctor syntax.
-
A mechanism for allowing the drag-and-drop of images into an AsciiDoc file where the corresponding
image::[]links are automatically created. -
An anchored subsection snippet. As you type in the section title, a corresponding anchor ID is generated. It is guaranteed to be lower-case and use hyphens instead of spaces.
-
Align an AsciiDoc table vertically so that it is easier to read.
There are a few features specifically for writing fiction:
-
A set of snippets for developing a story: character sheet, location sheet, scene card, story element, etc.
-
A rudimentary story-generator with a customizable template to kick start a writing exercise.
-
A command that standardizes scene breaks into AsciiDoc horizontal rule (''') syntax.
And, finally there are some Journaling features:
For writers of nonfiction/technical documents, these tools drastically speed up the workflows for cross-referencing and indexing the material, building tables, and more.
For fiction writers, this makes Sublime Text + Asciidoc a viable alternative to Scrivener. This is aimed at any author who is already an AsciiDoc user (e.g. writes technical documents for a living), or who grasps the benefits of AsciiDoc for self-publishing.
For editors and publishers who have standardized on using AsciiDoc, these power tools make it easy to import manuscripts into AsciiDoc format and whip them into shape.
This package is functional, but enhancements are pending. See the issues page.
This repository is not yet a full-fledged package that can be installed using SublimeText Package Control. Therefore, it must be manually installed, via Git:
-
From your terminal, navigate to your Packages subdirectory under the ST3’s data directory:
-
OS X:
~/Library/Application\ Support/Sublime\ Text\ 3/Packages/ -
Linux:
~/.config/sublime-text-3/Packages/ -
Windows:
%APPDATA%\Sublime Text 3\Packages\
-
-
From that directory, invoke Git to clone this repository into the
Asciidoc-Prosesubdirectory:git clone https://github.com/gruntwurk/Asciidoc-Prose.git Asciidoc-Prose
-
Restart SublimeText.
Any contribution to this project is most welcome, whether it’s a suggestion submitted by opening a new issue, or contributions to the code via pull requests using Git.
This is an original package developed by Craig Jones (https://github.com/polyglot-jones).
This project is licensed under MIT License. For the full text of the license, see the LICENSE file
Adds AsciiDoc support to SublimeText 4 — specifically, Asciidoctor-flavored support. It provides syntax highlighting, dozens of snippets and commands, and other basics for working with AsciiDoc). This package pretty much counts on ST4-Asciidoctor being installed as well.