MoinMoin: ParserMarket/LiterateProgramming/ReleaseNotes

Literate Programming declarations and cross links, exporter action for MoinMoin. See OlegKobchenko, download at ParserMarket.

This is an example of Literate programming style, where the code fragments are explained to the humans in the order as it fits to the explanation. The hypertext linking allows to track the relationships between fragments and then also to assemble the code units fit to be executed by a computer.

For an example of literate programming style, see J Language Wiki at http://www.jsoftware.com/jwiki/Literate. It uses a combination of an action and a parser.

Usage

Code fragments are marked with literate format, specifying anchor name and optional caption, which produces the fragment declaration «anchor»=.
   {{{#!literate name='anchor' caption='Optional caption'
   code here ...
      «target»
   ...
   }}}

The body of the fragment can contain links to other fragments marked with target anchor name in angle double quotes «target», or guillemet (pronounced [ˈgij:me]). Clicking on the link will navigate to the target fragment.

If the anchor name contains a dot . then the fragment is treated as the top level of a separate file. Clicking on file fragment downloads the individual file.

Fragments with the same name are merged in the order as they appear in the document.

The menu of actions contains action Literate, which creates and offers to download a zip files with all separate files in the document with literate.txt summary file.

For convenience this action can be made into a link on the page with the syntax [[Action(Literate)]].

See Also

• How to write an article, LiteratePrograms

• http://en.wikipedia.org/wiki/Literate_programming

• http://www.literateprogramming.com/

• http://www.google.com/search?q=literate+programming