Synfig Studio :: Documentation - User contributions [en]

Command:Panels

2017-04-20T12:17:43Z

D.j.a.y: deprecated + intra links to avoid dead end

Deprecated, maybe you could have a look to {{l|Category:Window Menu}}, or go back the {{l|Category:Manual}}

Category:File Menu/fr

2017-04-20T12:04:00Z

D.j.a.y: Reverted edits by Want (talk) to last revision by D.j.a.y

Tool Options Panel/fr

2017-04-20T11:48:29Z

D.j.a.y: using template (wip)

{{Title|Panneau Options des Outils}}
{{TOCright}}
{{Category|Panels}}
{{NewTerminology}}

{{Note|Translation / Traduction help|Des pages modèles (template) utilisés ici auraient besoin d'être créé et traduit}}
=Introduction=
Le panneau d'{{Literal|Options des Outils}} présente les options disponible que vous pouvez appliquer à l'outil actuellement sélectionné. Pour les outils pouvant créer plusieurs calques, le panneau affiche de manière contextuelle les options disponibles suivant le type de calques choisit.

L'icône du panneau {{Literal|Options des Outils}} change lors vous changez d'outil pour indiquer l'outil actif.

Les valeurs du panneau d'{{Literal|Options des Outils}} sont enregistrées lors d'un changement d'outils mais également entre les sessions de SynfigStudio, ainsi, vous pouvez les réutiliser autant de fois que vous le désirez.

Voici une liste des options disponible pour chaque outils:
==[[File:Tool Normal.png|30px]] {{l|Transform tool}}==

{{TransformToolOptions/fr}}

==[[File:Tool smooth move.png|30px]]{{l|Smooth Move Tool}}==

{{SmoothMoveToolOptions/fr}}

==[[File:Tool scale.png|30px]] {{l|Scale Tool}}==

{{ScaleToolOptions/fr}}

==[[File:Tool rotate.png|30px]] {{l|Rotate Tool}}==

{{RotateToolOptions}}

==[[File:Tool mirror.png|30px]] {{l|Mirror Tool}}==

{{MirrorToolOptions}}

==[[File:Tool circle icon.png|30px]] {{l|Circle Tool}}==

{{CircleToolOptions}}

==[[File:Tool rectangle icon.png|30px]] {{l|Rectangle Tool}}==

{{RectangleToolOptions}}

==[[File:Tool star icon.png|30px]] {{l|Star Tool}}==

{{StarToolOptions}}

==[[File:Tool polygon icon.png|30px]] {{l|Polygon Tool}}==

{{PolygonToolOptions}}

==[[File:Tool gradient icon.png|30px]] {{l|Gradient Tool}}==

{{GradientToolOptions}}

==[[File:Tool bline icon.png|30px]]{{l|Spline Tool}}==

{{SplineToolOptions}}

==[[File:Tool draw icon.png|30px]] {{l|Draw Tool}}==

{{DrawToolOptions}}

==[[File:Tool cutout icon.png|30px]] {{l|Cutout Tool}}==

{{CutoutToolOptions}}

==[[File:Tool width icon.png|30px]] {{l|Width Tool}}==

{{WidthToolOptions}}

==[[File:Tool fill icon.png|30px]] {{l|Fill Tool}}==

{{FillToolOptions}}

==[[File:Tool eyedrop icon.png|30px]] {{l|Eyedrop Tool}}==

{{EyedropToolOptions}}

==[[File:Tool text icon.png|30px]] {{l|Text Tool}}==

{{TextToolOptions}}

==[[File:Tool sketch icon.png|30px]] {{l|Sketch Tool}}==

{{SketchToolOptions}}

==[[File:Tool brush icon.png|30px]] {{l|Brush Tool}}==

{{BrushToolOptions}}

==[[File:Tool zoom icon.png|30px]] {{l|Zoom Tool}}==

{{ZoomToolOptions}}

Template:ScaleToolOptions/fr

2017-04-20T11:47:39Z

D.j.a.y: fix

[[File:Scale Tool Options.png|frame]]
Le {{l|Tool Options Panel}} vous permet de choisir :
* '''Verrouiller Proportions''' : Permet figer le ratio x:y de la sélection courante de {{l|Handle|poignées}}.

Template:ScaleToolOptions/fr

2017-04-20T11:45:28Z

D.j.a.y: creation

[[File:Scale Tool Options.png|frame]]
**Verrouiller Proportions (Booléen)
Le {{l|Tool Options Panel}} vous permet de choisir :
* '''Verrouiller Proportions''' : Permet figer le ratio x:y de la sélection courante de {{|Handle|poignées}}.

Template:SmoothMoveToolOptions/fr

2017-04-20T11:37:32Z

D.j.a.y: creation

*Rayon (nombre réel)

Template:TransformToolOptions/fr

2017-04-20T11:35:06Z

D.j.a.y: creation

* Aucun

Tool Options Panel/fr

2017-04-20T11:33:17Z

D.j.a.y: use tools templates. EN --> FR Translation needed !!!

{{Title|Panneau Options des Outils}}
{{TOCright}}
{{Category|Panels}}
{{NewTerminology}}

{{Note|Translation / Traduction help|Des pages modèles (template) utilisés ici auraient besoin d'être créé et traduit}}
=Introduction=
Le panneau d'{{Literal|Options des Outils}} présente les options disponible que vous pouvez appliquer à l'outil actuellement sélectionné. Pour les outils pouvant créer plusieurs calques, le panneau affiche de manière contextuelle les options disponibles suivant le type de calques choisit.

L'icône du panneau {{Literal|Options des Outils}} change lors vous changez d'outil pour indiquer l'outil actif.

Les valeurs du panneau d'{{Literal|Options des Outils}} sont enregistrées lors d'un changement d'outils mais également entre les sessions de SynfigStudio, ainsi, vous pouvez les réutiliser autant de fois que vous le désirez.

Voici une liste des options disponible pour chaque outils:
==[[File:Tool Normal.png|30px]] {{l|Transform tool}}==

{{TransformToolOptions}}

==[[File:Tool smooth move.png|30px]]{{l|Smooth Move Tool}}==

{{SmoothMoveToolOptions}}

==[[File:Tool scale.png|30px]] {{l|Scale Tool}}==

{{ScaleToolOptions}}

==[[File:Tool rotate.png|30px]] {{l|Rotate Tool}}==

{{RotateToolOptions}}

==[[File:Tool mirror.png|30px]] {{l|Mirror Tool}}==

{{MirrorToolOptions}}

==[[File:Tool circle icon.png|30px]] {{l|Circle Tool}}==

{{CircleToolOptions}}

==[[File:Tool rectangle icon.png|30px]] {{l|Rectangle Tool}}==

{{RectangleToolOptions}}

==[[File:Tool star icon.png|30px]] {{l|Star Tool}}==

{{StarToolOptions}}

==[[File:Tool polygon icon.png|30px]] {{l|Polygon Tool}}==

{{PolygonToolOptions}}

==[[File:Tool gradient icon.png|30px]] {{l|Gradient Tool}}==

{{GradientToolOptions}}

==[[File:Tool bline icon.png|30px]]{{l|Spline Tool}}==

{{SplineToolOptions}}

==[[File:Tool draw icon.png|30px]] {{l|Draw Tool}}==

{{DrawToolOptions}}

==[[File:Tool cutout icon.png|30px]] {{l|Cutout Tool}}==

{{CutoutToolOptions}}

==[[File:Tool width icon.png|30px]] {{l|Width Tool}}==

{{WidthToolOptions}}

==[[File:Tool fill icon.png|30px]] {{l|Fill Tool}}==

{{FillToolOptions}}

==[[File:Tool eyedrop icon.png|30px]] {{l|Eyedrop Tool}}==

{{EyedropToolOptions}}

==[[File:Tool text icon.png|30px]] {{l|Text Tool}}==

{{TextToolOptions}}

==[[File:Tool sketch icon.png|30px]] {{l|Sketch Tool}}==

{{SketchToolOptions}}

==[[File:Tool brush icon.png|30px]] {{l|Brush Tool}}==

{{BrushToolOptions}}

==[[File:Tool zoom icon.png|30px]] {{l|Zoom Tool}}==

{{ZoomToolOptions}}

Writer Documentation

2017-04-20T11:14:18Z

D.j.a.y: /* Editor Documentation */ template intra link

{{Title|Writer Documentation}}
{{TOCright}}

= Getting Started =
There you are...
==Translation==
To add {{l|Meta:Translation|translated}} pages.
==New pages==
To add an additional page just call the page by editing the address in your browser (without ending '/' ).
You'll then see a page telling you that this page currently doesn't exist and you can click on {{literal|Create}} at the top menu. If you don't feel comfortable doing changes in the mains pages, you can start by submitting your changes in the {{Literal|Discussion}} pages ( {{Shortcut|Alt|Shift|t}}).

= Editor Documentation =
* General Conventions
** {{l|Meta:General Documentation Style}}
** {{l|Meta:ScreenShots}}
** {{l|Meta:Synfig Naming Conventions}}

* Wiki
** {{l|Meta:Wiki Structure}}
** {{l|Meta:Template Style And Syntax}}
** {{l|Meta:Templates}}
** {{l|Wiki Improvements}}

* {{l|Meta:Translation}}

= Administrator Documentation =
* {{l|Meta:Templates}}
* {{l|Meta:How to add support for new language}}

= Marketing/Sales Documentation =
* {{l|Meta:Writing Press Releases}}

= Pages Currently Developed =
These pages are currently under development and do not show up on the official documentation:
* {{l|#Rewritefor_1x_series|Rewrite for 1.x series}}
* {{l|#WikificationofGenetestuff|Wikification of Genete's stuff}}
* {{l|#Terminologyrewritesprint|Terminology rewrite sprint}}

= Projects =
== (in progress) 2015 --> - Rewrite for 1.x series==

In order to update the documentation to follow the 1.0 release, a '''major revision of the documentation''' is needed.

In some cases, draft work has already been done in the '''Talk''' section of the pages.

According the synfigstudio 1.0 single window (and other changes) UI a global review and update of the '''screenshots''' must also be done...see howto in next paragraph.

The documentation can be now rewritten directly on the Pages (It's no longer necessary to use the Talk Pages nor the "Rewrite preparation for 0.65" has modification comment has suggested previously)

=== Where to start ===
* {{l|Category:Canvas_Window}} '''Ready for translation''' - (main rewrite done - polish done)
* {{l|Dock dialogs}} (outdated by {{l|Category:Panels}} update) : everything related to dock system should be reviewed (rewritten done)
* Something about jack synchro - done : {{l|FAQ#What_about_Jack_audio_server_.3F}}
* A sound layer tutorial
* A jack tutorial : draft here ---> {{l|Jack Audio Synchronization Tutorial}}
* {{l|Tool_Options_Panel}} '''Ready for translation''' - (main rewrite done)
* {{l|Category:File_Menu_%28Toolbox%29}} : in progress
* {{l|Category:Toolbox_Menu}} : in progress
* {{l|Help_Menu}} : in progress
* {{l|Toolbox}}
* and : http://wiki.synfig.org/wiki/index.php?title=Special%3ASearch&profile=advanced&search=rewrite+0.65&fulltext=Search&ns0=1&ns1=1&profile=advanced

===How to do the Screenshots ===
For complete recommendations on screenshot creation, see the synfig studio documentation : {{l|Meta:ScreenShots}}

* Please make screenshots in default light theme.
* Please keep image width under ~1000px.
* Use generic file notation : image_file_name_current.png. Example ''File:Render_settings_Dialog_current.png'' ‎used in [[Render_dialog]] (to take advantage of the upgrade image system)

===Terminology===
It's possible (and certain) that around the corners, some terminologies have been updated with all the GUI's recent changes. Some parts of the documentation may not reflect all the changes. If you find some... feel free to correct them in wiki original page (+ your native language?) ! (and add it to this list for helping the translation into other languages)

{|border="1" align="none"
|-style="background:#silver"
|'''Old Terminology'''||'''New Terminology'''||'''Where'''
|-
||Children Lock
||{{l|Lock Selection}}
||{{l|Group Layer}} and Swicth Group Layer
|-
||
||
||
|}

== (todo) 2015 --> - Wikification of Genete's stuff ==
A lot of documentation resources have been produced by Genete. They are hosted in the cloud. Some of it should be hosted in the wiki, in the dev, or tutorial or .... sections.

* [https://drive.google.com/folderview?id=0Bx8g_H3f7qpZZDExNjU0NmEtZWI2Mi00M2UzLWI2OWQtNDUyYmRhOGRiN2Qx&usp=sharing Genete Stuff].

''please, log here any progress to avoid duplicate work''

== (done) 2014-2015 - Rewrite preparation for future release 1.0==

The documentation can be now rewritten directly on the Page. It's no longer necessary to use the Talk Pages nor the "Rewrite preparation for 0.65" has modification comment has suggested previously.

Have a look at what has already been initiated : http://wiki.synfig.org/wiki/index.php?title=Special%3ASearch&profile=advanced&search=rewrite+0.65&fulltext=Search&ns0=1&ns1=1&profile=advanced

According the synfigstudio 1.0 single window (and other changes) UI a global review and update of the screenshots must be done...

(No more useful) <strike>Write inside Talk:Pages the new feature that will be available in synfig 1.0 in order to not do ''visible modification'' until next release is out.</strike>

(No more useful)<strike> Suggested work-flow : use "Rewrite preparation for 0.65" has modification comment, and add "Rewrite preparation for 0.65" sentence inside the Talk Page (to get an easy way to retrieve all the pages who need to be updated once 1.0 will be out)</strike>

== (in progress) 2013 ---> - Terminology rewrite sprint ==
Have a look in the Forum [http://www.synfig.org/forums/viewtopic.php?f=25&t=4056] for more information.

* (''[http://www.synfig.org/forums/viewtopic.php?f=1&t=4056&start=75#p18012 done]'') - {{l|Dev:Sprints/2013-01-07_Reworked_Terminology|Terminology}} step of original (English) doc .
* ''(done - over-dated by 1.0 work)'' - {{l|Dev:Sprints/2013-02-19_Screenshots_Update|Screenshot Update}} step
* ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18930 done])'' - Approve terminology change step on reference page (english)
* ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18985 done])'' - Signal translation pages outdated
* ''(done)'' - Banner with the instructions to all translation pages not updated with new terminology
* ''(done)'' - Some translation pages have to be renamed. For example "Params Panel/ru" have to become "Parameters Panel/ru". Only admins can do that.
* ''('''todo''')'' - Find a way to work on translation pages outdated
* ''('''todo''')'' - Update the translations step

Meta:Templates

2017-04-20T11:14:04Z

D.j.a.y: better title

{{Title|Templates list}}
{{Navigation|Writer_Documentation|}}
{{TOCright}}

Here's a list of templates used to improve this wiki functionality.

= User Templates =
Those templates can (and often should) be used in page body.

== C ==
* '''Location''': {{l|Template:C}}
* '''Description''': This template should always be used to ‘wrap’ items from the context menu GUI.
* '''Examples''': <nowiki>{{c|File|Open File}}</nowiki> is interpreted as {{c|File|Open File}}

== Category ==
* '''Location''': {{l|Template:Category}}
* '''Description''': Specifies category page belongs to.
* '''Examples''': <nowiki>{{Category|MyCategory}}</nowiki>.

== CategoryContents ==
* '''Location''': {{l|Template:CategoryContents}}
* '''Description''': Lists all pages in the specified category. Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category and the page titles will be replaced with their Spanish translations.
* '''Examples''': <nowiki>{{CategoryContents|MyCategory}}</nowiki>.

== L ==
* '''Location''': {{l|Template:L}}
* '''Description''': Creates link to another page, providing proper localization support.
* '''Examples''': See {{l|Meta:LinksTest/ru|Meta:LinksTest/ru}}.

== Literal ==
* '''Location''': {{l|Template:Literal}}
* '''Description''': This template should always be used to ‘wrap’ all reference to GUI items (control name, menu item, …).
* '''Examples''': <nowiki>{{Literal|Open File|New}}</nowiki> is interpreted as {{Literal|Open File}}

== Navigation ==
* '''Location''': {{l|Template:Navigation}}
* '''Description''': Defines navigation for sequence of pages and displays navigation bar. You need only to specify parent (index) page and next page (optional). There's no need to specify previous page, because it's determined automatically. Works only within the range of namespace though.
* '''Examples''': For result see the header from those page, or result example code <nowiki>{{Navigation|Top Page|Next Page}}</nowiki> :

{{Navigation|Top Page|Next Page}}

== Note ==
* '''Location''': {{l|Template:Note}}
* '''Description''': This template gives a box of fixed width. First argument is header for note and second a main content of note.
* '''Examples''': <nowiki>{{Note|Note title|Short note text}}</nowiki> See in ex. {{l|Doc:Getting_Started}} or note from example:

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

== Shorcut ==
* '''Location''': {{l|Template:Shortcut}}
* '''Description''': Put a sequence of up to 5 keys to show a shortcut.
* '''Examples''': <nowiki>{{Shortcut|Alt|Shift|t}}</nowiki> is interpreted as {{Shortcut|Alt|Shift|t}}

== Stub ==
* '''Location''': {{l|Template:Stub}}
* '''Description''': Mark page as a stub.
* '''Examples''': <nowiki>{{Stub}}</nowiki>.

== Title ==
* '''Location''': {{l|Template:Title}}
* '''Description''': Sets custom title for a page.
* '''Examples''': See sources of {{l|Main_Page|Main_Page}}, {{l|Doc:Getting_Started|Doc:Getting_Started}}, {{l|Doc:Getting_Started/ru|Doc:Getting_Started/ru}} pages.

== TOCright ==
* '''Location''': {{l|Template:TOCright}}
* '''Description''': Set the Table Of Content to the right side of the page.
* '''Examples''': <nowiki>{{TOCright}}</nowiki>. Mainly on every pages. Please use it when the page's TOC start to fill too much space.

= Internal Templates =
Templates below are not intended for direct use in page body. They are usually invoked by high-level templates listed above.

== ! ==
* '''Location''': {{l|Template:!}}
* '''Description''': This is an auxiliary template allowing one to encode "<code>|</code>"
within template and parser function parameters. {{L|Template:!|More...}}
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{!}}</nowiki>
|<nowiki>|</nowiki>
|
|}

== GetTitle ==
* '''Location''': {{l|Template:GetTitle}}
* '''Description''': Returns custom title of a page set with <nowiki>{{</nowiki>Title<nowiki>}}</nowiki> template in the page body.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{GetTitle|Doc:Getting_Started/ru}}</nowiki>
|Первые шаги
|Look at the source of {{l|Doc:Getting_Started/ru|Doc:Getting_Started/ru}} page.
|}

== Languages ==
* '''Location''': {{l|Template:Languages}}
* '''Description''': Displays bar listing available translations for current page. {{l|Template:Languages|More...}}
* '''Examples''': <nowiki>{{{Languages}}}</nowiki>

== Languages/Lang ==
* '''Location''': {{l|Template:Languages/Lang}}
* '''Description''': Utility template for language bar. Generates link to specified translation of current page if it's exists.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{Languages/Lang|en}}</nowiki>
|{{Languages/Lang|en}}
|Result is "English", but without a link, because current page is in English
|-
|<nowiki>{{Languages/Lang|es}}</nowiki>
|{{Languages/Lang|es}}
|Result is empty, because this page have no Spanish translation. If it does, then the result would be: " • {{l|Meta:Templates/es|Español}}"
|-
|<nowiki>{{Languages/Lang|ru}}</nowiki>
|{{Languages/Lang|ru}}
|Result is empty, because this page have no Russian translation. If it does, then the result would be: " • {{l|Meta:Templates/ru|Русский}}"
|}

== Languages/ThisPageTranslatedIn ==
* '''Location''': {{l|Template:Languages/ThisPageTranslatedIn}}
* '''Description''': Utility template for language bar. Returns a page name which translates current page to specified language.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{Languages/ThisPageTranslatedIn|en}}</nowiki>
|{{Languages/ThisPageTranslatedIn|en}}
|If this template invoked from Meta:Templates/es, then result is the same ("/es" suffix automatically dropped)
|-
|<nowiki>{{Languages/ThisPageTranslatedIn|ru}}</nowiki>
|{{Languages/ThisPageTranslatedIn|ru}}
|If this template invoked from Meta:Templates/es, then result is the same ("/es" suffix automatically dropped and "/ru" suffix added)
|}

== Navigation/PreviousPage ==
* '''Location''': {{l|Template:Navigation/PreviousPage}}
* '''Description''': Searches for previous page for current one and outputs its name.

== PagenameFromLink ==
* '''Location''': {{l|Template:PagenameFromLink}}
* '''Description''': Extracts page name from given link.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{PagenameFromLink|Doc:Getting_Started#Introduction}}</nowiki>
|Doc:Getting_Started
|-
|<nowiki>{{PagenameFromLink|layers}}</nowiki>
|Layers
|-
|<nowiki>{{PagenameFromLink|:Category:Manual}}</nowiki>
|Category:Manual
|}

== Title.dpl ==
* '''Location''': {{l|Template:Title.dpl}}
* '''Description''': Utility template used by [[#GetTitle|GetTitle]] template and DPL for page title extraction. See [http://semeb.com/dpldemo/index.php?title=DPL:Manual_-_DPL_parameters:_Controlling_output_volume#include_contents_related_to_templates this link].

== Title.dpl.default ==
* '''Location''': {{l|Template:Title.dpl.default}}
* '''Description''': Utility template used by [[#GetTitle|GetTitle]] template and DPL for page title extraction. See [http://semeb.com/dpldemo/index.php?title=DPL:Manual_-_DPL_parameters:_Controlling_output_volume#include_contents_related_to_templates this link].

= Warning banners =

== Warnings ==
* '''Location''': {{l|Template:Warnings}}
* '''Description''': Contains list of displayed warning banners and conditions for them

== OldTerminologyTranslation ==
* '''Location''': {{l|Template:OldTerminologyTranslation}}
* '''Description''': Outdated terminology for translated page banner

Meta:Templates

2017-04-20T11:12:59Z

D.j.a.y: title

{{Title|Templates used in synfig wiki}}
{{Navigation|Writer_Documentation|}}
{{TOCright}}

Here's a list of templates used to improve this wiki functionality.

= User Templates =
Those templates can (and often should) be used in page body.

== C ==
* '''Location''': {{l|Template:C}}
* '''Description''': This template should always be used to ‘wrap’ items from the context menu GUI.
* '''Examples''': <nowiki>{{c|File|Open File}}</nowiki> is interpreted as {{c|File|Open File}}

== Category ==
* '''Location''': {{l|Template:Category}}
* '''Description''': Specifies category page belongs to.
* '''Examples''': <nowiki>{{Category|MyCategory}}</nowiki>.

== CategoryContents ==
* '''Location''': {{l|Template:CategoryContents}}
* '''Description''': Lists all pages in the specified category. Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category and the page titles will be replaced with their Spanish translations.
* '''Examples''': <nowiki>{{CategoryContents|MyCategory}}</nowiki>.

== L ==
* '''Location''': {{l|Template:L}}
* '''Description''': Creates link to another page, providing proper localization support.
* '''Examples''': See {{l|Meta:LinksTest/ru|Meta:LinksTest/ru}}.

== Literal ==
* '''Location''': {{l|Template:Literal}}
* '''Description''': This template should always be used to ‘wrap’ all reference to GUI items (control name, menu item, …).
* '''Examples''': <nowiki>{{Literal|Open File|New}}</nowiki> is interpreted as {{Literal|Open File}}

== Navigation ==
* '''Location''': {{l|Template:Navigation}}
* '''Description''': Defines navigation for sequence of pages and displays navigation bar. You need only to specify parent (index) page and next page (optional). There's no need to specify previous page, because it's determined automatically. Works only within the range of namespace though.
* '''Examples''': For result see the header from those page, or result example code <nowiki>{{Navigation|Top Page|Next Page}}</nowiki> :

{{Navigation|Top Page|Next Page}}

== Note ==
* '''Location''': {{l|Template:Note}}
* '''Description''': This template gives a box of fixed width. First argument is header for note and second a main content of note.
* '''Examples''': <nowiki>{{Note|Note title|Short note text}}</nowiki> See in ex. {{l|Doc:Getting_Started}} or note from example:

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

== Shorcut ==
* '''Location''': {{l|Template:Shortcut}}
* '''Description''': Put a sequence of up to 5 keys to show a shortcut.
* '''Examples''': <nowiki>{{Shortcut|Alt|Shift|t}}</nowiki> is interpreted as {{Shortcut|Alt|Shift|t}}

== Stub ==
* '''Location''': {{l|Template:Stub}}
* '''Description''': Mark page as a stub.
* '''Examples''': <nowiki>{{Stub}}</nowiki>.

== Title ==
* '''Location''': {{l|Template:Title}}
* '''Description''': Sets custom title for a page.
* '''Examples''': See sources of {{l|Main_Page|Main_Page}}, {{l|Doc:Getting_Started|Doc:Getting_Started}}, {{l|Doc:Getting_Started/ru|Doc:Getting_Started/ru}} pages.

== TOCright ==
* '''Location''': {{l|Template:TOCright}}
* '''Description''': Set the Table Of Content to the right side of the page.
* '''Examples''': <nowiki>{{TOCright}}</nowiki>. Mainly on every pages. Please use it when the page's TOC start to fill too much space.

= Internal Templates =
Templates below are not intended for direct use in page body. They are usually invoked by high-level templates listed above.

== ! ==
* '''Location''': {{l|Template:!}}
* '''Description''': This is an auxiliary template allowing one to encode "<code>|</code>"
within template and parser function parameters. {{L|Template:!|More...}}
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{!}}</nowiki>
|<nowiki>|</nowiki>
|
|}

== GetTitle ==
* '''Location''': {{l|Template:GetTitle}}
* '''Description''': Returns custom title of a page set with <nowiki>{{</nowiki>Title<nowiki>}}</nowiki> template in the page body.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{GetTitle|Doc:Getting_Started/ru}}</nowiki>
|Первые шаги
|Look at the source of {{l|Doc:Getting_Started/ru|Doc:Getting_Started/ru}} page.
|}

== Languages ==
* '''Location''': {{l|Template:Languages}}
* '''Description''': Displays bar listing available translations for current page. {{l|Template:Languages|More...}}
* '''Examples''': <nowiki>{{{Languages}}}</nowiki>

== Languages/Lang ==
* '''Location''': {{l|Template:Languages/Lang}}
* '''Description''': Utility template for language bar. Generates link to specified translation of current page if it's exists.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{Languages/Lang|en}}</nowiki>
|{{Languages/Lang|en}}
|Result is "English", but without a link, because current page is in English
|-
|<nowiki>{{Languages/Lang|es}}</nowiki>
|{{Languages/Lang|es}}
|Result is empty, because this page have no Spanish translation. If it does, then the result would be: " • {{l|Meta:Templates/es|Español}}"
|-
|<nowiki>{{Languages/Lang|ru}}</nowiki>
|{{Languages/Lang|ru}}
|Result is empty, because this page have no Russian translation. If it does, then the result would be: " • {{l|Meta:Templates/ru|Русский}}"
|}

== Languages/ThisPageTranslatedIn ==
* '''Location''': {{l|Template:Languages/ThisPageTranslatedIn}}
* '''Description''': Utility template for language bar. Returns a page name which translates current page to specified language.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{Languages/ThisPageTranslatedIn|en}}</nowiki>
|{{Languages/ThisPageTranslatedIn|en}}
|If this template invoked from Meta:Templates/es, then result is the same ("/es" suffix automatically dropped)
|-
|<nowiki>{{Languages/ThisPageTranslatedIn|ru}}</nowiki>
|{{Languages/ThisPageTranslatedIn|ru}}
|If this template invoked from Meta:Templates/es, then result is the same ("/es" suffix automatically dropped and "/ru" suffix added)
|}

== Navigation/PreviousPage ==
* '''Location''': {{l|Template:Navigation/PreviousPage}}
* '''Description''': Searches for previous page for current one and outputs its name.

== PagenameFromLink ==
* '''Location''': {{l|Template:PagenameFromLink}}
* '''Description''': Extracts page name from given link.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{PagenameFromLink|Doc:Getting_Started#Introduction}}</nowiki>
|Doc:Getting_Started
|-
|<nowiki>{{PagenameFromLink|layers}}</nowiki>
|Layers
|-
|<nowiki>{{PagenameFromLink|:Category:Manual}}</nowiki>
|Category:Manual
|}

== Title.dpl ==
* '''Location''': {{l|Template:Title.dpl}}
* '''Description''': Utility template used by [[#GetTitle|GetTitle]] template and DPL for page title extraction. See [http://semeb.com/dpldemo/index.php?title=DPL:Manual_-_DPL_parameters:_Controlling_output_volume#include_contents_related_to_templates this link].

== Title.dpl.default ==
* '''Location''': {{l|Template:Title.dpl.default}}
* '''Description''': Utility template used by [[#GetTitle|GetTitle]] template and DPL for page title extraction. See [http://semeb.com/dpldemo/index.php?title=DPL:Manual_-_DPL_parameters:_Controlling_output_volume#include_contents_related_to_templates this link].

= Warning banners =

== Warnings ==
* '''Location''': {{l|Template:Warnings}}
* '''Description''': Contains list of displayed warning banners and conditions for them

== OldTerminologyTranslation ==
* '''Location''': {{l|Template:OldTerminologyTranslation}}
* '''Description''': Outdated terminology for translated page banner

Meta:Template Style And Syntax

2017-04-20T11:10:01Z

D.j.a.y: templates intra link

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

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:

<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 templates allowed in this section. For example, it's the good place to put the {{L|Template:TOCright|TOCright template}}.

=Basics templates=
== Title template ==

<nowiki>{{Title|Getting Started}}</nowiki>

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:
<pre><nowiki>{{Category|Manual}}</nowiki></pre>

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

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)

'''Reworked Terminology'''

For technical reasons, use just '''<nowiki>{{NewTerminology}}</nowiki>''' to mark page as updated when [http://wiki.synfig.org/wiki/Dev:Sprints/2013-01-07_Reworked_Terminology rewrite terminology is done]

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

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==
<pre><nowiki>{{</nowiki>TOCright<nowiki>}}</nowiki></pre>
Align to the right the Table of contents.

==More templates==
For a full list of templates used in the synfig wiki or before adding a new one, have a look to [[Meta:Templates|the template page listing]].

= Formating =

== Links ==
The rule is simple: just use <nowiki>{{L| ... }}</nowiki> (instead of <nowiki>[[ ... ]]</nowiki>) 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 <nowiki>{{L|OrginalPageName}}</nowiki>, if the {{literal|OrginalPageName}} exist in your language, the link will be translated and linked to it.

Usage :

<nowiki>A jump into {{L|Special:Random|random}} world.</nowiki>

gives

A jump into {{L|Special:Random|random}} world.

== 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 : <nowiki> </nowiki> (or simply change <nowiki>align="left"</nowiki> with <nowiki>align="none"</nowiki> from table definition)

Usage :

<code>
<nowiki>
{|border="0" align="left" style="border-collapse" cellpadding="3" cellspacing="0"</nowiki> <nowiki>
</nowiki> <nowiki>
|-style="background:#silver"</nowiki> <nowiki>
|'''Name'''||'''Value'''||'''Type''' </nowiki> <nowiki>
</nowiki> <nowiki>
|-</nowiki> <nowiki>
||{{l|Image:Type_real_icon.png|16px}} {{l|Z Depth Parameter|Z Depth}}</nowiki> <nowiki>
||0.000000</nowiki> <nowiki>
||real</nowiki> <nowiki>
</nowiki> <nowiki>
|-style="background:#eeeeee"</nowiki> <nowiki>
||{{l|Image:Type_real_icon.png|16px}} {{l|Amount Parameter|Quantity}}</nowiki> <nowiki>
||1.000000</nowiki> <nowiki>
||real</nowiki> <nowiki>
</nowiki> <nowiki>
|-</nowiki> <nowiki>
||icon ...</nowiki> <nowiki>
||...</nowiki> <nowiki>
||...</nowiki> <nowiki>
</nowiki> <nowiki>
|-style="background:#eeeeee"</nowiki> <nowiki>
||icon ...</nowiki> <nowiki>
||...</nowiki> <nowiki>
||...</nowiki> <nowiki>
</nowiki> <nowiki>
|}
</nowiki>
</code>

give

{|border="0" align="left" style="border-collapse" cellpadding="3" cellspacing="0"

|-style="background:#silver"
|'''Name'''||'''Value'''||'''Type'''

|-
||{{l|Image:Type_real_icon.png|16px}} {{l|Z Depth Parameter|Z Depth}}
||0.000000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_real_icon.png|16px}} {{l|Amount Parameter|Quantity}}
||1.000000
||real

|-
||icon ...
||...
||...

|-style="background:#eeeeee"
||icon ...
||...
||...

|}
 

More informations : [http://meta.wikimedia.org/wiki/Help:Table wikimedia.org / Help:Table]

== Menu command template ==
Used to indicate a path in the menu system.

<nowiki>{{c|<menuname>|<submenu1>|submenu2|…}}</nowiki>

Usage :
<nowiki>Display Layer Panel {{c|<File>|<Panel>|Layer|}} to ...</nowiki>

gives 

Display Layer Panel {{c|<File>|<Panel>|Layer|}} to ...

== Shortcut ==
The shortcut template display the shortcuts in a friendly way.

<includeonly>{{Shortcut/Hotkey|{{{1}}} |lower={{{lower1|}}}}}{{#if:{{{2|}}}|{{Shortcut/Hotkey| {{{2}}} |lower={{{lower2|}}}}} }}{{#if:{{{3|}}}|{{Shortcut/Hotkey| {{{3}}} |lower={{{lower3|}}}}} }}{{#if:{{{4|}}}|{{Shortcut/Hotkey| {{{4}}} |lower={{{lower4|}}}}} }}{{#if:{{{5|}}}|{{Shortcut/Hotkey| {{{5}}} |lower={{{lower5|}}}}} }}{{#if:{{{6|}}}|[[Category:Fixme/Shortcut template]] }}</includeonly><noinclude>Put a sequence of up to 5 keys to show a shortcut: 
<nowiki>{{Shortcut|<key1>|<key2>|...|...}}</nowiki>

Example :
<nowiki>{{Shortcut|alt|shift|S}}</nowiki>
returns {{Shortcut|alt|shift|S}}

More informations : [[Template:Shortcut]]

== Literal ==
This template is used to ‘wrap’ all reference to GUI items (control name, menu item, …).

Usage : 

<nowiki>Select {{Literal|Color}} parameter.</nowiki>

gives 

Select {{Literal|Color}} parameter.

More informations : [[Template:Literal]]

= Extras =

== Development Notes ==
Use DevNotesBegin and DevNotesEnd templates to mark text describing features of development Synfig version.

Usage : 

<nowiki>{{DevNotesBegin}}Any wiki markup.{{DevNotesEnd}}</nowiki>

gives 

{{DevNotesBegin}}Any wiki markup.{{DevNotesEnd}}

== Note template ==
This template gives a box of fixed width. 

<nowiki>{{Note|Note title|Short note text}}</nowiki>

gives 

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

while

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

gives 

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

= More informations =
For more ressources about synfig wiki template, have a look to [[Special:UncategorizedTemplates|Uncategorized Templates]]

Reading, Editing, Advanced editing ... [https://www.mediawiki.org/wiki/Help:Contents from mediawiki]

{{Navigation|Writer_Documentation|Meta:Translation}}

Meta:Templates

2017-04-20T11:00:38Z

D.j.a.y: toc right :-)

{{Navigation|Writer_Documentation|}}
{{TOCright}}

Here's a list of templates used to improve this wiki functionality.

= User Templates =
Those templates can (and often should) be used in page body.

== C ==
* '''Location''': {{l|Template:C}}
* '''Description''': This template should always be used to ‘wrap’ items from the context menu GUI.
* '''Examples''': <nowiki>{{c|File|Open File}}</nowiki> is interpreted as {{c|File|Open File}}

== Category ==
* '''Location''': {{l|Template:Category}}
* '''Description''': Specifies category page belongs to.
* '''Examples''': <nowiki>{{Category|MyCategory}}</nowiki>.

== CategoryContents ==
* '''Location''': {{l|Template:CategoryContents}}
* '''Description''': Lists all pages in the specified category. Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category and the page titles will be replaced with their Spanish translations.
* '''Examples''': <nowiki>{{CategoryContents|MyCategory}}</nowiki>.

== L ==
* '''Location''': {{l|Template:L}}
* '''Description''': Creates link to another page, providing proper localization support.
* '''Examples''': See {{l|Meta:LinksTest/ru|Meta:LinksTest/ru}}.

== Literal ==
* '''Location''': {{l|Template:Literal}}
* '''Description''': This template should always be used to ‘wrap’ all reference to GUI items (control name, menu item, …).
* '''Examples''': <nowiki>{{Literal|Open File|New}}</nowiki> is interpreted as {{Literal|Open File}}

== Navigation ==
* '''Location''': {{l|Template:Navigation}}
* '''Description''': Defines navigation for sequence of pages and displays navigation bar. You need only to specify parent (index) page and next page (optional). There's no need to specify previous page, because it's determined automatically. Works only within the range of namespace though.
* '''Examples''': For result see the header from those page, or result example code <nowiki>{{Navigation|Top Page|Next Page}}</nowiki> :

{{Navigation|Top Page|Next Page}}

== Note ==
* '''Location''': {{l|Template:Note}}
* '''Description''': This template gives a box of fixed width. First argument is header for note and second a main content of note.
* '''Examples''': <nowiki>{{Note|Note title|Short note text}}</nowiki> See in ex. {{l|Doc:Getting_Started}} or note from example:

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

== Shorcut ==
* '''Location''': {{l|Template:Shortcut}}
* '''Description''': Put a sequence of up to 5 keys to show a shortcut.
* '''Examples''': <nowiki>{{Shortcut|Alt|Shift|t}}</nowiki> is interpreted as {{Shortcut|Alt|Shift|t}}

== Stub ==
* '''Location''': {{l|Template:Stub}}
* '''Description''': Mark page as a stub.
* '''Examples''': <nowiki>{{Stub}}</nowiki>.

== Title ==
* '''Location''': {{l|Template:Title}}
* '''Description''': Sets custom title for a page.
* '''Examples''': See sources of {{l|Main_Page|Main_Page}}, {{l|Doc:Getting_Started|Doc:Getting_Started}}, {{l|Doc:Getting_Started/ru|Doc:Getting_Started/ru}} pages.

== TOCright ==
* '''Location''': {{l|Template:TOCright}}
* '''Description''': Set the Table Of Content to the right side of the page.
* '''Examples''': <nowiki>{{TOCright}}</nowiki>. Mainly on every pages. Please use it when the page's TOC start to fill too much space.

= Internal Templates =
Templates below are not intended for direct use in page body. They are usually invoked by high-level templates listed above.

== ! ==
* '''Location''': {{l|Template:!}}
* '''Description''': This is an auxiliary template allowing one to encode "<code>|</code>"
within template and parser function parameters. {{L|Template:!|More...}}
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{!}}</nowiki>
|<nowiki>|</nowiki>
|
|}

== GetTitle ==
* '''Location''': {{l|Template:GetTitle}}
* '''Description''': Returns custom title of a page set with <nowiki>{{</nowiki>Title<nowiki>}}</nowiki> template in the page body.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{GetTitle|Doc:Getting_Started/ru}}</nowiki>
|Первые шаги
|Look at the source of {{l|Doc:Getting_Started/ru|Doc:Getting_Started/ru}} page.
|}

== Languages ==
* '''Location''': {{l|Template:Languages}}
* '''Description''': Displays bar listing available translations for current page. {{l|Template:Languages|More...}}
* '''Examples''': <nowiki>{{{Languages}}}</nowiki>

== Languages/Lang ==
* '''Location''': {{l|Template:Languages/Lang}}
* '''Description''': Utility template for language bar. Generates link to specified translation of current page if it's exists.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{Languages/Lang|en}}</nowiki>
|{{Languages/Lang|en}}
|Result is "English", but without a link, because current page is in English
|-
|<nowiki>{{Languages/Lang|es}}</nowiki>
|{{Languages/Lang|es}}
|Result is empty, because this page have no Spanish translation. If it does, then the result would be: " • {{l|Meta:Templates/es|Español}}"
|-
|<nowiki>{{Languages/Lang|ru}}</nowiki>
|{{Languages/Lang|ru}}
|Result is empty, because this page have no Russian translation. If it does, then the result would be: " • {{l|Meta:Templates/ru|Русский}}"
|}

== Languages/ThisPageTranslatedIn ==
* '''Location''': {{l|Template:Languages/ThisPageTranslatedIn}}
* '''Description''': Utility template for language bar. Returns a page name which translates current page to specified language.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{Languages/ThisPageTranslatedIn|en}}</nowiki>
|{{Languages/ThisPageTranslatedIn|en}}
|If this template invoked from Meta:Templates/es, then result is the same ("/es" suffix automatically dropped)
|-
|<nowiki>{{Languages/ThisPageTranslatedIn|ru}}</nowiki>
|{{Languages/ThisPageTranslatedIn|ru}}
|If this template invoked from Meta:Templates/es, then result is the same ("/es" suffix automatically dropped and "/ru" suffix added)
|}

== Navigation/PreviousPage ==
* '''Location''': {{l|Template:Navigation/PreviousPage}}
* '''Description''': Searches for previous page for current one and outputs its name.

== PagenameFromLink ==
* '''Location''': {{l|Template:PagenameFromLink}}
* '''Description''': Extracts page name from given link.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{PagenameFromLink|Doc:Getting_Started#Introduction}}</nowiki>
|Doc:Getting_Started
|-
|<nowiki>{{PagenameFromLink|layers}}</nowiki>
|Layers
|-
|<nowiki>{{PagenameFromLink|:Category:Manual}}</nowiki>
|Category:Manual
|}

== Title.dpl ==
* '''Location''': {{l|Template:Title.dpl}}
* '''Description''': Utility template used by [[#GetTitle|GetTitle]] template and DPL for page title extraction. See [http://semeb.com/dpldemo/index.php?title=DPL:Manual_-_DPL_parameters:_Controlling_output_volume#include_contents_related_to_templates this link].

== Title.dpl.default ==
* '''Location''': {{l|Template:Title.dpl.default}}
* '''Description''': Utility template used by [[#GetTitle|GetTitle]] template and DPL for page title extraction. See [http://semeb.com/dpldemo/index.php?title=DPL:Manual_-_DPL_parameters:_Controlling_output_volume#include_contents_related_to_templates this link].

= Warning banners =

== Warnings ==
* '''Location''': {{l|Template:Warnings}}
* '''Description''': Contains list of displayed warning banners and conditions for them

== OldTerminologyTranslation ==
* '''Location''': {{l|Template:OldTerminologyTranslation}}
* '''Description''': Outdated terminology for translated page banner

Meta:Templates

2017-04-20T10:59:33Z

D.j.a.y: /* User Templates */ TOCright

{{Navigation|Writer_Documentation|}}

Here's a list of templates used to improve this wiki functionality.

= User Templates =
Those templates can (and often should) be used in page body.

== C ==
* '''Location''': {{l|Template:C}}
* '''Description''': This template should always be used to ‘wrap’ items from the context menu GUI.
* '''Examples''': <nowiki>{{c|File|Open File}}</nowiki> is interpreted as {{c|File|Open File}}

== Category ==
* '''Location''': {{l|Template:Category}}
* '''Description''': Specifies category page belongs to.
* '''Examples''': <nowiki>{{Category|MyCategory}}</nowiki>.

== CategoryContents ==
* '''Location''': {{l|Template:CategoryContents}}
* '''Description''': Lists all pages in the specified category. Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category and the page titles will be replaced with their Spanish translations.
* '''Examples''': <nowiki>{{CategoryContents|MyCategory}}</nowiki>.

== L ==
* '''Location''': {{l|Template:L}}
* '''Description''': Creates link to another page, providing proper localization support.
* '''Examples''': See {{l|Meta:LinksTest/ru|Meta:LinksTest/ru}}.

== Literal ==
* '''Location''': {{l|Template:Literal}}
* '''Description''': This template should always be used to ‘wrap’ all reference to GUI items (control name, menu item, …).
* '''Examples''': <nowiki>{{Literal|Open File|New}}</nowiki> is interpreted as {{Literal|Open File}}

== Navigation ==
* '''Location''': {{l|Template:Navigation}}
* '''Description''': Defines navigation for sequence of pages and displays navigation bar. You need only to specify parent (index) page and next page (optional). There's no need to specify previous page, because it's determined automatically. Works only within the range of namespace though.
* '''Examples''': For result see the header from those page, or result example code <nowiki>{{Navigation|Top Page|Next Page}}</nowiki> :

{{Navigation|Top Page|Next Page}}

== Note ==
* '''Location''': {{l|Template:Note}}
* '''Description''': This template gives a box of fixed width. First argument is header for note and second a main content of note.
* '''Examples''': <nowiki>{{Note|Note title|Short note text}}</nowiki> See in ex. {{l|Doc:Getting_Started}} or note from example:

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

== Shorcut ==
* '''Location''': {{l|Template:Shortcut}}
* '''Description''': Put a sequence of up to 5 keys to show a shortcut.
* '''Examples''': <nowiki>{{Shortcut|Alt|Shift|t}}</nowiki> is interpreted as {{Shortcut|Alt|Shift|t}}

== Stub ==
* '''Location''': {{l|Template:Stub}}
* '''Description''': Mark page as a stub.
* '''Examples''': <nowiki>{{Stub}}</nowiki>.

== Title ==
* '''Location''': {{l|Template:Title}}
* '''Description''': Sets custom title for a page.
* '''Examples''': See sources of {{l|Main_Page|Main_Page}}, {{l|Doc:Getting_Started|Doc:Getting_Started}}, {{l|Doc:Getting_Started/ru|Doc:Getting_Started/ru}} pages.

== TOCright ==
* '''Location''': {{l|Template:TOCright}}
* '''Description''': Set the Table Of Content to the right side of the page.
* '''Examples''': <nowiki>{{TOCright}}</nowiki>. Mainly on every pages. Please use it when the page's TOC start to fill too much space.

= Internal Templates =
Templates below are not intended for direct use in page body. They are usually invoked by high-level templates listed above.

== ! ==
* '''Location''': {{l|Template:!}}
* '''Description''': This is an auxiliary template allowing one to encode "<code>|</code>"
within template and parser function parameters. {{L|Template:!|More...}}
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{!}}</nowiki>
|<nowiki>|</nowiki>
|
|}

== GetTitle ==
* '''Location''': {{l|Template:GetTitle}}
* '''Description''': Returns custom title of a page set with <nowiki>{{</nowiki>Title<nowiki>}}</nowiki> template in the page body.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{GetTitle|Doc:Getting_Started/ru}}</nowiki>
|Первые шаги
|Look at the source of {{l|Doc:Getting_Started/ru|Doc:Getting_Started/ru}} page.
|}

== Languages ==
* '''Location''': {{l|Template:Languages}}
* '''Description''': Displays bar listing available translations for current page. {{l|Template:Languages|More...}}
* '''Examples''': <nowiki>{{{Languages}}}</nowiki>

== Languages/Lang ==
* '''Location''': {{l|Template:Languages/Lang}}
* '''Description''': Utility template for language bar. Generates link to specified translation of current page if it's exists.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{Languages/Lang|en}}</nowiki>
|{{Languages/Lang|en}}
|Result is "English", but without a link, because current page is in English
|-
|<nowiki>{{Languages/Lang|es}}</nowiki>
|{{Languages/Lang|es}}
|Result is empty, because this page have no Spanish translation. If it does, then the result would be: " • {{l|Meta:Templates/es|Español}}"
|-
|<nowiki>{{Languages/Lang|ru}}</nowiki>
|{{Languages/Lang|ru}}
|Result is empty, because this page have no Russian translation. If it does, then the result would be: " • {{l|Meta:Templates/ru|Русский}}"
|}

== Languages/ThisPageTranslatedIn ==
* '''Location''': {{l|Template:Languages/ThisPageTranslatedIn}}
* '''Description''': Utility template for language bar. Returns a page name which translates current page to specified language.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{Languages/ThisPageTranslatedIn|en}}</nowiki>
|{{Languages/ThisPageTranslatedIn|en}}
|If this template invoked from Meta:Templates/es, then result is the same ("/es" suffix automatically dropped)
|-
|<nowiki>{{Languages/ThisPageTranslatedIn|ru}}</nowiki>
|{{Languages/ThisPageTranslatedIn|ru}}
|If this template invoked from Meta:Templates/es, then result is the same ("/es" suffix automatically dropped and "/ru" suffix added)
|}

== Navigation/PreviousPage ==
* '''Location''': {{l|Template:Navigation/PreviousPage}}
* '''Description''': Searches for previous page for current one and outputs its name.

== PagenameFromLink ==
* '''Location''': {{l|Template:PagenameFromLink}}
* '''Description''': Extracts page name from given link.
* '''Examples''':
{| width="100%"
|+
|'''Code:'''
|'''Result:'''
|'''Comments:'''
|-
|<nowiki>{{PagenameFromLink|Doc:Getting_Started#Introduction}}</nowiki>
|Doc:Getting_Started
|-
|<nowiki>{{PagenameFromLink|layers}}</nowiki>
|Layers
|-
|<nowiki>{{PagenameFromLink|:Category:Manual}}</nowiki>
|Category:Manual
|}

== Title.dpl ==
* '''Location''': {{l|Template:Title.dpl}}
* '''Description''': Utility template used by [[#GetTitle|GetTitle]] template and DPL for page title extraction. See [http://semeb.com/dpldemo/index.php?title=DPL:Manual_-_DPL_parameters:_Controlling_output_volume#include_contents_related_to_templates this link].

== Title.dpl.default ==
* '''Location''': {{l|Template:Title.dpl.default}}
* '''Description''': Utility template used by [[#GetTitle|GetTitle]] template and DPL for page title extraction. See [http://semeb.com/dpldemo/index.php?title=DPL:Manual_-_DPL_parameters:_Controlling_output_volume#include_contents_related_to_templates this link].

= Warning banners =

== Warnings ==
* '''Location''': {{l|Template:Warnings}}
* '''Description''': Contains list of displayed warning banners and conditions for them

== OldTerminologyTranslation ==
* '''Location''': {{l|Template:OldTerminologyTranslation}}
* '''Description''': Outdated terminology for translated page banner

FAQ

2016-10-22T19:18:52Z

D.j.a.y: /* FAQs relating to the current Synfig release */ update bug tracker link

{{Title|FAQ}}


== General FAQs ==

=== Who is synfigbot at the Synfig IRC channel? ===

synfigbot is a bot that sits in the [http://www.synfig.org/cms/en/support/ Synfig IRC channel], not a human. It has some commands and can respond to some of the usual questions like: "What's the latest Synfig Studio version?" One of its funnier commands is to quote past funny comments from people at the IRC. To make it remember a quote, just type: !q. Please be nice with it, it is still learning. ;)

=== Why are the CIA in the Synfig IRC channel? ===

"CIA-28" and friends are bots that sit in the {{l|Contact|Synfig IRC channel}} and report whenever they detect a new commit in the subversion repository, giving the committer's name, revision number, and commit log message. The same information for recent commits can be found on [http://cia.vc/stats/project/synfig cia.vc]. [http://www.ohloh.net/projects/4832?p=Synfig ohloh.net] has similar pages of statistics.

== FAQs relating to the current Synfig release ==

Many issues are documented in the [https://github.com/synfig/synfig/issues bug tracker] and on the {{l|download}} page.

=== What is the status of the MacOS package? ===

Proud to build a native MacOS package, so nothing else than "official" package is needed.

=== Is there any Flash/SWF support? ===

Unfortunately not. Patches are welcome though. Please {{l|contact}} us to discuss your plans for adding SWF support so we can give any advice needed.

=== What is Synfig Studio native file format? ===

Synfig Studio uses its own file formats: {{Literal|.sif}} and {{Literal|.sifz}}. Sif is a synfig project file while sifz is a compressed (gzipped) sif file. As Sifs are (just) human readable XML, you can save some disk space choosing the compressed one when you save your animations.

There is also the {{Literal|.sfg}} format, introduced with the Synfig Studio 1.0 release, is the synfig package animation format. Among animation data it can store externals images in a zip kind format.

For deep informations about the Synfig Studio native file format, have a look to {{l|Sif_Format|this page}}.

There is no (known) link between [http://filext.com/file-extension/SIF other .sif file formats] or [https://en.wikipedia.org/wiki/Standard_Interchange_Format this one]. ...

=== Why doesn't synfig use SVG format? ===

Svg file format come from [http://www.w3c.org World Wide Web Consortium], they <troll on>try to<troll off> take care of standards around the big net....I'm not convicted that creating animated SVG, they were thinking in terms of film quality animation .... like synfig aims to produce ... in other terms, Sif is more than animated SVG.

Work has been done to implement Cairo render to Synfig that eventually would allow to export without too much effort to SVG as well as to PDF and others back ends. It is very simple to add SVG export just coding a similar exporter like the current PNG one. Anyone want to code that SVG exporter?

Always taking in mind that you'll lose some native Synfig goodies in the process. Export to SVG (animated or not) could be a great feature to have (in terms of workflow / open format support), although you lose some features.

=== Procedure entry point ... could not be located? ===

If you are on Windows and it says "the procedure entry point_ZN6synfig5Color7set_hexERSs could not be located in the dynamic link library libsynfig-0.dll" that means you forgot to upgrade synfig when you upgraded synfigstudio. Due to the dependency systems on Linux you will probably not get this there unless your distro has broken packages. Be sure to install the latest version of synfig and synfigstudio.

If you get the same error but with gtk, glib, iconv.dll or libxml2.dll you should look for old versions of these DLLs in your Windows directory and rename them to iconv.dll.bak and libxm2.dll.bak etc.

=== libsynfig-0.dll was not found ===

If you get the error message "libsynfig-0.dll was not found" please check that you have synfig (as well as synfig studio) correctly installed.

<div id="Can_I_do_anything_to_improve_the_stability_of_the_Windows_version_of_Synfig.3F"></div>
=== Can I do anything to improve the stability of synfigstudio? ===

If you're running on a Hyperthreading or multi-core CPU (e.g Pentium 4 with Hyperthreading or Intel Core2 Duo or Quadcore, etc.) then you may find Synfig is more stable if you restrict it to run on only one processor. '''Since version 0.62.01 the stability under Windows has increased noticiably. The single thread renderer option has been enabled by default in Synfig Studio.'''

===== How do I do this on Windows? =====

To do this on windows, start Synfig Studio, then press Ctrl-Shift-Esc this will start the 'Windows Task Manager', alternatively you can press Ctrl-Alt-Del and choose 'Task Manager'. Select the processes tab, find synfigstudio.exe in the processes list and right click on it. Choose 'Set Affinity...' and make sure only one CPU is checked. Unfortunately, this setting isn't preserved so you either have to do this manually each time you start Synfig Studio or use a tool such as the [http://www.tomshardware.com/2004/05/28/getting_more_bang_out_of_your_dual_processing_buck/index.html Tom's Hardware Guide Task Assignment Manager].

===== How do I do this on Linux? =====

On linux, you need to install schedutils.

Then run synfigstudio like this:

<pre>taskset -c 0 synfigstudio</pre>

Or if you have synfigstudio open already, run this:

<pre>taskset -p -c 0 `pgrep synfigstudio`</pre>

=== Why can't I get sound to work? ===
Synfig GUI implies that sound files can be loaded and played with the animation previews, to aid with e.g. lip synching. Synfig relies on a helper library called [http://mltframework.org/ MLT], libavcodec and their dependencies. Sound can be {{l|Category:ImportArt|imported}} like other supported medias. Have a look to {{l|Sound Layer}}.

=== What about Jack audio server ?===
Also you can synchronized your animation threw the [http://jackaudio.org/ JAck audio server], have a look to this [https://www.youtube.com/watch?v=NHFOyz2WjoA video tutorial].

=== How do I render moving pictures from Synfig under Windows ===
FFMPEG is now distributed as an optional component of the Windows installer (installed by default). If you're looking for a file to include on a web page, rendering to an animated gif file also works (although you may want to use a quality setting of 6 or higher to avoid rendering artifacts). For mpg, there are a couple of options.

* Use the ffmpeg render target in Synfig to render to an mpg file, or
* If you want more control over the final video file, the best solution may be to render to a sequence of png files and use a separate program, such as the command line version of ffmpeg, to assemble them to a video file. This could also allow you to incorporate an audio track in the same step.

Be careful where you choose to save your rendered file. If you save it to an area where Microsoft doesn't think you should be writing (like "c:\" or "c:\Program Files\.." etc.) it will pretend to let you, but in fact save it to another location to save yourself. You can find it using a file search, but it won't be where you thought it was. Be safe - save to the desktop or a folder under "c:\Users\yourname\..."

=== I have a weird problem building from source. What's up? ===

Did you read the [http://wiki.synfig.org/Developer_Documentation developer doc] ?

Your copy of pkg-config probably doesn't look in the right places for .pc files. If you are installing to /usr/local, try running "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" before building or installing anything.

Also, you can post a message to the [http://sourceforge.net/p/synfig/mailman/synfig-devl/ development mailing list].

=== Why does only the first frame of my animation render? ===

You probably have '''Use current frame''' checked in the render dialog box.

=== Why no colors available besides white ? ===
You should have to look around the Gamma Preferences.

Check out this: {{c|<Menu>|<Edit>|Preferences|Gamma}} from the {{l|Preferences_Dialog}}.
* Be sure the three color sliders are set to '''2.2'''
* Black level in the Gamma setup should be '''0''' and not '''100''' percent

=== Why don't I get the colors I'm expecting? ===

This [http://en.wikipedia.org/wiki/RGB_color_model#Nonlinearity Wikipedia] article talks about how color output is non-linear, that if 0 is black and 100 is white, then 50 is only about 22 percent of the brightness of white, rather than 50% as you might expect.

In synfig there is an option (on by default) to make sure that if you ask for 50, you get 50% of the brightness of white.

See {{c|<Edit>|<Preferences>}} which would open the {{l|Preferences Dialog}}. Then go to the Misc tab and to the {{literal|Visually Linear Color Selection}} checkbox. If you turn that off, everything will go back to its non-linear, yet strangely comfortable and familiar mode.

=== Why when I create more than one shape, the other one dissapears from the canvas, but its still on the layer bar ? ===
Take a look to the "blend method" to check if it's set to some other one than composite.

You like to read also {{l|New Layer Defaults}} and {{l|Blend Method Parameter}} pages.

=== Why doesn't the rotate tool rotate rectangles layers? ===
The {{l|Rotate Tool}} works on {{l|Handle}}. The {{l|Rectangle Layer}} works by drawing horizontal and vertical lines between the two {{l|Handle}}s, so when the rotate tool is used with a rectangle it only rotates the {{l|Handle}}s around the rotation point, but the lines of the rectangle are still horizontal and vertical. What you are probably looking for is the {{l|Layer#Rotate|Rotate Layer}}.

Good to know, the {{l|Rotate Tool}} has an {{l|Region Layer}} option which allow the behavior you might expect.

=== Tablet doesn't track as expected ===
When using some programs you may find that the mouse may not track as you would expect.
Synfig, Inkscape and Gimp are ones that I have used that will give odd tracking.
When drawing with the mouse the actual drawing is some distance from the cursor and when
you use the pen the drawing is drawn where the cursor is.
This can be easily fixed with the software that came with the tablet.

When using the tablet software that came with the graphire 4 tablet you will find
that it uses two different tracking methods for the mouse and pen and these two
tracking methods are called Mouse Mode and Pen Mode.

The Pen Mode uses absolute positioning, that means the active drawing area of the tablet
is in proportion to the whole screen. Wherever you move the pen the cursor will move
to the corresponding point on the screen, wether you drag the pen or you pick up the
pen and move it to a new location that cursor will move or jump to where the pen is.

The Mouse Mode uses a positioning system similar to a traditional mouse where you can pick up
and slide the mouse where you wish and the cursor will follow the mouse as it is moved.
It will not jump to new locations on the screen even if you pick up the mouse and place it
in a new position on the tablet, the cursor will just continue from it's last position.

In the case of the Wacom Graphire 4 tablet that I'm using in Windows XP I needed to open the
program called Pen Tablet and change the settings for the mouse.
To do this open Pen Tablet and you will see four tabs, click the tab marked Mouse and you will
find a box called Tracking with two options. One is Pen Mode and the other is Mouse Mode.
Select the Pen Mode and the mouse will now use absolute positioning.

=== Why does the Text Tool make Synfig Studio crash? ===

Occassionally, some users report that Synfig Studio crashes whenever the {{l|Text Tool}} is selected. This is caused by one or more of their currently installed fonts being corrupted or containing non-standard data.

Once the these fonts are uninstalled, the {{l|Text Tool}} will work correctly.

=== Can i change user interface language to english? ===

Synfig respect the Operating System language, great point you can say... but sometime users just want english user interface (helpful to follow tutos' for example). You can do that easily using the language selection box from the preference dialog {{c|<File>|<Preference>|<Misc>}}..

Nota: this way can ''force'' another languages.

{{Template:SkeletonDeformPartDisappear}}

Developer Documentation

2016-10-22T19:15:44Z

D.j.a.y: /* Other links */ update issue tracker link

{{Title|Developer Documentation}}
{{TOCright}}

The Developer Documentation part of this wiki is primarily for the following groups of people:

*Current developers of the code
*Future and potential developers
*Those interested in bug filing and generating ideas

= Main pages =

* {{l|Dev:Build Instructions|Build Instructions}}
* [[Building Documentation|Building Documentation]]
* {{l|Dev:Source code|Source code}} description and workflow
* {{l|Dev:Action System}} : structure of the action system, good entry-point into Synfig.
* IDE Setup {{l|Dev:IDE_Linux|under Linux}} | {{l|Dev:IDE_Windows| under Windows}}
* {{l|Dev:Roadmap|Roadmap}}
* {{l|Dev:Contribute to Code}}
* {{l|Dev:Translation}}
* {{l|Dev:Wish list|Wish List}}
* {{l|Dev:Coding_Conventions|Coding Conventions}}
* {{l|Dev:UI/UX Redesign|UI/UX Redesign}}
* {{l|Dev:ETL_replacement|ETL replacement}}

=Synfig components=
Synfig is divided into three main components: etl, synfig-core and synfig-studio.
* '''[http://download.tuxfamily.org/synfig/api/ETL/annotated.html ETL]''' is the extended template library. One of its most important components is the shared object class, which is the base class for most other parts of the application. Using "handles" to shared objects instead of c++ pointers provides garbage collection via reference counting.
* '''[http://download.tuxfamily.org/synfig/api/synfig-core/annotated.html Synfig-core]''' is the core/command-line (cli) renderer ("synfig") contains the document data structure for the application: valuenodes, layers, and canvases.
* '''[http://download.tuxfamily.org/synfig/api/synfig-studio/annotated.html Synfig Studio]''' ("synfig-studio") provides the gui for the application.
* See also: {{l|Dev:How Synfig Works|How Synfig Works}}

= External libs =
== Synfig use several external libs==
* [https://developer.gnome.org/gtkmm-tutorial/2.24/ Gtkmm 2], some work on branchs has been started to reach [https://developer.gnome.org/gtk3/ Gtkmm 3] ([https://developer.gnome.org/gtk3/3.4/gtk-migrating-2-to-3.html Migrating 2to3])
* [https://developer.gnome.org/gtkmm/2.24/namespaceGdk_1_1Cairo.html Cairo] (Cairo render mode)
* [http://freetype.org/ Freetype2] library (Text layer rendering in software render mode)
* [http://libxmlplusplus.sourceforge.net/ libxmlplusplus] (to parse the project files)
* [http://www.boost.org/doc/libs/1_54_0/doc/html/program_options.html Boost Program Options] (synfig cli)
* [http://www.mltframework.org/ MLT Framework - Media Loving Toolkit] (Sound Layer)
* [http://www.libpng.org/pub/png/libpng.html libpng] (load and write .png files)

==Optionally you will also need==
* [http://www.imagemagick.org/Magick++/ Magick++] the ImageMagick API (to build mod_magickpp, the magick++ module from synfig-core)
* libavcodec (to build mod_libavcodec, from synfig-core)
* libmng (to build mod_mng, from synfig-core)
... check the {{l|Dev:Build Instructions|Build Instructions}} page for more detailed informations.

=Complete coding tutorials=
* {{l|Dev:Adding a Layer|Adding a Layer}}
* Adding a Panel, {{l|Dev:Adding a Panel - Part I|Part I}} and {{l|Dev:Adding a Panel - Part II|Part II}}. '''Note: these are highly out of date''' please note that the directory "gtkmm" has been renamed to "gui", Panel is now know has Dock. Also, some files were moved into subfolders (take a look inside the "gui/docks" folder for example).

=Other links=
* [http://download.tuxfamily.org/synfig/api/index.html ETL, Synfig, SynfigStudio Api documentation]
* [http://synfig.org/wiki/index.php?title=Special:PrefixIndex&from=&namespace=102 All Dev namespace pages]
* {{l|Dev:Translation|Translate the application}}
* {{l|Dev:Release|Release procedure}}
* {{l|Dev:GoogleSoC|Google Summer of Code}}
* [http://sourceforge.net/p/synfig/mailman/synfig-devl/ Synfig Developer Mailing List]
* [https://github.com/synfig/synfig/issues Synfig Issue Tracker]
* [http://www.synfig.org/forums/viewtopic.php?f=2&t=6097 Genete free stuff...]
* {{l|Dev:C%2B%2B11_Migration|C++11 Migration}}

Dev:Source code

2016-10-18T15:06:20Z

D.j.a.y: toc / comment outdated stuff / add dev mailing list link

{{Category|Code}} {{Category|Permalink}}

Hey you! Do you want access to bleeding-edge Synfig? Well, I have good news. We provide a way to get the code:

*Using git (one repository)

Once you grab the code, you will need to follow the {{l|Dev:Build Instructions|build instructions}}.

Commit notifications to master branch are <strike>sent to [http://cia.vc/stats/project/synfig CIA] and</strike> shown up in the {{l|Contact|IRC channel}}.

== GIT repository at Github==

Anonymous access:

git clone git://github.com/synfig/synfig.git
People with commit access should use this command instead:

git clone git@github.com:synfig/synfig.git

Or this one if you prefer https protocol:

git clone https://github.com/synfig/synfig.git

You can also check out the [https://github.com/synfig/synfig web interface] to that repository.

Check out [https://help.github.com Github help page] for further references.

=Proposed git workflow=

* Consider the '''master''' branch the stable one.
* Each coder should have a '''username_master''' branch where all the small changes are done.
* Once the '''username_master''' branch is considered stable it can be rebased/merged to '''master'''.
* Work on new non-trivial features/fixes on '''username_feature''' branches.
* Once the '''username_feature''' branch is considered stable it can be rebased/merged to '''master'''.
* Obviously commit trivial fixes straight to the '''master'''.
* If it is possible, rebase & rework branches to keep history more sane, linear and atomic.
* Releases are tagged according to following criteria:
** If the release consist on a few trivial set of features or bug fixes then increase the third numeration level: 0.64.0 -> 0.64.1
** If the release consist on a set of important features and/or includes non backward compatible file format, then increase the second level numeration: 0.64.1 -> 0.65.0

=See Also=
While you are browsing the code, you may wish to refer to these links:

* [http://www.synfig.org/issues/thebuggenie/synfig Bug tracker]
* [http://sourceforge.net/p/synfig/mailman/synfig-devl/ Synfig Dev mailing list]
==Code overview==
* [http://download.tuxfamily.org/synfig/api/index.html API documentation]
* {{l|Dev:Source Outline|source code outline}}
* {{l|Dev:Source Glossary|source code glossary}}
* {{l|Dev:Layers|Mapping between layer types, classes and .cpp files}}
* {{l|Dev:class_ValueNode|ValueNode types}}
* {{l|Dev:BlendMethods|Blend Method enumeration values}}
==Others==
* {{l|Dev:ETL_make_check|ETL make check failures}}
* {{l|Interesting Readings}}

Template:CategoryContents

2016-10-16T18:15:16Z

D.j.a.y: back to rogin

<includeonly>
{{#dpl:
|category={{{1}}}{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}
|include={Title}.dpl
|format=,\n* [[%PAGE%|,]],
|noresultsheader= 
}}
</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T18:09:25Z

D.j.a.y: test

<includeonly>
{{#dpl:
|category={{{1}}}{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}
|include={Title}.dpl,{Layer}:image
|format=,\n* [[%PAGE%|,]]!image,
|noresultsheader= 
}}
</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T17:57:43Z

D.j.a.y: test

<includeonly>
{{#dpl:
|category={{{1}}}{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}
|include={Title}.dpl
|format=,\n* [[%PAGE%|,]]{Layer}:image,
|noresultsheader= 
}}
</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T17:56:54Z

D.j.a.y: tst

<includeonly>
{{#dpl:
|category={{{1}}}{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}
|include={Title}.dpl
|format=,\n* [[%PAGE%|,]],{Layer}:image
|noresultsheader= 
}}
</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T17:55:22Z

D.j.a.y: test

<includeonly>
{{#dpl:
|category={{{1}}}{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}
|include={Title}.dpl,{Layer}:image
|format=,\n* [[%PAGE%|,]],
|noresultsheader= 
}}
</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T17:44:51Z

D.j.a.y: format

Template:CategoryContents

2016-10-16T17:42:36Z

D.j.a.y: fix

<includeonly>{{#dpl:category={{{1}}}{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}|include={Title}.dpl|format=,\n* [[%PAGE%|,]],|noresultsheader= |includepage ={Layer}:image|columns=3|rowcolformat=width=100%}}</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T17:40:34Z

D.j.a.y: again...

<includeonly>
{{#dpl:category={{{1}}}{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}|include={Title}.dpl|format=,\n* [[%PAGE%|,]],|noresultsheader= |includepage ={Layer}:image|columns=3|rowcolformat=width=100%
}}
</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T17:39:33Z

D.j.a.y: fix?

<includeonly>
{{#dpl:category={{{1}}}{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}|include={Title}.dpl|format=,\n* [[%PAGE%|,]],|noresultsheader= 
| includepage ={Layer}:image
|columns=3
|rowcolformat=width=100%
}}
</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T17:37:52Z

D.j.a.y: table icon test

<includeonly>
{{#dpl:
category={{{1}}}{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}
|include={Title}.dpl
|format=,\n* [[%PAGE%|,]],
|noresultsheader= 
| includepage ={Layer}:image
|columns=3
|rowcolformat=width=100%
}}
</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Category talk:Layers

2016-10-16T17:33:29Z

D.j.a.y: test row + icon

{{#dpl:
| category = Layers
| includepage ={Layer}:image
|columns=3
|rowcolformat=width=100%
}}

Template:Layer

2016-10-16T17:30:30Z

D.j.a.y: fix

{{{image}}}

Advanced Outline Layer

2016-10-16T17:28:25Z

D.j.a.y: test

{{Title|Advanced Outline Layer}}
{{Category|Layers}}
{{Category|Primitive Layers}}
{{NewTerminology}}
{{TOCright}}

Under construction! See {{l|Talk:Advanced_Outline_Layer|Advanced Outline Layer Talk}} page
{{Layer
| image=[[Image:Layer_geometry_advanced_outline_icon.png|64px]]
}}
== About Advanced Outline Layers ==

To create an Advanced Outline Layer use the Spline Tool and check {{literal|Create Advanced Outline}} in the {{l|Tool Options Panel}}. Once you finish the definition of the geometry of your outline and after pressing the {{literal|Make Spline}} button (or selecting another tool or state) you create the Advanced Outline Layer with the {{l|New_Layer_Defaults#Brush_Colors|current}} {{literal|Outline Color}}.

Depending on the options you choose in the {{l|Tool Options Panel}} other {{l|Category:Tools|Tools}} like {{l|Star Tool}} or {{l|Circle Tool}} can also create Advanced Outline Layers.

Using the {{l|Canvas Layer Menu|Layer Menu}} {{Literal|Make Advanced Outline}}, {{Literal|Make Outline}} or {{Literal|Make Region}} commands you can also create those layers.

=== Differences with Outline Layer: Outline width ===

The '''width''' [[Handle]] define the outline width at particular place.

In the regular [[Outline Layer]], each width Handle is connected to the vertex that defines the outline shape at that place. That means that the user needs to insert a new vertex on the [[Spline]] every time he wants to change the outline width in some place. This behaviour can cause problems when the shape of the outline is very simple but the width varies a lot.

Practice shows that most of the time the user wants to specify the width independently from the placement of [[Spline]] vertices. Such functionality is available in the Advanced Outline layer, which Handles its width in a different way: the width Handles are freely moved around the Spline and define its width at any point.

== Features ==

Advanced Outline introduces some features to the regular outline, as shown in this [http://www.youtube.com/watch?v=boM_ZC9VZ54 Advanced outline demo] video. They are listed with examples below:

<gallery widths="490px" heights="300px" perrow="2">
File:Variable-width-without-blinepoints.png | No need to place vertex to change the width
File:Lots-of-blinepoints-width-just-two width-controls.png | Width controlled just by two points, while the Spline constructed of many vertices
File:Different-types of tips.png | Different types of tips : Rounded, Squared, Peak, Flat.
File: Segments of outlines.png | Segmented outline
File:Different cusps types.png | Three global cusps types : Sharp, Rounded, Bevel.
File:Smoothness control.png | Control of smoothness from linear (0.0) to smooth (1.0)
</gallery>

==Parameters of Advanced Outline Layers==

The parameters of the Advanced Outline Layers are:

{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:silver"
|'''Name'''||'''Value'''||'''Type'''
|-
||[[Image:Type_real_icon.png|16px]] [[Z Depth Parameter|Z Depth]]
||0.000000
||real

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Amount Parameter|Amount]]
||1.000000
||real

|-
||[[Image:type_integer_icon.png|16px]] [[Blend Method|Blend Method]]
||Composite
||integer

|-style="background:#eeeeee"
||[[Image:Type_color_icon.png|16px]] [[Colors Dialog|Color]]
||
{| style="width:95%; height:16px; background:black; color:black" border="1"
|-
|}
||color

|-style="background:#"
||[[Image:Type_vector_icon.png|16px]] [[Origin Parameter|Origin]]
||0.000000u,0.000000u
||vector

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Invert Parameter|Invert]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Antialiasing Parameter|Antialiasing]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Feather Parameter|Feather]]
||0.000000pt
||real

|-
||[[Image:Type_integer_icon.png|16px]] [[Feather_Parameter#Type_of_Feather|Type of Feather]]
||Fast Gaussian Blur
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Winding Style Parameter|Winding Style]]
||Non Zero
||integer

|-
||[[Image:Type_list_icon.png|16px]] Vertices
||List
||list (Spline)

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Outline_width|Outline Width]]
||2.000000pt
||real

|-
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Expand|Expand]]
||0.000000pt
||real

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at Start]]
||Rounded Stop
||integer

|-
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at End]]
||Rounded Stop
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Cusps_Type|Cusps Type]]
||Sharp
||integer

|-
||[[Image:Type_real_icon.png|16px]] [[Advanced_Outline_Layer#Smoothness|Smoothness]]
||0.500000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_bool_icon.png|16px}} [[Advanced_Outline_Layer#Homogeneous|Homogeneous]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_list_icon.png|16px]] [[Advanced_Outline_Layer#Width_Point_List|Width Point List]]
||List
||list(WPList)

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Fast|Fast]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Dashed_Outline|Dashed Outline]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_list_icon.png|16px]] Dash Item List
||List
||list(WPList)

|-
||[[Image:Type_real_icon.png|16px]] Dash Items Offset
||0.000000u
||real

|}

==Specific parameters for Advanced Outline Layer==

This section lists only the parameters specific to the Advanced Outline Layer. For documentation about the other parameters, refer to [[Outline Layer]].

* Tip Type at start
* Tip Type at end
* Cusps type
* Smoothness
* Width Point List

=== Tip type at start / end ===

As with width points, the end and start of the unlooped Advanced Outlines has a type of tip defined. The user can choose between the same types of tips as for a width point. When the first/last width point has its before/after interpolation type set to Interpolate the start/end of the outline is rendered using the Tip type at start/end parameter.

Those parameters don't have any effect if the Spline is looped or the first/last width point has its before/after interpolation type set to anything but Interpolate. In that case, the segment between the start/end width point and the start/end of the Spline is not rendered.

The types of tips are the same as the width point tip types except that it doesn't offer the Interpolate type because it would not make sense:

Parameters:
{| border="1"
|-
! Tip Type
! Example
|-
| Rounded
| [[File:Avanced-Outline-Layer-TipType-Rounded.png]]
|-
| Squared
| [[File:Avanced-Outline-Layer-TipType-Squared.png]]
|-
| Peak
| [[File:Avanced-Outline-Layer-TipType-Peak.png]]
|-
| Flat
| [[File:Avanced-Outline-Layer-TipType-Flat.png]]
|}

=== Cusps type ===

There are three types of cusps in the Advanced Outline:

Parameters:
{| border="1"
|-
! Cusp Type
! Example
|-
| Sharp
|[[File:Avanced-Outline-Layer-Cups-Sharp.png]]
|-
| Rounded
| [[File:Avanced-Outline-Layer-Cups-Rounded.png]]
|-
| Bevel
| [[File:Avanced-Outline-Layer-Cups-Bevel.png]]
|}

The type of cusp is controlled for the entire layer so currently it is not possible to control the type of corner individually. Maybe in future versions it will be possible.

=== Smoothness ===

The Smoothness controls how the width is calculated between widthpoints. The width at a position p is a function of the surrounding width points. When smoothness is '''zero''' interpolation is lineal, when smoothness is '''1.0''' interpolation is given by a 5th degree smooth Spline.

=== Homogeneous ===

Enabling {{literal|Homogeneous}} changes the way the position of the {{l|#widthpoint|width points}} change according modification of the outline.
* When false, the "Position" parameter for a width point is equally distributed '''among the vertices'''. For example, in a spline with five vertices, "Position" values of 0, 0.25, 0.5, 0.75, and 1 correspond to the first, second, third, fourth, and fifth vertex, respectively, regardless of how close or far apart those vertices are. Between vertices, the "Position" parameter is based on spline length.
* When true, the "Position" parameter increases smoothly from the start to the end of the spline '''based on the length of the entire spline'''. This means a "Position" of 0.5 will always correspond to the halfway point of the spline, not to a particular vertex.

=== Width Point List ===
Each Advanced Outline has a list of parameters that represent the information for each width item. They are called Width Points and consist of four sub-parameters:

* '''Position''' (Real number): represents the position of the width point along the Spline. Although it is allowed to be any real number, its meaning is only from '''0.0''' to '''1.0'''. 0.0 corresponds to the start of the Spline (first Spline point on the Spline list) and 1.0 to the last Spline point. For looped Splines 0.0 and 1.0 are equal. The position is represented by the light purple Handle that always lies on the Spline. The point on the spline corresponding to a particular "Position" value is affected by the "Homogeneous" parameter, explained above.
* '''Width''' (Real number): It is the width multiplicator of the global Width parameter of the Advanced Outline Layer on the position given by the Position parameter. The final width is calculated multiplying the global Advanced Outline's Width (W) by the Width of the widthpoint (w) and adding the Expand parameter (E). Calculated width = W*w+E
* '''Tip Side Before/After''': Those two sub-parameters controls how the width is interpolated before and after the current widthpoint. The sub-parameter can have four values:
** '''Interpolate''': Between the previous/following width point, the width is calculated by interpolation based on smoothness value.
** '''Rounded''': There is a rounded tip that points to the width point before or after. If the previous/following width point is {{Literal|Interpolate}} on its posterior/previous side it considers that the width of the widthpoint in question is zero just before/after it. If the previous/posterior width point is other than {{Literal|Interpolate}} then the segment between those two width points is empty. See examples to understand it fully.
** '''Squared''': Same as Rounded but using square tip.
** '''Peak''': Same as Rounded but using peak tip.
** '''Flat''': Same as Rounded but using flat tip.

The Width Point list has one internal non-animatable parameter called {{Literal|loop}}. You can reach it by right clicking the Width Point List parameter. If the Width Point list is unlooped, then any width point that has a Position outside the range of [0,1] is clamped to (brought within) that range. For example: a Position = 1.35 is clamped to 1.0 then the Width Point List is unlooped. Otherwise, if the Width Point List is looped and a width point has a Position of 1.3, its modulus based on the range [0,1] is used, so it is turned to a position of 0.3.

=== Fast ===
...TODO WriteME.about...

=== Dashed Outline ===
...TODO WriteME.about...

== Working with the Avdanced Outline ==

=== Creation of the Advanced Outline ===

You can create Advanced Outlines by various ways:
* With the {{l|Draw Tool}} (check ''Create Advanced Outline'' in the tool options).
* With the {{l|Spline Tool}} (check ''Create Advanced Outline'' in the tool options).
* Using a {{l|Layers#Geometry|Geometry Layer}} (check ''Create Advanced Outline'' in the tool options).
* With the menu {{c|<Insert>|<Layer>|Geometry|Advanced Outline}}.

=== Change the width of the Width Points ===

Initially the width Handles are hidden. You can make them visible by pressing ({{Shortcut|alt|5}}) or clicking on the width toggle button. It is possible to change the width using the {{l|Width Tool}} using the same procedure as for regular outlines. If you want more control over the width you can modify the width Handles with the {{l|Transform Tool}} ({{Shortcut|alt|A}}). More fine tunning is possible by expanding the width point sub-parameter and entering a specific value for the Width sub-parameter. In that case negative values are allowed to produce nice effects.

=== Change the position of the Width Points ===

When you make the width Handles of the width points visible/invisible, the position Handles also become visible/invisible. This way, the user has a single way to hide/show the position and width Handles.

{{Note|Change the position of the Width Points|This may change in the future}}

The position Handles of the width points can be modified using the {{l|Transform Tool}} ({{Shortcut|alt|A}}) and clicking and dragging the position Handle. You will notice that Handles are tied to the Spline so once clicked and dragged they can be placed at any way on the Spline. Notice that if you have a width point position Handle at position 0.2 and you click and drag at position 0.9 it may happen that you obtain a value of -0.1 because you dragged it in one step and the Width Point List may be looped. If you want to avoid those problems do the movement in small steps to indicate the correct path to follow when calculating the new position.

=== Adding or removing width points ===
To add a new width point you have to right click on the width point position Handle (purple Handle) to get the context menu. Then select {{literal|Add Item (smart)}} here to create more width points entries. The width points are created this way:

In the general case, the new widthpoint is created between the width point you click on and the "previous" width point. Depending on the loop status of the Spline, the "previous" width point can be the start of the Spline (unlooped) or the last widthpoint (looped). The worst case is when there is only one width point on the Width Point List. If you add one new item it will lie over the existing one.

The newly added width point will have the interpolated width at the position where it is created.

=== Specific actions for Width Points ===

Some needed actions have been added to width points as well as functionality for existing actions for items of the List type parameters. You can reach the list of available actions by right clicking on the width point position or directly on the width point item of the Width Point List. Here are some descriptions of the available actions:

* Convert: Width Points are composite Value Nodes so its natural format is Composite (you can access its components). But you can convert it to other formats. See Convert for details.
* Disconnect: This will disconnect the width point item from the Composite type Value Node. That means that there won't be any Handle to show and that any of its values can be modified. Maybe it is useful for some types of workflows. To restore its Composite status, choose Convert->Composite.
* Insert/ Remove Item Smart: This will add or remove a width point. If Remove is used in animation mode, it will also set the current width point as OFF instead of effectively removing it from the Width Point List. Opposite for the Insert Item Smart.
* Mark Active Point as ON/OFF: You can set width points off to make it not count for width control while the width point is off. When the width point is half on to off or viceversa, the used width point should be the interpolation between the on and off status. But it doesn't work properly at the moment. On / Off values are not interpolated but fully on or fully off. This has to be corrected.
* Export: See {{l|Export}}.
* Loop: When set as looped, as mentioned before, it allows the width point positions loop around the range [0,1].
* Rotate Order: Doesn't do anything.
* Set Side Before/After to: Interpolate, Rounded, Squared, Peak, Flat. Those are shortcuts to do the same as going directly to the sub-parameter and choosing the appropriate Tip Type. Maybe it should be renamed to "Set Tip Before/After".
* Set Width to default/zero: those actions have been added for two reasons. It is very common to want to set the width of a width point to zero. Despite the possibility of use the User Preference of Restrict Radius to First Quadrant, this way it is acceded quickly from the same usual menu. Also when a width point position Handle and a width point width Handle are on top of each other (width = 0) it is hard to modify the width or the position without trouble. To solve this the position Handle has preference over the width Handle in case of coincidence. So access the width Handle it is needed to have a quick action to set it to its default value (1.0).

Advanced Outline Layer

2016-10-16T17:14:58Z

D.j.a.y: Use "Layer" Template

{{Title|Advanced Outline Layer}}
{{Category|Layers}}
{{Category|Primitive Layers}}
{{NewTerminology}}
{{TOCright}}

Under construction! See {{l|Talk:Advanced_Outline_Layer|Advanced Outline Layer Talk}} page
{{Layer
| image=Layer_geometry_advanced_outline_icon.png
}}
== About Advanced Outline Layers ==

To create an Advanced Outline Layer use the Spline Tool and check {{literal|Create Advanced Outline}} in the {{l|Tool Options Panel}}. Once you finish the definition of the geometry of your outline and after pressing the {{literal|Make Spline}} button (or selecting another tool or state) you create the Advanced Outline Layer with the {{l|New_Layer_Defaults#Brush_Colors|current}} {{literal|Outline Color}}.

Depending on the options you choose in the {{l|Tool Options Panel}} other {{l|Category:Tools|Tools}} like {{l|Star Tool}} or {{l|Circle Tool}} can also create Advanced Outline Layers.

Using the {{l|Canvas Layer Menu|Layer Menu}} {{Literal|Make Advanced Outline}}, {{Literal|Make Outline}} or {{Literal|Make Region}} commands you can also create those layers.

=== Differences with Outline Layer: Outline width ===

The '''width''' [[Handle]] define the outline width at particular place.

In the regular [[Outline Layer]], each width Handle is connected to the vertex that defines the outline shape at that place. That means that the user needs to insert a new vertex on the [[Spline]] every time he wants to change the outline width in some place. This behaviour can cause problems when the shape of the outline is very simple but the width varies a lot.

Practice shows that most of the time the user wants to specify the width independently from the placement of [[Spline]] vertices. Such functionality is available in the Advanced Outline layer, which Handles its width in a different way: the width Handles are freely moved around the Spline and define its width at any point.

== Features ==

Advanced Outline introduces some features to the regular outline, as shown in this [http://www.youtube.com/watch?v=boM_ZC9VZ54 Advanced outline demo] video. They are listed with examples below:

<gallery widths="490px" heights="300px" perrow="2">
File:Variable-width-without-blinepoints.png | No need to place vertex to change the width
File:Lots-of-blinepoints-width-just-two width-controls.png | Width controlled just by two points, while the Spline constructed of many vertices
File:Different-types of tips.png | Different types of tips : Rounded, Squared, Peak, Flat.
File: Segments of outlines.png | Segmented outline
File:Different cusps types.png | Three global cusps types : Sharp, Rounded, Bevel.
File:Smoothness control.png | Control of smoothness from linear (0.0) to smooth (1.0)
</gallery>

==Parameters of Advanced Outline Layers==

The parameters of the Advanced Outline Layers are:

{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:silver"
|'''Name'''||'''Value'''||'''Type'''
|-
||[[Image:Type_real_icon.png|16px]] [[Z Depth Parameter|Z Depth]]
||0.000000
||real

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Amount Parameter|Amount]]
||1.000000
||real

|-
||[[Image:type_integer_icon.png|16px]] [[Blend Method|Blend Method]]
||Composite
||integer

|-style="background:#eeeeee"
||[[Image:Type_color_icon.png|16px]] [[Colors Dialog|Color]]
||
{| style="width:95%; height:16px; background:black; color:black" border="1"
|-
|}
||color

|-style="background:#"
||[[Image:Type_vector_icon.png|16px]] [[Origin Parameter|Origin]]
||0.000000u,0.000000u
||vector

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Invert Parameter|Invert]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Antialiasing Parameter|Antialiasing]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Feather Parameter|Feather]]
||0.000000pt
||real

|-
||[[Image:Type_integer_icon.png|16px]] [[Feather_Parameter#Type_of_Feather|Type of Feather]]
||Fast Gaussian Blur
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Winding Style Parameter|Winding Style]]
||Non Zero
||integer

|-
||[[Image:Type_list_icon.png|16px]] Vertices
||List
||list (Spline)

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Outline_width|Outline Width]]
||2.000000pt
||real

|-
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Expand|Expand]]
||0.000000pt
||real

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at Start]]
||Rounded Stop
||integer

|-
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at End]]
||Rounded Stop
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Cusps_Type|Cusps Type]]
||Sharp
||integer

|-
||[[Image:Type_real_icon.png|16px]] [[Advanced_Outline_Layer#Smoothness|Smoothness]]
||0.500000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_bool_icon.png|16px}} [[Advanced_Outline_Layer#Homogeneous|Homogeneous]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_list_icon.png|16px]] [[Advanced_Outline_Layer#Width_Point_List|Width Point List]]
||List
||list(WPList)

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Fast|Fast]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Dashed_Outline|Dashed Outline]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_list_icon.png|16px]] Dash Item List
||List
||list(WPList)

|-
||[[Image:Type_real_icon.png|16px]] Dash Items Offset
||0.000000u
||real

|}

==Specific parameters for Advanced Outline Layer==

This section lists only the parameters specific to the Advanced Outline Layer. For documentation about the other parameters, refer to [[Outline Layer]].

* Tip Type at start
* Tip Type at end
* Cusps type
* Smoothness
* Width Point List

=== Tip type at start / end ===

As with width points, the end and start of the unlooped Advanced Outlines has a type of tip defined. The user can choose between the same types of tips as for a width point. When the first/last width point has its before/after interpolation type set to Interpolate the start/end of the outline is rendered using the Tip type at start/end parameter.

Those parameters don't have any effect if the Spline is looped or the first/last width point has its before/after interpolation type set to anything but Interpolate. In that case, the segment between the start/end width point and the start/end of the Spline is not rendered.

The types of tips are the same as the width point tip types except that it doesn't offer the Interpolate type because it would not make sense:

Parameters:
{| border="1"
|-
! Tip Type
! Example
|-
| Rounded
| [[File:Avanced-Outline-Layer-TipType-Rounded.png]]
|-
| Squared
| [[File:Avanced-Outline-Layer-TipType-Squared.png]]
|-
| Peak
| [[File:Avanced-Outline-Layer-TipType-Peak.png]]
|-
| Flat
| [[File:Avanced-Outline-Layer-TipType-Flat.png]]
|}

=== Cusps type ===

There are three types of cusps in the Advanced Outline:

Parameters:
{| border="1"
|-
! Cusp Type
! Example
|-
| Sharp
|[[File:Avanced-Outline-Layer-Cups-Sharp.png]]
|-
| Rounded
| [[File:Avanced-Outline-Layer-Cups-Rounded.png]]
|-
| Bevel
| [[File:Avanced-Outline-Layer-Cups-Bevel.png]]
|}

The type of cusp is controlled for the entire layer so currently it is not possible to control the type of corner individually. Maybe in future versions it will be possible.

=== Smoothness ===

The Smoothness controls how the width is calculated between widthpoints. The width at a position p is a function of the surrounding width points. When smoothness is '''zero''' interpolation is lineal, when smoothness is '''1.0''' interpolation is given by a 5th degree smooth Spline.

=== Homogeneous ===

Enabling {{literal|Homogeneous}} changes the way the position of the {{l|#widthpoint|width points}} change according modification of the outline.
* When false, the "Position" parameter for a width point is equally distributed '''among the vertices'''. For example, in a spline with five vertices, "Position" values of 0, 0.25, 0.5, 0.75, and 1 correspond to the first, second, third, fourth, and fifth vertex, respectively, regardless of how close or far apart those vertices are. Between vertices, the "Position" parameter is based on spline length.
* When true, the "Position" parameter increases smoothly from the start to the end of the spline '''based on the length of the entire spline'''. This means a "Position" of 0.5 will always correspond to the halfway point of the spline, not to a particular vertex.

=== Width Point List ===
Each Advanced Outline has a list of parameters that represent the information for each width item. They are called Width Points and consist of four sub-parameters:

* '''Position''' (Real number): represents the position of the width point along the Spline. Although it is allowed to be any real number, its meaning is only from '''0.0''' to '''1.0'''. 0.0 corresponds to the start of the Spline (first Spline point on the Spline list) and 1.0 to the last Spline point. For looped Splines 0.0 and 1.0 are equal. The position is represented by the light purple Handle that always lies on the Spline. The point on the spline corresponding to a particular "Position" value is affected by the "Homogeneous" parameter, explained above.
* '''Width''' (Real number): It is the width multiplicator of the global Width parameter of the Advanced Outline Layer on the position given by the Position parameter. The final width is calculated multiplying the global Advanced Outline's Width (W) by the Width of the widthpoint (w) and adding the Expand parameter (E). Calculated width = W*w+E
* '''Tip Side Before/After''': Those two sub-parameters controls how the width is interpolated before and after the current widthpoint. The sub-parameter can have four values:
** '''Interpolate''': Between the previous/following width point, the width is calculated by interpolation based on smoothness value.
** '''Rounded''': There is a rounded tip that points to the width point before or after. If the previous/following width point is {{Literal|Interpolate}} on its posterior/previous side it considers that the width of the widthpoint in question is zero just before/after it. If the previous/posterior width point is other than {{Literal|Interpolate}} then the segment between those two width points is empty. See examples to understand it fully.
** '''Squared''': Same as Rounded but using square tip.
** '''Peak''': Same as Rounded but using peak tip.
** '''Flat''': Same as Rounded but using flat tip.

The Width Point list has one internal non-animatable parameter called {{Literal|loop}}. You can reach it by right clicking the Width Point List parameter. If the Width Point list is unlooped, then any width point that has a Position outside the range of [0,1] is clamped to (brought within) that range. For example: a Position = 1.35 is clamped to 1.0 then the Width Point List is unlooped. Otherwise, if the Width Point List is looped and a width point has a Position of 1.3, its modulus based on the range [0,1] is used, so it is turned to a position of 0.3.

=== Fast ===
...TODO WriteME.about...

=== Dashed Outline ===
...TODO WriteME.about...

== Working with the Avdanced Outline ==

=== Creation of the Advanced Outline ===

You can create Advanced Outlines by various ways:
* With the {{l|Draw Tool}} (check ''Create Advanced Outline'' in the tool options).
* With the {{l|Spline Tool}} (check ''Create Advanced Outline'' in the tool options).
* Using a {{l|Layers#Geometry|Geometry Layer}} (check ''Create Advanced Outline'' in the tool options).
* With the menu {{c|<Insert>|<Layer>|Geometry|Advanced Outline}}.

=== Change the width of the Width Points ===

Initially the width Handles are hidden. You can make them visible by pressing ({{Shortcut|alt|5}}) or clicking on the width toggle button. It is possible to change the width using the {{l|Width Tool}} using the same procedure as for regular outlines. If you want more control over the width you can modify the width Handles with the {{l|Transform Tool}} ({{Shortcut|alt|A}}). More fine tunning is possible by expanding the width point sub-parameter and entering a specific value for the Width sub-parameter. In that case negative values are allowed to produce nice effects.

=== Change the position of the Width Points ===

When you make the width Handles of the width points visible/invisible, the position Handles also become visible/invisible. This way, the user has a single way to hide/show the position and width Handles.

{{Note|Change the position of the Width Points|This may change in the future}}

The position Handles of the width points can be modified using the {{l|Transform Tool}} ({{Shortcut|alt|A}}) and clicking and dragging the position Handle. You will notice that Handles are tied to the Spline so once clicked and dragged they can be placed at any way on the Spline. Notice that if you have a width point position Handle at position 0.2 and you click and drag at position 0.9 it may happen that you obtain a value of -0.1 because you dragged it in one step and the Width Point List may be looped. If you want to avoid those problems do the movement in small steps to indicate the correct path to follow when calculating the new position.

=== Adding or removing width points ===
To add a new width point you have to right click on the width point position Handle (purple Handle) to get the context menu. Then select {{literal|Add Item (smart)}} here to create more width points entries. The width points are created this way:

In the general case, the new widthpoint is created between the width point you click on and the "previous" width point. Depending on the loop status of the Spline, the "previous" width point can be the start of the Spline (unlooped) or the last widthpoint (looped). The worst case is when there is only one width point on the Width Point List. If you add one new item it will lie over the existing one.

The newly added width point will have the interpolated width at the position where it is created.

=== Specific actions for Width Points ===

Some needed actions have been added to width points as well as functionality for existing actions for items of the List type parameters. You can reach the list of available actions by right clicking on the width point position or directly on the width point item of the Width Point List. Here are some descriptions of the available actions:

* Convert: Width Points are composite Value Nodes so its natural format is Composite (you can access its components). But you can convert it to other formats. See Convert for details.
* Disconnect: This will disconnect the width point item from the Composite type Value Node. That means that there won't be any Handle to show and that any of its values can be modified. Maybe it is useful for some types of workflows. To restore its Composite status, choose Convert->Composite.
* Insert/ Remove Item Smart: This will add or remove a width point. If Remove is used in animation mode, it will also set the current width point as OFF instead of effectively removing it from the Width Point List. Opposite for the Insert Item Smart.
* Mark Active Point as ON/OFF: You can set width points off to make it not count for width control while the width point is off. When the width point is half on to off or viceversa, the used width point should be the interpolation between the on and off status. But it doesn't work properly at the moment. On / Off values are not interpolated but fully on or fully off. This has to be corrected.
* Export: See {{l|Export}}.
* Loop: When set as looped, as mentioned before, it allows the width point positions loop around the range [0,1].
* Rotate Order: Doesn't do anything.
* Set Side Before/After to: Interpolate, Rounded, Squared, Peak, Flat. Those are shortcuts to do the same as going directly to the sub-parameter and choosing the appropriate Tip Type. Maybe it should be renamed to "Set Tip Before/After".
* Set Width to default/zero: those actions have been added for two reasons. It is very common to want to set the width of a width point to zero. Despite the possibility of use the User Preference of Restrict Radius to First Quadrant, this way it is acceded quickly from the same usual menu. Also when a width point position Handle and a width point width Handle are on top of each other (width = 0) it is hard to modify the width or the position without trouble. To solve this the position Handle has preference over the width Handle in case of coincidence. So access the width Handle it is needed to have a quick action to set it to its default value (1.0).

Template:Layer

2016-10-16T17:13:07Z

D.j.a.y: test

[[Image:{{{image}}}|64px]]

Circle Layer

2016-10-16T16:45:59Z

D.j.a.y: Undo revision 22313 by D.j.a.y (talk)

{{Title|Circle Layer}}
{{Category|Layers}}
{{Category|Primitive Layers}}
{{NewTerminology}}


{{l|Image:Circle_icon.png|64px}}

== About Circle Layers ==

Circle layers are used to represent circles =). A circle is the flat region defined by the inner area of a circle. A circle is a flat line on which all the points are at the same distance from the center or Origin. The distance to the center is called {{Literal|Radius}}.

To create a {{Literal|Circle Layer}} you would use the {{l|Circle Tool}}. Make a first left mouse button click where the Origin should go and hold-drag from the center to define the Radius when you release the left mouse button. The circle will be created with the current foreground Color.

== Parameters of the Circle Layers ==

The parameters of the Circle layers are:

{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:silver"
|'''Name'''||'''Value'''||'''Type'''
|-
||{{l|Image:Real_icon.png|16px}} {{l|Z Depth Parameter|Z Depth}}
||0.000000
||real
|-style="background:#eeeeee"
||{{l|Image:Real_icon.png|16px}} {{l|Amount Parameter|Amount}}
||1.000000
||real
|-
||{{l|Image:Integer_icon.png|16px}} {{l|Blend Method|Blend Method}}
||Composite
||integer
|-style="background:#eeeeee"
||{{l|Image:Integer_icon.png|16px}} {{l|Blur Layer|Type}}
||Fast Gaussian Blur
||integer
|-
||{{l|Image:Color_icon.png|16px}} {{l|Colors Dialog|Color}}
||
{| style="width:95%; height:16px; background:black; color:black" border="1"
|-
|}
||color
|-style="background:#eeeeee"
||{{l|Image:Real_icon.png|16px}} Radius
||59.999998pt
||real
|-
||{{l|Image:Real_icon.png|16px}} Feather
||0.000000pt
||real
|-style="background:#eeeeee"
||{{l|Image:Vector_icon.png|16px}}Origin
||0.000000pt,0.000000pt
||vector
|-
||{{l|Image:Bool_icon.png|16px}} Invert
||
{| style="width:18px; height:16px" border="1"
|-
|}
||bool
|-style="background:#eeeeee"
||{{l|Image:Integer_icon.png|16px}}Fallof
||Linear
||integer
|}

A simple {{Literal|Circle Layer}} in action:

[[File:Circle-0.63.06.png|frame|none]]

== Specific parameters for Circle Layers ==

Some of the parameters of Circle Layers are common parameter that are shared for several types of Layers. Click on the links to see their definitions. Only the particular parameters for the Circle Layers are described here.

=== Radius ===

As mentioned before is is the radius of the geometric circle or circumference. It is modified dragging the cyan handle at the edge of the circumference. Although you rotate it it always becomes horizontal.

=== Origin ===

It is a parameter type {{l|Vector Parameter|vector}} that defines the center of the circle/circumference. Just edit its x,y coordinates or drag the green handle to change this value.

Advanced Outline Layer

2016-10-16T16:45:18Z

D.j.a.y: Undo revision 22314 by D.j.a.y (talk)

{{Title|Advanced Outline Layer}}
{{Category|Layers}}
{{Category|Primitive Layers}}
{{NewTerminology}}
{{TOCright}}

Under construction! See {{l|Talk:Advanced_Outline_Layer|Advanced Outline Layer Talk}} page
[[Image:Layer_geometry_advanced_outline_icon.png|64px]]

== About Advanced Outline Layers ==

To create an Advanced Outline Layer use the Spline Tool and check {{literal|Create Advanced Outline}} in the {{l|Tool Options Panel}}. Once you finish the definition of the geometry of your outline and after pressing the {{literal|Make Spline}} button (or selecting another tool or state) you create the Advanced Outline Layer with the {{l|New_Layer_Defaults#Brush_Colors|current}} {{literal|Outline Color}}.

Depending on the options you choose in the {{l|Tool Options Panel}} other {{l|Category:Tools|Tools}} like {{l|Star Tool}} or {{l|Circle Tool}} can also create Advanced Outline Layers.

Using the {{l|Canvas Layer Menu|Layer Menu}} {{Literal|Make Advanced Outline}}, {{Literal|Make Outline}} or {{Literal|Make Region}} commands you can also create those layers.

=== Differences with Outline Layer: Outline width ===

The '''width''' [[Handle]] define the outline width at particular place.

In the regular [[Outline Layer]], each width Handle is connected to the vertex that defines the outline shape at that place. That means that the user needs to insert a new vertex on the [[Spline]] every time he wants to change the outline width in some place. This behaviour can cause problems when the shape of the outline is very simple but the width varies a lot.

Practice shows that most of the time the user wants to specify the width independently from the placement of [[Spline]] vertices. Such functionality is available in the Advanced Outline layer, which Handles its width in a different way: the width Handles are freely moved around the Spline and define its width at any point.

== Features ==

Advanced Outline introduces some features to the regular outline, as shown in this [http://www.youtube.com/watch?v=boM_ZC9VZ54 Advanced outline demo] video. They are listed with examples below:

<gallery widths="490px" heights="300px" perrow="2">
File:Variable-width-without-blinepoints.png | No need to place vertex to change the width
File:Lots-of-blinepoints-width-just-two width-controls.png | Width controlled just by two points, while the Spline constructed of many vertices
File:Different-types of tips.png | Different types of tips : Rounded, Squared, Peak, Flat.
File: Segments of outlines.png | Segmented outline
File:Different cusps types.png | Three global cusps types : Sharp, Rounded, Bevel.
File:Smoothness control.png | Control of smoothness from linear (0.0) to smooth (1.0)
</gallery>

==Parameters of Advanced Outline Layers==

The parameters of the Advanced Outline Layers are:

{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:silver"
|'''Name'''||'''Value'''||'''Type'''
|-
||[[Image:Type_real_icon.png|16px]] [[Z Depth Parameter|Z Depth]]
||0.000000
||real

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Amount Parameter|Amount]]
||1.000000
||real

|-
||[[Image:type_integer_icon.png|16px]] [[Blend Method|Blend Method]]
||Composite
||integer

|-style="background:#eeeeee"
||[[Image:Type_color_icon.png|16px]] [[Colors Dialog|Color]]
||
{| style="width:95%; height:16px; background:black; color:black" border="1"
|-
|}
||color

|-style="background:#"
||[[Image:Type_vector_icon.png|16px]] [[Origin Parameter|Origin]]
||0.000000u,0.000000u
||vector

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Invert Parameter|Invert]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Antialiasing Parameter|Antialiasing]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Feather Parameter|Feather]]
||0.000000pt
||real

|-
||[[Image:Type_integer_icon.png|16px]] [[Feather_Parameter#Type_of_Feather|Type of Feather]]
||Fast Gaussian Blur
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Winding Style Parameter|Winding Style]]
||Non Zero
||integer

|-
||[[Image:Type_list_icon.png|16px]] Vertices
||List
||list (Spline)

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Outline_width|Outline Width]]
||2.000000pt
||real

|-
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Expand|Expand]]
||0.000000pt
||real

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at Start]]
||Rounded Stop
||integer

|-
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at End]]
||Rounded Stop
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Cusps_Type|Cusps Type]]
||Sharp
||integer

|-
||[[Image:Type_real_icon.png|16px]] [[Advanced_Outline_Layer#Smoothness|Smoothness]]
||0.500000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_bool_icon.png|16px}} [[Advanced_Outline_Layer#Homogeneous|Homogeneous]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_list_icon.png|16px]] [[Advanced_Outline_Layer#Width_Point_List|Width Point List]]
||List
||list(WPList)

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Fast|Fast]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Dashed_Outline|Dashed Outline]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_list_icon.png|16px]] Dash Item List
||List
||list(WPList)

|-
||[[Image:Type_real_icon.png|16px]] Dash Items Offset
||0.000000u
||real

|}

==Specific parameters for Advanced Outline Layer==

This section lists only the parameters specific to the Advanced Outline Layer. For documentation about the other parameters, refer to [[Outline Layer]].

* Tip Type at start
* Tip Type at end
* Cusps type
* Smoothness
* Width Point List

=== Tip type at start / end ===

As with width points, the end and start of the unlooped Advanced Outlines has a type of tip defined. The user can choose between the same types of tips as for a width point. When the first/last width point has its before/after interpolation type set to Interpolate the start/end of the outline is rendered using the Tip type at start/end parameter.

Those parameters don't have any effect if the Spline is looped or the first/last width point has its before/after interpolation type set to anything but Interpolate. In that case, the segment between the start/end width point and the start/end of the Spline is not rendered.

The types of tips are the same as the width point tip types except that it doesn't offer the Interpolate type because it would not make sense:

Parameters:
{| border="1"
|-
! Tip Type
! Example
|-
| Rounded
| [[File:Avanced-Outline-Layer-TipType-Rounded.png]]
|-
| Squared
| [[File:Avanced-Outline-Layer-TipType-Squared.png]]
|-
| Peak
| [[File:Avanced-Outline-Layer-TipType-Peak.png]]
|-
| Flat
| [[File:Avanced-Outline-Layer-TipType-Flat.png]]
|}

=== Cusps type ===

There are three types of cusps in the Advanced Outline:

Parameters:
{| border="1"
|-
! Cusp Type
! Example
|-
| Sharp
|[[File:Avanced-Outline-Layer-Cups-Sharp.png]]
|-
| Rounded
| [[File:Avanced-Outline-Layer-Cups-Rounded.png]]
|-
| Bevel
| [[File:Avanced-Outline-Layer-Cups-Bevel.png]]
|}

The type of cusp is controlled for the entire layer so currently it is not possible to control the type of corner individually. Maybe in future versions it will be possible.

=== Smoothness ===

The Smoothness controls how the width is calculated between widthpoints. The width at a position p is a function of the surrounding width points. When smoothness is '''zero''' interpolation is lineal, when smoothness is '''1.0''' interpolation is given by a 5th degree smooth Spline.

=== Homogeneous ===

Enabling {{literal|Homogeneous}} changes the way the position of the {{l|#widthpoint|width points}} change according modification of the outline.
* When false, the "Position" parameter for a width point is equally distributed '''among the vertices'''. For example, in a spline with five vertices, "Position" values of 0, 0.25, 0.5, 0.75, and 1 correspond to the first, second, third, fourth, and fifth vertex, respectively, regardless of how close or far apart those vertices are. Between vertices, the "Position" parameter is based on spline length.
* When true, the "Position" parameter increases smoothly from the start to the end of the spline '''based on the length of the entire spline'''. This means a "Position" of 0.5 will always correspond to the halfway point of the spline, not to a particular vertex.

=== Width Point List ===
Each Advanced Outline has a list of parameters that represent the information for each width item. They are called Width Points and consist of four sub-parameters:

* '''Position''' (Real number): represents the position of the width point along the Spline. Although it is allowed to be any real number, its meaning is only from '''0.0''' to '''1.0'''. 0.0 corresponds to the start of the Spline (first Spline point on the Spline list) and 1.0 to the last Spline point. For looped Splines 0.0 and 1.0 are equal. The position is represented by the light purple Handle that always lies on the Spline. The point on the spline corresponding to a particular "Position" value is affected by the "Homogeneous" parameter, explained above.
* '''Width''' (Real number): It is the width multiplicator of the global Width parameter of the Advanced Outline Layer on the position given by the Position parameter. The final width is calculated multiplying the global Advanced Outline's Width (W) by the Width of the widthpoint (w) and adding the Expand parameter (E). Calculated width = W*w+E
* '''Tip Side Before/After''': Those two sub-parameters controls how the width is interpolated before and after the current widthpoint. The sub-parameter can have four values:
** '''Interpolate''': Between the previous/following width point, the width is calculated by interpolation based on smoothness value.
** '''Rounded''': There is a rounded tip that points to the width point before or after. If the previous/following width point is {{Literal|Interpolate}} on its posterior/previous side it considers that the width of the widthpoint in question is zero just before/after it. If the previous/posterior width point is other than {{Literal|Interpolate}} then the segment between those two width points is empty. See examples to understand it fully.
** '''Squared''': Same as Rounded but using square tip.
** '''Peak''': Same as Rounded but using peak tip.
** '''Flat''': Same as Rounded but using flat tip.

The Width Point list has one internal non-animatable parameter called {{Literal|loop}}. You can reach it by right clicking the Width Point List parameter. If the Width Point list is unlooped, then any width point that has a Position outside the range of [0,1] is clamped to (brought within) that range. For example: a Position = 1.35 is clamped to 1.0 then the Width Point List is unlooped. Otherwise, if the Width Point List is looped and a width point has a Position of 1.3, its modulus based on the range [0,1] is used, so it is turned to a position of 0.3.

=== Fast ===
...TODO WriteME.about...

=== Dashed Outline ===
...TODO WriteME.about...

== Working with the Avdanced Outline ==

=== Creation of the Advanced Outline ===

You can create Advanced Outlines by various ways:
* With the {{l|Draw Tool}} (check ''Create Advanced Outline'' in the tool options).
* With the {{l|Spline Tool}} (check ''Create Advanced Outline'' in the tool options).
* Using a {{l|Layers#Geometry|Geometry Layer}} (check ''Create Advanced Outline'' in the tool options).
* With the menu {{c|<Insert>|<Layer>|Geometry|Advanced Outline}}.

=== Change the width of the Width Points ===

Initially the width Handles are hidden. You can make them visible by pressing ({{Shortcut|alt|5}}) or clicking on the width toggle button. It is possible to change the width using the {{l|Width Tool}} using the same procedure as for regular outlines. If you want more control over the width you can modify the width Handles with the {{l|Transform Tool}} ({{Shortcut|alt|A}}). More fine tunning is possible by expanding the width point sub-parameter and entering a specific value for the Width sub-parameter. In that case negative values are allowed to produce nice effects.

=== Change the position of the Width Points ===

When you make the width Handles of the width points visible/invisible, the position Handles also become visible/invisible. This way, the user has a single way to hide/show the position and width Handles.

{{Note|Change the position of the Width Points|This may change in the future}}

The position Handles of the width points can be modified using the {{l|Transform Tool}} ({{Shortcut|alt|A}}) and clicking and dragging the position Handle. You will notice that Handles are tied to the Spline so once clicked and dragged they can be placed at any way on the Spline. Notice that if you have a width point position Handle at position 0.2 and you click and drag at position 0.9 it may happen that you obtain a value of -0.1 because you dragged it in one step and the Width Point List may be looped. If you want to avoid those problems do the movement in small steps to indicate the correct path to follow when calculating the new position.

=== Adding or removing width points ===
To add a new width point you have to right click on the width point position Handle (purple Handle) to get the context menu. Then select {{literal|Add Item (smart)}} here to create more width points entries. The width points are created this way:

In the general case, the new widthpoint is created between the width point you click on and the "previous" width point. Depending on the loop status of the Spline, the "previous" width point can be the start of the Spline (unlooped) or the last widthpoint (looped). The worst case is when there is only one width point on the Width Point List. If you add one new item it will lie over the existing one.

The newly added width point will have the interpolated width at the position where it is created.

=== Specific actions for Width Points ===

Some needed actions have been added to width points as well as functionality for existing actions for items of the List type parameters. You can reach the list of available actions by right clicking on the width point position or directly on the width point item of the Width Point List. Here are some descriptions of the available actions:

* Convert: Width Points are composite Value Nodes so its natural format is Composite (you can access its components). But you can convert it to other formats. See Convert for details.
* Disconnect: This will disconnect the width point item from the Composite type Value Node. That means that there won't be any Handle to show and that any of its values can be modified. Maybe it is useful for some types of workflows. To restore its Composite status, choose Convert->Composite.
* Insert/ Remove Item Smart: This will add or remove a width point. If Remove is used in animation mode, it will also set the current width point as OFF instead of effectively removing it from the Width Point List. Opposite for the Insert Item Smart.
* Mark Active Point as ON/OFF: You can set width points off to make it not count for width control while the width point is off. When the width point is half on to off or viceversa, the used width point should be the interpolation between the on and off status. But it doesn't work properly at the moment. On / Off values are not interpolated but fully on or fully off. This has to be corrected.
* Export: See {{l|Export}}.
* Loop: When set as looped, as mentioned before, it allows the width point positions loop around the range [0,1].
* Rotate Order: Doesn't do anything.
* Set Side Before/After to: Interpolate, Rounded, Squared, Peak, Flat. Those are shortcuts to do the same as going directly to the sub-parameter and choosing the appropriate Tip Type. Maybe it should be renamed to "Set Tip Before/After".
* Set Width to default/zero: those actions have been added for two reasons. It is very common to want to set the width of a width point to zero. Despite the possibility of use the User Preference of Restrict Radius to First Quadrant, this way it is acceded quickly from the same usual menu. Also when a width point position Handle and a width point width Handle are on top of each other (width = 0) it is hard to modify the width or the position without trouble. To solve this the position Handle has preference over the width Handle in case of coincidence. So access the width Handle it is needed to have a quick action to set it to its default value (1.0).

Template:CategoryContents

2016-10-16T16:43:34Z

D.j.a.y: Reverted edits by D.j.a.y (talk) to last revision by Zelgadis

<includeonly>{{#dpl:category={{{1}}}{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}|include={Title}.dpl|format=,\n* [[%PAGE%|,]],|noresultsheader= }}</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T16:41:01Z

D.j.a.y: ytest

<includeonly>
{{#dpl
|category={{{1}}}
{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}|include={Title}.dpl|format=,\n* [[%PAGE%|,]],|noresultsheader= 
}}
</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T16:39:24Z

D.j.a.y: test

<includeonly>
{{#dpl
|category={{{1}}}
|includepage=#About[350]
|table=,,About
{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}|include={Title}.dpl|format=,\n* [[%PAGE%|,]],|noresultsheader= 
}}
</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Template:CategoryContents

2016-10-16T16:34:54Z

D.j.a.y: test

<includeonly>{{#dpl:category={{{1}}}|includepage=#About[350]{{#ifeq:{{#titleparts:{{PAGENAME}}||-1}}|{{PAGENAME}}||/{{#titleparts:{{PAGENAME}}||-1}}}}|include={Title}.dpl|format=,\n* [[%PAGE%|,]],|noresultsheader= }}</includeonly>
<noinclude>
This template lists pages in category, considering their translated titles.

== Usage ==

List contents of specific category on the page. Usage:

<nowiki>{{CategoryContents|Example}}</nowiki>

NOTE: Output is localized, so if you use <nowiki>{{CategoryContents|Example}}</nowiki> on Spanish page, you will automatically get content of Example/es category
</noinclude>

Advanced Outline Layer

2016-10-16T16:30:38Z

D.j.a.y: test

{{Title|Advanced Outline Layer}}
{{Category|Layers}}
{{Category|Primitive Layers}}
{{NewTerminology}}
{{TOCright}}

Under construction! See {{l|Talk:Advanced_Outline_Layer|Advanced Outline Layer Talk}} page
[[Image:Layer_geometry_advanced_outline_icon.png|64px]]

== About ==

To create an Advanced Outline Layer use the Spline Tool and check {{literal|Create Advanced Outline}} in the {{l|Tool Options Panel}}. Once you finish the definition of the geometry of your outline and after pressing the {{literal|Make Spline}} button (or selecting another tool or state) you create the Advanced Outline Layer with the {{l|New_Layer_Defaults#Brush_Colors|current}} {{literal|Outline Color}}.

Depending on the options you choose in the {{l|Tool Options Panel}} other {{l|Category:Tools|Tools}} like {{l|Star Tool}} or {{l|Circle Tool}} can also create Advanced Outline Layers.

Using the {{l|Canvas Layer Menu|Layer Menu}} {{Literal|Make Advanced Outline}}, {{Literal|Make Outline}} or {{Literal|Make Region}} commands you can also create those layers.

=== Differences with Outline Layer: Outline width ===

The '''width''' [[Handle]] define the outline width at particular place.

In the regular [[Outline Layer]], each width Handle is connected to the vertex that defines the outline shape at that place. That means that the user needs to insert a new vertex on the [[Spline]] every time he wants to change the outline width in some place. This behaviour can cause problems when the shape of the outline is very simple but the width varies a lot.

Practice shows that most of the time the user wants to specify the width independently from the placement of [[Spline]] vertices. Such functionality is available in the Advanced Outline layer, which Handles its width in a different way: the width Handles are freely moved around the Spline and define its width at any point.

== Features ==

Advanced Outline introduces some features to the regular outline, as shown in this [http://www.youtube.com/watch?v=boM_ZC9VZ54 Advanced outline demo] video. They are listed with examples below:

<gallery widths="490px" heights="300px" perrow="2">
File:Variable-width-without-blinepoints.png | No need to place vertex to change the width
File:Lots-of-blinepoints-width-just-two width-controls.png | Width controlled just by two points, while the Spline constructed of many vertices
File:Different-types of tips.png | Different types of tips : Rounded, Squared, Peak, Flat.
File: Segments of outlines.png | Segmented outline
File:Different cusps types.png | Three global cusps types : Sharp, Rounded, Bevel.
File:Smoothness control.png | Control of smoothness from linear (0.0) to smooth (1.0)
</gallery>

==Parameters of Advanced Outline Layers==

The parameters of the Advanced Outline Layers are:

{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:silver"
|'''Name'''||'''Value'''||'''Type'''
|-
||[[Image:Type_real_icon.png|16px]] [[Z Depth Parameter|Z Depth]]
||0.000000
||real

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Amount Parameter|Amount]]
||1.000000
||real

|-
||[[Image:type_integer_icon.png|16px]] [[Blend Method|Blend Method]]
||Composite
||integer

|-style="background:#eeeeee"
||[[Image:Type_color_icon.png|16px]] [[Colors Dialog|Color]]
||
{| style="width:95%; height:16px; background:black; color:black" border="1"
|-
|}
||color

|-style="background:#"
||[[Image:Type_vector_icon.png|16px]] [[Origin Parameter|Origin]]
||0.000000u,0.000000u
||vector

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Invert Parameter|Invert]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Antialiasing Parameter|Antialiasing]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Feather Parameter|Feather]]
||0.000000pt
||real

|-
||[[Image:Type_integer_icon.png|16px]] [[Feather_Parameter#Type_of_Feather|Type of Feather]]
||Fast Gaussian Blur
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Winding Style Parameter|Winding Style]]
||Non Zero
||integer

|-
||[[Image:Type_list_icon.png|16px]] Vertices
||List
||list (Spline)

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Outline_width|Outline Width]]
||2.000000pt
||real

|-
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Expand|Expand]]
||0.000000pt
||real

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at Start]]
||Rounded Stop
||integer

|-
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at End]]
||Rounded Stop
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Cusps_Type|Cusps Type]]
||Sharp
||integer

|-
||[[Image:Type_real_icon.png|16px]] [[Advanced_Outline_Layer#Smoothness|Smoothness]]
||0.500000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_bool_icon.png|16px}} [[Advanced_Outline_Layer#Homogeneous|Homogeneous]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_list_icon.png|16px]] [[Advanced_Outline_Layer#Width_Point_List|Width Point List]]
||List
||list(WPList)

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Fast|Fast]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Dashed_Outline|Dashed Outline]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_list_icon.png|16px]] Dash Item List
||List
||list(WPList)

|-
||[[Image:Type_real_icon.png|16px]] Dash Items Offset
||0.000000u
||real

|}

==Specific parameters for Advanced Outline Layer==

This section lists only the parameters specific to the Advanced Outline Layer. For documentation about the other parameters, refer to [[Outline Layer]].

* Tip Type at start
* Tip Type at end
* Cusps type
* Smoothness
* Width Point List

=== Tip type at start / end ===

As with width points, the end and start of the unlooped Advanced Outlines has a type of tip defined. The user can choose between the same types of tips as for a width point. When the first/last width point has its before/after interpolation type set to Interpolate the start/end of the outline is rendered using the Tip type at start/end parameter.

Those parameters don't have any effect if the Spline is looped or the first/last width point has its before/after interpolation type set to anything but Interpolate. In that case, the segment between the start/end width point and the start/end of the Spline is not rendered.

The types of tips are the same as the width point tip types except that it doesn't offer the Interpolate type because it would not make sense:

Parameters:
{| border="1"
|-
! Tip Type
! Example
|-
| Rounded
| [[File:Avanced-Outline-Layer-TipType-Rounded.png]]
|-
| Squared
| [[File:Avanced-Outline-Layer-TipType-Squared.png]]
|-
| Peak
| [[File:Avanced-Outline-Layer-TipType-Peak.png]]
|-
| Flat
| [[File:Avanced-Outline-Layer-TipType-Flat.png]]
|}

=== Cusps type ===

There are three types of cusps in the Advanced Outline:

Parameters:
{| border="1"
|-
! Cusp Type
! Example
|-
| Sharp
|[[File:Avanced-Outline-Layer-Cups-Sharp.png]]
|-
| Rounded
| [[File:Avanced-Outline-Layer-Cups-Rounded.png]]
|-
| Bevel
| [[File:Avanced-Outline-Layer-Cups-Bevel.png]]
|}

The type of cusp is controlled for the entire layer so currently it is not possible to control the type of corner individually. Maybe in future versions it will be possible.

=== Smoothness ===

The Smoothness controls how the width is calculated between widthpoints. The width at a position p is a function of the surrounding width points. When smoothness is '''zero''' interpolation is lineal, when smoothness is '''1.0''' interpolation is given by a 5th degree smooth Spline.

=== Homogeneous ===

Enabling {{literal|Homogeneous}} changes the way the position of the {{l|#widthpoint|width points}} change according modification of the outline.
* When false, the "Position" parameter for a width point is equally distributed '''among the vertices'''. For example, in a spline with five vertices, "Position" values of 0, 0.25, 0.5, 0.75, and 1 correspond to the first, second, third, fourth, and fifth vertex, respectively, regardless of how close or far apart those vertices are. Between vertices, the "Position" parameter is based on spline length.
* When true, the "Position" parameter increases smoothly from the start to the end of the spline '''based on the length of the entire spline'''. This means a "Position" of 0.5 will always correspond to the halfway point of the spline, not to a particular vertex.

=== Width Point List ===
Each Advanced Outline has a list of parameters that represent the information for each width item. They are called Width Points and consist of four sub-parameters:

* '''Position''' (Real number): represents the position of the width point along the Spline. Although it is allowed to be any real number, its meaning is only from '''0.0''' to '''1.0'''. 0.0 corresponds to the start of the Spline (first Spline point on the Spline list) and 1.0 to the last Spline point. For looped Splines 0.0 and 1.0 are equal. The position is represented by the light purple Handle that always lies on the Spline. The point on the spline corresponding to a particular "Position" value is affected by the "Homogeneous" parameter, explained above.
* '''Width''' (Real number): It is the width multiplicator of the global Width parameter of the Advanced Outline Layer on the position given by the Position parameter. The final width is calculated multiplying the global Advanced Outline's Width (W) by the Width of the widthpoint (w) and adding the Expand parameter (E). Calculated width = W*w+E
* '''Tip Side Before/After''': Those two sub-parameters controls how the width is interpolated before and after the current widthpoint. The sub-parameter can have four values:
** '''Interpolate''': Between the previous/following width point, the width is calculated by interpolation based on smoothness value.
** '''Rounded''': There is a rounded tip that points to the width point before or after. If the previous/following width point is {{Literal|Interpolate}} on its posterior/previous side it considers that the width of the widthpoint in question is zero just before/after it. If the previous/posterior width point is other than {{Literal|Interpolate}} then the segment between those two width points is empty. See examples to understand it fully.
** '''Squared''': Same as Rounded but using square tip.
** '''Peak''': Same as Rounded but using peak tip.
** '''Flat''': Same as Rounded but using flat tip.

The Width Point list has one internal non-animatable parameter called {{Literal|loop}}. You can reach it by right clicking the Width Point List parameter. If the Width Point list is unlooped, then any width point that has a Position outside the range of [0,1] is clamped to (brought within) that range. For example: a Position = 1.35 is clamped to 1.0 then the Width Point List is unlooped. Otherwise, if the Width Point List is looped and a width point has a Position of 1.3, its modulus based on the range [0,1] is used, so it is turned to a position of 0.3.

=== Fast ===
...TODO WriteME.about...

=== Dashed Outline ===
...TODO WriteME.about...

== Working with the Avdanced Outline ==

=== Creation of the Advanced Outline ===

You can create Advanced Outlines by various ways:
* With the {{l|Draw Tool}} (check ''Create Advanced Outline'' in the tool options).
* With the {{l|Spline Tool}} (check ''Create Advanced Outline'' in the tool options).
* Using a {{l|Layers#Geometry|Geometry Layer}} (check ''Create Advanced Outline'' in the tool options).
* With the menu {{c|<Insert>|<Layer>|Geometry|Advanced Outline}}.

=== Change the width of the Width Points ===

Initially the width Handles are hidden. You can make them visible by pressing ({{Shortcut|alt|5}}) or clicking on the width toggle button. It is possible to change the width using the {{l|Width Tool}} using the same procedure as for regular outlines. If you want more control over the width you can modify the width Handles with the {{l|Transform Tool}} ({{Shortcut|alt|A}}). More fine tunning is possible by expanding the width point sub-parameter and entering a specific value for the Width sub-parameter. In that case negative values are allowed to produce nice effects.

=== Change the position of the Width Points ===

When you make the width Handles of the width points visible/invisible, the position Handles also become visible/invisible. This way, the user has a single way to hide/show the position and width Handles.

{{Note|Change the position of the Width Points|This may change in the future}}

The position Handles of the width points can be modified using the {{l|Transform Tool}} ({{Shortcut|alt|A}}) and clicking and dragging the position Handle. You will notice that Handles are tied to the Spline so once clicked and dragged they can be placed at any way on the Spline. Notice that if you have a width point position Handle at position 0.2 and you click and drag at position 0.9 it may happen that you obtain a value of -0.1 because you dragged it in one step and the Width Point List may be looped. If you want to avoid those problems do the movement in small steps to indicate the correct path to follow when calculating the new position.

=== Adding or removing width points ===
To add a new width point you have to right click on the width point position Handle (purple Handle) to get the context menu. Then select {{literal|Add Item (smart)}} here to create more width points entries. The width points are created this way:

In the general case, the new widthpoint is created between the width point you click on and the "previous" width point. Depending on the loop status of the Spline, the "previous" width point can be the start of the Spline (unlooped) or the last widthpoint (looped). The worst case is when there is only one width point on the Width Point List. If you add one new item it will lie over the existing one.

The newly added width point will have the interpolated width at the position where it is created.

=== Specific actions for Width Points ===

Some needed actions have been added to width points as well as functionality for existing actions for items of the List type parameters. You can reach the list of available actions by right clicking on the width point position or directly on the width point item of the Width Point List. Here are some descriptions of the available actions:

* Convert: Width Points are composite Value Nodes so its natural format is Composite (you can access its components). But you can convert it to other formats. See Convert for details.
* Disconnect: This will disconnect the width point item from the Composite type Value Node. That means that there won't be any Handle to show and that any of its values can be modified. Maybe it is useful for some types of workflows. To restore its Composite status, choose Convert->Composite.
* Insert/ Remove Item Smart: This will add or remove a width point. If Remove is used in animation mode, it will also set the current width point as OFF instead of effectively removing it from the Width Point List. Opposite for the Insert Item Smart.
* Mark Active Point as ON/OFF: You can set width points off to make it not count for width control while the width point is off. When the width point is half on to off or viceversa, the used width point should be the interpolation between the on and off status. But it doesn't work properly at the moment. On / Off values are not interpolated but fully on or fully off. This has to be corrected.
* Export: See {{l|Export}}.
* Loop: When set as looped, as mentioned before, it allows the width point positions loop around the range [0,1].
* Rotate Order: Doesn't do anything.
* Set Side Before/After to: Interpolate, Rounded, Squared, Peak, Flat. Those are shortcuts to do the same as going directly to the sub-parameter and choosing the appropriate Tip Type. Maybe it should be renamed to "Set Tip Before/After".
* Set Width to default/zero: those actions have been added for two reasons. It is very common to want to set the width of a width point to zero. Despite the possibility of use the User Preference of Restrict Radius to First Quadrant, this way it is acceded quickly from the same usual menu. Also when a width point position Handle and a width point width Handle are on top of each other (width = 0) it is hard to modify the width or the position without trouble. To solve this the position Handle has preference over the width Handle in case of coincidence. So access the width Handle it is needed to have a quick action to set it to its default value (1.0).

Circle Layer

2016-10-16T16:29:55Z

D.j.a.y: /* About Circle Layers */ test

{{Title|Circle Layer}}
{{Category|Layers}}
{{Category|Primitive Layers}}
{{NewTerminology}}


{{l|Image:Circle_icon.png|64px}}

== About ==

Circle layers are used to represent circles =). A circle is the flat region defined by the inner area of a circle. A circle is a flat line on which all the points are at the same distance from the center or Origin. The distance to the center is called {{Literal|Radius}}.

To create a {{Literal|Circle Layer}} you would use the {{l|Circle Tool}}. Make a first left mouse button click where the Origin should go and hold-drag from the center to define the Radius when you release the left mouse button. The circle will be created with the current foreground Color.

== Parameters of the Circle Layers ==

The parameters of the Circle layers are:

{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:silver"
|'''Name'''||'''Value'''||'''Type'''
|-
||{{l|Image:Real_icon.png|16px}} {{l|Z Depth Parameter|Z Depth}}
||0.000000
||real
|-style="background:#eeeeee"
||{{l|Image:Real_icon.png|16px}} {{l|Amount Parameter|Amount}}
||1.000000
||real
|-
||{{l|Image:Integer_icon.png|16px}} {{l|Blend Method|Blend Method}}
||Composite
||integer
|-style="background:#eeeeee"
||{{l|Image:Integer_icon.png|16px}} {{l|Blur Layer|Type}}
||Fast Gaussian Blur
||integer
|-
||{{l|Image:Color_icon.png|16px}} {{l|Colors Dialog|Color}}
||
{| style="width:95%; height:16px; background:black; color:black" border="1"
|-
|}
||color
|-style="background:#eeeeee"
||{{l|Image:Real_icon.png|16px}} Radius
||59.999998pt
||real
|-
||{{l|Image:Real_icon.png|16px}} Feather
||0.000000pt
||real
|-style="background:#eeeeee"
||{{l|Image:Vector_icon.png|16px}}Origin
||0.000000pt,0.000000pt
||vector
|-
||{{l|Image:Bool_icon.png|16px}} Invert
||
{| style="width:18px; height:16px" border="1"
|-
|}
||bool
|-style="background:#eeeeee"
||{{l|Image:Integer_icon.png|16px}}Fallof
||Linear
||integer
|}

A simple {{Literal|Circle Layer}} in action:

[[File:Circle-0.63.06.png|frame|none]]

== Specific parameters for Circle Layers ==

Some of the parameters of Circle Layers are common parameter that are shared for several types of Layers. Click on the links to see their definitions. Only the particular parameters for the Circle Layers are described here.

=== Radius ===

As mentioned before is is the radius of the geometric circle or circumference. It is modified dragging the cyan handle at the edge of the circumference. Although you rotate it it always becomes horizontal.

=== Origin ===

It is a parameter type {{l|Vector Parameter|vector}} that defines the center of the circle/circumference. Just edit its x,y coordinates or drag the green handle to change this value.

Bevel Layer

2016-10-16T16:19:27Z

D.j.a.y: tocright / table align none

{{Title|Bevel Layer}}
{{Category|Layers}}
{{TOCright}}
{{NewTerminology}}


{{l|Image:Layer_stylize_bevel_icon.png‎|64px}}

== About Bevel Layer ==
Bevel layer is used to create a highlight and shadow over a shape. It pretends to give some volume to the shape by adding a dark area on the opposite place of the light direction and a light area on the light direction side.

== Parameters of Bevel Layer ==
The parameters of the Bevel Layers are:
{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:silver"
|'''Name'''||'''Value'''||'''Type'''
|-
||{{l|Image:Real_icon.png|16px}} {{l|Z Depth Parameter|Z Depth}}
||0.000000
||real
|-style="background:#eeeeee"
||{{l|Image:Real_icon.png|16px}} {{l|Amount Parameter|Amount}}
||1.000000
||real
|-
||{{l|Image:Integer_icon.png|16px}} {{l|Blend Method|Blend Method}}
||Composite
||integer
|-style="background:#eeeeee"
||{{l|Image:Integer_icon.png|16px}} {{l|Blur Layer|Type}}
||Fast Gaussian Blur
||integer
|-
||{{l|Image:Color_icon.png|16px}} {{l|Colors Dialog|Hi-Color}}
||
{| style="width:100%; height:16px; background:white; color:white" border="1"
|-
|}
||color
|-style="background:#eeeeee"
||{{l|Image:Color_icon.png|16px}} {{l|Colors Dialog|Lo-Color}}
||
{| style="width:100%; height:16px; background:olive; color:olive" border="1"
|-
|}
||color
|-
||{{l|Image:Angle_icon.png|16px}} Light Angle
||135.00 DEG
||angle
|-style="background:#eeeeee"
||{{l|Image:Real_icon.png|16px}} Depth of Bevel
||12.000000pt
||real
|-
||{{l|Image:Real_icon.png|16px}} Softness
||6.000000pt
||real
|-style="background:#eeeeee"
||{{l|Image:Bool_icon.png|16px}} Use Luma
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool
|-
||{{l|Image:Bool_icon.png|16px}} Solid
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool
|-style="background:#eeeeee"
|}

== Specific Parameters for Bevel Layers ==
Only particular parameters of the Bevel Layer are described here. The other parameters are common for other layers and are explained separately.

The Bevel Layer produces two effects over the context of the layer that are based on the Alpha channel of each pixel of the context. Imagine that the Bevel Layer traces light rays from the light source. When the ray line finds a transition from transparent to solid it creates a light region (Hi-color). When the ray finds a transition from solid to transparent it creates a shadow region (Lo-color). The Light Angle parameter determines the source of the light. The Depth of Bevel determines how wide is the region of light or shadow created and the Softness parameter produces a feathered light or shadow region instead of a sharp one. The feather type is determined by the Type parameter and can be one of the known {{l|Blur_Layer#Types|Blur Types}}.

[[File:Bevel1.png]]

=== Light Angle ===

Modifying the light angle changes the regions that are high lighted and darkened. It is an angle parameter and it is defined from the X positive axis counter clock wise.

=== Depth of Bevel ===
The Depth of Bevel parameter determines the width or expansion of the bevel on both sides (dark and light side). The bigger the parameter is the softer the produced bevel is.

=== Softness ===
Softness parameter controls how feathered is the bevel. Its type of feather is controlled by the Type parameter.

=== Use Luma ===
Please write me.

=== Solid ===
Please write me.

== Samples ==

Here you can find some visual examples of hos does the parameters affect to the bevel. Unless specified, all parameters are the default ones:

The Blend Method has been set to Onto in the following image

{{l|Image:Bevel-sample2.png}}

{{l|File:Bevel-sample1.sifz‎}}

Here you can see a sample usage of Solid and Use Luma parameters:

{{l|Image:Bevel-sample3.png}}

{{l|File:Bevel-sample2.sifz‎}}

One usage of Solid parameter combined with Hard Light Blend Method in the resulting bevel over the gradient.

{{l|Image:Bevel-solid-hardlight.png}}

{{l|File:Bevel-solid-hardlight.sifz}}

Amount Parameter

2016-10-15T18:29:22Z

D.j.a.y: template

{{Category|Parameters}}
{{NewTerminology}}
=Common use=
This parameter controls the layer visibility (it is more like an alpha value).

Example :
* '''0''' means the layer is invisible,
* '''1''' means the layer is visible.


{{SowHideLayerFade}}

=Specific cases=
==Rotate and Scale Layers==
This parameter control a rotation angle or a scale size.

Doc:How Do I

2016-10-15T18:25:44Z

D.j.a.y: /* Artwork Composition */ Template ShowHideLayer

{{Title|How Do I...}}
{{Category|Manual}}
{{Category|Tutorials}}
{{Category|Tutorials Basic}}
{{NewTerminology}}


Feel free to add your own questions here or {{l|Contact|contact}} us with them. Or put them on the {{l|Wiki Wish List}}.

__TOC__

=Graphic User Interface (gui)=

== Dock windows together? ==

*To dock (join) separate windows ({{l|Panel}} into one you must drag the tab ''icons'' (the {{l|Panel tab}}) for each of the tools into another window.
*You can create subdivisions inside the windows by dragging the Panel tab into the {{l|Placement Widget}}.
*Tool tabs inside the window can be arranged by dragging them on top of one another, therefore changing the order.

see also [[:Category:Interface|Interface]].

== Restore Default Layout ==

From {{l|Category:Edit Menu}}, open the {{l|Preferences_Dialog}} and use the {{l|Command:Restore_Defaults}}

=Artwork Composition=

== Insert some text? ==
Use the {{l|Text Tool}} or right click on your {{l|Canvas}} and choose {{c|<Layer>|<New>|Other|Text}} .

You can also create some text from your [http://en.wikipedia.org/wiki/Scalable_Vector_Graphics svg] software preferred editor ([http://inkscape.org inkscape] for example) , create some text and {{l|Doc:Svg2synfig|import it}} into synfig.


{{SowHideLayerFade}}

== "Rotate" a figure on herself==

To rotate a figure (composed of several {{l|Layers|layers}}), we will use the {{l|Rotate Layer}}.

* Start by {{l|Group Layer|group}} the layers of your figure to rotate.
* Then add a {{l|Rotate Layer}}, with the {{l|Handle|handle}} position (green), center the layer rotation in the middle of the object.
* Finally, group layer Rotate and the group of your figure.

[[File:Rotate1-layer.png|frame|none|Once grouped layers]]

The hierarchy of layers is implemented!

* To do the rotation, select the layer "rotate" created earlier and use the (blue) angle handle.
* To move the object (from left to right or up and down), use the primary group (the one at the top) with the handful of position.

[[File:Rotate-arrow.gif|frame|none|Example of the use of the "rotate" layer]]

== Fill an outline? ==
(Requested by {{l|User:Karlb|Karlb}})

Select the outline, choose {{Literal|Make Region}} command from the {{l|Canvas Layer Menu}}

Also, there are several other and manual options:
* One way is to link a new region layer to the outline's shape.
*# Select the outline you want to fill.
*# In the Parameters Panel, right-click the Vertices parameter, select "Export", enter a name for the shape, and hit return. This will export the shape of the outline, making it visible in the {{l|Library Panel}}.
*# In the Library panel, open the ValueBase Nodes tree and select the name you just saved the shape as.
*# From the {{l|Layer Menu}} (either context-click on the {{l|Layers Panel}} or use the {{l|Canvas Menu Caret}}) create a new {{l|Region Layer}} by selecting "New Layer -> Geometry -> Region". Ensure that the created layer is selected.
*# In the parameter dialog, right-click the Vertices parameter and click "Connect".
*# Now, if you don't need exported shape, you can unexport it: right click name of the shape in the Library panel and click "Unexport".
* Similar to the above, but using a different method:
*# Create a new region layer as above, and leave it selected.
*# Don't make any changes to the outline layer, which you want to fill! (see the Tier 5 on the {{l|Linking}} page for details).
*# Select both layers in the {{l|Layers Panel}} This will display only the parameters shared by both layers in the {{l|Parameters Panel}}.
*# Context-click on the {{l|Vertices Parameter}}, and select {{l|Linking|Link}}.
*# The {{l|Region Layer}} will snap to the shape of the {{l|Outline Layer}}.
* When you create an {{l|Outline Layer|outline}} with the {{l|Spline Tool|Spline Tool}} that you intend to be a filled area as well, make sure you select the Fill checkbox in the {{l|Spline Tool#Options|tool options dialog}}. Obviously, this doesn't help much if you realize later that you needed a fill here.
* If you are using the {{l|Draw Tool}}, there is a button at the bottom of the {{l|Draw Tool#Options|tool options dialog}} labeled {{l|Draw Tool#Buttons|"Fill Last Stroke"}}, which creates a new {{l|Region Layer}} and links its shape to the previously drawn outline. Unfortunately, it doesn't work as of Synfig Studio v0.61.04. It has been fixed in the current SVN version of the code.
* Create a {{l|Region Layer|region}} with the same number of handles, and manually link each handle. If you want a region that depends on multiple outline layers, this is really your only choice for now.
* Use the draw tool, select only the outline to fill, draw a stroke roughly following the outline and make sure you're holding the Control key when you left go of the mouse button at the end of the stroke. This doesn't work 100% right at the moment.

== Close a Spline? ==

* Right click on the starting point and then click on loop Spline.

Note: It doesn't work unless the initial point has a tangent - ie the first segment is curved. But you can hide tangent handles ({{l|Keyboard_Shortcuts|shortcut}} {{shortcut|Alt|3}}, or "Caret Menu > View > Show/Hide handles > Show tangent handles") and process as described. Don't forget to press ({{l|Keyboard_Shortcuts|shortcut}} {{shortcut|Alt|3}}) after that to show tangent handles again.

== Extend a Spline? ==

The {{l|Draw Tool}} has an option to {{literal|Extend}} a spline.

Also, you may be interest inserting an Item? . Right click on the spline segment you want to extend and choose {{literal|Insert Item - Smart}}. This will add an extra vector point to the line which is basically the same as "extending" it.

== Join two Spline? ==

For joining two splines together, place one endpoint above the other, select the end points of both splines ({{l|Keyboard_Shortcuts|shortcut}} {{shortcut|ctrl|leftclick}} , {{shortcut|cmd|leftclick}} on the mac, and draw a bounding box over the area to select both points), right click on one of them and choosing {{literal|Link}} in the menu. The two lines will be joined, but you also need to link the bezier handles of each endpoint. To do that, extend each bezier handle so they are visible, select both, right click one of them and choose {{literal|Link Opposite}}. Then right click on the orange spline point that the bezier handles are connected to and choose {{literal|Merge Tangents}}. Then the two lines will function as one line.

== Draw a rectangle with a given width and height? ==

I was asked on IRC how to specify the width and height of a rectangle, rather than having to specify the position of two opposite corners. Here's how:

* draw a rectangle
* go to the {{l|Parameters Panel}}
* right-click the 'point 1' parameter and {{l|Export}}
* give it a name, "p1" say
* right-click the 'point 2' parameter and {{l|Convert}} to {{l|Convert#Add|Add}}
* (that's saying that rather than specifying the absolute position of the other point, you want synfig to calculate it for you)
* (it will make 2 new sub-parameters for 'point 2', and the value used for point 2 will be their sum so we want to tell it to use 'point 1' and your (width,height))
* open up the sub-parameters of 'point 2' by clicking the triangle to its left
* go to the {{l|Library Panel}}, open up the values and select the one you exported earlier (p1)
* right-click the "LHS" parameter in the parameters dialog and {{l|Connect}} it
* then enter the width and height you want in the 'RHS' parameter

== Draw a rectangle with rounded corners ? ==

Draw a rectangle using the {{l|Rectangle Tool}}. Draw circle ({{l|Circle Tool}}) and use each corner point of the rectangle as the center. Select the rectangle, right click on it and select {{literal|Insert item and keep shape}} where the outline of the circle crosses the outline of the rectangle.

Then remove the cornerpoint (right click on {{l|Region Layer}}, select {{literal|Remove item, smart}})

''tip by darkspace65 from the [http://www.synfig.org/forums/viewtopic.php?f=11&t=9159 forum]''

== Make linked Spline vertices not affected by Rotate layer? ==
Look at the http://dooglus.rincevent.net/synfig/logs/2008/%23synfig-2008-02-07.log
See also: {{l|Convert}}.

== Create dashed outlines? ==

The {{l|Advanced Outline Layer}} has an option for dashed lines.

If you want to make simple dashed outlines manually the way is proceed like this:

* Create a Curve Gradient and an Outline over the same {{l|Spline|Spline}} using the {{l|Spline Tool|Spline Tool}} options. Check both Outline and Gradient at the {{l|Tool Options Panel}}.
* Raise up the gradient layer (it is created below the {{l|Outline Layer}}).
* Modify the gradient {{l|Blend Method}} parameter to be Straight Onto. That would render the gradient onto the outline width. Also it wouldn't render the outline, so transparent portions of the gradient are transparent.
* Check the 'Perpendicular' parameter of the Curve Gradient Layer.
* {{l|Convert}} the Gradient Parameter of the Curve Gradient Layer to be one of those types: Stripes or Repeat Gradient.
* Modify the properties of the sub parameters to achieve the desired effect.

You may be interested also in {{l|Doc:Brushes}}.

== Move an Image Layer Origin==
When images are {{l|Category:ImportArt|imported}}, the {{l|Import_Image_Layer|Image Layer}} is automatically grouped in a {{l|Switch Group Layer}} and with {{l|Group Transformation Widget}} you got an {{l|Origin Parameter}}.

If your image is not grouped, just do, and you will take advantage of {{l|Group Layer}} or {{l|Switch Group Layer}} parameters !

Also, to be exhaustive, yes, the {{l|Import_Image_Layer|Image Layer}} doesn't have an {{l|Origin Parameter}}, but (...often a but with synfig isn't it ?...) selecting both {{l|Handle|handles}} of the Image to move them together is similar of moving image origin. Nota, to select all the Image Layer handles, use the {{l|Keyboard_Shortcuts|shortcut}} {{shortcut|ctrl|a}} !

== Use an image as a fill color? ==

Make a new object (outline, region, squares, circles, polygons all work)
Import the image you want as the fill color, and put it on the layer underneath your object. Set the blend method of the image (using the {{l|Parameters Panel}}) to "onto" or "straight onto".
Group the object and the fill color image, otherwise everything below the image will have the same fill color.
Be sure to have a look at what the other composite options do as well.

=Import Artwork=

Check generic informations and all 'Import Artwork' related documentation page from the {{l|Category:ImportArt}} category.

== Use an external bitmap? ==

* From the main or {{l|Canvas_Menu_Caret|caret}} menu, choose {{c|<File>|Import}}. PNG with alpha channel works fine.
* To animate it without accidental stretching, right-click on the layer and choose {{literal|Group Layer}} action. Using the {{l|Group_Transformation_Widget}} you can then animate the {{l|Group_Layer}} instead of the {{l|Import_Image_Layer|Image Layer}}'s bounding box.

== Import filmstrip image ? ==

To import a series of images (TGA, etc) as frames of an animation, on a layer, use 'lst' files of a [[Doc:ListImporter|list of images]].
I've used this to develop a walk cycle. See {{l|Walk_Cycle|Walk cycle}} for an example.

== Use an external Vector? ==

Synfig doesn't yet support vector import because no-one has written an import process yet. You can use the Svg2synfig {{l|Converters|converter}}, or import it as a bitmap and trace over it in synfig. If you want to implement vector import we would gladly accept your patch.

== Import a movie into Synfig? ==

===Script (linux)===
{{l|File:Convert-movie-to-png-seq.sh|Convert-movie-to-png-seq}} : Nautilus (Gnome file manager) script which creates a png-sequence from a given movie file and creates a list-file which you can then import into Synfig. By rylleman , [http://synfig.org/forums/viewtopic.php?f=2&t=470&start=0&st=0&sk=t&sd=a Synfig forum thread] for more info.

See also : {{l|Doc:ListImporter}}
===Manually===
To import manually a movie into synfig there is only one option for the moment: Extract an image sequence and of sound file from the movie and import them using {{l|Doc:ListImporter}} and {{l|Sound_Layer}}.

Before you can load the image sequence you have to extract it from the movie. There are several software to do that but a straight and easy way is to use mplayer:

mplayer mymovie.avi -vo png:z=1 -ss seconds-start -endpos duration

where {{literal|seconds-start}} are the seconds where you want to extract form and {{literal|duration}} is the number of seconds you want to extract from {{literal|mymovie.avi}}. Also the image format specified in this case is {{literal|png}} but {{literal|jpeg}} or {{literal|tga}} can be used also. See [http://www.mplayerhq.hu/DOCS/man/en/mplayer.1.html mplayer manual page] for more info.

It would extract a set of files of the selected section of the movie. Each file takes the frame number padded with leading zeros as name.

Add a line specifying the frame rate at the beginning of the text file (if the movie was 25 fps):

echo FPS 25 > mymovie.lst

and put all the filenames into a {{literal|.lst}} file just type this in the folder where the files are:

ls *.png >> mymovie.lst

==== Audio ====

Extract audio of a movie and import them using {{l|Sound_Layer}}.

mplayer mymovie.avi -ao pcm:mymovie.wav -ss seconds-start -endpos duration

=Animate=

== Make objects go behind each other, without moving layers? ==

You'll notice each layer you make has a number in the {{literal|Z Depth}} column in the {{l|Layers Panel}}. Say you have 3 layers, they will be numbered 2 (lowest, e.g. a square) 1 (eg a circle) 0 (highest, the default, e.g. a line).

In order to make layer 1, the circle, pass behind layer 2, the square, in the {{l|Parameters Panel}}, change its {{literal|Z Depth}} to be 3 or more. The {{literal|Z Depth}} of the circle needs to be greater than 2 in order to be behind the square. To make the square on top of everything, you'd change its {{literal|Z Depth}} to -1 or less.

Positive numbers on the z axis go into the screen, and negative numbers go out of the screen, towards the viewer.

It is possible to animate this effect, but each layer is discrete. They seem to go from lower than '''-9999''' to more than '''9999'''.

In addition, objects in {{l|Group_Layer|grouped layers}} can only go behind other objects in the same grouped layer. However an grouped layer can go behind another grouped layer.

Check additional informations in {{l|Z Depth Parameter}} page.

== Use a boolean parameter to hide a layer ?==

You can use set the [[Amount Parameter|amount]]'s layer parameter to [[Constant]] [[Waypoint#Interpolation|Interpolation]].

Or you can convert the [[Amount Parameter]] to a [[Convert#Switch|Switch]] value and give '''0''' and '''1''' to the Linked OFF/ON values.

== How do I transform grouped objects? ==

* Right click on the Grouped object in the Layer dialog and choose "select all child layers". Then you select the handles you want to transform (usually just all of them, like for rotating the object), and the rotate or scale tool and do the work.

== Copy a complex convert combination between parameters of different layers? ==

For example: you want to copy a complicated {{l|Convert|conversion}} type that you have in one parameter from a layer, to other parameter (maybe not a root parameter, but a sub-parameter) of other layer. If you {{l|Export|export}} the complicated conversion type from the original layer and then go to the other layer and select {{l|Connect}} (right click and the exported and the parameter both selected) then you have the parameter form the second layer to be exactly the same than the original one. But there is a drawback: if you modify one of the sub-parameters in the complicated conversion type (e.g. you change the value of one of them) then automatically the same sub-parameter of the other layer is changed.

How can you copy the conversion but allow modify the sub-parameters independently on each layer?

Once you have achieved the complex conversion type in the original layer, don't export the root parameter! If you have done yet {{l|Export|unexport}} it. (Why?. You will understand it later.) Now duplicate the original layer. Then you should obtain the same layer with the same conversion type placed at the same parameter (but not exported). NOW export the parameter from the duplicated layer. Then go to the (sub) parameter of the layer where you want to copy the complex conversion type and Connect it to the just exported parameter form the duplicated layer. Now delete the duplicated layer (!). Then the exported {{l|ValueNode}} still undeleted and the layer where you wanted to copy the complex convert type have a (sub) parameter connected to it. You can {{l|Export|unexport}} the ValueNode or not. It is up to you. But notice that the conversion type is already copied into other (sub) parameter of other layer and they are independent as well as you can change one of them (by modifying the sub-parameters) and the other remains untouched.

== Make an existing animation run at half speed? ==

If you have an animation that runs from 0s to 10s and you want it to run at half speed from 0s to 20s, how can you do that?

* Either: group it, and use the 'time offset' parameter in the group layer to slow it down:
** Right-click 'time offset' in the group layer, convert>linear, rate -0.5 offset 0. That means offset the time by -0.5 seconds per second - or in other words, run at half speed
** Or, putting waypoints on the 'time offset' param would work too: 0 at 0s and -10 at 20s. (The choice between using a linear convert and valuenodes is entirely up to you. They both achieve the same result in this simple case).

* Or: use a {{l|Time Loop Layer}}. The first method seems better and more intuitive in this case, but there are ways of getting the same effect from the Time Loop layer. Perhaps the Time Loop layer is better if the animation doesn't run from 0s, but from some other time. Anyway: put a Time Loop layer over the layers you wish to slow down, and:
** Either: set duration to 0, local time to 0, convert->linear the link time and set rate to 0.5 - this slows the animation down *to* 50% of its original speed; use bigger rates to slow it down less
** Or: set duration to 1h (*), link time to 0, convert->linear the local time and set rate to 0.5 - this slows the animation down *by* 50%; use bigger rates to slow it down more
(*) if your animation is longer than 1h then set this parameter to EOT (End Of Time) what is the same as Infinite (INF) for a real number but for a time parameter.

== Flip when no possible with {{l|Mirror Tool}}==

The more secure way to achieve that on complex compositions is to place a {{l|Stretch Layer}} onto the composition and set its {{literal|Amount}} value to this:

* Amount = (1, 1) does nothing
* Amount = (1, -1) mirror by x axis
* Amount = (-1, 1) mirror by y axis
* Amount = (-1, -1) mirror by x and y axis

Maybe you will need also to take a look at {{l|Doc:How_Do_I#How do I transform grouped objects?|How do I transform grouped objects?}}

(Note: if you have pixels as Synfig {{l|Unit_System|system units}} you have to remember that 1 Synfig unit is equal to 60 pixels by default)

== Create Custom switch controllers ==
[[File:CustomSwitchControler.png]]
* Make a 12 point red star.
* On top of the red star make a yellow 3 point star.
* Select the yellow star and grey out the "Origin", "Inner Radius" and "Outer Radiu"s points (right click on the points and convert them to "Greyed").
* Leave the blue "Angle" point as it is.

* Select the group that contains the drawings to be switched (in the attached example it is the hands folder). Note, that this can be an external imported file, which adds a possibility to use library of hands!
* In the parameters panel enable "Z-Range" checkbox.
* Right-click on "Z-Range Position" and convert it to "Integer".
* Click the little triangle next to "Z-Range Position" to open it and right click on "Link" and export the value and name it "switch-pos" or whatever.

* Select the yellow star.
* In the Parameters Panel right click on "Angle" and convert it to "Scale".
* Click on the little triangle next to "Angl"e to open it and convert the link to "Integer" and change the amount in "Scalar" to "30".
* Click on the little triangle next to "Link" to open it and connect the second link to the exported "switch-pos" value.

* Your switch controller is now active. Rotate the controller to change the hand shapes in the hands folder.
And here’s the sample file: [[File:CustomSwitchControler.sifz]]

(Originaly writen by [[https://plus.google.com/u/0/100974854123198382898 Dirk Baeten]])

See also : https://youtu.be/_uRFFOqkwEw

=Render=

== Render to AVI with higher quality? ==

=== Using raw video ===
The module used by Synfig to render AVI files is ffmpeg. For the moment there is not interface to control ffmpeg options so you render with a fixed bitrate and quality. If you want the maximum quality in your AVI file, follow these steps:

* Render your animation to yuv420p format. To do that select that target at the drop down list of the render dialog and add the ".yuv" extension to your animation name (without quotes).
* Once rendered (it would produce a huge size yuv file) you can quickly convert it to AVI using this command:

ffmpeg -i animation.yuv -sameq animation.avi

Change the animation file name to your one.

=== Rendering through a .png sequence. ===
Render your sif to png sequence
mkdir render
synfig my_animation.sifz -o render/frame.png
Then convert it to movie with ffmpeg
ffmpeg -r <frame rate> -i render/frame.%04d.png <more settings from ffmpeg's manual> my_animation.mp4

=== Possible settings for ffmpeg ===
Possible settings for converting the png sequence from synfig into a video using ffmpeg, from the [http://www.ffmpeg.org/ffmpeg-doc.html ffmpeg manual], are
* for a low quality flv file (eg: for streaming from low bandwidth server)
ffmpeg -r <frame rate> -i render/frame.%04d.png -f flv my_animation.flv
* for a high quality flv file (2 pass encoding, eg: to be uploaded on youtube)
ffmpeg -r <frame rate> -i render/frame.%04d.png -f flv -b 2M -s y -pass 1 -passlogfile log_file video.flv
ffmpeg -r <frame rate> -i render/frame.%04d.png -f flv -b 2M -s y -pass 2 -passlogfile log_file video.flv
flvtool2 -UP video.flv
* for mid quality H264 mp4 file (try to change CRF from 15 -high quality- to 25 -generally satisfactory for animations-). H264 codec requires both width and height of source frames to be multiples of 16.
ffmpeg -r <frame rate> -i render/frame.%04d.png -crf 25 -vcodec libx264 -vpre hq my_animation.mp4
* for high quality H264 mp4 file (2 pass encoding)
ffmpeg -y -r <frame rate> -i render/frame.%04d.png -r 30000/1001 -b 2M -bt 4M -vcodec libx264 -pass 1 -vpre fastfirstpass -an my_animation.mp4
ffmpeg -r <frame rate> -i render/frame.%04d.png -crf 25 -vcodec libx264 -vpre hq my_animation.mp4
* replace the second pass above with the following to include an AAC audio stream
ffmpeg -i <audio file> -r <frame rate> -i render/frame.%04d.png -crf 25 -vcodec libx264 -vpre hq -acodec libfaac -ac 2 -ar 48000 -ab 192k my_animation.mp4

If you need nice open source format without any tweaks you may try ffmpeg2theora:
ffmpeg2theora render/frame.%04d.png --inputfps <frame rate> -o my_animation.ogg
png takes less disk space then yuv.
--{{l|User:AkhIL|AkhIL}} 21:38, 9 April 2008 (EDT)

If you want you can also use [http://www.mplayerhq.hu/ mplayer].

mencoder mf://render/frame.*.png -mf fps=25 -o my_animation.avi -ovc lavc -lavcopts vcodec=mpeg4

== Render an animation with transparent (alpha) background ? ==

===Synfig's Extract alpha way===
You can create final and [http://en.wikipedia.org/wiki/Alpha_compositing alpha mask] video in one time '''direclty from synfig'''.

* SynfigStudio (gui) : From the {{l|Render dialog}} check {{Literal|Extract alpha}},
* Synfig (cli) : From the {{l|Doc:Synfig_CLI_Syntax|command line interface (CLI)}} use {{Literal|--extract-alpha}} option.

{{Template:RenderOptionExtractAlpha}}

===PNG images sequence way===
You also can {{l|Render_options|render}} has {{Literal|[https://en.wikipedia.org/wiki/Portable_Network_Graphics PNG]}}.

That will produce a {{Literal|[https://en.wikipedia.org/wiki/Lossless_compression lossless]}} quality image sequence, then import this image sequence in your preferred video editor to compose the video.

You can also import the PNG image sequence in a video editor that supports video alpha channel (like [http://blender.org Blender]) to export it has video + alpha.

=Others=

==Increase performance by optimizing during compilation time? ==

I would like to know what parameters do I need to apply to configure to improve performance. {{l|User:Genete|Genete}} 11:04, 9 April 2008 (EDT)

To optimize program you should set two environment variables
export CFLAGS=""
export CXXFLAGS="${CFLAGS}"

First flag will be "-O3" (ow three). "-02" is normal optimization. "-03" is hard optimization.

Now you should get info about your CPU
cat /proc/cpuinfo

find your cpu model name

now go to man gcc and search "-mtune"

find your cpu and add "-mtune=your-cpu -march=your-cpu" to CFLAGS.

Then look at flags from /proc/cpuinfo and search it in gcc manual
For example I have 3dnow. So I can find "-m3dnow". For sse I can find "-msse" and "-mfpmath=sse" (can make program unstable).

Finaly you may add "-ffast-math" to disable math checks. But it can make program unstable.

For my AthlonXP I'm using this flags:
export CFLAGS="-O3 -pipe -mtune=athlon-xp -march=athlon-xp -mmmx -msse -m3dnow -mfpmath=sse -ffast-math -funsigned-char -fno-strict-aliasing"
export CXXFLAGS="${CFLAGS}"
--{{l|User:AkhIL|AkhIL}} 12:05, 9 April 2008 (EDT)

For my Pentium3 i use the line:
export CFLAGS="-O3 -pipe -mtune=pentium3 -march=pentium3 -msse -mfpmath=sse -funsigned-char -fno-strict-aliasing"
export CXXFLAGS="${CFLAGS}"

The additional switches -mmmx and -ffast-math does seem to '''not''' yield any gain in computing performance! So you could leave them out.
--{{l|User:SvH|SvH}} 03:46, 20 May 2008 (EDT)

== Unpacking sifz-files ==

Synfigs file format sifz is a packed sif [https://en.wikipedia.org/wiki/XML xml-file] which can be edited in a text editor and eventually fix each section easily. You cannot however directly unpack the sifz file.

Rename the file with the extension .sif.gz and you'll be able to unpack it.

# Rename your file from {{literal|myfile.sifz}} to {{literal|myfile.sif.gz}}. The extension {{literal|gz}} tells to the OS that it is a compressed file.
# Now use your convenient application to uncompress the file to {{literal|myfile.sif}}. Unrar for windows will do the job.
# Then you can edit it on a text editor. (Notepad++ is excellent for that)

== Fix a not well formed document ==

Good to know you had a backup. If something like this happens again you can try to fix it manually with the following instructions:

# SIFZ format is just a gzipped XML file, so rename the file to .sif.gz.
# {{l|Doc:How_Do_I#Unpacking sifz-files|Extract it}}.
# You'll see a .sif file, open it with any XML editor (a text editor with [https://en.wikipedia.org/wiki/Syntax_highlighting Syntax highlighting] capacities (see also [https://en.wikipedia.org/wiki/Comparison_of_text_editors Comparison of text editors]))
# Find a problem line (Synfig will tell you the line number).
# Fix the problem. Usually, it isn't hard, because XML is pretty human-readable so look for some trash in values, extremely big/low parameters, messed tags, etc.
# Save file.
# Open with Synfig and if everything is OK save it back as .sifz.

== Granted Wishes ==

=== General outline / Polygon-based Outline / "Set Tangents to Zero" button ===
(3.5) I'm no artist, thus my primary form of art is stick figures, not to mention, many interesting animations are done in stick-figure style. Stick figures must be perfectly straight to get the effect across, so when I'm making an outline using B-Curves, it is too time consuming to set the tangents to 0 each time. Similarly, outlines of other shapes like squares, circles and so forth would be very useful. Whichever of the above is easiest, please implement right away. --{{l|User:Dragontamer|Dragontamer}} 02:35, 19 November 2007 (EST)
: For perfectly straight lines, click without moving the mouse. You will get a single point with no tangents. Outline shapes would require some development, particularly with some thought given to backward compatibility. A workaround you might consider is to create a duplicate shape with a different color and make the top one slightly smaller, so the outline of the one below shows. {{l|User:Pxegeek|Pxegeek}} 21:58, 19 November 2007 (EST)
:: Well, in general, whenever I click on a point to edit it (say, to make it move somewhere in animation mode), there is a decent chance that I click on a tangent instead. Then, if I want to right click the point itself, I usually right click the tangent marker instead. It isn't that big a deal, but simplicity at the cost of power generally is a good thing, especially when it will save a few mouse clicks.
:: As for the outlines, yeah, I've tried that and it is a decent solution for now, although it is no replacement for a real outline. I am going to also experiment with a clamp to see if I can make the center of the shape have 100% alpha... but I don't have synfig on the computer I'm on right now. Thanks for the tips Pxegeek. --{{l|User:Dragontamer|Dragontamer}} 01:58, 27 November 2007 (EST)
::: You can press Alt+3 to hide tangent handles. --{{l|User:Zelgadis|Zelgadis}} 09:27, 27 November 2007 (EST)

What to do when I've made a mistake and added tangents to a point wich had none initially ? How can I "remove" tangents ? The only way I see is to go to the "param" panel, look for the correct tangent, and manually enter a zero value for its lengh.--[[User:Grondilu|Grondilu]] 22:34, 13 April 2010 (UTC)

=== Recursive Waypoint Manipulation ===

(4) it is really tiresome to revert changes to waypoints created by manipulating tangent/position handles or change their interpolation functions. making it possible to right-click-modify the waypoint shown for objects that have some waypoint in a referenced sub-object would be great! -- timonator 2007-06-01
:You can do it in two ways: changing the interpolation method of the waypoint of group layer or editing the keyframe properties. The first allow to modify the waypoints interpolation method for all the waypoints of all the parameters of all the layers that are inside the group layer layer. You can right click on the left or right part of the waypoint to edit by a context menu the left or the right interpolation method of the waipoints. The second method would add and modify all the parameters that have any waypoint in the animation. See {{l|Keyframe}} for more detail. --{{l|User:Genete|Genete}} 13:10, 29 October 2007 (EDT)

=== Tweening for images developed in other imaging programs ===

It's obvious I am a beginner at image movement, but morphing is not enough: movement across the page is needed. Thanks for listening. {{l|User:Comwell@bellsouth.net|Comwell}} 
Imported images can be moved across the page. They can also be scaled, rotated and deformed. Was there a specific example you had in mind? {{l|User:Pxegeek|pxegeek}} 
:I also would like a way to tween images that have been drawn in other programs. I've had trouble drawing with Spline tool and the drawing tool in Synfig, and I'd rather just draw with a paint brush (like the one in Photoshop). Another problem I have is that Synfig tends to shut down on me every 20 minutes or so, and it's really frustrating even with the auto recover feature, because my sketches disappear. It'd be nice if I'm able to draw all of the keyframes in Photoshop or another image program and import it to Synfig so that Synfig can tween and animate them. Thank you. {{l|User:xychefoo@gmail.com|Huina}}
::You CAN use images, drawn in other programs. Just select "File->Import" from {{l|Canvas Menu Caret|canvas menu}} --{{l|User:Zelgadis|Zelgadis}} 01:39, 24 November 2007 (EST)
:::But how do you animate using images from other sources? I tried to make 2 keyframes with 2 different images, and it doesn't animate. It just stays as 1 picture for the entire render. The closest thing I saw to importing images from another source into Synfig and having it animate is the Walking Cycle Tutorial, but I would still have to trace the images to make it animate. As I said earlier, I'm not entirely fond of using the draw/Spline tool. {{l|User:xychefoo@gmail.com|Huina}}
:::: Huina, there's no way to do what you want right now. Interpolating between two images that are not created in Synfig is well beyond its scope right now. However, what you could do is take an image and separate elements of the picture onto different layers (e.g. have a picture of an arm and another of the rest of the body) and you can move those around, stretch and rotate them. (If you're familiar with the work of Terry Gilliam on Monty Python you'll know what I mean) I don't know how feasible it is to implement your request (I suspect some heavy lifting). We'll keep it on the list, but don't hold your breath. {{l|User:Pxegeek|Pxegeek}} 19:57, 24 November 2007 (EST)

:::: I think, you hardly find any other animation package which allow you to do such things. You could use a special tools for this task, like xmorph (http://xmorph.sourceforge.net/). But to do the tween between two bitmap images you STILL need to set points. It's not tracing, but very similar. Anyway, result may be poor and I'd better suggest to use technique, described in Walking Cycle Tutorial or which the {{l|User:Pxegeek|Pxegeek}} meant. --{{l|User:Zelgadis|Zelgadis}} 02:08, 25 November 2007 (EST)

:::: There is a technique called "optical flow". It takes two input frames and calculates the movement of each individual pixel between the frames, allowing interpolation to be done. Here's an example: http://www.fxguide.com/article333.html. It doesn't require setting of control points, but it has problems it's own set of problems: http://www.fxguide.com/article333.html. --{{l|User:Yoyobuae|Yoyobuae}} 13:32, 3 February 2008 (EST)

=== Auto-link option in {{l|Draw Tool}} ===

(4) so that you can draw a line, and have its endpoint automatically link to a handle - or if Auto-connect is off, you can get a line object linked to the end of another line object. / I missed this too, it even should be like that by default I think. {{l|User:Maxy|Maxy}} 13:22, 25 Apr 2006 (PDT)

: Isn't this done already? We don't have line objects, but Splines are automatically linked to if auto-connect is on. Am I missing something? -- {{l|User:Dooglus|dooglus}} 17:29, 27 September 2007 (EDT)

::To clarify dooglus' comments - If you have an outline created by the draw tool highlighted in the layer dialog and the auto-extend checkbox is checked, then you can continue drawing with the draw tool in that same layer. Splines created with the Spline tool cannot be extended once a different tool or layer is selected. {{l|User:Pxegeek|Pxegeek}} 23:46, 12 October 2007 (EDT)

::: A line is a line - Synfig doesn't remember whether it was created with the Spline tool or the Draw tool - so you can extend Splines created with the Spline tool using the draw tool. Just make sure the line is selected (so that its handles are visible), not looped (so that it has end points to extend from), enable the draw tool, check 'auto extend' and start drawing at one of its end handles. {{l|User:Dooglus|dooglus}} 05:47, 13 October 2007 (EDT)

So this sounds like it is already done. But on a related note, being able to open an existing Spline in the Spline tool to extend it would be useful. -- {{l|User:Dooglus|dooglus}} 04:51, 29 January 2008 (EST)

=== Character Animation Tools ===

<strike>I have seen some interesting methods for helping character design/animation in different 2d/3d software. Hash's animation master has 'poses' which are extremes of a model, for example smiling and frowning, once you add these extremes ot a set you can use slider to create a pose that somewhere inbetween. The real power of this is when you have serveral different poses on the same object, a face say, you can easily come up with new facial expressions. Maybe something similar could be done with synfig using layers and sets, the implementation could something similar to Moho's switch layers. --{{l|User:Triclops|Triclops}} 09:52, 9 Aug 2006 (PDT)
: Have you read this tutorial? {{l|Reuse Animations}}. It is very close to the Switch layer of Moho/Anime Studio. Also You can change the Canvas parameter to any other canvas dynamically in the time line by clicking on it and selecting other exported canvas. Other option is convert the canvas to a Switch type and alternate between two different canvas. --{{l|User:Genete|Genete}} 13:26, 29 October 2007 (EDT)</strike>

Fixed by {{l|Switch Group Layer}}

===Remove the thin line from stitched regions===
When you stitch or {{l|Sewing_Splines|sew two regions together}} with the same color (or different even?) it can appear a thin line in the common edge that reveals the background color (see the problem {{l|Sewing_Splines#Removing_thin_line_bug|here}}). This is due to that the antialiasing effect is keeping the background pixels information and displays it on the region. To solve this issue it is needed to:
:1) Uncheck all the antialias parameter of all the regions involved
:2) Add a Supersample Layer over the layers that has the antialiasing parameter disabled. A value of 4 for the height and width values is usually enough. Maybe you need to check "Alpha Safe" for better results.
:3) Render normally.
This tip is particularly useful when you want to have a region over and under other composition at the same time.
{|
|'''SAMPLE SHOWING THE THIN LINE'''
|''' REMOVED THIN LINE AFTER SUPER SAMPLE'''
|-
|{{l|Image: planet-saturn2.png}}
|{{l|Image: planet-saturn2ss.png}}
|}

It has the draw back that intermediate layers has to be super sampled too (line the planet in the example) because the super sample has to be done at the same time to the involved regions (the back and top half rings).

Template:SowHideLayerFade

2016-10-15T18:25:10Z

D.j.a.y: creation from HOWDOI

== Show or hide a layer, or fade the effect of a blur? ==
In the {{l|Parameters Panel}}, look for an option labeled {{l|Amount Parameter|Amount}} - this controls how much of the blended result of the layer is composited with the blend of the layers beneath it.

In other words, for a typical layer, this will 'fade it out'. For a {{l|Blur Layer}} set to "{{l|Blend Method#Straight|Straight}}", this will fade ''between'' the blurred version and the unblurred version of the canvas. If you want it to become less blurry, adjust the {{l|Blur Layer#Size|Blur Layer's 'size' parameter}}.

If you want to affect multiple layers at the same time, you have several options :
* You can {{l|Group_Layer|Group}} your layers and use the group's {{l|Amount Parameter}},
* {{l|Export}} one of the layers {{l|Amount Parameter}} and {{l|Linking|link}} others layer's {{l|Amount Parameter|Amount}},
* {{l|Linking}} all layer's {{l|Amount Parameter|Amount}}. Select the layers you want to affect in the {{l|Layers Panel}}, right click to {{l|Amount Parameter|Amount}} in the {{l|Parameters Panel}} and choose {{Literal|Link}}.

New Layer Defaults

2016-10-10T10:45:51Z

D.j.a.y: sumarry

{{Title|New Layer Defaults}}
{{Category|Toolbox}}
{{NewTerminology}}
{{TOCright}}

==Summary==
{{l|New Layer Defaults}} aim to group all settings that influence a new {{l|Layer}} that can be created from the {{l|Category:Layer_Menu#New_Layer_Menu|New Layer}} menu entry or using a {{l|Category:Tools|tool}}.

Some defaults settings can be set from the {{l|Toolbox}}. Others defaults settings are set by tools from the {{l|Tool Options Panel}} or from the {{l|Category:Canvas_Window}}.
==Brush Colors==
[[File:FlowerTutorial 0.png|right|frame]]This section of the palette contains two large overlapping squares - the one in front is the {{Literal|Outline Color}} (previously called foreground color), the one in back is the {{Literal|Fill Color}} (previously called background color). When you are creating a layer of only one color, the {{Literal|Outline Color}} is always used. When you create a {{l|Region Layer|region}} and an {{l|Outline Layer|outline}} simultaneously, the region is given the {{Literal|Fill Color}}. The {{l|#Current Gradient|current gradient}} fill defaults to dynamically between these two colors. Clicking either will bring up the {{l|Colors Dialog}} to select a new color.

In addition to these two controls, there are two smaller controls located in the corners between them.

The '''arrows''' on the upper-right side swap the outline and fill colors. {{l|Image:swap_colors_icon.png|16px}}

The two little squares on the lower left reverts the outline and fill colors to their default of black and white respectively.

==Brush Size==
* If you are using the {{l|Draw_Tool}}, this sets the maximum size that the line will be based on pressure sensitivity (on graphic tablet).
* Adjust the size of the {{l|Brush_Tool}}
The size of {{l|Outline Layer|Outline Layers}}'s line is set in the {{l|Tool_Options_Panel}}

==Default Blend Method==
The {{l|Blend Method}} is set from the {{l|Tool_Options_Panel}}. It's a by tool preference.

==Default Opacity==
Sets the {{l|Amount Parameter}} for new layers. Defaults to 1.00 (Completely opaque)
The Opacity is set from the {{l|Tool Options Panel}}. It's a by tool preference.

==Current Gradient==
Used by the {{l|Spline Tool}} when creating a new {{l|Curve Gradient Layer|Curve Gradient}} layer. Also used by all {{l|Gradient Layer Category|Gradient layers}} as their fill. This defaults to a gradient between the {{Literal|Outline Color}} (previously foreground color) and {{Literal|Fill Color}} (previously background color). Clicking this will bring up the {{l|Gradient Editor Dialog}}

==Default Interpolation==
Sets the default {{l|Waypoints#Interpolation|interpolation}} of new waypoints. Initially this is set to {{l|Clamped}}.

The Default Interpolation is set into the {{l|Category:Canvas_Window}}

New Layer Defaults

2016-10-10T10:32:50Z

D.j.a.y: /* Brush Colors */ image (from flower tutorial)

{{Title|New Layer Defaults}}
{{Category|Toolbox}}
{{NewTerminology}}
Some defaults settings can be set from the {{l|Toolbox}}. Others defaults settings are set by tools from the {{l|Tool Options Panel}}.
==Brush Colors==
[[File:FlowerTutorial 0.png|right|frame]]This section of the palette contains two large overlapping squares - the one in front is the {{Literal|Outline Color}} (previously called foreground color), the one in back is the {{Literal|Fill Color}} (previously called background color). When you are creating a layer of only one color, the {{Literal|Outline Color}} is always used. When you create a {{l|Region Layer|region}} and an {{l|Outline Layer|outline}} simultaneously, the region is given the {{Literal|Fill Color}}. The {{l|#Current Gradient|current gradient}} fill defaults to dynamically between these two colors. Clicking either will bring up the {{l|Colors Dialog}} to select a new color.

In addition to these two controls, there are two smaller controls located in the corners between them.

The '''arrows''' on the upper-right side swap the outline and fill colors. {{l|Image:swap_colors_icon.png|16px}}

The two little squares on the lower left reverts the outline and fill colors to their default of black and white respectively.

==Brush Size==
* If you are using the {{l|Draw_Tool}}, this sets the maximum size that the line will be based on pressure sensitivity (on graphic tablet).
* Adjust the size of the {{l|Brush_Tool}}
The size of {{l|Outline Layer|Outline Layers}}'s line is set in the {{l|Tool_Options_Panel}}

==Default Blend Method==
The {{l|Blend Method}} is set from the {{l|Tool_Options_Panel}}. It's a by tool preference.

==Default Opacity==
Sets the {{l|Amount Parameter}} for new layers. Defaults to 1.00 (Completely opaque)
The Opacity is set from the {{l|Tool Options Panel}}. It's a by tool preference.

==Current Gradient==
Used by the {{l|Spline Tool}} when creating a new {{l|Curve Gradient Layer|Curve Gradient}} layer. Also used by all {{l|Gradient Layer Category|Gradient layers}} as their fill. This defaults to a gradient between the {{Literal|Outline Color}} (previously foreground color) and {{Literal|Fill Color}} (previously background color). Clicking this will bring up the {{l|Gradient Editor Dialog}}

==Default Interpolation==
Sets the default {{l|Waypoints#Interpolation|interpolation}} of new waypoints. Initially this is set to {{l|Clamped}}.

The Default Interpolation is set into the {{l|Category:Canvas_Window}}

Advanced Outline Layer

2016-10-10T10:28:38Z

D.j.a.y: fix span

{{Title|Advanced Outline Layer}}
{{Category|Layers}}
{{Category|Primitive Layers}}
{{NewTerminology}}
{{TOCright}}

Under construction! See {{l|Talk:Advanced_Outline_Layer|Advanced Outline Layer Talk}} page
[[Image:Layer_geometry_advanced_outline_icon.png|64px]]

== About Advanced Outline Layers ==

To create an Advanced Outline Layer use the Spline Tool and check {{literal|Create Advanced Outline}} in the {{l|Tool Options Panel}}. Once you finish the definition of the geometry of your outline and after pressing the {{literal|Make Spline}} button (or selecting another tool or state) you create the Advanced Outline Layer with the {{l|New_Layer_Defaults#Brush_Colors|current}} {{literal|Outline Color}}.

Depending on the options you choose in the {{l|Tool Options Panel}} other {{l|Category:Tools|Tools}} like {{l|Star Tool}} or {{l|Circle Tool}} can also create Advanced Outline Layers.

Using the {{l|Canvas Layer Menu|Layer Menu}} {{Literal|Make Advanced Outline}}, {{Literal|Make Outline}} or {{Literal|Make Region}} commands you can also create those layers.

=== Differences with Outline Layer: Outline width ===

The '''width''' [[Handle]] define the outline width at particular place.

In the regular [[Outline Layer]], each width Handle is connected to the vertex that defines the outline shape at that place. That means that the user needs to insert a new vertex on the [[Spline]] every time he wants to change the outline width in some place. This behaviour can cause problems when the shape of the outline is very simple but the width varies a lot.

Practice shows that most of the time the user wants to specify the width independently from the placement of [[Spline]] vertices. Such functionality is available in the Advanced Outline layer, which Handles its width in a different way: the width Handles are freely moved around the Spline and define its width at any point.

== Features ==

Advanced Outline introduces some features to the regular outline, as shown in this [http://www.youtube.com/watch?v=boM_ZC9VZ54 Advanced outline demo] video. They are listed with examples below:

<gallery widths="490px" heights="300px" perrow="2">
File:Variable-width-without-blinepoints.png | No need to place vertex to change the width
File:Lots-of-blinepoints-width-just-two width-controls.png | Width controlled just by two points, while the Spline constructed of many vertices
File:Different-types of tips.png | Different types of tips : Rounded, Squared, Peak, Flat.
File: Segments of outlines.png | Segmented outline
File:Different cusps types.png | Three global cusps types : Sharp, Rounded, Bevel.
File:Smoothness control.png | Control of smoothness from linear (0.0) to smooth (1.0)
</gallery>

==Parameters of Advanced Outline Layers==

The parameters of the Advanced Outline Layers are:

{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:silver"
|'''Name'''||'''Value'''||'''Type'''
|-
||[[Image:Type_real_icon.png|16px]] [[Z Depth Parameter|Z Depth]]
||0.000000
||real

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Amount Parameter|Amount]]
||1.000000
||real

|-
||[[Image:type_integer_icon.png|16px]] [[Blend Method|Blend Method]]
||Composite
||integer

|-style="background:#eeeeee"
||[[Image:Type_color_icon.png|16px]] [[Colors Dialog|Color]]
||
{| style="width:95%; height:16px; background:black; color:black" border="1"
|-
|}
||color

|-style="background:#"
||[[Image:Type_vector_icon.png|16px]] [[Origin Parameter|Origin]]
||0.000000u,0.000000u
||vector

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Invert Parameter|Invert]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Antialiasing Parameter|Antialiasing]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Feather Parameter|Feather]]
||0.000000pt
||real

|-
||[[Image:Type_integer_icon.png|16px]] [[Feather_Parameter#Type_of_Feather|Type of Feather]]
||Fast Gaussian Blur
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Winding Style Parameter|Winding Style]]
||Non Zero
||integer

|-
||[[Image:Type_list_icon.png|16px]] Vertices
||List
||list (Spline)

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Outline_width|Outline Width]]
||2.000000pt
||real

|-
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Expand|Expand]]
||0.000000pt
||real

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at Start]]
||Rounded Stop
||integer

|-
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at End]]
||Rounded Stop
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Cusps_Type|Cusps Type]]
||Sharp
||integer

|-
||[[Image:Type_real_icon.png|16px]] [[Advanced_Outline_Layer#Smoothness|Smoothness]]
||0.500000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_bool_icon.png|16px}} [[Advanced_Outline_Layer#Homogeneous|Homogeneous]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_list_icon.png|16px]] [[Advanced_Outline_Layer#Width_Point_List|Width Point List]]
||List
||list(WPList)

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Fast|Fast]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Dashed_Outline|Dashed Outline]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_list_icon.png|16px]] Dash Item List
||List
||list(WPList)

|-
||[[Image:Type_real_icon.png|16px]] Dash Items Offset
||0.000000u
||real

|}

==Specific parameters for Advanced Outline Layer==

This section lists only the parameters specific to the Advanced Outline Layer. For documentation about the other parameters, refer to [[Outline Layer]].

* Tip Type at start
* Tip Type at end
* Cusps type
* Smoothness
* Width Point List

=== Tip type at start / end ===

As with width points, the end and start of the unlooped Advanced Outlines has a type of tip defined. The user can choose between the same types of tips as for a width point. When the first/last width point has its before/after interpolation type set to Interpolate the start/end of the outline is rendered using the Tip type at start/end parameter.

Those parameters don't have any effect if the Spline is looped or the first/last width point has its before/after interpolation type set to anything but Interpolate. In that case, the segment between the start/end width point and the start/end of the Spline is not rendered.

The types of tips are the same as the width point tip types except that it doesn't offer the Interpolate type because it would not make sense:

Parameters:
{| border="1"
|-
! Tip Type
! Example
|-
| Rounded
| [[File:Avanced-Outline-Layer-TipType-Rounded.png]]
|-
| Squared
| [[File:Avanced-Outline-Layer-TipType-Squared.png]]
|-
| Peak
| [[File:Avanced-Outline-Layer-TipType-Peak.png]]
|-
| Flat
| [[File:Avanced-Outline-Layer-TipType-Flat.png]]
|}

=== Cusps type ===

There are three types of cusps in the Advanced Outline:

Parameters:
{| border="1"
|-
! Cusp Type
! Example
|-
| Sharp
|[[File:Avanced-Outline-Layer-Cups-Sharp.png]]
|-
| Rounded
| [[File:Avanced-Outline-Layer-Cups-Rounded.png]]
|-
| Bevel
| [[File:Avanced-Outline-Layer-Cups-Bevel.png]]
|}

The type of cusp is controlled for the entire layer so currently it is not possible to control the type of corner individually. Maybe in future versions it will be possible.

=== Smoothness ===

The Smoothness controls how the width is calculated between widthpoints. The width at a position p is a function of the surrounding width points. When smoothness is '''zero''' interpolation is lineal, when smoothness is '''1.0''' interpolation is given by a 5th degree smooth Spline.

=== Homogeneous ===

Enabling {{literal|Homogeneous}} changes the way the position of the {{l|#widthpoint|width points}} change according modification of the outline.
* When false, the "Position" parameter for a width point is equally distributed '''among the vertices'''. For example, in a spline with five vertices, "Position" values of 0, 0.25, 0.5, 0.75, and 1 correspond to the first, second, third, fourth, and fifth vertex, respectively, regardless of how close or far apart those vertices are. Between vertices, the "Position" parameter is based on spline length.
* When true, the "Position" parameter increases smoothly from the start to the end of the spline '''based on the length of the entire spline'''. This means a "Position" of 0.5 will always correspond to the halfway point of the spline, not to a particular vertex.

=== Width Point List ===
Each Advanced Outline has a list of parameters that represent the information for each width item. They are called Width Points and consist of four sub-parameters:

* '''Position''' (Real number): represents the position of the width point along the Spline. Although it is allowed to be any real number, its meaning is only from '''0.0''' to '''1.0'''. 0.0 corresponds to the start of the Spline (first Spline point on the Spline list) and 1.0 to the last Spline point. For looped Splines 0.0 and 1.0 are equal. The position is represented by the light purple Handle that always lies on the Spline. The point on the spline corresponding to a particular "Position" value is affected by the "Homogeneous" parameter, explained above.
* '''Width''' (Real number): It is the width multiplicator of the global Width parameter of the Advanced Outline Layer on the position given by the Position parameter. The final width is calculated multiplying the global Advanced Outline's Width (W) by the Width of the widthpoint (w) and adding the Expand parameter (E). Calculated width = W*w+E
* '''Tip Side Before/After''': Those two sub-parameters controls how the width is interpolated before and after the current widthpoint. The sub-parameter can have four values:
** '''Interpolate''': Between the previous/following width point, the width is calculated by interpolation based on smoothness value.
** '''Rounded''': There is a rounded tip that points to the width point before or after. If the previous/following width point is {{Literal|Interpolate}} on its posterior/previous side it considers that the width of the widthpoint in question is zero just before/after it. If the previous/posterior width point is other than {{Literal|Interpolate}} then the segment between those two width points is empty. See examples to understand it fully.
** '''Squared''': Same as Rounded but using square tip.
** '''Peak''': Same as Rounded but using peak tip.
** '''Flat''': Same as Rounded but using flat tip.

The Width Point list has one internal non-animatable parameter called {{Literal|loop}}. You can reach it by right clicking the Width Point List parameter. If the Width Point list is unlooped, then any width point that has a Position outside the range of [0,1] is clamped to (brought within) that range. For example: a Position = 1.35 is clamped to 1.0 then the Width Point List is unlooped. Otherwise, if the Width Point List is looped and a width point has a Position of 1.3, its modulus based on the range [0,1] is used, so it is turned to a position of 0.3.

=== Fast ===
...TODO WriteME.about...

=== Dashed Outline ===
...TODO WriteME.about...

== Working with the Avdanced Outline ==

=== Creation of the Advanced Outline ===

You can create Advanced Outlines by various ways:
* With the {{l|Draw Tool}} (check ''Create Advanced Outline'' in the tool options).
* With the {{l|Spline Tool}} (check ''Create Advanced Outline'' in the tool options).
* Using a {{l|Layers#Geometry|Geometry Layer}} (check ''Create Advanced Outline'' in the tool options).
* With the menu {{c|<Insert>|<Layer>|Geometry|Advanced Outline}}.

=== Change the width of the Width Points ===

Initially the width Handles are hidden. You can make them visible by pressing ({{Shortcut|alt|5}}) or clicking on the width toggle button. It is possible to change the width using the {{l|Width Tool}} using the same procedure as for regular outlines. If you want more control over the width you can modify the width Handles with the {{l|Transform Tool}} ({{Shortcut|alt|A}}). More fine tunning is possible by expanding the width point sub-parameter and entering a specific value for the Width sub-parameter. In that case negative values are allowed to produce nice effects.

=== Change the position of the Width Points ===

When you make the width Handles of the width points visible/invisible, the position Handles also become visible/invisible. This way, the user has a single way to hide/show the position and width Handles.

{{Note|Change the position of the Width Points|This may change in the future}}

The position Handles of the width points can be modified using the {{l|Transform Tool}} ({{Shortcut|alt|A}}) and clicking and dragging the position Handle. You will notice that Handles are tied to the Spline so once clicked and dragged they can be placed at any way on the Spline. Notice that if you have a width point position Handle at position 0.2 and you click and drag at position 0.9 it may happen that you obtain a value of -0.1 because you dragged it in one step and the Width Point List may be looped. If you want to avoid those problems do the movement in small steps to indicate the correct path to follow when calculating the new position.

=== Adding or removing width points ===
To add a new width point you have to right click on the width point position Handle (purple Handle) to get the context menu. Then select {{literal|Add Item (smart)}} here to create more width points entries. The width points are created this way:

In the general case, the new widthpoint is created between the width point you click on and the "previous" width point. Depending on the loop status of the Spline, the "previous" width point can be the start of the Spline (unlooped) or the last widthpoint (looped). The worst case is when there is only one width point on the Width Point List. If you add one new item it will lie over the existing one.

The newly added width point will have the interpolated width at the position where it is created.

=== Specific actions for Width Points ===

Some needed actions have been added to width points as well as functionality for existing actions for items of the List type parameters. You can reach the list of available actions by right clicking on the width point position or directly on the width point item of the Width Point List. Here are some descriptions of the available actions:

* Convert: Width Points are composite Value Nodes so its natural format is Composite (you can access its components). But you can convert it to other formats. See Convert for details.
* Disconnect: This will disconnect the width point item from the Composite type Value Node. That means that there won't be any Handle to show and that any of its values can be modified. Maybe it is useful for some types of workflows. To restore its Composite status, choose Convert->Composite.
* Insert/ Remove Item Smart: This will add or remove a width point. If Remove is used in animation mode, it will also set the current width point as OFF instead of effectively removing it from the Width Point List. Opposite for the Insert Item Smart.
* Mark Active Point as ON/OFF: You can set width points off to make it not count for width control while the width point is off. When the width point is half on to off or viceversa, the used width point should be the interpolation between the on and off status. But it doesn't work properly at the moment. On / Off values are not interpolated but fully on or fully off. This has to be corrected.
* Export: See {{l|Export}}.
* Loop: When set as looped, as mentioned before, it allows the width point positions loop around the range [0,1].
* Rotate Order: Doesn't do anything.
* Set Side Before/After to: Interpolate, Rounded, Squared, Peak, Flat. Those are shortcuts to do the same as going directly to the sub-parameter and choosing the appropriate Tip Type. Maybe it should be renamed to "Set Tip Before/After".
* Set Width to default/zero: those actions have been added for two reasons. It is very common to want to set the width of a width point to zero. Despite the possibility of use the User Preference of Restrict Radius to First Quadrant, this way it is acceded quickly from the same usual menu. Also when a width point position Handle and a width point width Handle are on top of each other (width = 0) it is hard to modify the width or the position without trouble. To solve this the position Handle has preference over the width Handle in case of coincidence. So access the width Handle it is needed to have a quick action to set it to its default value (1.0).

Advanced Outline Layer

2016-10-10T10:26:52Z

D.j.a.y: /* Specific parameters for Advanced Outline Layer */ width point intra link

{{Title|Advanced Outline Layer}}
{{Category|Layers}}
{{Category|Primitive Layers}}
{{NewTerminology}}
{{TOCright}}

Under construction! See {{l|Talk:Advanced_Outline_Layer|Advanced Outline Layer Talk}} page
[[Image:Layer_geometry_advanced_outline_icon.png|64px]]

== About Advanced Outline Layers ==

To create an Advanced Outline Layer use the Spline Tool and check {{literal|Create Advanced Outline}} in the {{l|Tool Options Panel}}. Once you finish the definition of the geometry of your outline and after pressing the {{literal|Make Spline}} button (or selecting another tool or state) you create the Advanced Outline Layer with the {{l|New_Layer_Defaults#Brush_Colors|current}} {{literal|Outline Color}}.

Depending on the options you choose in the {{l|Tool Options Panel}} other {{l|Category:Tools|Tools}} like {{l|Star Tool}} or {{l|Circle Tool}} can also create Advanced Outline Layers.

Using the {{l|Canvas Layer Menu|Layer Menu}} {{Literal|Make Advanced Outline}}, {{Literal|Make Outline}} or {{Literal|Make Region}} commands you can also create those layers.

=== Differences with Outline Layer: Outline width ===

The '''width''' [[Handle]] define the outline width at particular place.

In the regular [[Outline Layer]], each width Handle is connected to the vertex that defines the outline shape at that place. That means that the user needs to insert a new vertex on the [[Spline]] every time he wants to change the outline width in some place. This behaviour can cause problems when the shape of the outline is very simple but the width varies a lot.

Practice shows that most of the time the user wants to specify the width independently from the placement of [[Spline]] vertices. Such functionality is available in the Advanced Outline layer, which Handles its width in a different way: the width Handles are freely moved around the Spline and define its width at any point.

== Features ==

Advanced Outline introduces some features to the regular outline, as shown in this [http://www.youtube.com/watch?v=boM_ZC9VZ54 Advanced outline demo] video. They are listed with examples below:

<gallery widths="490px" heights="300px" perrow="2">
File:Variable-width-without-blinepoints.png | No need to place vertex to change the width
File:Lots-of-blinepoints-width-just-two width-controls.png | Width controlled just by two points, while the Spline constructed of many vertices
File:Different-types of tips.png | Different types of tips : Rounded, Squared, Peak, Flat.
File: Segments of outlines.png | Segmented outline
File:Different cusps types.png | Three global cusps types : Sharp, Rounded, Bevel.
File:Smoothness control.png | Control of smoothness from linear (0.0) to smooth (1.0)
</gallery>

==Parameters of Advanced Outline Layers==

The parameters of the Advanced Outline Layers are:

{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:silver"
|'''Name'''||'''Value'''||'''Type'''
|-
||[[Image:Type_real_icon.png|16px]] [[Z Depth Parameter|Z Depth]]
||0.000000
||real

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Amount Parameter|Amount]]
||1.000000
||real

|-
||[[Image:type_integer_icon.png|16px]] [[Blend Method|Blend Method]]
||Composite
||integer

|-style="background:#eeeeee"
||[[Image:Type_color_icon.png|16px]] [[Colors Dialog|Color]]
||
{| style="width:95%; height:16px; background:black; color:black" border="1"
|-
|}
||color

|-style="background:#"
||[[Image:Type_vector_icon.png|16px]] [[Origin Parameter|Origin]]
||0.000000u,0.000000u
||vector

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Invert Parameter|Invert]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Antialiasing Parameter|Antialiasing]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Feather Parameter|Feather]]
||0.000000pt
||real

|-
||[[Image:Type_integer_icon.png|16px]] [[Feather_Parameter#Type_of_Feather|Type of Feather]]
||Fast Gaussian Blur
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Winding Style Parameter|Winding Style]]
||Non Zero
||integer

|-
||[[Image:Type_list_icon.png|16px]] Vertices
||List
||list (Spline)

|-style="background:#eeeeee"
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Outline_width|Outline Width]]
||2.000000pt
||real

|-
||[[Image:Type_real_icon.png|16px]] [[Outline_Layer#Expand|Expand]]
||0.000000pt
||real

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at Start]]
||Rounded Stop
||integer

|-
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Tip_type_at_start_.2F_end|Tip Type at End]]
||Rounded Stop
||integer

|-style="background:#eeeeee"
||[[Image:Type_integer_icon.png|16px]] [[Advanced_Outline_Layer#Cusps_Type|Cusps Type]]
||Sharp
||integer

|-
||[[Image:Type_real_icon.png|16px]] [[Advanced_Outline_Layer#Smoothness|Smoothness]]
||0.500000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_bool_icon.png|16px}} [[Advanced_Outline_Layer#Homogeneous|Homogeneous]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_list_icon.png|16px]] [[Advanced_Outline_Layer#Width_Point_List|Width Point List]]
||List
||list(WPList)

|-style="background:#eeeeee"
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Fast|Fast]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-
||[[Image:Type_bool_icon.png|16px]] [[Advanced_Outline_Layer#Dashed_Outline|Dashed Outline]]
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||[[Image:Type_list_icon.png|16px]] Dash Item List
||List
||list(WPList)

|-
||[[Image:Type_real_icon.png|16px]] Dash Items Offset
||0.000000u
||real

|}

==Specific parameters for Advanced Outline Layer==

This section lists only the parameters specific to the Advanced Outline Layer. For documentation about the other parameters, refer to [[Outline Layer]].

* Tip Type at start
* Tip Type at end
* Cusps type
* Smoothness
* Width Point List

=== Tip type at start / end ===

As with width points, the end and start of the unlooped Advanced Outlines has a type of tip defined. The user can choose between the same types of tips as for a width point. When the first/last width point has its before/after interpolation type set to Interpolate the start/end of the outline is rendered using the Tip type at start/end parameter.

Those parameters don't have any effect if the Spline is looped or the first/last width point has its before/after interpolation type set to anything but Interpolate. In that case, the segment between the start/end width point and the start/end of the Spline is not rendered.

The types of tips are the same as the width point tip types except that it doesn't offer the Interpolate type because it would not make sense:

Parameters:
{| border="1"
|-
! Tip Type
! Example
|-
| Rounded
| [[File:Avanced-Outline-Layer-TipType-Rounded.png]]
|-
| Squared
| [[File:Avanced-Outline-Layer-TipType-Squared.png]]
|-
| Peak
| [[File:Avanced-Outline-Layer-TipType-Peak.png]]
|-
| Flat
| [[File:Avanced-Outline-Layer-TipType-Flat.png]]
|}

=== Cusps type ===

There are three types of cusps in the Advanced Outline:

Parameters:
{| border="1"
|-
! Cusp Type
! Example
|-
| Sharp
|[[File:Avanced-Outline-Layer-Cups-Sharp.png]]
|-
| Rounded
| [[File:Avanced-Outline-Layer-Cups-Rounded.png]]
|-
| Bevel
| [[File:Avanced-Outline-Layer-Cups-Bevel.png]]
|}

The type of cusp is controlled for the entire layer so currently it is not possible to control the type of corner individually. Maybe in future versions it will be possible.

=== Smoothness ===

The Smoothness controls how the width is calculated between widthpoints. The width at a position p is a function of the surrounding width points. When smoothness is '''zero''' interpolation is lineal, when smoothness is '''1.0''' interpolation is given by a 5th degree smooth Spline.

=== Homogeneous ===

Enabling {{literal|Homogeneous}} changes the way the position of the {{l|#widthpoint|width points}} change according modification of the outline.
* When false, the "Position" parameter for a width point is equally distributed '''among the vertices'''. For example, in a spline with five vertices, "Position" values of 0, 0.25, 0.5, 0.75, and 1 correspond to the first, second, third, fourth, and fifth vertex, respectively, regardless of how close or far apart those vertices are. Between vertices, the "Position" parameter is based on spline length.
* When true, the "Position" parameter increases smoothly from the start to the end of the spline '''based on the length of the entire spline'''. This means a "Position" of 0.5 will always correspond to the halfway point of the spline, not to a particular vertex.

=== Width Point List ===
Each Advanced Outline has a list of parameters that represent the information for each width item. They are called Width Points and consist of four sub-parameters:

* '''Position''' (Real number): represents the position of the width point along the Spline. Although it is allowed to be any real number, its meaning is only from '''0.0''' to '''1.0'''. 0.0 corresponds to the start of the Spline (first Spline point on the Spline list) and 1.0 to the last Spline point. For looped Splines 0.0 and 1.0 are equal. The position is represented by the light purple Handle that always lies on the Spline. The point on the spline corresponding to a particular "Position" value is affected by the "Homogeneous" parameter, explained above.
* '''Width''' (Real number): It is the width multiplicator of the global Width parameter of the Advanced Outline Layer on the position given by the Position parameter. The final width is calculated multiplying the global Advanced Outline's Width (W) by the Width of the widthpoint (w) and adding the Expand parameter (E). Calculated width = W*w+E
* '''Tip Side Before/After''': Those two sub-parameters controls how the width is interpolated before and after the current widthpoint. The sub-parameter can have four values:
** '''Interpolate''': Between the previous/following width point, the width is calculated by interpolation based on smoothness value.
** '''Rounded''': There is a rounded tip that points to the width point before or after. If the previous/following width point is {{Literal|Interpolate}} on its posterior/previous side it considers that the width of the widthpoint in question is zero just before/after it. If the previous/posterior width point is other than {{Literal|Interpolate}} then the segment between those two width points is empty. See examples to understand it fully.
** '''Squared''': Same as Rounded but using square tip.
** '''Peak''': Same as Rounded but using peak tip.
** '''Flat''': Same as Rounded but using flat tip.

The Width Point list has one internal non-animatable parameter called {{Literal|loop}}. You can reach it by right clicking the Width Point List parameter. If the Width Point list is unlooped, then any width point that has a Position outside the range of [0,1] is clamped to (brought within) that range. For example: a Position = 1.35 is clamped to 1.0 then the Width Point List is unlooped. Otherwise, if the Width Point List is looped and a width point has a Position of 1.3, its modulus based on the range [0,1] is used, so it is turned to a position of 0.3.

=== Fast ===
...TODO WriteME.about...

=== Dashed Outline ===
...TODO WriteME.about...

== Working with the Avdanced Outline ==

=== Creation of the Advanced Outline ===

You can create Advanced Outlines by various ways:
* With the {{l|Draw Tool}} (check ''Create Advanced Outline'' in the tool options).
* With the {{l|Spline Tool}} (check ''Create Advanced Outline'' in the tool options).
* Using a {{l|Layers#Geometry|Geometry Layer}} (check ''Create Advanced Outline'' in the tool options).
* With the menu {{c|<Insert>|<Layer>|Geometry|Advanced Outline}}.

=== Change the width of the Width Points ===

Initially the width Handles are hidden. You can make them visible by pressing ({{Shortcut|alt|5}}) or clicking on the width toggle button. It is possible to change the width using the {{l|Width Tool}} using the same procedure as for regular outlines. If you want more control over the width you can modify the width Handles with the {{l|Transform Tool}} ({{Shortcut|alt|A}}). More fine tunning is possible by expanding the width point sub-parameter and entering a specific value for the Width sub-parameter. In that case negative values are allowed to produce nice effects.

=== Change the position of the Width Points ===

When you make the width Handles of the width points visible/invisible, the position Handles also become visible/invisible. This way, the user has a single way to hide/show the position and width Handles.

{{Note|Change the position of the Width Points|This may change in the future}}

The position Handles of the width points can be modified using the {{l|Transform Tool}} ({{Shortcut|alt|A}}) and clicking and dragging the position Handle. You will notice that Handles are tied to the Spline so once clicked and dragged they can be placed at any way on the Spline. Notice that if you have a width point position Handle at position 0.2 and you click and drag at position 0.9 it may happen that you obtain a value of -0.1 because you dragged it in one step and the Width Point List may be looped. If you want to avoid those problems do the movement in small steps to indicate the correct path to follow when calculating the new position.

=== Adding or removing width points ===
To add a new width point you have to right click on the width point position Handle (purple Handle) to get the context menu. Then select {{literal|Add Item (smart)}} here to create more width points entries. The width points are created this way:

In the general case, the new widthpoint is created between the width point you click on and the "previous" width point. Depending on the loop status of the Spline, the "previous" width point can be the start of the Spline (unlooped) or the last widthpoint (looped). The worst case is when there is only one width point on the Width Point List. If you add one new item it will lie over the existing one.

The newly added width point will have the interpolated width at the position where it is created.

=== Specific actions for Width Points ===

Some needed actions have been added to width points as well as functionality for existing actions for items of the List type parameters. You can reach the list of available actions by right clicking on the width point position or directly on the width point item of the Width Point List. Here are some descriptions of the available actions:

* Convert: Width Points are composite Value Nodes so its natural format is Composite (you can access its components). But you can convert it to other formats. See Convert for details.
* Disconnect: This will disconnect the width point item from the Composite type Value Node. That means that there won't be any Handle to show and that any of its values can be modified. Maybe it is useful for some types of workflows. To restore its Composite status, choose Convert->Composite.
* Insert/ Remove Item Smart: This will add or remove a width point. If Remove is used in animation mode, it will also set the current width point as OFF instead of effectively removing it from the Width Point List. Opposite for the Insert Item Smart.
* Mark Active Point as ON/OFF: You can set width points off to make it not count for width control while the width point is off. When the width point is half on to off or viceversa, the used width point should be the interpolation between the on and off status. But it doesn't work properly at the moment. On / Off values are not interpolated but fully on or fully off. This has to be corrected.
* Export: See {{l|Export}}.
* Loop: When set as looped, as mentioned before, it allows the width point positions loop around the range [0,1].
* Rotate Order: Doesn't do anything.
* Set Side Before/After to: Interpolate, Rounded, Squared, Peak, Flat. Those are shortcuts to do the same as going directly to the sub-parameter and choosing the appropriate Tip Type. Maybe it should be renamed to "Set Tip Before/After".
* Set Width to default/zero: those actions have been added for two reasons. It is very common to want to set the width of a width point to zero. Despite the possibility of use the User Preference of Restrict Radius to First Quadrant, this way it is acceded quickly from the same usual menu. Also when a width point position Handle and a width point width Handle are on top of each other (width = 0) it is hard to modify the width or the position without trouble. To solve this the position Handle has preference over the width Handle in case of coincidence. So access the width Handle it is needed to have a quick action to set it to its default value (1.0).

Writer Documentation

2016-10-10T10:10:03Z

D.j.a.y: anchor template missing : anchor --->

{{Title|Writer Documentation}}
{{TOCright}}

= Getting Started =
There you are...
==Translation==
To add {{l|Meta:Translation|translated}} pages.
==New pages==
To add an additional page just call the page by editing the address in your browser (without ending '/' ).
You'll then see a page telling you that this page currently doesn't exist and you can click on {{literal|Create}} at the top menu. If you don't feel comfortable doing changes in the mains pages, you can start by submitting your changes in the {{Literal|Discussion}} pages ( {{Shortcut|Alt|Shift|t}}).

= Editor Documentation =
* General Conventions
** {{l|Meta:General Documentation Style}}
** {{l|Meta:ScreenShots}}
** {{l|Meta:Synfig Naming Conventions}}

* Wiki
** {{l|Meta:Wiki Structure}}
** {{l|Meta:Template Style And Syntax}}
** {{l|Wiki Improvements}}

* {{l|Meta:Translation}}

= Administrator Documentation =
* {{l|Meta:Templates}}
* {{l|Meta:How to add support for new language}}

= Marketing/Sales Documentation =
* {{l|Meta:Writing Press Releases}}

= Pages Currently Developed =
These pages are currently under development and do not show up on the official documentation:
* {{l|#Rewritefor_1x_series|Rewrite for 1.x series}}
* {{l|#WikificationofGenetestuff|Wikification of Genete's stuff}}
* {{l|#Terminologyrewritesprint|Terminology rewrite sprint}}

= Projects =
== (in progress) 2015 --> - Rewrite for 1.x series==

In order to update the documentation to follow the 1.0 release, a '''major revision of the documentation''' is needed.

In some cases, draft work has already been done in the '''Talk''' section of the pages.

According the synfigstudio 1.0 single window (and other changes) UI a global review and update of the '''screenshots''' must also be done...see howto in next paragraph.

The documentation can be now rewritten directly on the Pages (It's no longer necessary to use the Talk Pages nor the "Rewrite preparation for 0.65" has modification comment has suggested previously)

=== Where to start ===
* {{l|Category:Canvas_Window}} '''Ready for translation''' - (main rewrite done - polish done)
* {{l|Dock dialogs}} (outdated by {{l|Category:Panels}} update) : everything related to dock system should be reviewed (rewritten done)
* Something about jack synchro - done : {{l|FAQ#What_about_Jack_audio_server_.3F}}
* A sound layer tutorial
* A jack tutorial : draft here ---> {{l|Jack Audio Synchronization Tutorial}}
* {{l|Tool_Options_Panel}} '''Ready for translation''' - (main rewrite done)
* {{l|Category:File_Menu_%28Toolbox%29}} : in progress
* {{l|Category:Toolbox_Menu}} : in progress
* {{l|Help_Menu}} : in progress
* {{l|Toolbox}}
* and : http://wiki.synfig.org/wiki/index.php?title=Special%3ASearch&profile=advanced&search=rewrite+0.65&fulltext=Search&ns0=1&ns1=1&profile=advanced

===How to do the Screenshots ===
For complete recommendations on screenshot creation, see the synfig studio documentation : {{l|Meta:ScreenShots}}

* Please make screenshots in default light theme.
* Please keep image width under ~1000px.
* Use generic file notation : image_file_name_current.png. Example ''File:Render_settings_Dialog_current.png'' ‎used in [[Render_dialog]] (to take advantage of the upgrade image system)

===Terminology===
It's possible (and certain) that around the corners, some terminologies have been updated with all the GUI's recent changes. Some parts of the documentation may not reflect all the changes. If you find some... feel free to correct them in wiki original page (+ your native language?) ! (and add it to this list for helping the translation into other languages)

{|border="1" align="none"
|-style="background:#silver"
|'''Old Terminology'''||'''New Terminology'''||'''Where'''
|-
||Children Lock
||{{l|Lock Selection}}
||{{l|Group Layer}} and Swicth Group Layer
|-
||
||
||
|}

== (todo) 2015 --> - Wikification of Genete's stuff ==
A lot of documentation resources have been produced by Genete. They are hosted in the cloud. Some of it should be hosted in the wiki, in the dev, or tutorial or .... sections.

* [https://drive.google.com/folderview?id=0Bx8g_H3f7qpZZDExNjU0NmEtZWI2Mi00M2UzLWI2OWQtNDUyYmRhOGRiN2Qx&usp=sharing Genete Stuff].

''please, log here any progress to avoid duplicate work''

== (done) 2014-2015 - Rewrite preparation for future release 1.0==

The documentation can be now rewritten directly on the Page. It's no longer necessary to use the Talk Pages nor the "Rewrite preparation for 0.65" has modification comment has suggested previously.

Have a look at what has already been initiated : http://wiki.synfig.org/wiki/index.php?title=Special%3ASearch&profile=advanced&search=rewrite+0.65&fulltext=Search&ns0=1&ns1=1&profile=advanced

According the synfigstudio 1.0 single window (and other changes) UI a global review and update of the screenshots must be done...

(No more useful) <strike>Write inside Talk:Pages the new feature that will be available in synfig 1.0 in order to not do ''visible modification'' until next release is out.</strike>

(No more useful)<strike> Suggested work-flow : use "Rewrite preparation for 0.65" has modification comment, and add "Rewrite preparation for 0.65" sentence inside the Talk Page (to get an easy way to retrieve all the pages who need to be updated once 1.0 will be out)</strike>

== (in progress) 2013 ---> - Terminology rewrite sprint ==
Have a look in the Forum [http://www.synfig.org/forums/viewtopic.php?f=25&t=4056] for more information.

* (''[http://www.synfig.org/forums/viewtopic.php?f=1&t=4056&start=75#p18012 done]'') - {{l|Dev:Sprints/2013-01-07_Reworked_Terminology|Terminology}} step of original (English) doc .
* ''(done - over-dated by 1.0 work)'' - {{l|Dev:Sprints/2013-02-19_Screenshots_Update|Screenshot Update}} step
* ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18930 done])'' - Approve terminology change step on reference page (english)
* ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18985 done])'' - Signal translation pages outdated
* ''(done)'' - Banner with the instructions to all translation pages not updated with new terminology
* ''(done)'' - Some translation pages have to be renamed. For example "Params Panel/ru" have to become "Parameters Panel/ru". Only admins can do that.
* ''('''todo''')'' - Find a way to work on translation pages outdated
* ''('''todo''')'' - Update the translations step

Writer Documentation

2016-10-10T10:07:02Z

D.j.a.y: refixbis

{{Title|Writer Documentation}}
{{TOCright}}

= Getting Started =
There you are...
==Translation==
To add {{l|Meta:Translation|translated}} pages.
==New pages==
To add an additional page just call the page by editing the address in your browser (without ending '/' ).
You'll then see a page telling you that this page currently doesn't exist and you can click on {{literal|Create}} at the top menu. If you don't feel comfortable doing changes in the mains pages, you can start by submitting your changes in the {{Literal|Discussion}} pages ( {{Shortcut|Alt|Shift|t}}).

= Editor Documentation =
* General Conventions
** {{l|Meta:General Documentation Style}}
** {{l|Meta:ScreenShots}}
** {{l|Meta:Synfig Naming Conventions}}

* Wiki
** {{l|Meta:Wiki Structure}}
** {{l|Meta:Template Style And Syntax}}
** {{l|Wiki Improvements}}

* {{l|Meta:Translation}}

= Administrator Documentation =
* {{l|Meta:Templates}}
* {{l|Meta:How to add support for new language}}

= Marketing/Sales Documentation =
* {{l|Meta:Writing Press Releases}}

= Pages Currently Developed =
These pages are currently under development and do not show up on the official documentation:
* [[#Rewritefor_1x_series|Rewrite for 1.x series]]
* {{l|#WikificationofGenetestuff|Wikification of Genete's stuff}}
* {{l|#Terminologyrewritesprint|Terminology rewrite sprint}}

= Projects =
{{Anchor|Rewritefor_1x_series}}
== (in progress) 2015 --> - Rewrite for 1.x series==

In order to update the documentation to follow the 1.0 release, a '''major revision of the documentation''' is needed.

In some cases, draft work has already been done in the '''Talk''' section of the pages.

According the synfigstudio 1.0 single window (and other changes) UI a global review and update of the '''screenshots''' must also be done...see howto in next paragraph.

The documentation can be now rewritten directly on the Pages (It's no longer necessary to use the Talk Pages nor the "Rewrite preparation for 0.65" has modification comment has suggested previously)

=== Where to start ===
* {{l|Category:Canvas_Window}} '''Ready for translation''' - (main rewrite done - polish done)
* {{l|Dock dialogs}} (outdated by {{l|Category:Panels}} update) : everything related to dock system should be reviewed (rewritten done)
* Something about jack synchro - done : {{l|FAQ#What_about_Jack_audio_server_.3F}}
* A sound layer tutorial
* A jack tutorial : draft here ---> {{l|Jack Audio Synchronization Tutorial}}
* {{l|Tool_Options_Panel}} '''Ready for translation''' - (main rewrite done)
* {{l|Category:File_Menu_%28Toolbox%29}} : in progress
* {{l|Category:Toolbox_Menu}} : in progress
* {{l|Help_Menu}} : in progress
* {{l|Toolbox}}
* and : http://wiki.synfig.org/wiki/index.php?title=Special%3ASearch&profile=advanced&search=rewrite+0.65&fulltext=Search&ns0=1&ns1=1&profile=advanced

===How to do the Screenshots ===
For complete recommendations on screenshot creation, see the synfig studio documentation : {{l|Meta:ScreenShots}}

* Please make screenshots in default light theme.
* Please keep image width under ~1000px.
* Use generic file notation : image_file_name_current.png. Example ''File:Render_settings_Dialog_current.png'' ‎used in [[Render_dialog]] (to take advantage of the upgrade image system)

===Terminology===
It's possible (and certain) that around the corners, some terminologies have been updated with all the GUI's recent changes. Some parts of the documentation may not reflect all the changes. If you find some... feel free to correct them in wiki original page (+ your native language?) ! (and add it to this list for helping the translation into other languages)

{|border="1" align="none"
|-style="background:#silver"
|'''Old Terminology'''||'''New Terminology'''||'''Where'''
|-
||Children Lock
||{{l|Lock Selection}}
||{{l|Group Layer}} and Swicth Group Layer
|-
||
||
||
|}

{{Anchor|WikificationofGenetestuff}}
== (todo) 2015 --> - Wikification of Genete's stuff ==
A lot of documentation resources have been produced by Genete. They are hosted in the cloud. Some of it should be hosted in the wiki, in the dev, or tutorial or .... sections.

* [https://drive.google.com/folderview?id=0Bx8g_H3f7qpZZDExNjU0NmEtZWI2Mi00M2UzLWI2OWQtNDUyYmRhOGRiN2Qx&usp=sharing Genete Stuff].

''please, log here any progress to avoid duplicate work''

== (done) 2014-2015 - Rewrite preparation for future release 1.0==

The documentation can be now rewritten directly on the Page. It's no longer necessary to use the Talk Pages nor the "Rewrite preparation for 0.65" has modification comment has suggested previously.

Have a look at what has already been initiated : http://wiki.synfig.org/wiki/index.php?title=Special%3ASearch&profile=advanced&search=rewrite+0.65&fulltext=Search&ns0=1&ns1=1&profile=advanced

According the synfigstudio 1.0 single window (and other changes) UI a global review and update of the screenshots must be done...

(No more useful) <strike>Write inside Talk:Pages the new feature that will be available in synfig 1.0 in order to not do ''visible modification'' until next release is out.</strike>

(No more useful)<strike> Suggested work-flow : use "Rewrite preparation for 0.65" has modification comment, and add "Rewrite preparation for 0.65" sentence inside the Talk Page (to get an easy way to retrieve all the pages who need to be updated once 1.0 will be out)</strike>

{{Anchor|Terminologyrewritesprint}}
== (in progress) 2013 ---> - Terminology rewrite sprint ==
Have a look in the Forum [http://www.synfig.org/forums/viewtopic.php?f=25&t=4056] for more information.

* (''[http://www.synfig.org/forums/viewtopic.php?f=1&t=4056&start=75#p18012 done]'') - {{l|Dev:Sprints/2013-01-07_Reworked_Terminology|Terminology}} step of original (English) doc .
* ''(done - over-dated by 1.0 work)'' - {{l|Dev:Sprints/2013-02-19_Screenshots_Update|Screenshot Update}} step
* ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18930 done])'' - Approve terminology change step on reference page (english)
* ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18985 done])'' - Signal translation pages outdated
* ''(done)'' - Banner with the instructions to all translation pages not updated with new terminology
* ''(done)'' - Some translation pages have to be renamed. For example "Params Panel/ru" have to become "Parameters Panel/ru". Only admins can do that.
* ''('''todo''')'' - Find a way to work on translation pages outdated
* ''('''todo''')'' - Update the translations step