View source for Wiki:Editing

''This page is about editing pages on this wiki in general. For editing command reference pages, also see [[Help:Reference]].''

== General ==

=== May I edit pages without signing in? ===

Yes, but you are <b>highly encouraged</b> to sign in before contributing if possible.
Even if your account has a username/nickname with no resemblance to your real name,
this is still better than not signing in at all while editing.

=== What commands do I use to edit this wiki? ===

In order of increasing generality, have a look at: 
* Mediawiki's [http://www.mediawiki.org/wiki/Help:Formatting guide to formatting]
* Mediawiki's [http://meta.wikimedia.org/wiki/Help:Editing guide to editing in general]
* [http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide Mediawiki User Guide]
* There are some special commands and templates 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> (three tildes)
* '''Looks like:''' --[[User:Esteis|Esteis]]

* '''You type:''' <code><nowiki>--~~~~</nowiki></code> (four tildes)
* '''Looks like:''' --[[User:Esteis|Esteis]] 16:37, 14 June 2012 (CEST)

=== How do I edit the Main Page? ===

The Main Page is protected to avoid spammers. Only wiki administrators are allowed to edit that page.  You can leave your change request in the [[Talk:Main Page]] page.

== In-line elements ==

=== ConTeXt commands ===

Use the [[Template:cmd|cmd template]] for command names in running text: 
* <nowiki>{{cmd|mycommand}}</nowiki>, 
* <nowiki>{{cmd|mycommand|parameters, text, etc.}}</nowiki>
That way, you get an automatic link to e.g. {{cmd|startnarrower}}, or {{cmd|startnarrower|[middle]}}.

{| 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"
| 
* <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>
* <tt><nowiki>{{cmd|startcolumns|[n=4]}}</nowiki></tt>
* <tt><nowiki>{{cmd|section{First section}}}</nowiki></tt>
| 
* {{cmd|startnarrower[middle]}}
* {{cmd|startcolumns|[n=4]}}
* {{cmd|section{First section}}}
|}

For grouped instance command pages, use the [[Template:gen|gen template]] instead. These wiki page names start with an underscore, and the backslash added by {{tl|cmd}} doesn't look very nice either
(`<nowiki>{{cmd|_startsection}}</nowiki>` produces {{cmd|_startsection}}), which is why there is a separate template. 
{| 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"
| 
* <tt><nowiki>{{gen|startsection}}</nowiki></tt>
| 
* {{gen|startsection}}
|}

=== Linking to parameter value description pages ===

In ConTeXt many of the {{code|1=key=value}} parameters have predefined value types, 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]].)  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.

''Note:'' except in [[Command]] documentation pages, where the fluidity of templates is actually a disadvantage. 
In [[Command]] pages {{code|&lt;code>}} is required.

{| 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 the 
{{cmd|framed}} command with the 
parameters {{code|1=background=color}} 
and {{code|1=offset=1cm}}.
</xmlcode>

| 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 ===
There are two templates to link to online copies of the files contained in the <code>texmf-context</code> tree of the ConTeXt distribution.

Practically all of ConTeXt's actual source files are stored in the directory {{code|tex/context/base/mkiv}}

Link to the file in {{code|tex/context/base/mkiv}} directly:
* '''You type:''' <nowiki>{{src|type-akb.tex}}</nowiki>
* '''Links to:''' https://source.contextgarden.net/tex/context/base/mkiv/type-akb.tex
* '''Looks like:''' {{src|type-akb.tex}}

But the ConTeXt distribution also contains various other files, like documentation and scripts.

Link to any file in the ConTeXt distribution:
* '''You type:''' <nowiki>[[source:mtxrun.lua|mtxrun.lua]]</nowiki>
* '''Links to:''' http://source.contextgarden.net/mtxrun.lua
* '''Looks like:''' [[source:mtxrun.lua|mtxrun.lua]]

The software at http://source.contextgarden.net/ will find the actual file location for you. 

Please use the <code><nowiki>{{src|}}</nowiki></code> format for pointing to actual ConTeXt source files.

=== Linking to other sections of the wiki ===

* '''You type:''' <nowiki>[[modules:t-lettrine|Lettrine module]]</nowiki>
* '''Links to:''' http://modules.contextgarden.net/t-lettrine
* '''Looks like:''' [[modules:t-bnf|Lettrine module]]

=== Some other templates ===

There are a few other templates that may be useful:

* <tt><nowiki>{{todo|}}</nowiki></tt> adds a page to the [[:Category:ToDo|ToDo list]]. This is intended for wiki pages that need more work done.
* <tt><nowiki>{{howto}}}</nowiki></tt> adds a page to the [[:Category:How to|How to list]]. This is for wiki pages that you would like to be on the [[:Category:ToDo|ToDo list]], but where you are not sure whether the current page is the right place to add the documentation.
* <tt><nowiki>{{bug|}}}</nowiki></tt> adds a page to the [[:Category:Bugreports|Bug reports list]]. This is for problems you find in ConTeXt and/or the ConTeXt installation on the server. ''Not for wiki page problems!'' (you should fix those yourself, or add one of the two previous templates.)

{| 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"
| 
* <tt><nowiki>{{todo|this page needs more work}}</nowiki></tt>
| 
* {{todo|this page needs more work}}
|- style="vertical-align: top"
| 
* <tt><nowiki>{{howto}}</nowiki></tt>
| 
* {{howto}}
|- style="vertical-align: top"
| 
* <tt><nowiki>{{bug|this feature does not work on the wiki}}</nowiki></tt>
|
* {{bug|this feature does not work on the wiki}}
|}

== Block elements ==

=== Displaying ConTeXt output (and source) ===

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]].

{| 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 is using ConTeXt LMTX: \crlf
 \contextversionnumber\
 (lmtx mode : \the\contextlmtxmode)
</context>
</pre>
| <context force="yes">
The wiki is using ConTeXt LMTX: \crlf
 \contextversionnumber\ (lmtx mode : \the\contextlmtxmode)
</context>
|- style="vertical-align: top"
| <pre>
<context mode="mkiv" source="yes" text="This produces:">
The wiki also contains ConTeXt Mark IV: \crlf
\contextversionnumber\ 
 (lmtx mode : \the\contextlmtxmode)
</context>
</pre>
| <context mode="mkiv" source="yes" text="This produces:">
The wiki also contains ConTeXt Mark IV: \crlf
 \contextversionnumber\ 
 (lmtx mode : \the\contextlmtxmode)
</context>
|}

=== Displaying a ConTeXt command syntax ===
If you want to show the calling convention(s) of a ConTeXt command, you can use <code><nowiki><syntax> ... </syntax></nowiki></code>.

The <nowiki><syntax></nowiki> tag works like this:
* To get the syntax for a ConTeXt command like <code>\page</code>, use its name without the leading backslash
* To get the syntax for a ConTeXt environment like <code>itemize</code>, use the name of the command that starts the environment.
* Some ConTeXt commands and environments have multiple variants with different arguments. If you want only a specific variant of such a command or environment, you can add <code>variant=</code>. The possible variants are listed in the relevant command page (for an example, see the {{cmd|cite}} page) 
{| class=wikitable
! scope=col width=300 style="text-align: left"| You type
! scope=col width=500 style="text-align: left"| You see
|- style="vertical-align: top"
| <pre>
<syntax>page</syntax>
</pre>
| <syntax>page</syntax>
|- 
| <pre>
<syntax>startitemize</syntax>
</pre>
| <syntax>startitemize</syntax>
|-
| <pre>
<syntax variant='direct'>cite</syntax> 
</pre>
| <syntax variant='direct'>cite</syntax> 

|-
| <pre>
<syntax>cite</syntax> 
</pre>
| <syntax>cite</syntax> 

|}

=== Displaying TeX or ConTeXt code alone ===

For displaying TeX and ConTeXt code use <code><nowiki><texcode> ... </texcode></nowiki></code>.

{| 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>
<texcode>
\def\person#1#2{{\em #1 (#2)}}

\setupcolors [state=start]
\framed [background=color,
         backgroundcolor=green,
         offset=1cm ]{hello world!}
</texcode>
</pre>
| <texcode>
\def\person#1#2{{\em #1 (#2)}}

\setupcolors [state=start]
\framed [background=color,
         backgroundcolor=green,
         offset=1cm ]{hello world!}
</texcode>
|}

=== Displaying XML ===

For presenting XML source use <code><nowiki><xmlcode> ... </xmlcode></nowiki></code>.

{| 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>
&lt;xmlcode>
<?xml version="1.0"?>
<TeXML>
  <env name="text">
    Hello World
  </env>
</TeXML>
&lt;/xmlcode>
</pre>
| <xmlcode>
<?xml version="1.0"?>
<TeXML>
  <env name="text">
    Hello World
  </env>
</TeXML>
</xmlcode>
|}

=== Displaying other verbatim text ===

To dispay other verbatim text use <code><nowiki><pre> ... </pre></nowiki></code>.

{| 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 some code.

\unprotect
\def\!test{alfa} 
\protect 
&lt;/pre>
</pre>

| <pre>
This is some text and some code.

\unprotect
\def\!test{alfa} 
\protect 
</pre>
|}

{{About this wiki navbox}}