Meta:Template Style And Syntax

2010-03-04T06:50:49Z

Robertgroves: Some grammatical edits were made.

{{Title|Style And Syntax}}
{{Navigation|Writer_Documentation|Meta:Translation}}

Before you start editing pages in this wiki, you should be aware about some improvements we made to original MediWiki to provide extra features.

= Page head =
At the top of each page there is a special section where additional page information is stored. Shown below is an example of how this section might look:

<code><nowiki></nowiki>
<nowiki>{{</nowiki>Title|Getting Started}}
<nowiki>{{</nowiki>Navigation|Category:Manual|Doc:Animation_Basics}}
<nowiki>{{</nowiki>Category|Manual}}
<nowiki>{{</nowiki>Category|Tutorials}}
<nowiki>{{</nowiki>Category|Tutorials Basic}}
<nowiki></nowiki></code>

Please take your time and be sure to fill in this section properly, otherwise some things may not work as expected. There are only few tags allowed in this section.

== Title tag ==
The Title tag is mandatory and used to specify the title for a page. Its main purpose is to provide a proper title for translated pages. You should set the page title even if it's the same as the page name. This ensures that translators will not forget to set this tag at the time of translation.

== Category tag ==
You can specify which categories a page belongs to using the Category tag, like this:
<pre><nowiki>{{Category|Manual}}</nowiki></pre>

:Consider the fact that this syntax statement differs from the usual MediaWiki syntax. In an ordinary MediaWiki setup, category is specified with ''<nowiki>[[</nowiki>Category:MyCategory<nowiki>]]</nowiki>'' statement and you are forced to use ''<nowiki>[[</nowiki>:Category:MyCategory<nowiki>]]</nowiki>'' syntax if you want a link to category. That approach is replaced here by one considered more logical for our taste, where all links are defined by L tag (see below) and categories are set with Category tag.

== Navigation tag ==
The Navigation tag is optional. It's used when you want to link a set of pages into a sequence, like {{l|Doc:Manual|Manual pages}}. The syntax is: <pre><nowiki>{{</nowiki>Navigation|Parent Page|Next Page<nowiki>}}</nowiki></pre>

* "Parent Page" is the name of the top-level (index) page for the sequence which the current page belongs to. For example, "Parent Page" for {{l|Doc:Getting Started}} is {{L|Category:Manual}}. And the parent page for this page is {{L|Writer_Documentation}}.
* "Next Page" is the neme of the page which place in sequence is after current one. For example, "Next Page" for {{L|Doc:Getting Started}} is {{L|Doc:Animation Basics}}.

Notice that you don't need to specify the previous page because it's determined automatically from the data in the navigation tags of other pages.

= Links =
The rule is simple: just use <nowiki>{{l| ... }}</nowiki> instead of <nowiki>[[ ... ]]</nowiki> EVERYWHERE.

TODO: table here

= Menu entries =
...

= Useful templates =
...

Meta:Wiki Structure

2010-03-04T06:25:48Z

Robertgroves: Some minor grammatical edits were made.

{{Title|Wiki Structure}}
{{Navigation|Writer_Documentation|Meta:Style And Syntax}}


Pages on this wiki are grouped into collections called "'''namespaces'''", which differentiate between the purpose of the pages at a high level. Pages in certain namespaces can also have special properties or behave differently when they interact with other pages.

Namespaces are indicated in page titles by prefixing the page name with "<tt>namespace:</tt>", so the prefix "<tt>{{NAMESPACE}}:</tt>" in this page's title ("{{FULLPAGENAME}}") indicates that this page is in the {{NAMESPACE}} namespace. Note, however, that colons and prefixes can also appear in page titles ''without'' indicating a namespace: The page [[Foo:{{PAGENAME}}]] is a page located in the Main namespace because the namespace "Foo" does not exist (the "Main namespace" does not have a prefix). Similarly the page [[{{NAMESPACE}}:Foo:{{PAGENAME}}]] is in the "{{NAMESPACE}}" namespace.

You can read more about namespaces [http://www.mediawiki.org/wiki/Manual:Namespace here].

'''If you are creating a new page in this wiki, please consider putting it into the correct namespace.'''

Here's a list of defined namespaces and their descriptions:
* '''Main''' - These pages describe concepts and definitions. Usually they are part of the {{l|Category:Reference}} or {{l|Category:Glossary}}. Remember, that pages in the Main namespace have no prefix, that makes them easy to reference from other pages.
* '''Doc''' - This namespace is for {{l|Category:Manual|manual}} and {{l|Tutorials|tutorials}} pages. Generally they are dedicated to describing some process, i.e. [[Doc:Creating Shapes]], [[Doc:Animation Basics]].
* '''Command''' - Pages in this category describe functionality of commands from Synfig menus (i.e. [[Command:Open]], [[Command:Save_as]]).
* '''Dev''' - These pages are to help developers and/or to describe project functionalities as they are implemented, i.e. [[Dev:Roadmap]].
* '''Meta''' - These pages deal with the wiki itself, its usage, development and standards.

Just like in any other wiki based on MediaWiki engine, you will find the following built-in namespaces:
* '''Category''' - Categories pages.
* '''User''' - In your user page you’re quite free to add anything you want (should be related to Synfig though). Please avoid spamming with links to commercial sites unrelated to Synfig.

Synfig Studio :: Documentation - User contributions [en]

Meta:Template Style And Syntax

Meta:Wiki Structure