Difference between revisions of "Wiki:Editing"

From Wiki
Jump to navigation Jump to search
(Big reorganization, and add a few of the new snippets and conventions.)
({{About this wiki navbox}})
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''For Formatting help see [http://www.mediawiki.org/wiki/Help:Formatting www.mediawiki.org/wiki/Help:Formatting]'''
+
''This page is about editing pages on this wiki in general. For editing command reference pages, also see [[Help:Command reference]].''
  
 
== General ==
 
== General ==
Line 9: Line 9:
 
this is still better than not signing in at all while editing.
 
this is still better than not signing in at all while editing.
  
=== How do I edit the first page? ===
+
=== What commands do I use to edit this wiki? ===
  
First page is protected to avoid spammers. However, you can still edit it (let's hope for stupid spammers). Type '''Template:Main Page''' after contextgarden.net/ and edit that template.
+
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? ===
 
=== How do I sign when posting a comment? ===
  
* <code><nowiki>~~~</nowiki></code> will expand into <nowiki>[[User:Yourusername|Yournickname]]</nowiki>, so basically your <b>nickname</b> will be shown
+
* '''You type:''' <code><nowiki>--~~~</nowiki></code> (three tildes)
* <code><nowiki>~~~~</nowiki></code> will also add a <b>timestamp</b> next to your nickname
+
* '''Looks like:''' --[[User:Esteis|Esteis]]
 
 
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 the [http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User Guide]  (esp. http://meta.wikimedia.org/wiki/Help:Editing ).
+
=== How do I edit the Main Page? ===
  
Most of the following markup on this help page is specific for contextgarden. So, read on!
+
The Main Page is protected to avoid spammers. However, you can still edit it (let's hope for stupid spammers). Type '''Template:Main Page''' after contextgarden.net/ and edit that template.
  
 
== In-line elements ==
 
== In-line elements ==
 
You can use references to other garden projects. Use the following syntax to create links to the other contextgarden projects:
 
  
 
=== ConTeXt commands ===
 
=== ConTeXt commands ===
  
Use the following markup for command names in running text:  
+
Use the [[Template:cmd|cmd template]] for command names in running text:  
 
* <nowiki>{{cmd|mycommand}}</nowiki>,  
 
* <nowiki>{{cmd|mycommand}}</nowiki>,  
 
* <nowiki>{{cmd|mycommand|parameters, text, etc.}}</nowiki>
 
* <nowiki>{{cmd|mycommand|parameters, text, etc.}}</nowiki>
Line 42: Line 43:
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
 
|  
 
|  
* <nowiki>{{cmd|startitemize}}</nowiki></code>
+
* <tt><nowiki>{{cmd|startitemize}}</nowiki></tt>
* <nowiki>{{cmd|startnarrower|[middle]}}</nowiki>
+
* <tt><nowiki>{{cmd|startnarrower|[middle]}}</nowiki></tt>
* <nowiki>{{cmd|section|{First section}}}</nowiki>
+
* <tt><nowiki>{{cmd|startcolumns|2=[n=4]}}</nowiki></tt>
 +
* <tt><nowiki>{{cmd|section|{First section}}}</nowiki></tt>
 
|  
 
|  
 
* {{cmd|startitemize}}
 
* {{cmd|startitemize}}
 
* {{cmd|startnarrower|[middle]}}
 
* {{cmd|startnarrower|[middle]}}
 +
* {{cmd|startcolumns|2=[n=4]}}
 
* {{cmd|section|{First section}}}
 
* {{cmd|section|{First section}}}
 
|-
 
|-
| Forgetting the pipe leads to this:
+
| Forgetting the pipe or the '2=' leads to this:
* <nowiki>{{cmd|startnarrower[middle]}}</nowiki>
+
* <tt><nowiki>{{cmd|startnarrower[middle]}}</nowiki></tt>
* <nowiki>{{cmd|section{First section}}}</nowiki>
+
* <tt><nowiki>{{cmd|startcolumns|[n=4]}}</nowiki></tt>
 +
* <tt><nowiki>{{cmd|section{First section}}}</nowiki></tt>
 
|  
 
|  
 
* {{cmd|startnarrower[middle]}}
 
* {{cmd|startnarrower[middle]}}
 +
* {{cmd|startcolumns|[n=4]}}
 
* {{cmd|section{First section}}}
 
* {{cmd|section{First section}}}
 
|}
 
|}
Line 60: Line 65:
 
=== The &lt;cmd&gt; tag is deprecated. ===
 
=== 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. This is an older, deprecated form, and should be turned into <nowiki>{{cmd|somecommand}}</nowiki> wherever you see it.
+
Sometimes, when editing an older page, you will see &lt;cmd&gt;\somecommand&lt;/cmd&gt; on this wiki. 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 ===
 
=== Other inline code ===
  
For in-line markup of code, commands, parameters, etc. in running text use <tt>&lt;code&gt; ... &lt;/code&gt;</tt>.
+
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
 
{| class=wikitable
Line 73: Line 82:
 
In the following examples we use the  
 
In the following examples we use the  
 
{{cmd|framed}} command with the  
 
{{cmd|framed}} command with the  
parameters <code>background=color</code>
+
parameters {{code|1=background=color}}
and <code>offset=1cm</code>.
+
and {{code|1=offset=1cm}}.
 
</xmlcode>
 
</xmlcode>
  
 
| style="background-color: white" |
 
| style="background-color: white" |
 
In the following examples we use the {{cmd|framed}} command  
 
In the following examples we use the {{cmd|framed}} command  
with the parameters <code>background=color</code> and  
+
with the parameters {{code|1=background=color}} and  
<code>offset=1cm</code>.
+
{{code|1=offset=1cm}}.
 
|}
 
|}
  
 
=== Linking to source files ===
 
=== Linking to source files ===
  
Practically all of ConTeXt's source files are stored in the directory <code>/tex/context/base</code>. There are two templates to link to online versions of the source file.
+
Practically all of ConTeXt's source files are stored in the directory {{code|.../tex/context/base}}. There are two templates to link to online copies of the source files.
  
 
Link to the most recent version (recommended):
 
Link to the most recent version (recommended):
Line 107: Line 116:
 
=== Displaying ConTeXt output (and source) ===
 
=== 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]].
+
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 good practice to include a comment {{code|1=% mode=mkiv}}: otherwise, the reader will have no indication that the example is compiled with MkIV instead of the usual MkII.
  
 
{| class=wikitable
 
{| class=wikitable
Line 115: Line 124:
 
| <pre>
 
| <pre>
 
<context>
 
<context>
The wiki uses ConTeXt version: \crlf
+
The wiki's default is ConTeXt Mark II: \crlf
 
\contextversionnumber
 
\contextversionnumber
 
</context>
 
</context>
 
</pre>
 
</pre>
 
| <context>
 
| <context>
The wiki uses ConTeXt version: \crlf
+
The wiki's default is ConTeXt Mark II: \crlf
 
\contextversionnumber
 
\contextversionnumber
 
</context>
 
</context>
Line 126: Line 135:
 
| <pre>
 
| <pre>
 
<context source=yes mode=mkiv text="This produces:">
 
<context source=yes mode=mkiv text="This produces:">
The wiki uses ConTeXt version: \crlf
+
% mode=mkiv
 +
The wiki also uses ConTeXt Mark IV: \crlf
 
\contextversionnumber
 
\contextversionnumber
 
</context>
 
</context>
 
</pre>
 
</pre>
 
| <context source=yes mode=mkiv text="This produces:">
 
| <context source=yes mode=mkiv text="This produces:">
The wiki uses ConTeXt version: \crlf
+
% mode=mkiv
 +
The wiki also uses ConTeXt Mark IV: \crlf
 
\contextversionnumber
 
\contextversionnumber
 
</context>
 
</context>
Line 138: Line 149:
 
=== Displaying TeX or ConTeXt code alone ===
 
=== Displaying TeX or ConTeXt code alone ===
  
For displaying TeX and ConTeXt source use <code><nowiki><texcode> ... </texcode></nowiki></code>.
+
For displaying TeX and ConTeXt code use <code><nowiki><texcode> ... </texcode></nowiki></code>.
  
 
{| class=wikitable
 
{| class=wikitable
Line 218: Line 229:
 
</pre>
 
</pre>
 
|}
 
|}
 +
 +
{{About this wiki navbox}}

Revision as of 20:52, 19 September 2012

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

General

May I edit pages without signing in?

Yes, but you are highly encouraged 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:

How do I sign when posting a comment?

  • You type: --~~~ (three tildes)
  • Looks like: --Esteis
  • You type: --~~~~ (four tildes)
  • Looks like: --Esteis 16:37, 14 June 2012 (CEST)

How do I edit the Main Page?

The Main Page is protected to avoid spammers. However, you can still edit it (let's hope for stupid spammers). Type Template:Main Page after contextgarden.net/ and edit that template.

In-line elements

ConTeXt commands

Use the cmd template for command names in running text:

  • {{cmd|mycommand}},
  • {{cmd|mycommand|parameters, text, etc.}}

That way, you get an automatic link to e.g. \startnarrower, or \startnarrower[middle].

You type You see
  • {{cmd|startitemize}}
  • {{cmd|startnarrower|[middle]}}
  • {{cmd|startcolumns|2=[n=4]}}
  • {{cmd|section|{First section}}}
Forgetting the pipe or the '2=' leads to this:
  • {{cmd|startnarrower[middle]}}
  • {{cmd|startcolumns|[n=4]}}
  • {{cmd|section{First section}}}
  • [[Command/startnarrower[middle]|\startnarrower[middle]]]
  • \startcolumns
  • [[Command/section{First section|\section{First section]]}

The <cmd> tag is deprecated.

Sometimes, when editing an older page, you will see <cmd>\somecommand</cmd> on this wiki. This is an older, deprecated form, and you should turned it into {{cmd|somecommand}} wherever you see it.

Linking to parameter description pages

In ConTeXt many 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. (Example.) The linking is achieved with {{key|alternative}}, which expands to [[Command/keyword:alternative]]. 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 {{code|some code}}. If there are equality signs in the code, use e.g. {{code|1=some=code}}, because the wiki templating software interprets all text up to the first equality sign as a template parameter name. Please do use the code template instead of the <code> tags, as templates are much easier to change.

You type You see
In the following examples we use the 
{{cmd|framed}} command with the 
parameters {{code|1=background=color}} 
and {{code|1=offset=1cm}}.

In the following examples we use the \framed command with the parameters background=color and offset=1cm.

Linking to source files

Practically all of ConTeXt's source files are stored in the directory .../tex/context/base. There are two templates to link to online copies of the source files.

Link to the most recent version (recommended):

Link to the version stored on contextgarden.net:

Linking to other sections of 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. When using MkIV, it is good practice to include a comment % mode=mkiv: otherwise, the reader will have no indication that the example is compiled with MkIV instead of the usual MkII.

You type You see
<context>
The wiki's default is ConTeXt Mark II: \crlf
\contextversionnumber
</context>
<context source=yes mode=mkiv text="This produces:">
% mode=mkiv
The wiki also uses ConTeXt Mark IV: \crlf
\contextversionnumber
</context>
% mode=mkiv
The wiki also uses ConTeXt Mark IV: \crlf
\contextversionnumber

This produces:

Displaying TeX or ConTeXt code alone

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

You type You see
<texcode>
\def\person#1#2{{\em #1 (#2)}}

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

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

Displaying XML

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

You type You see
<xmlcode>
<?xml version="1.0"?>
<TeXML>
  <env name="text">
    Hello World
  </env>
</TeXML>
</xmlcode>
<?xml version="1.0"?>
<TeXML>
  <env name="text">
    Hello World
  </env>
</TeXML>

Displaying other verbatim text

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

You type You see
<pre>
This is some text and some code.

\unprotect
\def\!test{alfa} 
\protect 
</pre>
This is some text and some code.

\unprotect
\def\!test{alfa} 
\protect