3,897
edits
Changes
Jump to navigation
Jump to search
→Editing XML documentation
* Please '''do not''' add options to or delete portions of the pre-generated XML!
* Do not use block-level objects like subsections, lists, tables and figures except in the '''Description''' and '''Examples''' sections. Most documentation fields are intended to be used as running text.
* With the exception of {{tl|cmd}}, {{tl|gen}} and {{tl|todo}}, do not use wiki templates. Wiki templates can change over time, and that creates a nasty external dependency, so they are disallowed.* Don't use regular HTML tags except for <code><nowiki><pre></nowiki></code> (but <code><nowiki><texcode></nowiki></code> is usually a better choice) and <code><nowiki><code></nowiki></code>. For bold or italic text, use the regular [http://www.mediawiki.org/wiki/Help:Formatting wikicode markup]. Most inline wikicode can be used anywhere, and the sectioning codes can be used in descriptions, examples, and notes. The one exception is `<nowiki>`, that is forbidden everywhere.
* External links can be better placed in the '''See also''' section than in your main documentation.
* See below for a 'structural' way to refer to command parameters and options.
