Changes between Version 10 and Version 11 of Submitting/Docs


Ignore:
Timestamp:
04/09/15 07:25:03 (10 years ago)
Author:
neteler
Comment:

(why cannot trac follow mediawiki syntax?!)

Legend:

Unmodified
Added
Removed
Modified

  • Submitting/Docs

    v10 v11  
    1515The manual pages are not only fundamental for the users but also the "business card" of the respective module. An ideal page comes with clear descriptions, hints on the implemented algorithm and example(s).
    1616
    17 * Note: Do not upload broken or even empty HTML manual pages. This breaks things in various places.
    18 * To avoid the insertion of overly complicated HTML tags (see also below), we strongly suggest to use a plain text editor rather than a HTML editor for editing.
     17 * Note: Do not upload broken or even empty HTML manual pages. This breaks things in various places.
     18 * To avoid the insertion of overly complicated HTML tags (see also below), we strongly suggest to use a plain text editor rather than a HTML editor for editing.
    1919
    20 Important: The HTML file contains <b>no header nor footer</b>. The complete HTML file is autogenerated during the compilation process (indeed, it is generated in a virtual session directly after compilation of the module). In this virtual session the module is called internally with --html-description which generates the parameters/flags list in HTML format, along with '<module>.html', HTML header and footer the final HTML manual page is created and stored in the target binaries directory. In a separate process, the MAN format is generated from the complete HTML files.
     20Important: The HTML file contains '''no header nor footer'''. The complete HTML file is autogenerated during the compilation process (indeed, it is generated in a virtual session directly after compilation of the module). In this virtual session the module is called internally with --html-description which generates the parameters/flags list in HTML format, along with '<module>.html', HTML header and footer the final HTML manual page is created and stored in the target binaries directory. In a separate process, the MAN format is generated from the complete HTML files.
    2121
    2222=== Module Manual Pages ===