[pmwiki-users] PmWiki DocumentationGuidelines

Hans design at softflow.co.uk
Sat Mar 11 14:05:06 CST 2006

PmWiki.DocumentationGuidelines looks good.

In addition I would like guidance on some points about text layout:

When do we use [@ ....  @] and when @@ ... @@ ?

     (I usually use [@ ... @] for all markup documentation,
      but have not given the other any thought)

Shall blocks of code be indented with

and sometimes

rather than doing character indents like
        [@ .....

     (I prefer the first, also I have used the last up till now)

Shall placeholders for variable values be written out as an example
value rather than symbolic as <value> ?

     (I much prefer example values, names etc.)

Best regards,

More information about the pmwiki-users mailing list