Instructions to help writing reference documentation

Some notes about what I’ve done these last days, trying to make things better, in parallel to the pages written by @grosgood.

In particular :

  • Automatic anchors put for each section/subsection.
  • Explicit anchor links in text (equivalent to invisible sections).
  • Rendering of math formula as embedded images (with pdflatex and gs).
  • Blockquotes.
  • Detail block.
  • Shell command.

I’m probably done with it, unless someone has a very special need that could not be replaced by an existing syntax.
I was thinking about adding tables, but I’m not really fan of the idea anymore, mainly because:

  • The G’MIC-Markdown has to generate, not only HTML pages, but also ascii (for console) and man pages. Formating tables in ascii is a pain, and it’s almost impossible to get a coherent rendering of a table in ascii.
  • I believe tables can actually be replaced most of the time by a different presentation. And if you really need tables, then it’s still possible to generate one, either with a G’MIC pipeline, or a LaTeX formula.

I’ve also re-implemented a “tutorial generation script” from scratch, that generates the tutorial pages according to the G’MIC website structure. I’ll be able to re-generate the complete tutorial pages at each new G’MIC release (just as I do for the reference documentation). It will ensure that the generated image and text will be always up-to-date.

What I need to do now is:

  • Finalize the ascii and man output for the Markdown generator, implementing the latest features for these outputs.
  • Continue converting the existing tutorial pages into the new markdown format.
  • Convince people other than @grosgood to write documentation pages as well. It’s now easier than ever :slight_smile:
2 Likes