Style And Syntax
From Synfig Studio :: Documentation
(first draft) |
(more information) |
||
| Line 1: | Line 1: | ||
<!-- Page info --> | <!-- Page info --> | ||
| − | {{Title|Style | + | {{Title|Style And Syntax}} |
| + | {{Navigation|Writer_Documentation|Meta:Translation}} | ||
<!-- Page info end --> | <!-- Page info end --> | ||
| + | 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 = | = Page head = | ||
At the top of each page there is a special section where additional page information is stored. That's how it may look like: | At the top of each page there is a special section where additional page information is stored. That's how it may look like: | ||
| − | <code><nowiki><!-- Page info --> | + | <code><nowiki><!-- Page info --></nowiki> |
| − | {{Title|Getting Started}} | + | <nowiki>{{</nowiki>Title|Getting Started}}<!-- Scary? That's to make sure that GetTitle template will not catch the Title tag --> |
| − | {{Navigation|Category:Manual|Doc:Animation_Basics}} | + | <nowiki>{{</nowiki>Navigation|Category:Manual|Doc:Animation_Basics}} |
| − | {{Category|Manual}} | + | <nowiki>{{</nowiki>Category|Manual}} |
| − | {{Category|Tutorials}} | + | <nowiki>{{</nowiki>Category|Tutorials}} |
| − | {{Category|Tutorials Basic}} | + | <nowiki>{{</nowiki>Category|Tutorials Basic}} |
| − | <!-- Page info end --></nowiki></code> | + | <nowiki><!-- Page info end --></nowiki></code> |
Please take your time to fill that section properly, otherwise some things may not work as expected. There are only few tags allowed here. | Please take your time to fill that section properly, otherwise some things may not work as expected. There are only few tags allowed here. | ||
== Title tag == | == Title tag == | ||
| − | That tag is used to specify proper title for translated pages. | + | That tag is mandatory and used to specify title for a page. It main purpose to provide proper title for translated pages. Please set the page title even if it s the same as the page name. That will make sure that translators will not forget to set this tag at the translation time, |
== Category tag == | == Category tag == | ||
| − | You can specify categories page belongs using "Category" tag, like this: | + | You can specify categories page belongs to using "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 and categories set with Category tag. | + | :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. |
| − | + | ||
| − | + | ||
== Navigation tag == | == Navigation tag == | ||
| − | Navigation tag is optional. It's used when you want to link a set of pages into a sequence, like Manual pages. | + | 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 a name of the top-level (index) page for the sequence current page belongs to. For example, "Parent Page" for {{l|Doc:Getting Started}} is {{L|Category:Manual}}. And parent page for this one is {{#dpl:titlematch={{NAMESPACE}}{{PAGENAME}}|namespace={{NAMESPACE}}|includepage={Navigation}:1}}. | ||
| + | * "Next Page" is the neme of the page which plce in sequence is after current one. For example, "Next Page" for {{L|Doc:Getting Started}} is {{L|Doc:Animation Basics}}. | ||
| + | |||
| + | Notice, you don't need to specify previous page, because it's determined automatically from the data in navigation tags of other pages. | ||
= Links = | = Links = | ||
| + | The rule is simple: just use <nowiki>{{l| ... }}</nowiki> instead of <nowiki>[[ ... ]]</nowiki> EVERYWHERE. | ||
| + | |||
| + | TODO: table here | ||
| + | |||
| + | = Menu entries = | ||
... | ... | ||
= Useful templates = | = Useful templates = | ||
... | ... | ||
Revision as of 15:40, 10 February 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. That's how it may look like:
<!-- 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 to fill that section properly, otherwise some things may not work as expected. There are only few tags allowed here.
Title tag
That tag is mandatory and used to specify title for a page. It main purpose to provide proper title for translated pages. Please set the page title even if it s the same as the page name. That will make sure that translators will not forget to set this tag at the translation time,
Category tag
You can specify categories page belongs to using "Category" tag, like this:
{{Category|Manual}}.
- Consider the fact that this syntax statement differs from usual MediaWiki syntax. In 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 by more logical for our taste, where all links are defined by L tag (see below) and categories set with Category tag.
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 a name of the top-level (index) page for the sequence current page belongs to. For example, "Parent Page" for Getting Started is Manual. And parent page for this one is
Extension:DynamicPageList (DPL), version 2.3.0 : Warning: No results.
. - "Next Page" is the neme of the page which plce in sequence is after current one. For example, "Next Page" for Getting Started is Animation Basics.
Notice, you don't need to specify previous page, because it's determined automatically from the data in navigation tags of other pages.
Links
The rule is simple: just use {{l| ... }} instead of [[ ... ]] EVERYWHERE.
TODO: table here
Menu entries
...
Useful templates
...
