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

David Prévot david at tilapin.org
Sun Oct 17 20:08:59 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) advise the use of the “[t]he following conventions 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 I think that 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'll update tonight
some changes, please let me now if it's OK or not to continue. Once this
will be OK, 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
appreciated (reviewing changes and spot forgotten stuff for example).

Cheers

David


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

iEYEARECAAYFAky7V9oACgkQ18/WetbTC/oM+wCeKJ89r0cPq1qPs1w8bDMhNyq6
0uEAn28OVwhYcg47XQrBxR4EsJBwur7V
=bXVl
-----END PGP SIGNATURE-----



More information about the Po4a-commits mailing list