Maintain the translations of your documentation with ease (PO for anything)
Perl XS C Shell Roff HTML Other
Latest commit e1e2708 Aug 13, 2018
Permalink
Failed to load latest commit information.
doc
extension Cleanup trailing spaces. Apr 7, 2017
lib/Locale/Po4a
po Translated using Weblate (Spanish) Aug 13, 2018
scripts Fix minor typos Mar 21, 2018
share/doc remove the po4a-build tool, that is deprecated by po4a since maybe a … May 26, 2018
t Some testing simplifications Aug 13, 2018
testsuite Cleanup trailing spaces. Apr 7, 2017
.appveyor.yml tests: don't mess with dos2unix and make sure that appveyor uses core… Aug 4, 2018
.gitignore add a gitignore Sep 22, 2016
.travis.yml Add texlive-latex-base to required packages on travis. Aug 7, 2018
.weblate add the file to interact with weblate from the command line Feb 18, 2018
Build.PL Make sure Pod::Parser is installed to avoid issue 142 Aug 3, 2018
CONTRIBUTING.md Update docs for testing Jul 3, 2018
COPYING Merge changes introduced in the Debian 0.31-1 package. Jun 17, 2007
MANIFEST
MANIFEST.SKIP Update MANIFEST.SKIP Aug 7, 2018
META.json
NEWS
Po4aBuilder.pm Build.PL: make sure we also regenerate the doc pot file before postats Jun 16, 2018
README.maintainers
README.md Minor reformatting for markdown, add travis build status Jun 16, 2018
TODO remove the po4a-build tool, that is deprecated by po4a since maybe a … May 26, 2018
changelog Update changelog Aug 21, 2013
po4a remove the remaining mentions of po4a-build Jul 24, 2018
po4a-gettextize Fix detection of input charset in po4a-gettextize Aug 15, 2013
po4a-normalize Cosmetics: replace tabs by spaces Oct 29, 2012
po4a-translate
po4a-updatepo Fix minor typos Mar 21, 2018

README.md

Introduction to Po4a

Build Status

The po4a (PO for anything) project goal is to ease translations (and more interestingly, the maintenance of translations) using gettext tools on areas where they were not expected like documentation.

In po4a each documentation format is handled by a module. For now, we have a module for the following formats:

  • asciidoc: AsciiDoc format.
  • dia: uncompressed Dia diagrams.
  • docbook: DocBook XML.
  • guide: Gentoo Linux's XML documentation format.
  • ini: INI format.
  • kernelhelp: Help messages of each kernel compilation option.
  • latex: LaTeX format.
  • man: Good old manual page format.
  • pod: Perl Online Documentation format.
  • sgml: either DebianDoc or DocBook DTD.
  • texinfo: The info page format.
  • tex: generic TeX documents (see also latex).
  • text: simple text document.
  • wml: WML documents.
  • xhtml: XHTML documents.
  • xml: generic XML documents (see also docbook).
  • yaml: YAML documents.

Installation

To install this module type the following:

   perl Build.PL
   ./Build
   ./Build install

Use without installation

If you want to use a version without installing it (e.g. directly from the git tree), use the PERLLIB environment variable as such:

   PERLLIB=~/git-checkouts/po4a/lib ~/git-checkouts/po4a/po4a-gettextize [usual args]

Po4a dependencies

  • Locale::gettext (v1.01)

    This module being itself internationalized, it needs the Locale::gettext library to translate its own messages. If it is not present, then po4a's messages won't be translated, but po4a will remain fully functional.

  • Text::WrapI18N

    This module is used to format po4a's warnings and error messages. It permits to wrap long error messages without splitting words. If it is not present, the formatting of messages will be different, but po4a will remain fully functional.

  • Term::ReadKey

    This module is used to retrieve the terminal's line width. It is not used if Text::WrapI18N is not available. If it is not present, the line width can be specified with the COLUMN environment variable.

SGML module specific dependencies

  • SGMLS (1.03ii)

    This is a set of Perl5 routines for processing the output from the onsgmls SGML parser.

  • opensp (1.5.2) OpenJade group's SGML parsing tools

    This is the SGML parser we use.

Text module specific dependencies

YAML module specific dependencies

  • YAML::Tiny

    This module is used to parse and serialize the YAML file.

Project hosting

Copyright and license

This program is free software; you may redistribute it and/or modify it under the terms of GPL (see COPYING file).

Copyright © 2002-2O18 by SPI, inc.

Authors: