define standard for parameter descriptions

[rgerhards]

trafficstars

We need to define a standard way of describing a parameter. This is already inconsistent in the the original html doc and was on the "this needs to be fixed" list there as well.

IMHO, each parameter needs to have

• parameter name
• type (string, number, boolean, ...)
• mandatory yes/no
• available in which versions
• longer description

All of this should of course come in a consistent formatting (which was not the case in the html doc).

[Ralnoc]

Is this referring to things like the structure of the module documentations? (ie omrelp, omprog, etc)

[rgerhards]

Yup, sorry was obvious for me. But also for things like global() or main_queue() -- essentially wherever we have config parameters.

[Ralnoc]

The last couple of commits have been changing the formatting of a log of the module pages. Could you take a look and give comments? I don't have access to my system for uploading to the site at the moment.

Modules updated in all branches are: source\configuration\modules\im3195.rst source\configuration\modules\imfile.rst source\configuration\modules\imgssapi.rst source\configuration\modules\imklog.rst

Modules updated in just v5-stable so far: source\configuration\modules\impstats.rst source\configuration\modules\imptcp.rst