search

adl / hoaf

Hanoi Omega-Automata Format
14 stars 2 forks source link

better typesetting #21

Closed adl closed 10 years ago

adl commented 10 years ago

We need to prepare a better version of these specifications, with better rendering of maths, and pictures of automata to illustrate some example and the semantics. I guess we want both a document that can be printed, and that can be browsed on the web.

Should we use LaTeX? or a better flavor of MarkDown with support for maths?

Note that the repository currently has a Makefile that will compile README.md using pandoc to produce some HTML or PDF. In the current configuration, it is possible to use \(...\) or \[...\] for inline or displayed maths using TeX syntax. It's just the Markdown flavor used at github that do not support that. We could continue using the current markdown file and just host the resulting html on github pages.

adl commented 10 years ago

In commit 2b7eca3 I have typeset all the examples automata in TikZ, setup some conversion from TikZ from SVG, and used that to illustrate each example in the spec. I also tweaked the HTML generated by pandoc and the CSS to get a slightly better rendering than GitHub's built-in MarkDown rendering. The result is at http://adl.github.io/hoaf/ and these web pages are served directly off the gh-pages branch of the repository. These automata will appear as an empty link on github's file browser, since the generated SVG files are not stored on the master branch. But it's good enough to work on the text.

Please do not touch the gh-pages branch directly, as it contains only the files for the web pages, and these are mostly generated files. The Makefile at the root of the master branch contains the necessary instructions to build a local copy of the pages (to work on them) and to publish them on the gh-pages branch.

Figures to illustrate the semantics are still missing.

I haven't yet played with \(...\) and \[...\] to improve the math formating. This will work for the generated web page, but not on github.

adl commented 10 years ago

Rewrote all the maths using Mathjax.