Writer Documentation

From Synfig Studio :: Documentation
Jump to: navigation, search
(/*перевел первый раздел/*)
Line 1: Line 1:
= Приступая к работе =
+
<!-- Page info -->
Чтобы добавить страницы в документацию (а также {{l|Meta:Перевод|страницы с переводом}}) просто введите ее адрес в адресную строку вашего браузера. Вы увидите страницу, которая указывает, что такая страница не существует. Для ее создания нажмите на кнопку «Edit» в верхней части окна...
+
{{Title|Writer Documentation}}
 +
{{TOCright}}
 +
<!-- Page info -->
 +
= С чего начать =
 +
Для создания новой страницы в вики проекте (а также страницу {{l|Meta:Translation|перевода}}) просто введите адрес добавляемой страницы в адресную строку вашего браузера и вызовите ее для редактирования.
 +
Далее вы увидите уведомление, что запрашиваемая страница не существует и тогда вы сможете кликнуть на "создать страницу" и внести с помощью предложенного редактора ее содержимое. Если вы не хотите вносить изменения в содержимое страницы сразу же, вы можете вынести на обсуждение ваши правки на вкладку страницы {{Literal|Обсуждение}} ( {{Shortcut|Alt|Shift|t}}). There you are...
  
= Документация для редактирования статей =
+
= Editor Documentation =
* Общие положения
+
* General Conventions
** {{l|Meta:Основной стиль документации|основной стиль документации}}
+
** {{l|Meta:General Documentation Style}}
** {{l|Meta:Снимки экрана|снимки экрана}}
+
** {{l|Meta:ScreenShots}}
** {{l|Meta:Соглашения по наименованию Synfig|соглашения по наименованию Synfig}}
+
** {{l|Meta:Synfig Naming Conventions}}
  
* Вики
+
* Wiki
** {{l|Meta:Структура вики|структура вики}}
+
** {{l|Meta:Wiki Structure}}
** {{l|Meta:Шаблон стиля и синтаксиса|шаблон стиля и синтаксиса}}
+
** {{l|Meta:Template Style And Syntax}}
 +
** {{l|Wiki Improvements}}
  
* {{l|Meta:Перевод|Перевод}}
+
* {{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 =
* {{l|Meta:Шаблоны|Шаблоны}}
+
These pages are currently under development and do not show up on the official documentations
* {{l|Meta:Как добавить поддержку нового языка|Как добавить поддержку нового языка}}
+
* {{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#.28in_progress.29_2013_-_Terminology_rewrite_sprint|Terminology rewrite sprint}}
  
= Документация в сфере маркетинга и продаж =
+
= Projects =
* {{l|Meta:Написание пресс-релизов|Написание пресс-релизов}}
+
  
= Страницы, находящиеся на стадии написания =
+
== (in progress) 2015 - Rewrite for 1.x series==
Эти страницы находятся на стадии написания и не показываются в официальной документации
+
* {{l|Meta:Введение|Введение}}
+
* {{l|Meta:Установка|Установка}}
+
  
= Проекты =
+
In order to update the documentation to follow the 1.0 release, a '''major revision of the documention''' is needed.
  
== (в прогрессе) 2014 - подготовка перезаписи страниц для будущего релиза Synfig (0.65?)==
+
In some cases, draft work have been already done in the '''Talk''' section of the pages.  
  
Предлагается писать внутри Обсуждения страниц, описывающих новые функции программы, которые будут доступны в Synfig 0.65, для того, чтобы сделать невидимыми эти изменения в документации до следующего выпуска Synfig.
+
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.
  
Предлагаемый порядок написания: использовать предложение: «Подготовка перезаписи для версии 0.65» для страниц, имеющих комментарии к новым функциям программы (таким образом получаем легкий способ выборки всех страниц, которые необходимо будет обновить после выхода новой версии программы 0.65).
+
The documentation can be now rewrited directly on the Pages (It's no more necessary to use the Talk Pages nor the "Rewrite preparation for 0.65" has modification comment has suggested previously)
  
Посмотрите, с чего нужно начать: http://wiki.synfig.org/wiki/index.php?title=Special%3ASearch&profile=advanced&search=rewrite+0.65&fulltext=Search&ns0=1&ns1=1&profile=advanced
+
=== Where to start ===
 +
* {{l|Doc:Interface}}
 +
* {{l|Canvas}}
 +
* {{l|Category:Canvas_Window}}
 +
* Something about jack synchro
 +
* A sound layer tutorial
 +
* A jack tutorial
 +
* {{l|Tool_Options_Panel}} (see talk)
 +
* {{l|Category:File_Menu_%28Toolbox%29}}
 +
* {{l|Category:Toolbox_Menu}}
 +
* {{l|Help_Menu}}
 +
* {{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
  
== (в прогрессе) 2013 - Быстрая перезапись терминологии Synfig ==
+
===How to do the Screenshots ===
Обратитесь к странице форума по адресу [http://www.synfig.org/forums/viewtopic.php?f=25&t=4056] для получения большей информации.
+
For a complete recommendations on screenshots creation for the synfig studio documentation : {{l|Meta:ScreenShots}}
  
* {{l|Dev:Sprints/2013-01-07_Reworked_Terminology|Приведение}} терминологии в документации в соответствие с терминологией оригинальной (английской) документации (''[http://www.synfig.org/forums/viewtopic.php?f=1&t=4056&start=75#p18012 закончено]'').
+
* Please make in default light theme.
* {{l|Dev:Sprints/2013-02-19_Screenshots_Update|Обновление}} снимков экрана ''(в прогрессе)''
+
* Please try to do not make image bigger than something like 1000px wide.
* Утверждение терминологии, выбранной на странице обсуждения (на английском) ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18930 закончено])''
+
* 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)
* Обнаружение переведенных страниц с устаревшей терминологией ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18985 закончено])''
+
 
* Внедрение баннера в соответствующие страницы документации с инструкциями по обновлению переведенных страниц с устаревшей терминологией ''(закончено)''
+
===Terminology===
* Некоторые страницы необходимо переименовать, например, имеющие опечатку. Переименование выполнять только администраторам ''(закончено)''
+
It's possible (and certain) that around the corners, some terminologies has been updated with all the gui recent changes. Some part of the documentation may does'nt reflect all the changes. If you found some... feel free to correct them in wiki original page (+ your native langage?) ! (and add it to this list for helping translation in others languages)
* Найти способы обновления страниц с устаревшей терминологией ''(todo)''
+
 
* Обновить страницы с переводами документации ''(todo)''
+
{|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 stuff has produced by Genete. Actually they are hosted in a cloud. Some 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 couple work''
 +
 
 +
== (done) 2014-2015 - Rewrite preparation for future release 1.0==
 +
 
 +
The documentation can be now rewrited directly on the Page. It's no more necessary to use the Talk Pages nor the "Rewrite preparation for 0.65" has modification comment has suggested previously.
 +
 
 +
To have a look of what has been already initiate : 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 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)</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 informations.
 +
 
 +
* (''[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 - overdated 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

Revision as of 12:33, 29 October 2015

Warning!

This page contains outdated information.

The release of Synfig Studio 0.64.0 introduced new terminology and this translated page needs to be updated according to original English text.

You can help updating this page - see instructions here. Thank you!

warning end



С чего начать

Для создания новой страницы в вики проекте (а также страницу перевода) просто введите адрес добавляемой страницы в адресную строку вашего браузера и вызовите ее для редактирования. Далее вы увидите уведомление, что запрашиваемая страница не существует и тогда вы сможете кликнуть на "создать страницу" и внести с помощью предложенного редактора ее содержимое. Если вы не хотите вносить изменения в содержимое страницы сразу же, вы можете вынести на обсуждение ваши правки на вкладку страницы "Обсуждение" ( Alt⇧ ShiftT). There you are...

Editor Documentation

Administrator Documentation

Marketing/Sales Documentation

Pages Currently Developed

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

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 have been already 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 rewrited directly on the Pages (It's no more 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 a complete recommendations on screenshots creation for the synfig studio documentation : Screen Shots

  • Please make in default light theme.
  • Please try to do not make image bigger than something like 1000px wide.
  • 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 has been updated with all the gui recent changes. Some part of the documentation may does'nt reflect all the changes. If you found some... feel free to correct them in wiki original page (+ your native langage?) ! (and add it to this list for helping translation in others languages)

Old Terminology New Terminology Where
Children Lock Lock Selection Слой-холст and Swicth Group Layer

(todo) 2015 - Wikification of Genete's stuff

A lot of documentation stuff has produced by Genete. Actually they are hosted in a cloud. Some should be hosted in the wiki in the dev or tutorial or .... sections.

please, log here any progress to avoid couple work

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

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

To have a look of what has been already initiate : 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 informations.

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