Parenthetical Notes

bstanly

Notes:

  1. Wiki format is expressed in terms of the Markdown syntax, However there is no standard for Markdown. Rather each Wiki site has a modest subset in common and then goes its own way on whatever seems nice to the site operators.
  2. The STF translator attempts to cast its output (when --wiki is specified) to the most common subset of Markdown. However even then, there are incompatibilities between sites. This leads to a dielmma. Should the translator support multiple flags such as --wiki2, --wiki3, ...? This approach results in multiple translators (and possibly midnight madness for your humble author.) Or support modifying the output according to embedded commands. This results in a single Wiki translator with the ability to tweak its output according to formatting flags.
  3. For the nonce, I have chosen the latter approach.
  4. The current Wiki expansion displays correctly on SourceForge and by using a GitHub formatter (http://tmpvar.com/markdown.html.) Thus to target to a Wiki site, run the default (which happens to support the SourceForge and GitHub wiki formats) and if it doesn't look right on other sites, examine the STF Syntax Summary and see how to tweak the output to conform to other sites' syntax.
  5. Exercise care when a document is to be processed on both Linux/UNIX and Windows, as the Linux/UNIX file system is case sensitive. For example including SampleFile.txt, when the actual name is samplefile.txt works under Windows but fails under Linux/UNIX.

Related

Wiki: DocumationMagic
Wiki: STFXLateSummary