Difference between revisions of "Writer Documentation"

From Synfig Studio :: Documentation
Jump to: navigation, search
m (→‎(in progress) 2013 - Terminology rewrite sprint: Update the translations step)
m (→‎Editor Documentation: template intra link)
 
(52 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
<!-- Page info -->
 +
{{Title|Writer Documentation}}
 +
{{TOCright}}
 +
<!-- Page info -->
 
= Getting Started =
 
= Getting Started =
−
To add an additional page (also translated pages) just call the page by editing the address in your browser.
+
There you are...
−
You'll then see a page telling you that this page currently doesn't exist and you can click on "create" at the top menu. 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 =
 
= Editor Documentation =
Line 12: Line 20:
 
** {{l|Meta:Wiki Structure}}
 
** {{l|Meta:Wiki Structure}}
 
** {{l|Meta:Template Style And Syntax}}
 
** {{l|Meta:Template Style And Syntax}}
 +
** {{l|Meta:Templates}}
 +
** {{l|Wiki Improvements}}
  
 
* {{l|Meta:Translation}}
 
* {{l|Meta:Translation}}
−
 
−
 
  
 
= Administrator Documentation =
 
= Administrator Documentation =
Line 25: Line 33:
  
 
= Pages Currently Developed =
 
= Pages Currently Developed =
−
These pages are currently under development and do not show up on the official documentations
+
These pages are currently under development and do not show up on the official documentation:
−
* {{l|introduction}}
+
* {{l|#Rewritefor_1x_series|Rewrite for 1.x series}}
−
* {{l|installation}}
+
* {{l|#WikificationofGenetestuff|Wikification of Genete's stuff}}
 +
* {{l|#Terminologyrewritesprint|Terminology rewrite sprint}}
  
 
= Projects =
 
= Projects =
 +
== <span id="Rewritefor_1x_series"></span>(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
 +
|-
 +
||
 +
||
 +
||
 +
|}
 +
 +
== <span id="WikificationofGenetestuff"></span>(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...
  
−
== (in progress) 2013 - Terminology rewrite sprint ==
+
(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>
−
Have a look in the Forum [http://www.synfig.org/forums/viewtopic.php?f=25&t=4056] for more informations.
+
  
−
* {{l|Dev:Sprints/2013-01-07_Reworked_Terminology|Terminology}} step of original (English) doc (''[http://www.synfig.org/forums/viewtopic.php?f=1&t=4056&start=75#p18012 done]'').
+
(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>
−
* {{l|Dev:Sprints/2013-02-19_Screenshots_Update|Screenshot Update}} step ''(in progress)''
+
−
* Approve terminology change step on reference page (english) ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18930 done])''
+
−
* Signal translation pages outdated ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18985 done])''
+
−
* Find a way to work on translation pages outdated ''(todo)''
+
−
* Update the translations step ''(todo)''
+
  
−
== (done) 2010 - Restructure and update the documentations ==
+
== <span id="Terminologyrewritesprint"></span>(in progress) 2013 ---> - Terminology rewrite sprint ==
−
'''to all writers / translators'''
+
Have a look in the Forum [http://www.synfig.org/forums/viewtopic.php?f=25&t=4056] for more information.
  
−
A project has been started to restructure and update the documentation.
+
* (''[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 .
−
please have a look in the Forum [http://synfig.org/forums/viewforum.php?f=25] for more information.
+
* ''(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

Latest revision as of 13:14, 20 April 2017


Getting Started

There you are...

Translation

To add 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 "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 "Discussion" pages ( Alt⇧ ShiftT).

Editor Documentation

Administrator Documentation

Marketing/Sales Documentation

Pages Currently Developed

These pages are currently under development and do not show up on the official documentation:

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

How to do the Screenshots

For complete recommendations on screenshot creation, see the synfig studio documentation : Screen Shots

  • 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)

Old Terminology New Terminology Where
Children Lock Lock Selection 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.

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

(No more useful) 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)

(in progress) 2013 ---> - Terminology rewrite sprint

Have a look in the Forum [1] for more information.

  • (done) - Terminology step of original (English) doc .
  • (done - over-dated by 1.0 work) - Screenshot Update step
  • (done) - Approve terminology change step on reference page (english)
  • (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
Retrieved from "https://wiki.synfig.org/index.php?title=Writer_Documentation&oldid=23144"