Skip to content

Latest commit

 

History

History
67 lines (59 loc) · 3.61 KB

README.md

File metadata and controls

67 lines (59 loc) · 3.61 KB
Raw

Zoia

CI Coverage Status License: GPLv3

A language for writing fiction.

Status & Agenda

  • Write a grammar
  • Create a functional lexer/parser via ANTLR
  • Implement AST node classes
  • Write a converter (parse tree -> AST)
  • Implement canonical reprs for all AST nodes
  • Come up with some tests for the lexer, parser and canonical repr
  • Experiment with AO3 (the primary output target) drafts:
    • What's the nicest output format? One file, multiple files? -> multiple HTML files
    • What about summaries and author notes? -> separate files per chapter
    • And all the other stuff (warnings, tags, etc.)? -> useful because we want to be independent of AO3 - also, a newline-separated list of tags is much nicer than a gigantic single comma-separated line
    • Revisit later: What about work summaries/notes? E.g. this fic has:
      • A work summary
      • Author notes at the beginning of the work
      • Author notes at the end of the work
      • A summary on the first chapter
      • Author notes at the end of the first chapter
    • But the AO3 form only has three boxes for entering a summary and 2x notes
    • Probably can't figure this out without actually posting a fic, hence revisit later
    • Work off the assumption that we'll potentially put out three extra files for work summaries and notes
  • Come up with a mockup for a project layout (src, build, config, etc.)
  • Come up with mockup classes to model this (series, story, chapter)
  • Write tests for these mockup classes (not really mockup anymore, so hey)
  • Model how we want the whole system to process our nodes (rough draft):
    • 1. Evaluate aliases
    • 2. Evaluate dictionary
    • 3. Insert fragments
    • 4. Resolve aliases (repeat until no more alias nodes left)
    • At this point, we hand off to the separate backends
    • 5. Evaluate lines top to bottom, left to right. Commands get executed here, resolving either to text fragments or to nothing at all (in which case they probably have side effects).
    • 6. Once a line is evaluated, combine all text fragments
    • 7. Keep combining fragments together (newlines become spaces, similar to HTML) until we hit a double newline or a breaking command - that marks the end of a paragraph
  • Consider other types of HTML markup and how to integrate those
  • Write a user-friendly CLI for setting up a new project, creating new chapters, etc.
  • Come up with a good way to deploy this on Linux
  • Bonus credit: same thing, but on Windows (ugh)

Name

Named after Zoia Markovna Horn, an American librarian and advocate for intellectual freedom.

License

Zoia is licensed under the GPLv3.

For information on third party dependencies and their licenses, please see doc/LICENSE-3RD-PARTY.

Note that this does not affect fiction you write using it, nor does it affect the output generated from such fiction once Zoia compiles it. You may license that data however you like.

The examples inside doc/examples are not part of Zoia itself and are licensed under other licenses. See the LICENSE files inside those folders for more information.