Changes

Jump to navigation Jump to search
2,843 bytes added ,  20:52, 19 September 2012
{{About this wiki navbox}}
'''This page is about editing pages on this wiki in general. For Formatting help editing command reference pages, also see [http://www.mediawiki.org/wiki/[Help:Formatting www.mediawikiCommand reference]].org/wiki/Help:Formatting]'''
== General ==
=== May I edit pages without signing in? ===
Yes, you may (mainly because we are still glad if the users who hate signing in can nevertheless contribute), but you are highly <b>discouragedhighly encouraged</b> to do so. Please, sign in before contributing if possible. Even if you use your account has a username/nickname with no resemblance to your real name, this is still better than not signing in at allwhile editing.
=== How What commands do I use to edit the first pagethis wiki? ===
First page is protected to avoid spammers. HoweverIn order of increasing generality, you can still edit it (lethave a look at: * Mediawiki's hope for stupid spammers)[http://www.mediawiki. Type org/wiki/Help:Formatting guide to formatting]* Mediawiki'''Templates [http://meta.wikimedia.org/wiki/Help:Editing guide to editing in general]* [http:Main Page''' after contextgarden//meta.wikimedia.netorg/wiki/ MediaWiki_User%27s_Guide Mediawiki User Guide]* There are some special commands and edit that templatetemplates available on this wiki; they are described on the rest of this page.
=== How do I sign when posting a comment? ===
* '''You type:''' <code><nowiki>--~~~</nowiki></code> will expand into <nowiki>(three tildes)* '''Looks like:''' --[[User:YourusernameEsteis|YournicknameEsteis]]</nowiki>, so basically your <b>nickname</b> will be shown* <code><nowiki>~~~~</nowiki></code> will also add a <b>timestamp</b> next to your nickname So you will usually write <code><nowiki>--~~~</nowiki></code> or <code><nowiki>--~~~~</nowiki></code>
=== What are the other commands to edit this wiki? ===* '''You type:''' <code><nowiki>--~~~~</nowiki></code> (four tildes)* '''Looks like:''' --[[User:Esteis|Esteis]] 16:37, 14 June 2012 (CEST)
The markup used in this wiki is a general MediaWiki markup and is described in === How do I edit the [http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User Guide] (esp. http://meta.wikimedia.org/wiki/Help:Editing ).Main Page? ===
Most of the following markup on this help page The Main Page is specific protected to avoid spammers. However, you can still edit it (let's hope for stupid spammers). Type '''Template:Main Page''' after contextgarden. So, read on!net/ and edit that template.
== In-line elements ==
== Pretty printing = ConTeXt commands ===
Use the [[Template:cmd|cmd template]] for command names in running text: * <code><nowiki>'''Bold text'''{{cmd|mycommand}}</nowiki></code> -- '''Bold text''', * <code><nowiki>''Italic {{cmd|mycommand|parameters, text'', etc.}}</nowiki></code> -- ''Italic text''* <code><nowiki>----</nowiki></code> draws a horizonal ruleThat way, you get an automatic link to e.g. {{cmd|startnarrower}}, or {{cmd|startnarrower|[middle]}}.
{| class=wikitable! scope=col width=360 style= In"text-line elements align: left"| You type! scope=col width=360 style="text-align: left"| You see|-style="vertical--align: top"| * <tt><nowiki>{{cmd|startitemize}}</nowiki></tt>* <tt><nowiki>{{cmd|startnarrower|[middle]}}</nowiki></tt>* <tt><nowiki>{{cmd|startcolumns|2=[n=4]}}</nowiki></tt>* <tt><nowiki>{{cmd|section|{First section}}}</nowiki></tt>| * {{cmd|startitemize}}* {{cmd|startnarrower|[middle]}}* {{cmd|startcolumns|2=[n=4]}}* {{cmd|section|{First section}}}|-| Forgetting the pipe or the '2=''leads to this:* <tt><nowiki>{{cmd|startnarrower[middle]}}</nowiki></tt>* <codett><nowiki>{{cmd|startcolumns|[n=4]}}</nowiki></tt>* <tt><codenowiki>{{cmd|section{First section}}}</nowiki></codett>'''| * {{cmd|startnarrower[middle]}}* {{cmd|startcolumns|[n=4]}}* {{cmd|section{First section}}}|}
For in-line markup of code, commands, parameters, etc. in the running text use <code><nowiki><code> ... </code></nowiki></code>=== The &lt;cmd&gt; tag is deprecated.===
''Sometimes, when editing an older page, you will see &lt;cmd&gt;\somecommand&lt;/cmd&gt; on this wiki markup''. This is an older, deprecated form, and you should turned it into <nowiki>{{cmd|somecommand}}</nowiki> wherever you see it.
=== Linking to parameter description pages === In ConTeXt many {{code|1=key=value}} parameters are common across commands, so this wiki intends to have separate description pages for those parameters. Those are not linked from the text, in general, but they are linked from the syntax tables on command description pages. ([[Command/setupframed|Example]].) The linking is achieved with <nowiki>{{key|alternative}}</nowiki>, which expands to [[Command/keyword:alternative|<nowiki>[[Command/keyword:alternative]]</nowiki>]]. Nearly all the target pages do not exist yet, but don't let that stop you from linking to them. We'll get around to filling them in. === Other inline code === For in-line markup of code, commands, parameters, etc. in running text use <nowiki>{{code|some code}}</nowiki>. If there are equality signs in the code, use e.g. <nowiki>{{code|1=some=code}}</nowiki>, because the wiki templating software interprets all text up to the first equality sign as a template parameter name. Please do use the {{code|code}} template instead of the {{code|&lt;code>}} tags, as templates are much easier to change. {| class=wikitable! scope=col width=360 style="text-align: left"| You type! scope=col width=360 style="text-align: left"| You see|- style="vertical-align: top"| <xmlcode>In the following examples we use <code>\the {{cmd|framed</code> }} command with the parameters <{{code>|1=background=color</code> }} and <{{code>|1=offset=1cm</code>}}.
</xmlcode>
''wiki display''| style="background-color: white" |In the following examples we use the {{cmd|framed}} command with the parameters {{code|1=background=color}} and {{code|1=offset=1cm}}.|} === Linking to source files ===
In Practically all of ConTeXt's source files are stored in the following examples we use <directory {{code>\framed<|.../code> command with the parameters <code>background=color<tex/code> and <code>offset=1cm<context/code>base}}. There are two templates to link to online copies of the source files.----
=== Block elements ===----Link to the most recent version (recommended):* '''You type:'''<code><nowiki><pre>{{src|type-akb.tex}}</nowiki><* '''Links to:''' http://repo.or.cz/w/context.git/blob/HEAD:/tex/context/base/code>type-akb.tex* '''Looks like:'''{{src|type-akb.tex}}
To dispay verabtim text use <code>Link to the version stored on contextgarden.net:* '''You type:''' <nowiki><pre> .[[source:type-akb.tex| type-akb. tex]]</prenowiki><* '''Links to:''' http://nowiki><source.contextgarden.net/code>type-akb.tex* '''Looks like:''' [[source:type-akb.tex|type-akb.tex]]
''=== Linking to other sections of the wiki markup''===
* '''You type:''' <xmlcodenowiki>[[modules:t-lettrine|Lettrine module]]<pre/nowiki>This is an announcement from the mailing list with some code* '''Links to:''' http://modules.contextgarden.net/t-lettrine* '''Looks like:''' [[modules:t-bnf|Lettrine module]]
\unprotect\def\!test{alfa} \protect </pre></xmlcode>== Block elements ==
''wiki display''=== Displaying ConTeXt output (and source) ===
<pre>This wiki allows you to type ConTeXt code to obtain a PNG of the resultant output, with extraneous whitespace cropped. This is very useful for including in-page examples. Below are two simple ones; for more, see [[Help:Context]]. When using MkIV, it is an announcement from good practice to include a comment {{code|1=% mode=mkiv}}: otherwise, the mailing list reader will have no indication that the example is compiled with some codeMkIV instead of the usual MkII.
{| class=wikitable! scope=col width=300 style="text-align: left"| You type! scope=col width=300 style="text-align: left"| You see|- style="vertical-align: top"| <pre><context>The wiki's default is ConTeXt Mark II: \unprotectcrlf\defcontextversionnumber</context></pre>| <context>The wiki's default is ConTeXt Mark II: \!test{alfa} crlf\contextversionnumber</context>|- style="vertical-align: top"| <pre><context source=yes mode=mkiv text="This produces:">% mode=mkivThe wiki also uses ConTeXt Mark IV: \crlf\protect contextversionnumber</context>
</pre>
| <context source=yes mode=mkiv text="This produces:">
% mode=mkiv
The wiki also uses ConTeXt Mark IV: \crlf
\contextversionnumber
</context>
|}
----'''<=== Displaying TeX or ConTeXt code><nowiki><texcode></nowiki></code>'''alone ===
For displaying TeX an and ConTeXt source code use <code><nowiki><texcode> ... </texcode></nowiki></code>.
''wiki markup''{| class=wikitable! scope=col width=360 style="text-align: left"| You type! scope=col width=360 style="text-align: left"| You see|- style="vertical-align: top"| <xmlcodepre>
<texcode>
\def\person#1#2{{\em #1 (#2)}}
offset=1cm ]{hello world!}
</texcode>
</xmlcodepre''wiki display'' | <texcode>
\def\person#1#2{{\em #1 (#2)}}
offset=1cm ]{hello world!}
</texcode>
----|}
'''<code><nowiki><xmlcode></nowiki></code>'''=== Displaying XML ===
For presenting XML source use <code><nowiki><xmlcode> ... </xmlcode></nowiki></code>.
''wiki markup''{| class=wikitable! scope=col width=360 style="text-align: left"| You type! scope=col width=360 style="text-align: left"| You see|- style="vertical-align: top"| <xmlcodepre>
&lt;xmlcode>
<?xml version="1.0"?>
</TeXML>
&lt;/xmlcode>
</xmlcodepre''wiki display'' | <xmlcode>
<?xml version="1.0"?>
<TeXML>
</TeXML>
</xmlcode>
|}
----=== Displaying other verbatim text ===
'''To dispay other verbatim text use <code><nowiki><contextpre> ... </pre></nowiki></code>'''.
Nice local feature of contextgarden allows you to run ConTeXt on the fly {| class=wikitable! scope=col width=360 style="text-align: left"| You type! scope=col width=360 style="text-align: left"| You see|- style="vertical-align: top"| <pre><pre>This is some text and the wiki page will include the result of the eneterd some code in the page. See also http://live.contextgarden.net/ for an online ConTeXt.
''wiki markup''\unprotect\def\!test{alfa} \protect &lt;/pre></pre>
| <xmlcodepre><context>\setupcolors [state=start]\framed [background=color, backgroundcolor=green, offset=1cm ]{hello world!}</context></xmlcode>This is some text and some code.
''wiki display'' <context>\unprotect\setupcolors [state=start]def\framed [background=color, backgroundcolor=green, offset=1cm ]{hello world!}</context>---- '''<code>source="yes"</code>''' If you add <code>source="yes"</code> to the <code><nowiki><context></nowiki></code> tag, you have the source and the result displayed. The contents of the attribute <code>text</code> will be inserted between the text and the result. ''wiki markup'' <xmlcode><context source="yes" text="produces">\setupcolors [state=start]\framed [background=color, backgroundcolor=green, offset=1cm ]test{hello world!alfa}</context></xmlcode> ''wiki display'' <context source="yes" text="produces">\setupcolors [state=start]\framed [background=color, backgroundcolor=green, offset=1cm ]{hello world!}protect </context>---- == Links == You can use references to other garden projects. Use the following syntax to create links to the other contextgarden projects: <pre><nowiki> [[source:type-akb.tex| type-akb.tex]] [[modules:t-bnf| bnf module]] [[cmd:goto|\goto]] </nowiki></pre>}
Looks like:* [[source:type-akb.tex| type-akb.tex]] -- source files of ConTeXt* [[modules:t-bnf| bnf module]] -- [http://modules.contextgarden.net third party modules]* [[cmd:goto|\goto]] -- links to the definition of the command{{About this wiki navbox}}

Navigation menu