Difference between revisions of "User manual information"

From Inkscape Wiki
Jump to navigation Jump to search
(39 intermediate revisions by 12 users not shown)
Line 1: Line 1:
This is mainly a scratchpad to begin working out the [[UserManual]]. We can post ideas and fragments of text up here, but the real deal will be in CVS so that it can be checked out and worked on.
== Read ==


Other manuals and tutorials are [http://inkscape.org/cgi-bin/wiki.pl?OtherProjects#outsidetut listed here]
http://en.flossmanuals.net/inkscape — this is where you read the manual.


: Why not write the manual here? Use wiki as a versioning & collaboration tool -- that's what it's for :) You can then use a script to turn raw wiki pages into whatever format you need for the distribution
== Contribute ==


Currently in CVS there is a manual (or beginnings of a manual) that was written in French for SodiPodi. Has anyone looked at it? What are your thoughts?
# [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].


* [[VectorAndBitmap]]
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.
* [[IllustratorUsers|Inkscape for Illustrator Converts]]
* [[TricksAndTips]]
* [[KeyboardShortcuts]]
* [[InkscapeColor]]


We need to work now on an update of this Manual and have a specific version for Inkscape.
== Translate ==


* Queries about Manual can be added here or sent to cedric@le-radar.com
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.


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


== Inkscape tutorial paginated for printing ==
* [http://translate.flossmanuals.net/bin/view/Inkscape_br/WebHome Brazilian]
* [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]


In SVG, each page is a layer.  Make one page visible and others invisible.  (The Wiki would not accept the PDF because the files are too big.)
Here is how you translate:


These tutorials were adapted from Inkscape 0.41.
# 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'


* upload:inkscape-tutorial-basic.svgz
You can still do further revision of that chapter anytime by clicking 'Edit' from the Contents table.
* upload:inkscape-tutorial-shapes.svgz


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


== Where can I find the latest update?  ==
It's best to team up with several people and coordinate your efforts.
* If you want to contribute, download the USER_MANUAL part of SVN (http://svn.sourceforge.net/viewcvs.cgi/inkscape/user_manual/trunk/)
* If you just want to browse to find a subject, you can go to http://www.le-radar.com/?mm/inkscape_inkscape.rss and choose your language. It is the most up2date.
* An alternative, in-progress, unofficial version can be found at http://www.angelfire.com/mi/kevincharles/inkscape/


== How to Help  ==
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.


* Adding new information to the manual : write your files in docbook or in plain text that we'll convert (please follow [[Manualguidelines.html|guidelines]])
We still haven't decided how to provide source SVG files in most comfortable way to make localization of illustrations easy. Ideas are welcome.
* translating pages
* contact a contributor or add your name in the follow list and have a look at the [[Manualwip.Html|WIP]]
 
 
* If you want to contribute, download the USER_MANUAL part of SVN
* To view actual state in html, type "make your_language" (notice that xsltproc is needed). If nothing is generated, it is that your language is actually not added to the manual. Thanks to begin one, ad become responsible for this part ;)
* edit the trunk/xml/inkscapeUTF.xml file. All languages are inside.
* Just read the file, choose the language reference you want to use (en, fr...) and translate by duplicating the node and changing lang attribute to yours.
* For pictures, you may use the "images/sshot_yourlanguage" directory or create it if necessary".
* when finishing editing, if necessary edit the Makefile and add your language to the Makefile. In every case test your file with some tools (xmllint...) or just type again "make your_language" : syntax errors will be displayed : please correct them.
* svn commit
 
== FAQ  ==
'''Why is there only one xml file?'''
Because some experience show it is much easier to follow : the translator reads the text in the same time it is editing. But the day many languages will be added, it will be a need to produce a trunked manual file.
 
'''I try to validate the manual file and i get some errors corresponding the the language attributes.'''
Normal, some tags are not allowed to be repeated in the DTD (sect1 title for example), but having all language in one file makes it necessary. In this case, validate with the given Makefile that take this difference in consideration.
 
'''How can i produce HTML files from the XML one?'''
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.
 
'''Can i export to PDF?'''
yep. make a single html file (read above) and "make pdfYour_language". Dependancy to htmldoc. If anyone wants to work on a different XSL stylesheet that produce language specific XML file and use db2pdf, it is welcome.
 
== Translations of the manual ==
 
* [[http://wiki.inkscape-forum.de/handbuch|German]] already started by [[User:fzap]]


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 ==
* '''[[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:Elisa-yemanja|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''
* '''[[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


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


== People ==
* the [http://inkscape.org/doc/inkscape-man.html Inscape "man page"]
'''[[User:Cedric|Cedric Gemy]]''' - main contributor - ''cedric at le-radar.com''


'''John''' - Author and French/British translation
* [[VectorAndBitmap]]
 
* [[Inkscape for Adobe Illustrator users]]
'''Ernesto''' - Spanish translation - ''celise at prodigy.net.mx''
* [[TricksAndTips]]
 
* [[KeyboardShortcuts]]
'''Antonio''' - Italian translation - ''antonio.angelo at poste.it''
* [[InkscapeColor]]
 
'''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 the german language.


[[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"