Root/
| Source at commit 2862 created 7 years 24 days ago. By ifabio, Tag 2.3 release, bump svn to 2.4 | |
|---|---|
| 1 | Introduction to Po4a␊ |
| 2 | ====================␊ |
| 3 | ␊ |
| 4 | The po4a (PO for anything) project goal is to ease translations (and␊ |
| 5 | more interestingly, the maintenance of translations) using gettext␊ |
| 6 | tools on areas where they were not expected like documentation.␊ |
| 7 | ␊ |
| 8 | In po4a each documentation format is handled by a module. For now, we have a␊ |
| 9 | module for the POD format (in which the perl documentation is written), the␊ |
| 10 | good old man pages, and the documentation of the kernel compilation options.␊ |
| 11 | Some other modules are underway, like for sgml, xml or texinfo.␊ |
| 12 | ␊ |
| 13 | ␊ |
| 14 | INSTALLATION␊ |
| 15 | ␊ |
| 16 | To install this module type the following:␊ |
| 17 | ␊ |
| 18 | make␊ |
| 19 | make install␊ |
| 20 | ␊ |
| 21 | ␊ |
| 22 | USE WITHOUT INSTALLATION␊ |
| 23 | ␊ |
| 24 | If you want to use a version without installing it (such as the CVS one),␊ |
| 25 | use the PERLLIB environment variable is such construction:␊ |
| 26 | ␊ |
| 27 | PERLLIB=~/svn-checkouts/po4a/lib ~/svn-checkouts/po4a/po4a-gettextize [usual args]␊ |
| 28 | ␊ |
| 29 | ␊ |
| 30 | PO4A DEPENDENCIES␊ |
| 31 | ␊ |
| 32 | Locale::gettext (v1.01):␊ |
| 33 | This module being itself internationalized, it needs the Locale::gettext␊ |
| 34 | library to translate its own messages.␊ |
| 35 | If it is not present, then po4a's messages won't be translated, but␊ |
| 36 | po4a will remain fully functional.␊ |
| 37 | ␊ |
| 38 | Text::WrapI18N:␊ |
| 39 | This module is used to format po4a's warnings and error messages. It␊ |
| 40 | permits to wrap long error messages without splitting words.␊ |
| 41 | If it is not present, the formatting of messages will be different,␊ |
| 42 | but po4a will remain fully functional.␊ |
| 43 | ␊ |
| 44 | Term::ReadKey:␊ |
| 45 | This module is used to retrieve the terminal's line width. It is not␊ |
| 46 | used if Text::WrapI18N is not available.␊ |
| 47 | If it is not present, the line width can be specified with the COLUMN␊ |
| 48 | environment variable.␊ |
| 49 | ␊ |
| 50 | ␊ |
| 51 | SGML MODULE SPECIFIC DEPENDENCIES␊ |
| 52 | ␊ |
| 53 | SGMLS (1.03ii):␊ |
| 54 | This is a set of Perl5 routines for processing the output from the sgmls␊ |
| 55 | and nsgmls SGML parsers.␊ |
| 56 | ␊ |
| 57 | sp (1.3.4): James Clark's SGML parsing tools␊ |
| 58 | This is the parser we use.␊ |
| 59 | http://www.jclark.com/sp/␊ |
| 60 | ␊ |
| 61 | ␊ |
| 62 | PROJECT WEB PAGE␊ |
| 63 | ␊ |
| 64 | You can find more information and report bugs at the po4a project web page:␊ |
| 65 | ␊ |
| 66 | http://po4a.alioth.debian.org␊ |
| 67 | ␊ |
| 68 | ␊ |
| 69 | COPYRIGHT AND LICENSE␊ |
| 70 | ␊ |
| 71 | This program is free software; you may redistribute it and/or modify it␊ |
| 72 | under the terms of GPL (see COPYING file).␊ |
| 73 | ␊ |
| 74 | Copyright (C) 2002-2O15 by SPI, inc.␊ |
| 75 | Authors:␊ |
| 76 | Denis Barbier <barbier@linuxfr.org>␊ |
| 77 | Martin Quinson (mquinson#debian.org)␊ |
| 78 | |
