Difference between revisions of "User manual information"

From Inkscape Wiki
Jump to navigation Jump to search
m (→‎How to Help: Creat new link for work in french)
(21 intermediate revisions by 6 users not shown)
Line 1: Line 1:
We need to work now on an update of this Manual and have a specific version for Inkscape.
== Read ==


* Queries about Manual can be added here or sent to <cedric@le-radar.com>
http://en.flossmanuals.net/inkscape — this is where you read the manual.


== Translations of the manual ==
== Contribute ==


* [http://wiki.inkscape-forum.de/handbuch German] started by [[User:FZap]] - will need to be merged once we are ready
# [http://lists.sourceforge.net/mailman/listinfo/inkscape-docs Subscribe] to the inkscape-docs mailing list
# Read the manual
# [http://wiki.inkscape.org/wiki/index.php/User_Manual_Work_in_Progress Read what needs to be done]
# Introduce yourself in the list and tell us what you want to do so that no work is duplicated
# Read [http://en.flossmanuals.net/bin/view/Inkscape/WritingConventions writing conventions]
# [http://en.flossmanuals.net/bin/view/Inkscape/WebHome Start contributing].


== Getting the latest version ==
Here is is a hint: we try to use as much content from release notes as possible, since last 5-6 ones were written in a very much verbose way.
* If you want to contribute, download the USER_MANUAL part of SVN (http://inkscape.svn.sourceforge.net/viewvc/inkscape/user_manual/trunk/)
  svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/user_manual/trunk user_manual
* If you just want to browse to find a subject, go to http://www.le-radar.com/?mm/inkscape_inkscape.rss and choose your language. It is the most up-to-date version
* An alternative, in-progress, unofficial version can be found at http://www.usinginkscape.com/usermanual


== How to Help  ==
== Translate ==


* Adding new information to the manual : write your files in docbook or in plain text that we'll convert (please follow the [[User Manual Guidelines]])
We very much welcome translations of the manual. Please [http://lists.sourceforge.net/mailman/listinfo/inkscape-docs join] the inkscape-docs mailing list and tell us about yourself.
* translating pages
* contact a contributor or add your name in the follow list and have a look at the [[User Manual Work in Progress]]


* To view the current state in HTML, type "make fr" or "make en" (xsltproc is needed).
So far we have established the following translations "zones":
* For pictures, you may use the "images/sshot_yourlanguage" directory or create it if necessary".
* Don't translate anything yet, we are working on the [[French Version]], which will then be translated into English, and that will become the basis for translation work. You will get a PO file for translating later.


== FAQ  ==
* [http://translate.flossmanuals.net/bin/view/Inkscape_br/WebHome Brazilian]
;Why is there only one xml file?: The single XML file has now been split into language-specific versions, please only edit these.
* [http://translate.flossmanuals.net/bin/view/Inkscape_ca/WebHome Catalan]
* [http://fr.flossmanuals.net/ French]
* [http://translate.flossmanuals.net/bin/view/Inkscape_de/WebHome German]
* [http://translate.flossmanuals.net/bin/view/Inkscape_es/WebHome Spanish]
* [http://translate.flossmanuals.net/bin/view/Inkscape_pl/WebHome Polish]
* [http://translate.flossmanuals.net/bin/view/Inkscape_pt/WebHome Portuguese]
* [http://translate.flossmanuals.net/bin/view/Inkscape_ru/WebHome Russian]


;How can I produce HTML output from the XML file?: Type "make your_language" to have truncated html file (one file per sect1), or "make singleYour_language" to have all the manual in one html file.
Here is how you translate:


;Can I export to PDF?: Yes. Make a single HTML file as described above and run "make pdfYour_language". This depends on htmldoc. If anyone wants to work on a different XSL stylesheet that produce language specific XML file and use db2pdf, it is welcome.
# In your translation zone you will see contents of the book. For each chapter there are "Edit" and "Translate" links and a status combobox that reveals various options. Start with those chapters which are marked as "Untranslated".
# Click "Translate"
# In the newly opened copy'n'paste contents of the most recent revision of chapter fromthe left editing field to the right one. A sequence of Ctrl+C and Ctrl+C should do the trick
# Translate
# Choose a new status of the newly created translation. '''Untranslated''' — if you just copy'n'pasted original text in English. '''Unpublished''' — if you translated the text, but want to review and improve it before it goes live.  '''Published''' — if your translation is '''really''' ready to go live and visible for everybody else.
# Click 'Save'
 
You can still do further revision of that chapter anytime by clicking 'Edit' from the Contents table.
 
Reading [http://en.flossmanuals.net/bin/view/Inkscape/WritingConventions writing conventions] is strictly recommended for better understanding of markup rules and use of styles.
 
You can also track revisions in the translation zone by clicking "Subscribe" link in the translation zone index page. This will enable mailing you list of changes (to the address with which you registered in the system).
 
It's best to team up with several people and coordinate your efforts.
 
German contributors might like to reuse some text from [http://wiki.inkscape-forum.de/handbuch German] translation started by [[User:FZap]] in the DocBook/XML days of the manual.
 
We still haven't decided how to provide source SVG files in most comfortable way to make localization of illustrations easy. Ideas are welcome.
 
Note that French translation is placed in a different zone, because it's mostly ready. As soon as each translation is close to completeness, it is moved to its own subdomain too.


== People ==
== People ==
* '''[[User:Relsi.ramone|Relsi Ramone]]''' - Contributor for Brazilian Portuguese - ''relsi.ramone at gmail.com''
* '''[[User:Cedric|Cedric Gemy]]''' - main contributor - ''cedric at le-radar.com''
* '''[[User:Cedric|Cedric Gemy]]''' - main contributor - ''cedric at le-radar.com''
* '''[[User:Elisa-yemanja|Elisa]]''' - contributor in French - ''elisa at ec.yemanja.net''
* '''[[User:Elisa-yemanja|Elisa]]''' - contributor in French - ''elisa at ec.yemanja.net''
Line 40: Line 63:
* '''[[User:Colin Marquardt|Colin Marquardt]]''' - volunteer for a German translation from English, help with xml2po if needed. Especially interested in [[Embedded_Help]].
* '''[[User:Colin Marquardt|Colin Marquardt]]''' - volunteer for a German translation from English, help with xml2po if needed. Especially interested in [[Embedded_Help]].
* '''[[User:vonHalenbach|vonHalenbach-de]]''' - volunteer for a translation of pygmees manual from English to German
* '''[[User:vonHalenbach|vonHalenbach-de]]''' - volunteer for a translation of pygmees manual from English to German
* '''[[User:Prokoudine|Alexandre Prokoudine]]''' - volunteer for a translation into Russian


== Misc ==
== Misc ==
* automated screenshot taking: maybe via [http://people.redhat.com/zcerza/dogtail/ Dogtail] (see [http://www.redhat.com/magazine/020jun06/features/dogtail/] and [http://www.redhat.com/magazine/021jul06/features/dogtail/]) or [http://ldtp.freedesktop.org/ LDTP]?
* automated screenshot taking: maybe via [http://people.redhat.com/zcerza/dogtail/ Dogtail] (see [http://www.redhat.com/magazine/020jun06/features/dogtail/] and [http://www.redhat.com/magazine/021jul06/features/dogtail/]) or [http://ldtp.freedesktop.org/ LDTP]?
* see http://live.gnome.org/autoshot, http://osdir.com/ml/gnome.documentation/2006-08/msg00045.html


* the [http://inkscape.org/doc/inkscape-man.html Inscape "man page"]
* the [http://inkscape.org/doc/inkscape-man.html Inscape "man page"]


* [[VectorAndBitmap]]
* [[VectorAndBitmap]]
* [[IllustratorUsers|Inkscape for Illustrator Converts]]
* [[Inkscape for Adobe Illustrator users]]
* [[TricksAndTips]]
* [[TricksAndTips]]
* [[KeyboardShortcuts]]
* [[KeyboardShortcuts]]
* [[InkscapeColor]]
* [[InkscapeColor]]
==TODO==
* add COPYING (GPL?)
* use dblatex for conversion to PDF
* get rid of inkscapeUTF.xml (the Makefile still uses that file!)
* rename the files to e.g. user_manual.fr.xml
* clean up Makefile (don't use inkscapeUTF.xml)
* add Makefile target that uploads a manual snapshot to the Inkscape website


[[Category:User Documentation]]
[[Category:User Documentation]]
[[Category:Needs Work]]
[[Category:Needs Work]]

Revision as of 02:10, 20 June 2009

Read

http://en.flossmanuals.net/inkscape — this is where you read the manual.

Contribute

  1. Subscribe to the inkscape-docs mailing list
  2. Read the manual
  3. Read what needs to be done
  4. Introduce yourself in the list and tell us what you want to do so that no work is duplicated
  5. Read writing conventions
  6. Start contributing.

Here is is a hint: we try to use as much content from release notes as possible, since last 5-6 ones were written in a very much verbose way.

Translate

We very much welcome translations of the manual. Please join the inkscape-docs mailing list and tell us about yourself.

So far we have established the following translations "zones":

Here is how you translate:

  1. In your translation zone you will see contents of the book. For each chapter there are "Edit" and "Translate" links and a status combobox that reveals various options. Start with those chapters which are marked as "Untranslated".
  2. Click "Translate"
  3. In the newly opened copy'n'paste contents of the most recent revision of chapter fromthe left editing field to the right one. A sequence of Ctrl+C and Ctrl+C should do the trick
  4. Translate
  5. Choose a new status of the newly created translation. Untranslated — if you just copy'n'pasted original text in English. Unpublished — if you translated the text, but want to review and improve it before it goes live. Published — if your translation is really ready to go live and visible for everybody else.
  6. Click 'Save'

You can still do further revision of that chapter anytime by clicking 'Edit' from the Contents table.

Reading writing conventions is strictly recommended for better understanding of markup rules and use of styles.

You can also track revisions in the translation zone by clicking "Subscribe" link in the translation zone index page. This will enable mailing you list of changes (to the address with which you registered in the system).

It's best to team up with several people and coordinate your efforts.

German contributors might like to reuse some text from German translation started by User:FZap in the DocBook/XML days of the manual.

We still haven't decided how to provide source SVG files in most comfortable way to make localization of illustrations easy. Ideas are welcome.

Note that French translation is placed in a different zone, because it's mostly ready. As soon as each translation is close to completeness, it is moved to its own subdomain too.

People

  • Relsi Ramone - Contributor for Brazilian Portuguese - relsi.ramone at gmail.com
  • Cedric Gemy - main contributor - cedric at le-radar.com
  • Elisa - contributor in French - elisa at ec.yemanja.net
  • John - Author and French/British translation
  • Ernesto - Spanish translation - celise at prodigy.net.mx
  • Antonio - Italian translation - antonio.angelo at poste.it
  • Bryce - English translation/editing - bryce at bryceharrington.com
  • Kevin - English translation/editing - inkscape.docs at wixsonit.com
  • Colin Marquardt - volunteer for a German translation from English, help with xml2po if needed. Especially interested in Embedded_Help.
  • vonHalenbach-de - volunteer for a translation of pygmees manual from English to German
  • Alexandre Prokoudine - volunteer for a translation into Russian

Misc

Retrieved from "https://wiki.inkscape.org/wiki/index.php?title=User_manual_information&oldid=53169"