Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 18 Jun 2004 09:35:53 +0300
From:      Ruslan Ermilov <ru@FreeBSD.org>
To:        "Simon L. Nielsen" <simon@FreeBSD.org>
Cc:        Hiroki Sato <hrs@FreeBSD.org>
Subject:   Re: Auto generated hardware notes
Message-ID:  <20040618063553.GA8235@ip.net.ua>
In-Reply-To: <20040617195633.GG907@zaphod.nitro.dk>
References:  <20040617195633.GG907@zaphod.nitro.dk>

next in thread | previous in thread | raw e-mail | index | archive | help

--Qxx1br4bt0+wmkIi
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Thu, Jun 17, 2004 at 09:56:33PM +0200, Simon L. Nielsen wrote:
>=20
> Inspired by NetBSD I have created a HARDWARE section in section 4 manual
> pages.  This section will then be extracted on put in to the hardware
> notes.
>=20
Looks great from the mdoc(7) perspective, please go ahead.

> The main advantage to this model is that if the manual page is updated
> the hardware notes are updated, so there is no need for duplicate work.
> The main disadvantage is that since the same text has to be used both in
> the manual page and in the hardware notes for text structure (see sample
> generated version for what I mean) is not perfect for the hardware
> notes.
>=20
[...]
> The main unresolved issue for me is translation.  Since most of the text
> is now extracted directly from manual pages (which only exists in
> English and Japaneese) I'm not really sure how to deal with this nicely.
>=20
I may be blind, but I don't see a real problem here.  Whenever a
manpage gets updated, the English version of hardware notes gets
updated, and translators could pick it up easily, and add/change
the necessary translation.  If only list of supported hardware
is changed, this will be even easier.  Another approach would be
for Japanese hardware notes to convert section 4 manpages to this
new syntax with HARDWARE section, and then scan Japanese manpages
using your script.


Cheers,
--=20
Ruslan Ermilov
ru@FreeBSD.org
FreeBSD committer

--Qxx1br4bt0+wmkIi
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (FreeBSD)

iD8DBQFA0o1JqRfpzJluFF4RAkygAJ9cTyBOSPBy4zf9pbxXzfSGYOafGQCfZNkO
8+LEckKaywpyJ7BD8LxSHr0=
=xaKB
-----END PGP SIGNATURE-----

--Qxx1br4bt0+wmkIi--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20040618063553.GA8235>