Style And Syntax
From Synfig Studio :: Documentation
m (moved Meta:Style and syntax to Meta:Style And Syntax) |
Robertgroves (Talk | contribs) m (Some grammatical edits were made.) |
||
| Line 6: | Line 6: | ||
= Page head = | = Page head = | ||
| − | At the top of each page there is a special section where additional page information is stored. | + | 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><!-- Page info --></nowiki> | <code><nowiki><!-- Page info --></nowiki> | ||
| Line 16: | Line 16: | ||
<nowiki><!-- Page info end --></nowiki></code> | <nowiki><!-- Page info end --></nowiki></code> | ||
| − | Please take your time to fill | + | 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 == | == 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 == | == Category tag == | ||
| − | You can specify categories page belongs to using | + | You can specify which categories a page belongs to using the Category tag, like this: |
<pre><nowiki>{{Category|Manual}}</nowiki></pre> | <pre><nowiki>{{Category|Manual}}</nowiki></pre> | ||
| − | :Consider the fact that this syntax statement differs from usual MediaWiki syntax. In 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 by more logical for our taste, where all links are defined by L tag (see below) and categories set with Category tag. | + | :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 == | == Navigation tag == | ||
| − | 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> | + | 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 | + | * "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}}. | * "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 | + | 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 = | = Links = | ||
Revision as of 08:50, 4 March 2010
Before you start editing pages in this wiki, you should be aware about some improvements we made to original MediWiki to provide extra features.
Contents
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:
<!-- Page info -->
{{Title|Getting Started}}
{{Navigation|Category:Manual|Doc:Animation_Basics}}
{{Category|Manual}}
{{Category|Tutorials}}
{{Category|Tutorials Basic}}
<!-- Page info end -->
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:
{{Category|Manual}}
- Consider the fact that this syntax statement differs from the usual MediaWiki syntax. In an ordinary MediaWiki setup, category is specified with [[Category:MyCategory]] statement and you are forced to use [[:Category:MyCategory]] 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.
The Navigation tag is optional. It's used when you want to link a set of pages into a sequence, like Manual pages. The syntax is:
{{Navigation|Parent Page|Next Page}}
- "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 Getting Started is Manual. And the parent page for this page is Writer Documentation.
- "Next Page" is the neme of the page which place in sequence is after current one. For example, "Next Page" for Getting Started is 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 {{l| ... }} instead of [[ ... ]] EVERYWHERE.
TODO: table here
Menu entries
...
Useful templates
...
