Difference between revisions of "Wiki:Editing"

From Wiki
Jump to navigation Jump to search
(19 intermediate revisions by 5 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:Reference]].''
 +
 
 +
{{todo|Warning: explain here the use of ToDo category.}}
  
 
== General ==
 
== General ==
Line 9: Line 11:
 
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>
+
* '''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. 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 ==
  
=== What are the other commands to edit this wiki? ===
+
=== ConTeXt commands ===
  
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 ).
+
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]}}.
  
Most of the following markup on this help page is specific for contextgarden. So, read on!
+
{| 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}}}
 +
|}
  
 +
=== The &lt;cmd&gt; tag is deprecated. ===
  
== Pretty printing ==
+
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.
  
* <code><nowiki>'''Bold text'''</nowiki></code> -- '''Bold text'''
+
=== Linking to parameter description pages ===
* <code><nowiki>''Italic text''</nowiki></code> -- ''Italic text''
 
* <code><nowiki>----</nowiki></code> draws a horizonal rule
 
  
=== In-line elements ===
+
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.
----
 
'''<code><nowiki><code></nowiki></code>'''
 
  
For in-line markup of code, commands, parameters, etc. in the running text use <code><nowiki><code> ... </code></nowiki></code>.
+
=== Other inline code ===
  
''wiki markup''
+
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.
  
<xmlcode>
+
{| class=wikitable
In the following examples we use <code>\framed</code> command with the parameters <code>background=color</code> and <code>offset=1cm</code>.
+
! 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>
 
</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 the following examples we use <code>\framed</code> command with the parameters <code>background=color</code> and <code>offset=1cm</code>.
+
Practically all of ConTeXt's source files are stored in the directory {{code|.../tex/context/base/mkiv}}. There are two templates to link to online copies of the source files.
----
 
  
=== Block elements ===
+
Link to the most recent version (recommended):
----
+
* '''You type:''' <nowiki>{{src|type-akb.tex}}</nowiki>
'''<code><nowiki><pre></nowiki></code>'''
+
* '''Links to:''' https://source.contextgarden.net/tex/context/base/mkiv/type-akb.tex
 +
* '''Looks like:''' {{src|type-akb.tex}}
  
To dispay verabtim text use <code><nowiki><pre> ... </pre></nowiki></code>.
+
Link to the version stored on contextgarden.net:
 +
* '''You type:''' <nowiki>[[source:type-akb.tex| type-akb.tex]]</nowiki>
 +
* '''Links to:''' http://source.contextgarden.net/type-akb.tex
 +
* '''Looks like:''' [[source:type-akb.tex|type-akb.tex]]
  
''wiki markup''
+
=== Linking to other sections of the wiki ===
  
<xmlcode>
+
* '''You type:''' <nowiki>[[modules:t-lettrine|Lettrine module]]</nowiki>
<pre>
+
* '''Links to:''' http://modules.contextgarden.net/t-lettrine
This is an announcement from the mailing list with some code.
+
* '''Looks like:''' [[modules:t-bnf|Lettrine module]]
 +
 
 +
== 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]].
  
\unprotect
+
{| class=wikitable
\def\!test{alfa}
+
! scope=col width=300 style="text-align: left"| You type
\protect
+
! scope=col width=300 style="text-align: left"| You see
 +
|- style="vertical-align: top"
 +
| <pre>
 +
<context>
 +
The wiki is using ConTeXt Mark IV: \crlf
 +
\contextversionnumber
 +
</context>
 +
</pre>
 +
| <context>
 +
The wiki is using ConTeXt Mark IV: \crlf
 +
\contextversionnumber
 +
</context>
 +
|- style="vertical-align: top"
 +
| <pre>
 +
<context source=yes text="This produces:">
 +
The wiki still uses ConTeXt Mark IV: \crlf
 +
\contextversionnumber
 +
</context>
 
</pre>
 
</pre>
</xmlcode>
+
| <context source=yes text="This produces:">
 +
The wiki still uses ConTeXt Mark IV: \crlf
 +
\contextversionnumber
 +
</context>
 +
|}
  
''wiki display''
 
  
<pre>
+
=== Displaying a ConTeXt command syntax ===
This is an announcement from the mailing list with some code.
+
If you want to show the calling convention(s) of a ConTeXt command, you can use <code><nowiki><syntax> ... </syntax></nowiki></code>. This is particularly useful in a "Command" page.
  
\unprotect
+
{| class=wikitable
\def\!test{alfa}
+
! scope=col width=300 style="text-align: left"| You type
\protect
+
! scope=col width=300 style="text-align: left"| You see
 +
|- style="vertical-align: top"
 +
| <pre>
 +
<syntax>page</syntax>
 
</pre>
 
</pre>
 +
| <syntax>page</syntax>
 +
|}
  
----
 
'''<code><nowiki><texcode></nowiki></code>'''
 
  
For displaying TeX an ConTeXt source use <code><nowiki><texcode> ... </texcode></nowiki></code>.
+
=== Displaying TeX or ConTeXt code alone ===
  
''wiki markup''
+
For displaying TeX and ConTeXt code use <code><nowiki><texcode> ... </texcode></nowiki></code>.
  
<xmlcode>
+
{| 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>
 
<texcode>
 
\def\person#1#2{{\em #1 (#2)}}
 
\def\person#1#2{{\em #1 (#2)}}
Line 94: Line 179:
 
         offset=1cm ]{hello world!}
 
         offset=1cm ]{hello world!}
 
</texcode>
 
</texcode>
</xmlcode>
+
</pre>
 
+
| <texcode>
''wiki display''
 
 
 
<texcode>
 
 
\def\person#1#2{{\em #1 (#2)}}
 
\def\person#1#2{{\em #1 (#2)}}
  
Line 106: Line 188:
 
         offset=1cm ]{hello world!}
 
         offset=1cm ]{hello world!}
 
</texcode>
 
</texcode>
----
+
|}
  
'''<code><nowiki><xmlcode></nowiki></code>'''
+
=== Displaying XML ===
  
 
For presenting XML source use <code><nowiki><xmlcode> ... </xmlcode></nowiki></code>.
 
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
<xmlcode>
+
! scope=col width=360 style="text-align: left"| You see
 +
|- style="vertical-align: top"
 +
| <pre>
 
&lt;xmlcode>
 
&lt;xmlcode>
 
<?xml version="1.0"?>
 
<?xml version="1.0"?>
Line 123: Line 207:
 
</TeXML>
 
</TeXML>
 
&lt;/xmlcode>
 
&lt;/xmlcode>
</xmlcode>
+
</pre>
 
+
| <xmlcode>
''wiki display''
 
 
 
<xmlcode>
 
 
<?xml version="1.0"?>
 
<?xml version="1.0"?>
 
<TeXML>
 
<TeXML>
Line 135: Line 216:
 
</TeXML>
 
</TeXML>
 
</xmlcode>
 
</xmlcode>
 +
|}
  
----
+
=== Displaying other verbatim text ===
  
'''<code><nowiki><context></nowiki></code>'''
+
To dispay other verbatim text use <code><nowiki><pre> ... </pre></nowiki></code>.
  
Nice local feature of contextgarden allows you to run ConTeXt on the fly and the wiki page will include the result of the eneterd code in the page. See also http://live.contextgarden.net/ for an online ConTeXt.
+
{| 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.
  
''wiki markup''
+
\unprotect
 +
\def\!test{alfa}
 +
\protect
 +
&lt;/pre>
 +
</pre>
  
<xmlcode>
+
| <pre>
<context>
+
This is some text and some code.
\setupcolors [state=start]
 
\framed [background=color,
 
        backgroundcolor=green,
 
        offset=1cm ]{hello world!}
 
</context>
 
</xmlcode>
 
  
''wiki display''
+
\unprotect
 
+
\def\!test{alfa}  
<context>
+
\protect
\setupcolors [state=start]
+
</pre>
\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 ]{hello world!}
 
</context>
 
</xmlcode>
 
 
 
''wiki display''
 
 
 
<context source="yes" text="produces">
 
\setupcolors [state=start]
 
\framed [background=color,
 
        backgroundcolor=green,
 
        offset=1cm ]{hello world!}
 
</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:
+
{{About this wiki navbox}}
* [[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
 

Revision as of 13:05, 2 July 2020

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


TODO: Warning: explain here the use of ToDo category. (See: To-Do List)


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/mkiv. 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.

You type You see
<context>
The wiki is using ConTeXt Mark IV: \crlf
\contextversionnumber
</context>
<context source=yes text="This produces:">
The wiki still uses ConTeXt Mark IV: \crlf
\contextversionnumber
</context>
The wiki still uses ConTeXt Mark IV: \crlf
\contextversionnumber

This produces:


Displaying a ConTeXt command syntax

If you want to show the calling convention(s) of a ConTeXt command, you can use <syntax> ... </syntax>. This is particularly useful in a "Command" page.

You type You see
<syntax>page</syntax>
\page[...,...]
[...,...]inherits from \pagebreak


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