From owner-freebsd-doc@FreeBSD.ORG Fri Jun 18 07:00:13 2004 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 252EB16A4CE; Fri, 18 Jun 2004 07:00:13 +0000 (GMT) Received: from tigra.ip.net.ua (tigra.ip.net.ua [82.193.96.10]) by mx1.FreeBSD.org (Postfix) with ESMTP id EE82D43D2F; Fri, 18 Jun 2004 07:00:09 +0000 (GMT) (envelope-from ru@ip.net.ua) Received: from heffalump.ip.net.ua (heffalump.ip.net.ua [82.193.96.213]) by tigra.ip.net.ua (8.12.11/8.12.11) with ESMTP id i5I6gUie094160 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Fri, 18 Jun 2004 09:42:31 +0300 (EEST) (envelope-from ru@ip.net.ua) Received: (from ru@localhost) by heffalump.ip.net.ua (8.12.11/8.12.11) id i5I6ZrvE008388; Fri, 18 Jun 2004 09:35:53 +0300 (EEST) (envelope-from ru) Date: Fri, 18 Jun 2004 09:35:53 +0300 From: Ruslan Ermilov To: "Simon L. Nielsen" Message-ID: <20040618063553.GA8235@ip.net.ua> References: <20040617195633.GG907@zaphod.nitro.dk> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="Qxx1br4bt0+wmkIi" Content-Disposition: inline In-Reply-To: <20040617195633.GG907@zaphod.nitro.dk> User-Agent: Mutt/1.5.6i X-Virus-Scanned: by amavisd-new X-Spam-Checker-Version: SpamAssassin 2.55 (1.174.2.19-2003-05-19-exp) cc: "Bruce A. Mah" cc: freebsd-doc@FreeBSD.org cc: Hiroki Sato Subject: Re: Auto generated hardware notes X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 18 Jun 2004 07:00:13 -0000 --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--