2023-08-21 23:31:24 -07:00
|
|
|
* 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~.
|
|
|
|
|
|
2023-09-11 20:40:30 -07:00
|
|
|
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
|
2023-08-22 23:19:38 -07:00
|
|
|
number which can be extracted in Emacs via ~nov.el~ and
|
|
|
|
|
#+begin_src emacs-lisp
|
2023-08-21 23:31:24 -07:00
|
|
|
(setq nov-text-width t)
|
|
|
|
|
(add-hook 'nov-mode-hook 'visual-line-mode)
|
2023-08-22 23:19:38 -07:00
|
|
|
#+end_src
|
|
|
|
|
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~
|
