Changes between Version 9 and Version 10 of Submitting/Docs


Ignore:
Timestamp:
Apr 9, 2015, 7:24:30 AM (9 years ago)
Author:
neteler
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Submitting/Docs

    v9 v10  
    55 * '''Library programmer's manual''': we [http://grass.osgeo.org/programming7/ use doxygen and document the functions] directly in the source code. See lib/gis/*.c and lib/gis/gislib.dox for examples
    66
    7  * '''User manual''': each command ("module") comes with its own page. We write it in simple HTML, storing the manual in a file '<module>.html' within the subdirectory of the module. The 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.
     7 * '''User manual''': each command ("module") comes with its own page. We write it in simple HTML, storing the manual in a file '<module>.html' within the subdirectory of the module. See below for details on the structure.
    88
    99 * '''Python documentation''': written in Markdown which is compiled with Sphinx (see [http://grass.osgeo.org/grass71/manuals/libpython/pygrass_index.html PyGRASS documentation])
    … …  
    1313== HTML Pages ==
    1414
    15 The manual pages are not only fundamental for the users but also the "business card" of the respective module.
     15The 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.
     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.
    1819
    19 To avoid 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.
     20Important: 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.
    2021
    2122=== Module Manual Pages ===