Difference between revisions of "User manual information"

From Inkscape Wiki
Jump to navigation Jump to search
(Updated links)
 
(33 intermediate revisions by 13 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.
+
{{Other languages|en=User manual information}}
  
* Queries about Manual can be added here or sent to <cedric@le-radar.com>
+
== Read ==
  
== Translations of the manual ==
+
There exist a number of comprehensive manuals for Inkscape:
 +
*[http://tavmjong.free.fr/INKSCAPE/MANUAL/html/ Inkscape: Guide to a Vector Drawing Program] by Tavmjong Bah
 +
*[http://en.flossmanuals.net/Inkscape/ FLOSS Manuals guide]
  
* [http://wiki.inkscape-forum.de/handbuch German] started by [[User:FZap]] - will need to be merged once we are ready
+
An always up-to-date list is available at [https://inkscape.org/en/learn/books/ the main Inkscape website].
  
== Getting the latest version ==
+
== Contribute ==
* 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
 
* 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]
 
* An alternative, in-progress, unofficial version can be found at http://www.usinginkscape.com/usermanual
 
  
== How to Help  ==
+
# [http://lists.sourceforge.net/mailman/listinfo/inkscape-docs Subscribe] to the inkscape-docs mailing list
 +
# Familiarize yourself with the free [http://en.flossmanuals.net/Inkscape/ manual]
 +
# Introduce yourself on the list and tell us what you want to do so we can avoid duplicating work
 +
# Ask on the list how you can start to contribute.
  
* 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]])
+
Here 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.
* translating pages
+
An old To-Do list for the manual is available [[User Manual Work in Progress|here]].
* contact a contributor or add your name in the list below 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).
+
== Translate ==
* 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  ==
+
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.
;Why is there only one xml file?: The single XML file has now been split into language-specific versions, please only edit these.
 
  
;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.
+
So far we have established the following translations “zones”:
  
;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.
+
* [http://fr.flossmanuals.net/ French]
 +
<!-- '''Outdated!''' Here is how you translate:
 +
 
 +
# 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.
 +
 
 +
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:Cedric|Cedric Gemy]]''' - main contributor - ''cedric at le-radar.com''
+
A few of these are no longer active on the Inkscape project.
* '''[[User:Elisa-yemanja|Elisa]]''' - contributor in French - ''elisa at ec.yemanja.net''
+
 
* '''John''' - Author and French/British translation  
+
* '''[[User:Relsi.ramone|Relsi Ramone]]''' — Contributor for Brazilian Portuguese — ''relsi.ramone at gmail.com''
* '''Ernesto''' - Spanish translation - ''celise at prodigy.net.mx''
+
* '''[[User:Cedric|Cedric Gemy]]''' — Contributor in French — ''cedric.gemy at gmail.com''
* '''Antonio''' - Italian translation - ''antonio.angelo at poste.it''
+
* '''[[User:Elisa-yemanja|Elisa]]''' — Contributor in French ''elisa at ec.yemanja.net''
* '''Bryce''' - English translation/editing - ''bryce at bryceharrington.com''
+
* '''John''' Author and French/British translation  
* '''Kevin''' - English translation/editing - ''inkscape.docs at wixsonit.com''
+
* '''Ernesto''' Spanish translation ''celise at prodigy.net.mx''
* '''[[User:Colin Marquardt|Colin Marquardt]]''' - volunteer for a German translation from English, help with xml2po if needed. Especially interested in [[Embedded_Help]].
+
* '''Antonio''' Italian translation ''antonio.angelo at poste.it''
* '''[[User:vonHalenbach|vonHalenbach-de]]''' - volunteer for a translation of pygmees manual from English to German
+
* '''Bryce''' English translation/editing ''bryce at bryceharrington.com''
 +
* '''Kevin''' English translation/editing ''inkscape.docs at wixsonit.com''
 +
* '''[[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:Prokoudine|Alexandre Prokoudine]]''' — Volunteer for a translation into Russian
 +
* '''[[User:Frigory|Sylvain Chiron]]''' — Volunteer for a translation into French
  
 
== 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]?
 
 
* the [http://inkscape.org/doc/inkscape-man.html Inscape "man page"]
 
  
* [[VectorAndBitmap]]
+
* The [https://inkscape.org/doc/inkscape-man.html Inscape “man page”]
* [[IllustratorUsers|Inkscape for Illustrator Converts]]
 
* [[TricksAndTips]]
 
* [[KeyboardShortcuts]]
 
* [[InkscapeColor]]
 
  
==TODO==
+
* [[Vector and bitmap]]
* add COPYING (GPL?)
+
* [[Inkscape for Adobe Illustrator users]]
* use dblatex for conversion to PDF
+
* [[Tricks and tips]]
* get rid of inkscapeUTF.xml (the Makefile still uses that file!)
+
* [[Keyboard shortcuts]]
* rename the files to e.g. user_manual.fr.xml
+
* [[Color management]]
* 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]]

Latest revision as of 05:44, 27 July 2016

Other languages: العربية Català Česky Deutsch English Español Français Italiano 日本語 한국어 Português Português do Brasil Русский Slovenčina 中文

Read

There exist a number of comprehensive manuals for Inkscape:

An always up-to-date list is available at the main Inkscape website.

Contribute

  1. Subscribe to the inkscape-docs mailing list
  2. Familiarize yourself with the free manual
  3. Introduce yourself on the list and tell us what you want to do so we can avoid duplicating work
  4. Ask on the list how you can start to contribute.

Here 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. An old To-Do list for the manual is available here.

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”:

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

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

A few of these are no longer active on the Inkscape project.

  • Relsi Ramone — Contributor for Brazilian Portuguese — relsi.ramone at gmail.com
  • Cedric Gemy — Contributor in French — cedric.gemy at gmail.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
  • Sylvain Chiron — Volunteer for a translation into French

Misc