Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
translations:update-documentation [2009/08/17 14:57] – created miketranslations:update-documentation [2026/09/09 05:27] (current) – [Update the documentation] kevinbowen
Line 1: Line 1:
-====== Update the documentation ======+~~NOTOC~~ 
 +====== Update the localization documentation ======
 This how-to applies essentially to project maintainers that are using a ''po-doc'' directory for the documentation localization. These projects use the tool ''xml2po'' and ''xsltproc''. When the maintainer updates the documentation he must also refresh the PO files. Now when the maintainer receives an updated PO file, he runs the opposite commands to update the localized documentation and also include the new images when there are some. This how-to applies essentially to project maintainers that are using a ''po-doc'' directory for the documentation localization. These projects use the tool ''xml2po'' and ''xsltproc''. When the maintainer updates the documentation he must also refresh the PO files. Now when the maintainer receives an updated PO file, he runs the opposite commands to update the localized documentation and also include the new images when there are some.
 +
 +----
  
 ===== Check-in a new translation ===== ===== Check-in a new translation =====
Line 19: Line 22:
 **3.** Prepare the doc/ directory for the new translation. **3.** Prepare the doc/ directory for the new translation.
  
-FIXME 
   # example   # example
-  svn export doc/C doc/ja/+  mkdir -p doc/ja/images 
 +  cp doc/C/Makefile.am doc/C/project.xml.in doc/C/project.html doc/ja 
 +  cp doc/C/images/Makefile.am doc/C/images/*.png doc/ja/images
   vim configure.ac.in doc/Makefile.am doc/ja/Makefile.am doc/ja/images/Makefile.am   vim configure.ac.in doc/Makefile.am doc/ja/Makefile.am doc/ja/images/Makefile.am
  
-//The translations update the XML documentations that is usually put inside a docs/ directory. In that directory you have at least one sub-directory that is the english version named ''C''. To create a new directory for a new translation you can use ''svn export'' as in the above example so that it doesn't copy the hidden ''.svn'' directories. Then you have to edit the appropriate Makefiles. The autoconf script also needs to be updated.//+//The translations update the XML documentations that is usually put inside a docs/ directory. In that directory you have at least one sub-directory that is the english version named ''C''. You have to edit the appropriate Makefiles. The autoconf script also needs to be updated for the new Makefile.in output files.//
  
 **4.** Regenerate the configure script and new Makefiles. **4.** Regenerate the configure script and new Makefiles.
Line 31: Line 35:
  
 **5.** Now you have to update the XML localized documentation, which is explained in the next section. **5.** Now you have to update the XML localized documentation, which is explained in the next section.
 +
 +[[|Back to Top]]
 +----
  
 ===== Update a translation ===== ===== Update a translation =====
Line 48: Line 55:
  
   make -C doc/ja/   make -C doc/ja/
 +
 +----
  
 ===== Update the PO files ===== ===== Update the PO files =====
Line 55: Line 64:
  
 //This will generate the PO template and update all the PO files.// //This will generate the PO template and update all the PO files.//
 +
 +
 +[[|Back to Top]]
 +----
 +[[:translations:|Return to main Wiki translations page]]