Writer Documentation
m (literal on create) |
m (Grammatical corrections) |
||
| Line 4: | Line 4: | ||
<!-- Page info --> | <!-- Page info --> | ||
= Getting Started = | = Getting Started = | ||
| − | To add an additional page (also {{l|Meta:Translation|translated}} pages) just call the page by editing the address in your browser. | + | To add an additional page (and also {{l|Meta:Translation|translated}} pages) just call the page by editing the address in your browser. |
| − | 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 | + | 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}}). There you are... |
= Editor Documentation = | = Editor Documentation = | ||
| Line 28: | Line 28: | ||
= Pages Currently Developed = | = Pages Currently Developed = | ||
| − | These pages are currently under development and do not show up on the official | + | These pages are currently under development and do not show up on the official documentation: |
* {{l|Writer_Documentation#.28in_progress.29_2015_-_Rewrite_for_1.x_series|Rewrite for 1.x series}} | * {{l|Writer_Documentation#.28in_progress.29_2015_-_Rewrite_for_1.x_series|Rewrite for 1.x series}} | ||
* {{l|Writer_Documentation#.28todo.29_2015_-_Wikification_of_Genete.27s_stuff|Wikification of Genete's stuff}} | * {{l|Writer_Documentation#.28todo.29_2015_-_Wikification_of_Genete.27s_stuff|Wikification of Genete's stuff}} | ||
| Line 39: | Line 39: | ||
In order to update the documentation to follow the 1.0 release, a '''major revision of the documention''' is needed. | In order to update the documentation to follow the 1.0 release, a '''major revision of the documention''' is needed. | ||
| − | In some cases, draft work | + | 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. | 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 | + | 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 === | === Where to start === | ||
| Line 49: | Line 49: | ||
* {{l|Canvas}} | * {{l|Canvas}} | ||
* {{l|Category:Canvas_Window}} | * {{l|Category:Canvas_Window}} | ||
| − | * {{l|Dock dialogs}} : and everything related to dock system should be | + | * {{l|Dock dialogs}} : and everything related to dock system should be rewritten |
* Something about jack synchro | * Something about jack synchro | ||
* A sound layer tutorial | * A sound layer tutorial | ||
| Line 61: | Line 61: | ||
===How to do the Screenshots === | ===How to do the Screenshots === | ||
| − | For | + | For complete recommendations on screenshot creation, see the synfig studio documentation : {{l|Meta:ScreenShots}} |
| − | * Please make in default light theme. | + | * Please make screenshots in default light theme. |
| − | * Please | + | * 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) | * 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=== | ===Terminology=== | ||
| − | It's possible (and certain) that around the corners, some terminologies | + | 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 langage?) ! (and add it to this list for helping the translation into other languages) |
{|border="1" align="none" | {|border="1" align="none" | ||
| Line 84: | Line 84: | ||
== (todo) 2015 - Wikification of Genete's stuff == | == (todo) 2015 - Wikification of Genete's stuff == | ||
| − | A lot of documentation | + | 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]. | * [https://drive.google.com/folderview?id=0Bx8g_H3f7qpZZDExNjU0NmEtZWI2Mi00M2UzLWI2OWQtNDUyYmRhOGRiN2Qx&usp=sharing Genete Stuff]. | ||
| − | ''please, log here any progress to avoid | + | ''please, log here any progress to avoid duplicate work'' |
== (done) 2014-2015 - Rewrite preparation for future release 1.0== | == (done) 2014-2015 - Rewrite preparation for future release 1.0== | ||
| − | The documentation can be now | + | 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... | According the synfigstudio 1.0 single window (and other changes) UI a global review and update of the screenshots must be done... | ||
| Line 103: | Line 103: | ||
== (in progress) 2013 - Terminology rewrite sprint == | == (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 | + | 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 . | * (''[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 . | ||
Revision as of 02:27, 19 March 2016
 |
Language: |
English • español • français • Bahasa Indonesia • português • русский • 中文（中国大陆） • 中文（台灣） |
Getting Started
To add an additional page (and also translated pages) just call the page by editing the address in your browser. 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). There you are...
Editor Documentation
- General Conventions
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 documention 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
- Interface
- Canvas
- Canvas Window
- Dock Dialogs : and everything related to dock system should be rewritten
- Something about jack synchro
- A sound layer tutorial
- A jack tutorial
- Tool Options Panel (see talk)
- Category:File_Menu_%28Toolbox%29 : in progress
- Toolbox : in progress
- Help Menu : in progress
- 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 : 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 langage?) ! (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 workflow : 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 - overdated 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
