[Po4a-devel] Following man-pages conventions (Was: r2287 - /branches/manpage/)

David Prévot david at tilapin.org
Mon Oct 18 01:57:44 UTC 2010


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

Le 17/10/2010 15:59, taffit-guest at users.alioth.debian.org a écrit :
[...]
> Added:
>     branches/manpage/
>       - copied from r2286, trunk/

man(1) advises the use of the “[t]he following conventions [that] apply
to the *SYNOPSIS* section and can be used as a guide in other sections.

       *bold text*          type exactly as shown.
       _italic text_        replace with appropriate argument.”, etc.

Using these conventions makes the manual pages really easier to read and
search for information, and po4a is a good place to follow these good
practices as an example in manual pages documentation.

I volunteer to such job, that's why I initiate the branches/manpage
branch, not to brake current translations and so on. I've updated
tonight some changes to section 1, please let me now if it's OK or not
to continue. Once this will be done, there will be again some work to
manually unfuzzy translations, since most of this change may be unfuzzy
before asking for update.

Of course, if others want to join the effort, any help will be
welcome (review changes, look for forgotten stuff, unfuzzy translation,
etc.)

Cheers

David

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)

iEYEARECAAYFAky7qZgACgkQ18/WetbTC/pTsQCfZup5HQV46LMI9VBRrh+F5qgu
i+0AoJmGqymT1FE0InZ3Mmh2mCh1Pefy
=jKQz
-----END PGP SIGNATURE-----



More information about the Po4a-devel mailing list