3,897
edits
Changes
Jump to navigation
Jump to search
→Editing the 'Notes'
* 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}}, {{tl|bug}} 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.
* As is <code><syntax></code>. Use {{tl|cmd}} or {{tl|gen}} to refer to other commands.
* 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 text content of 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 ([[Extension:ConTeXtXML#Implementation notes]] explains this in more detail).
Use a Note to report something that is not quite part of the regular command reference. For example, if you find a bug in this command in a specific ConTeXt version. If you need more than one Note, you have to save the page and re-edit. That will produce a new empty note field.
'''Note:''' notes can not be deleted., and because of that do not allow {{tl|todo}} and {{tl|bug}}
=== Editing the ''''See also'''' ===
It is not always easy to automatically deduct cross-references from the original interface XML, so chances are that there are many more interesting links that the database generator has missed. Feel free to add any relevant links. If you want to add an explanatory text as well, you can key that in the final field.
Links to wiki pages with the <code>Category:</code> or <code>Keywords:</code> prefix are automatically remapped to <code>Category:Command/</code> entries and will not appear in the visible output of the Section. This means that you cannot link to Categories other than subcategories of <code>Command/</code>; that is intentional.
== Referencing ==
