To-The-Stars/README.org

1.2 KiB

To The Stars Battle Diagrams and Annotations

This project's goal is to provide visualisations and summaries of battles and plots in the AO3 novel To The Stars.

The battle symbology is derived from NATO Joint Military Symbols and is augmented to ensure full compatibility.

Format

The symbology used in battle diagrams is given in references.tex.

To cite a passage, use the format (VOL CH LINE), e.g. (1.1.123) refers to line 123 of volume 1 chapter 1 (A Wish). The line number is the unfolded line number which can be extracted in Emacs via nov.el and

(setq nov-text-width t)
(add-hook 'nov-mode-hook 'visual-line-mode)

To refer to a character "First, Last", use "Last F.". For example, Shizuki Ryouko is referred to as "Shizuki R.". This format is uniform across the wiki.

The way wiki generates is by assigning a plot timestamp to every part of an org file based on the next citation point.

Wiki Generation

litwiki, a Python package specifically developed for this project, is included here to assist with the progressive generation of wikis.

Contributing

Install an editor capable of handling Org mode files. Install

  • Python 3
  • pylint
  • pre-commit