Changes

Jump to navigation Jump to search
1,259 bytes added ,  18:07, 11 August 2020
* '''I tried to create a new page but the form loads up empty.'''
: You tried to create a page for a ConTeXt command that is not documented in the interface files. Check that you didn't make a typing error first. Alternatively, it is possible that the ConTeXt command is a generated instance, and in that case the page should be a `<nowiki>#REDIRECT</nowiki>`. If neither are the case of or you are unsure, ask for advice on the mailing list.
* '''When saving my edit, I see some red text with an XML error.'''
: [[Command]] pages must be either well-formed XML, or nothing but a `<nowiki>#REDIRECT</nowiki>`. You likely made a booboo with an XML tagor have an unquoted `<` or `>` or `&` somewhere. Only the content of `<xmlcode>`, `<texcode>`, and `<context>` are exempt from the normal XML rules (but on the downside, they cannot be nested). Note that <nowiki><pre></nowiki> and <nowiki><code></nowiki> content should be properly quoted as well: the wikicode tag is not the same as the actual HTML tag, even though its results are visually similar.
* '''I tried to edit a section, but I see an error that says 'Section not found'.'''
: Only the predefined top-level sections can be edited separately (this limitation is likely to stay).
* 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.* The <code>&lt;nowiki&gt;</code> tag is '''forbidden''' anywhere within a Command page.* Don't use regular HTML tags except for <code>&lt;b&gt;</code>, <code>&lt;i&gt;</code>, <code>&lt;tt&gt;</code>, <code><nowiki><pre></nowiki></code> (but and <code><nowiki><code></nowiki></code>. '''As noted above:''' even 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> is usually a better choice) , <code><nowiki><xmlcode></nowiki></code>, and <code><nowiki><codecontext></nowiki></code>tags. For bold or italic text, These three are handled as special cases to make porting existing pages easier.* You can also use the regular [http://www.mediawiki.org/wiki/Help:Formatting wikicode markup]. * Almost all inline wikicode can be used anywhere textual input is allowed (the exception is <code>&lt;nowiki&gt;</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.

Navigation menu