[pmwiki-users] PmWiki DocumentationGuidelines

[christian.ridderstrom at gmail.com]

On Sat, 11 Mar 2006, Patrick R. Michaud wrote:

> > Shall blocks of code be indented with
> > ->[@
> > ..
> > @]
> > 
> > and sometimes
> > -->[@
> > 
> > rather than doing character indents like
> >         [@ .....
> 
> I'm thinking that ->[@ is likely to be more consistent.

Are we talking about PmWiki markup code here? If so, why not use a wiki 
style for this purpose? To me it'd make sense to have a special style for 
PmWiki code (or even a special markup).

> > Shall placeholders for variable values be written out as an example
> > value rather than symbolic as <value> ?
> > 
> >      (I much prefer example values, names etc.)
> 
> I prefer example values as well (this is what all of the *Variables
> pages have done).  I tend to be a learn-by-example sort of person.

I usually prefer placeholders, but I don't care that much about it really.

/Christian

-- 
Christian Ridderström, +46-8-768 39 44               http://www.md.kth.se/~chr