Changes

'''WARNING: this page has to be finished fisrtfirst, than reviewed! Don't rely on actual information.'''

<!-- == Commands Command ==

As in TeX all commands start \command{the command works with its parameter(s)} Command consists of:<!-- table -->{||-| <code>\</code> || leading backslash|-| <code>name</code> || command name|-| <code>{ }</code> || scope or range of the command (if applicable)|-| <code>[ ]</code> || setups (if applicable)|-| <code>$$ $$</code> || math input (if applicable)|-|} Example: <pre>\placeformula[...]{...}$$...$$</pre> == Switch == {\switch the switch influences everything in its group} Example: <pre> {\em here is emphasized text} </pre> == Find definition == There are several places where you can search for command definitions: * [http: //www.pragma-ade.nl/general/qrcs/setup-en.pdf setup-en.pdf] (and appropriate language variants) most up-to-date ConTeXt command reference (but without explanations).* [http://pmrb.free.fr/contextref.pdf ConTeXt reference manual] (2013, somewhat outdated)* The main source for the XML description is in [cmd[source:showsetupstex/context/interface/mkiv/context-en.xml|\showsetupscontext-en.xml]] * The sources for the XML command descriptions for MkII: [[source:tex/context/interface/mkii|tex/context/interface/mkii]](obsolete)

* without argument: [[cmd:hairline|\hairline]]<pre>* with mandatory argument: [[cmd:overbar|\overbar{This is what I usually do to find out about an option...}]]* with optional argument: [[cmd:note|\note[''ref'']]]Search * with ??? argument: [[cmd:moveongrid|\moveongrid''[texwebshow for options...]'']]If it is there, read the manual for the * and thier combinations: [[cmd:chapter|\chapter''[ref,...]''{...}]] or [[cmd:date|\date''[...,.=.,...]''[..description.]]]

== Pairing ==If I do not find any relevant option, but know that ConTeXt ought to have Numbers an option for what I want (manualswhich usually means that it will), background colors look in the sources. My strategy for searching the sources involves finding out which source file defines the option. (texshow)search on sources.contextgarden.net work for most cases, font colors (emacs helpI use grep for the cases which are more trickier to find) in arguments '''don't''' have any special meaning, they just pair the argument with its desription below.

ExapmleMost (all?) commands come with an accompanying \setup command, which initialises all the options for the command. This way, one knows at least which options a command will accept. In most cases guessing the functionality of an option is easy, as ConTeXt uses a consistent interface for everything. Sometimes, when I have no clue what that option does, I search where theoption is used. Most options are stored using \getparameters[\??xx]where xx is a two letter abbreviation. Then you can search for\@@xxoption to see where it is used. That way, you can usually guess whatan option does. The sources also have some examples that are usually useful in understanding a few tricks about the command. If I still can not figure out, I ask on the mailing list.</pre> == Referencing of arguments == In these sources there is different '''referencing of arguments''' to thier possible values and different '''typographic conventions'''. Example: [[{{cmd:setupheadertexts|\setupheadertexts]]}}

* in the texshow \setupheadertexts<span style='background-color: #00FFFF; color: red'>[.1.]</span><span style='background-color:#CCFF66'>[.2.]</span><span style='background-colorwiki Command pages:#FF6FCF'>[.3.]</span> <span style='background-color: #00FFFF'syntax>.1. '''''text''''' margin edge</span> <span style='background-color:#CCFF66'>.2. ''text'' ''section'' date ''mark'' pagenumber</span> <span style='background-color:#FF6FCF'>.3. ''text'' ''section'' date ''mark'' pagenumbersetupheadertexts</spansyntax>

== Notation, typographic convention Typographic conventions ==

You As you can find command definitions see in in * printed manualsprevious examples, * texshow,* emacs ConTeXt help, * xml description in [[source:cont-en.xml| cont-en.xml]] (and appropriate language variants)command references have different typographic conventions.

Following table explains the meaning of values and shows their notationin different sources. (add examples)

| || meaning || manuals [http://www.pragma-ade.nl/general/qrcs/setup-en.pdf | setup-en.pdf] || [manual:http://pmrb.free.fr/contextref.pdf ConTeXt reference manual] || [http://texshow .contextgarden.net/ texshow-web] || [http://levana.de/emacs |etexshow] | | [[source:cont-en.xml description| cont-en.xml]]|-| default || x || x || x || x || x || x|-| predefined || x || x || x || x || x || x|-| user input || x || x || x || x || x || x

|arguments text || x || x || x || x || x || x

|mandatory number || x || x || x || x || x || x

|??? reference || x || x || x || x || x || x

|argument values identifier|| x || x || x || x || x || x

|key-=value pair || x || x || x || x || x || x

|user input triplet || x || x || x || x || x || x

|list of || x || x || x || x || x || x

|default command || x || x || x || x || x || x|-|-| ...,...,... || x || x || x || x || x || x|-| || x || x || x || x || x || x|-|-| || x || x || x || x || x || x|-| || x || x || x || x || x || x

== Contexgarden Other notes == * In LaTeX optional arguments come before mandatory arguments. This is not true in ConTeXt. Optional argument can be at any position. \definetextvariable* If <code>key=value</code> pair is missing the value, than the key is assigned the default value. <code>location=</code> == This wiki ==

While writing to on this wiki you can refer to the user commands with the [[:Template:cmd|cmd]] template, like so:<pre>[[{{cmd:|goto}}or{{cmd|\goto|{some text}[label:1]]}}</pre> which This displays as [[{{cmd:|goto}} or {{cmd|\goto|{some text}[label:1]] and the }}, respectively. The link brings you leads to the command definition in [http[://texshow.contextgarden.net/ texshow-webCategory:Commands]].

add [[Category:Tools]][[Category:Basics]]