3,897
edits
Changes
Jump to navigation
Jump to search
→Editing XML documentation
* With the exception of {{tl|cmd}}, {{tl|gen}} and {{tl|todo}}, you cannot use wiki templates. Wiki templates can change over time, and that would create a nasty external dependency.
* The <code><nowiki></code> tag is '''forbidden''' anywhere within a Command page.
* Don't use regular HTML tags except for <code><b></code>, <code><i></code>, <code><tt></code>, <code><nowiki><pre></nowiki></code> and <code><nowiki><code></nowiki></code>. '''As noted above, :''' even the content of <code><pre></code> and <code><code></code> must be properly quoted according to the XML rules: use XML entities for less-than, greater-than and ampersand: <code>&lt;</code>, <code>&gt;</code> and <code>&amp;</code>
* You don't have to quote the XML special characters inside the <code><nowiki><texcode></nowiki></code>, <code><nowiki><xmlcode></nowiki></code>, and <code><nowiki><context></nowiki></code> tags. These three are handled as special cases to make porting existing pages easier.
* For bold or italic text, You can also use the regular [http://www.mediawiki.org/wiki/Help:Formatting wikicode markup]. * Most Almost all inline wikicode can be used anywheretextual input is allowed (the exception is <code><nowiki></code>), and the section block wiki codes can be used in descriptions, examples, and notes.
* 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.
