gardener, Interface administrators, Administrators
3,893
edits
Changes
Jump to navigation
Jump to search
m
highlight "if you want to help" section
As you can see above, Using the {{tl|cmd}} template for referring to the group pages looks a bit weird (`<nowiki>{{cmd|_startsection}}</nowiki>` was given) which is why there is a separate template for referring to those group pages: {{tl|gen}}. `<nowiki>{{gen|startsection}}</nowiki>` produces: {{gen|startsection}}.
== Page stucture structure ==
The structure of the new command pages is always the same:
| '''Forum help''' || A list of quick-links to community searches.
|}
=== The syntax table in '''Settings''', in detail ===
A table that is set up along the following lines.
<table cellspacing="4" cellpadding="2" class="cmd">
<tr>
<td colspan="2" class="cmd">\XXX<!--
--><span class="first">[...]</span><!--
--><span class="second">[...]</span><!--
--><span class="third">[...]</span><!--
--></td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[...]</td>
<td>''text''</td>
</tr>
<tr valign="top" class="second">
<td class="cmd">key</td>
<td>'''default''' variant other</td>
</tr>
<tr valign="top" class="third">
<td class="cmd">[...]</td>
<td>''text''</td>
</tr>
</table>
Let us examine the following example:
<syntax>placefloat</syntax>
You would not normally type {{cmd|placefloat}} in your TeX-text, but rather a previously defined kind of float (<tt>figure</tt>, for example). If you '''did''' use {{cmd|placefloat}} literally, then the first argument would be the name of the predefined kind of float, like <tt>figure</tt>.
But normally, the command to use in a document would be {{cmd|placefigure}}:
<syntax>placefigure</syntax>
The first two arguments of {{cmd|placefigure}} are optional (recognisable because they are slanted), the second two are mandatory. The first optional argument takes one of the keywords mentioned in {{cmd|placefloat}}. If the argument is not given, then it uses the keyword in bold (assuming there is one). <tt>reference</tt> stands for a reference label; just insert a name that you want to refer to later. In the third and fourth argument ''text'' is in ''italics'' (to indicate that it is not the keyword '''text''', which does exist). Rather, it is a (terse) description of what you can enter. In this case, you can enter any kind of text. ''content'' is similar.
To get syntax tables like the ones above easily in a different page, add
<pre>
<syntax>placefloat</syntax>
</pre>
where you need it. This will fetch the relevant table(s) from the command database.
== Pre-existing pages ==
* Save the new `Command/setuphead`, and delete the `Command_old/setuphead` page (this can also be done via the `More` dropdown at the top of the page)
== If you want to help: == there are three pages with specifics about what needs to be checked, converted or added:
* [[Document level commands work page]] (most important, especially the existing pages that should be converted)
