3,897
edits
Changes
Jump to navigation
Jump to search
{{todo|Warning: explain here the use of ToDo category.}}
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 <nowiki>{{cmd|somecommand}}</nowiki> wherever you see it.=== Linking to parameter value description pages ===
=== Linking to parameter description pages === In ConTeXt many of the {{code|1=key=value}} parameters are common across commandshave 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]].) 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.
no edit summary
''This page is about editing pages on this wiki in general. For editing command reference pages, also see [[Help:Reference]].''
== General ==
=== How do I edit the Main Page? ===
The Main Page is protected to avoid spammers. However, you can still Only wiki administrators are allowed to edit it (let's hope for stupid spammers)that page. Type '''Template You can leave your change request in the [[Talk:Main Page''' after contextgarden.net/ and edit that template]] page.
== In-line elements ==
|}
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= The <cmd> tag is deprecated. col width=360 style="text-align: left"| You see|- style="vertical-align: top"| * <tt><nowiki>{{gen|startsection}}</nowiki></tt>| * {{gen|startsection}}|}
=== 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|<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|<code>}} is required.
{| class=wikitable
=== 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}}. There are two templates to link to online copies of the source files.
Link to the most recent version (recommended)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 version stored on contextgarden.netConTeXt distribution:* '''You type:''' <nowiki>[[source:type-akbmtxrun.texlua| type-akbmtxrun.texlua]]</nowiki>* '''Links to:''' http://source.contextgarden.net/type-akbmtxrun.texlua* '''Looks like:''' [[source:type-akbmtxrun.texlua|type-akbmtxrun.texlua]] 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 ===
* '''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 ==
| <pre>
<context>
The wiki is using ConTeXt Mark IVLMTX: \crlf
\contextversionnumber
(lmtx mode: \the\contextlmtxmode)
</context>
</pre>
| <context>
The wiki is using ConTeXt Mark IVLMTX: \crlf\contextversionnumber(lmtx mode: \the\contextlmtxmode)
</context>
|- style="vertical-align: top"
| <pre>
<context mode="mkiv" source="yes " text="This produces:">The wiki still uses also contains ConTeXt Mark IV: \crlf
\contextversionnumber
(lmtx mode: \the\contextlmtxmode)
</context>
</pre>
| <context mode="mkiv" source="yes " text="This produces:">The wiki still uses 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>. This is particularly useful in a "Command" page.
The <nowiki><syntax></nowiki> tag accepts two attributes:
* 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>.
{| class=wikitable
! scope=col width=300 style="text-align: left"| You type
</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 ===
