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

Moderation

This wiki is moderated. It means that by default it displays the latest approved version instead of the very latest edit.

The moderation is introduced for two reasons:

Contributors can safely prepare documentation for the new (upcoming) version of Synfig, while information about current (stable) version still will be available by default at the frontend.

Administrators can review the edits in most comfortable time for them, without worrying that someone will put undesired edits during their absence.

If the approved edit for the page is not the latest one, then you will see a special message near the page heading: "This is the approved revision of this page; it is not the most recent." That means there are some newer edits not approved by moderator (yet). You can click "View the most recent revision." to see the most recent edit.

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:

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. For example, it's the good place to put the TOCright template.

Basics templates

Title template

{{Title|Getting Started}}

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

Please specify categories a page belongs to with this syntax:

{{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.

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 Navigation at the top of the chapter, do so as well at the end... this is the natural place when you read the documentation.

Table of contents : TOC

More templates

Formating

Links

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

This special template make the localization mechanic work on this wiki. When you translate a page, create (or let) the links with {{L|OrginalPageName}}, if the "OrginalPageName" exist in your language, the link will be translated and linked to it.

Table

Add a table with a lot of options. Typicaly used in Layer's parameters description.
If you have a left align table (what is default align) and want a paragraph break after the table, add this following "magic" code after it : <br style="clear:both;"> (or simply change align="left" with align="none" from table definition)

Wiki

Search

Tools

Content of this Synfig Studio Documentation Wiki is available under the terms of Creative Commons Attribution-Share Alike 3.0 license.
By contributing here you agree that the same license will be applied to your writing. If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it to this wiki. You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!