Writing documentation

User documentation is written within the TeXmacs software. Low level source code documentation is handled by Doxygen, who produces html browsable information.

The Doxygen support for TeXmacs (available only from version 1.0.6.15) provides you with two macros:

• <doxygen-load|file.tag> that takes a tag file name as argument and loads its content. This content is to be understood as an index to the Doxygen files. Several files can be loaded in sequence.

• <doxygen-link|text|key> that links text to the documentation of key produced by Doxygen.

  If key is not a valid entry in the index then a list of proposal will be made available in the bottom message bar of TeXmacs.

When writting documentation, please take care of the following conventions:

• Use the mmxdoc style, and use all the macros and markups defined within mmxdoc.ts provided by TeXmacs. In particular use mmx-fragment for Mathemagix source code.
• Take care of the main structure of the document. Do not create sections that are too short or too long.

• In examples use the following coding conventions:

  • Write a := 1 and not a:= 1. Similary write a += 1, a *= 2, etc
  • For a function declaration write: f (x: Integer, y: Integer): Integer