Difference between revisions of "User manual information"

From Inkscape Wiki
Jump to: navigation, search
(People)
(revamp)
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.
  
== Work in progress ==
+
== Contribute ==
  
[[User Manual Work in Progress]] reflects current work on the guide.
+
# [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
 +
# [http://en.flossmanuals.net/bin/view/Inkscape/WebHome Start contributing].
  
We track ongoing work for various languages right on FM website:
+
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.
  
* [http://en.flossmanuals.net/bin/view/Inkscape/WebHome Status for English version]
+
== Translate ==
  
== Translations of the manual ==
+
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.
  
* [http://wiki.inkscape-forum.de/handbuch German] started by [[User:FZap]] - will need to be merged once we are ready
+
So far we have established the following translations "zones":
  
== Getting the latest version ==
+
* [http://translate.flossmanuals.net/bin/view/Inkscape_br/WebHome Brazilian]
* If you want to contribute, download the USER_MANUAL part of SVN (http://inkscape.svn.sourceforge.net/viewvc/inkscape/user_manual/trunk/)
+
* [http://translate.flossmanuals.net/bin/view/Inkscape_de/WebHome German]
  svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/user_manual/trunk user_manual
+
* [http://translate.flossmanuals.net/bin/view/Inkscape_es/WebHome Spanish]
* 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
+
* [http://translate.flossmanuals.net/bin/view/Inkscape_pt/WebHome Portuguese]
* Also, see [http://oerks.net/~colin/alltutorials/inkscapeUTFen.pdf inkscapeUTFen.pdf] and [http://oerks.net/~colin/alltutorials/inkscapeUTFfr.pdf inkscapeUTFfr.pdf] for the manual processed with [http://dblatex.sf.net dblatex]
+
* [http://translate.flossmanuals.net/bin/view/Inkscape_ru/WebHome Russian]
* An alternative, in-progress, unofficial version can be found at http://www.usinginkscape.com/usermanual
+
  
== How to Help  ==
+
Here is how you translate:
  
* [http://lists.sourceforge.net/mailman/listinfo/inkscape-docs Subscribe] to the inkscape-docs mailing list and tell us what you are planning to do so that no work is duplicated
+
# 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".
* 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]])
+
# Click "Translate"
* translating pages
+
# 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
* contact a contributor or add your name in the list below and have a look at the [[User Manual Work in Progress]]
+
# 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'
  
* To view the current state in HTML, type "make fr" or "make en" (xsltproc is needed). See the Makefile for other targets.
+
You can still do further revision of that chapter anytime by clicking 'Edit' from the Contents table.
* 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.
+
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.
  
 
== People ==
 
== People ==
Line 44: Line 53:
 
* '''[[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, DocBook/XML nerd :)
+
* '''[[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
+
* 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"]
Line 59: Line 67:
 
* [[InkscapeColor]]
 
* [[InkscapeColor]]
  
* [[DocumentationReferences]] for us who don't know anything about DocBook, etc.
 
 
==TODO==
 
* rename the files to e.g. user_manual.fr.xml
 
* add Makefile target that uploads a manual snapshot to the Inkscape website
 
* Create a new [[userManualOutline]]
 
* Determine [[DocumentationStandards]]
 
 
[[Category:User Documentation]]
 
[[Category:User Documentation]]
 
[[Category:Needs Work]]
 
[[Category:Needs Work]]

Revision as of 15:54, 20 October 2008

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

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.

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