Revision as of 00:00, 28 April 2010 (view source) Ohoservices (Talk | contribs) ← Older edit		Revision as of 11:45, 14 May 2010 (view source) Ohoservices (Talk | contribs) Newer edit →
Line 80:		Line 80:
	(TODO) This template gives a box with an icon and a title, expanding with the text width up to page-width.		(TODO) This template gives a box with an icon and a title, expanding with the text width up to page-width.
	...		...
		+
		+
	{{Navigation|Writer_Documentation|Meta:ScreenShots}}		{{Navigation|Writer_Documentation|Meta:ScreenShots}}

---

Revision as of 11:45, 14 May 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.

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 templates allowed in this section.

Title template

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.

Categories

You can specify categories a page belongs to the same way as with any mediawiki:

[[Category:Manual]]

Consider the fact that linking to categories differs from the usual MediaWiki syntax. In an ordinary MediaWiki setup 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).

We have too many categories today. We might delete many of them soon.

Just use those categories today:

• Unverified / Updated - marks page/screenshot status.
• Manual / Tutorial / Glossary - shows is the page in "Doc" namespace belong to tutorials or is it part of the Manual or Glossary.
• Tutorials Basic / Tutorials Intermediate / Tutorials Advanced - shows tutorial complexity level.
• Tools / Layers / Panels / Parameters / Tools - group relevant pages together.
• CMS - images belonging to CMS interface ("Theme" category is the same, should be merged with)

Navigation template

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 name of the page which in reading sequence is following the 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.

Please, if you place the Anvigation at the top of the chapter, do so as well at the end... this is the natural place when you read the documentation.

Links

The rule is simple: just use {{L| ... }} instead of [[ ... ]] EVERYWHERE for internal links.

TODO: table here

Menu command template

Usage: {{c|<menuname>|<submenu1>|submenu2|…}}

Development Notes

Use DevNotesBegin and DevNotesEnd templates to mark text describing features of development Synfig version. Usage: {{DevNotesBegin}}Any wiki markup.{{DevNotesEnd}}

Note template

This template gives a box of fixed width.

{{Note|Note title|Short note text}}

gives

Note title Short note text

while

{{Note|Note title|Suspendisse sodales leo at dolor mollis sagittis. In tempor venenatis tellus sed tincidunt.}}

gives

Note title Suspendisse sodales leo at dolor mollis sagittis. In tempor venenatis tellus sed tincidunt.

See also Template:NiceTip

NiceTip template

(TODO) This template gives a box with an icon and a title, expanding with the text width up to page-width. ...