Difference between revisions of "User manual information"

From Inkscape Wiki
Jump to navigation Jump to search
(→‎How to Help: Remove translation info.)
Line 15: Line 15:
 
== How to Help  ==
 
== How to Help  ==
  
* Adding new information to the manual : write your files in docbook or in plain text that we'll convert (please follow [[Manualguidelines.html|guidelines]])
+
* 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]])
 
* translating pages
 
* translating pages
* contact a contributor or add your name in the follow list and have a look at the [[Manualwip.Html|WIP]]
+
* contact a contributor or add your name in the follow list and have a look at the [[User Manual Work in Progress]]
  
* If you want to contribute, download the USER_MANUAL part of SVN
+
* To view the current state in HTML, type "make fr" or "make en" (xsltproc is needed).
* 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".
 
* 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.
+
* 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.
* svn commit
 
  
 
== FAQ  ==
 
== FAQ  ==

Revision as of 22:43, 1 August 2007

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

  • Queries about Manual can be added here or sent to <cedric@le-radar.com>

Translations of the manual

Getting the latest version

  svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/user_manual/trunk user_manual

How to Help

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

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

People

  • 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

Misc

The Inscape "man page".