Changes

Jump to navigation Jump to search
279 bytes added ,  18:01, 11 August 2020
* Please '''do not''' add options to or delete portions of the pre-generated XML!
* Do not You can't 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 you cannot use wiki templates. Wiki templates can change over time, and that creates would create a nasty external dependency, so they are disallowed.
* The <code>&lt;nowiki&gt;</code> tag is '''forbidden''' anywhere within a Command page.
* 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. As noted above, the content of <code>&lt;pre&gt;</code> and <code>&lt;code&gt;</code> must be properly quoted according to the XML rules: use XML entities for less-than, greater-than and ampersand: <code>&amp;lt;</code>, <code>&amp;gt;</code> and <code>&amp;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, use the regular [http://www.mediawiki.org/wiki/Help:Formatting wikicode markup]. * Most inline wikicode can be used anywhere, 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.

Navigation menu