Document your parameters

Henri Bergius <[email protected]> Mon, 24 Nov 2003 14:48:04 +0100
Newsgroups gmane.comp.web.midgard.devel,gmane.comp.cms.aegir.devel
Message-ID <[email protected]>
Greetings!

Alexey made the good point that we should start maintaining a centralized
registry of parameters used by different Midgard apps to promote reuse
of common parameters for same purposes.

For example, all apps should have same concept of "Power user", and
use same "preferred language" definition.

The page for this is at:
 
http://wwwdev.midgard-project.org/documentation/reference/parameter/used-parameters

Page maintainer is Alexey Zakhlestine. If you have developed a Midgard application
that uses some predefined parameters, please either:
  * Add them to the page directly
  * Document them by using page comments
  * Mail them to here (dev)

<Spike_Spiegel> we should start a registry of parameter domains and names
<bergie> good point!
<Spike_Spiegel> it, probably, can be a part of documentation.
<bergie> yep. I'll open a page for it. Can you add the first ones? :-)
<Spike_Spiegel> ok.
...
<Spike_Spiegel> what did you use for formatting, anyway?
<bergie> Ok... Can edit now:
http://wwwdev.midgard-project.org/documentation/reference/parameter/used-parameters
<bergie> I wrote HTML, <dl>, <dt>, <dd>
<Spike_Spiegel> ah.. ok. I'll do the same then.
<bergie> Do you want to be the maintainer for that doc?
<Spike_Spiegel> no problem.
<bergie> excellent. I'll send an email to dev asking for more parameters to be
added there

/Bergie