Date: Fri, 16 Mar 2001 19:08:08 +0000 From: Nik Clayton <nik@freebsd.org> To: Udo Erdelhoff <uerdelho@eu.uu.net> Cc: doc@FreeBSD.org, Udo Erdelhoff <ue@nathan.ruhr.de>, Nik Clayton <nik@FreeBSD.org> Subject: Re: Translators: Need feedback on FAQ reorganization Message-ID: <20010316190808.A389@canyon.nothing-going-on.org> In-Reply-To: <20010316104207.H24155@django.de.uu.net>; from uerdelho@eu.uu.net on Fri, Mar 16, 2001 at 10:42:07AM %2B0000 References: <20010312214725.B74204@canyon.nothing-going-on.org> <20010313002953.I77178@nathan.ruhr.de> <20010313124524.B2130@canyon.nothing-going-on.org> <20010313231654.G83336@nathan.ruhr.de> <20010314131233.C6138@canyon.nothing-going-on.org> <20010314210730.J83336@nathan.ruhr.de> <20010315023806.B46684@canyon.nothing-going-on.org> <20010315200337.N83336@nathan.ruhr.de> <20010315210350.A1113@canyon.nothing-going-on.org> <20010316104207.H24155@django.de.uu.net>
next in thread | previous in thread | raw e-mail | index | archive | help
--wq9mPyueHGvFACwf
Content-Type: multipart/mixed; boundary="bp/iNruPH9dso1Pn"
Content-Disposition: inline
--bp/iNruPH9dso1Pn
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
On Fri, Mar 16, 2001 at 10:42:07AM +0000, Udo Erdelhoff wrote:
> On Thu, Mar 15, 2001 at 09:03:50PM +0000, Nik Clayton wrote:
> > On Thu, Mar 15, 2001 at 08:03:37PM +0100, Udo Erdelhoff wrote:
> > > On Thu, Mar 15, 2001 at 02:38:06AM +0000, Nik Clayton wrote:
> > > > If you've submitted stuff to the -doc list before and not had any f=
eedback
> > > > then I'm sorry, but sometimes that's how things work.
> > >=20
> > > Yeah, that's what I told myself the first time a month's work went do=
wn
> > > the drain. I still believed it the second time. By the third time, I =
took
> > > the hint and stopped doing it.
> >=20
> > As already noted, you seem to have
> > a good record of getting PRs committed.
>=20
> That's no big surprise because I've learned to cheat: Find a committer,
> pester him until he agrees to the proposed change, do the work, submit
> the PR and voila, no more working for the trash can. No, that's not
> the correct way to do things.
That's certainly one way to do things. Until we get more committers I
wouldn't be surprised if it was quite an effective way.
> > I am also *not* about to start pulling out stuff committed by other
> > people because I don't have the time to go through it in detail.
>=20
> This is an ... intresting statement; especially in combination with your
> remarks about 'following up with Alex'.=20
I have no intention of pulling out any work you've done while there's no
alternative. But when there is an alternative, I would expect the
German (and any other translations) to to follow suit.
> > "Interesting idea, but I don't have the time to look at it right now,
> > please come back when I do" is also not going to encourage people to
> > contribute. If I have nothing constructive to add I try and stay away
> > from the topic until I can.
>=20
> If the discussion is on the list, that's one thing. If it's a mail to
> you, a "Interesting, must look at it later" is way better than silence.
I do my best to make sure that stuff like this is replied to with "I'm
too busy right now, please try asking on -doc where someone else may be
able to assist."
Stuff slips through the cracks some times. Sorry, but that's life.
=20
> In this spirit I'll refrain from comments about the bibliography issue.
> It's quite clear (to me, at least ;->) that we should agree to disagree
> on this subject. Both approaches have their advantages and disadvantages;
> right now I'm resting my case on the point that existing code is one of t=
he
> better arguments :->
Attached is a diff to freebsd.dsl which rewrites Norm's
xref-biblioentry function, and a diff to the FAQ to use it. It pulls in
the title, publisher, and ISBN when a biblio entry is referenced, and
leaves the rest of the information in the bibliography. It's trivial to
extend this to include other elements from the bibliography (and if you,
or anyone else, is looking for an easy way to in to DSSSL I suggest
looking at my xref-biblioentry function, and Norm's in
$PREFIX/share/sgml/docbook/dsssl/modular/html/dblink.dsl to see how I
modified it).
Acceptable compromise? Test it by applying the patches and doing
make JADEFLAGS=3D-Vbiblio-xref-title
As a bonus, I've also knocked up a quick function (probably needs a
little work) that shows how every &man.xxx.n; reference (which devolves
to <citerefentry>) can automatically be turned in to links to the CGI
manual page thingy on www.freebsd.org.
N
--=20
FreeBSD: The Power to Serve http://www.freebsd.org/
FreeBSD Documentation Project http://www.freebsd.org/docproj/
--- 15B8 3FFC DDB4 34B0 AA5F 94B7 93A8 0764 2C37 E375 ---
--bp/iNruPH9dso1Pn
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename=diff1
Content-Transfer-Encoding: quoted-printable
Index: freebsd.dsl
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /home/ncvs/doc/share/sgml/freebsd.dsl,v
retrieving revision 1.25
diff -u -r1.25 freebsd.dsl
--- freebsd.dsl 2001/03/04 18:05:19 1.25
+++ freebsd.dsl 2001/03/16 19:01:46
@@ -1,3 +1,5 @@
+
+
<!-- $FreeBSD: doc/share/sgml/freebsd.dsl,v 1.25 2001/03/04 18:05:19 nik E=
xp $ -->
=20
<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
@@ -78,6 +80,16 @@
(empty-sosofo))
($email-footer$))))
=20
+ (element citerefentry
+ (let* ((title (select-elements (children (current-node))
+ (normalize "refentrytitle=
")))
+ (manvolnum (select-elements (children (current-node))
+ (normalize "manvolnum")))
+ (href (string-append
+"http://www.freebsd.org/cgi/man.cgi?" (data title) "(" (data manvolnum) ")=
" )))
+ (make element gi: "A"
+ attributes: (list (list "HREF" href))
+ (process-children))))
]]>
=20
<!-- HTML with images ............................................ =
-->
@@ -354,6 +366,56 @@
(string-append "Q" (question-answer-label)))
(else
(string-append "AEN" (number->string (all-element-number nd)))=
)))
+
+
+(define (xref-biblioentry target)
+ (let* ((abbrev (node-list-first
+ (node-list-filter-out-pis (children target))))
+ (label (attribute-string (normalize "xreflabel") target)))
+
+ (if biblio-xref-title
+ (let* ((citetitles (select-elements (descendants target)
+ (normalize "citetitle")))
+ (titles (select-elements (descendants target)
+ (normalize "title")))
+ (isbn (select-elements (descendants target)
+ (normalize "isbn")))
+ (publisher (select-elements (descendants target)
+ (normalize "publishername")))
+ (title (if (node-list-empty? citetitles)
+ (node-list-first titles)
+ (node-list-first citetitles))))
+ (with-mode xref-title-mode
+ (make sequence
+ (process-node-list title)
+ (if (node-list-empty? publisher)
+ (empty-sosofo)
+ (make sequence
+ (literal %biblsep%)
+ (process-node-list publisher)))
+ (if (node-list-empty? isbn)
+ (empty-sosofo)
+ (make sequence
+ (literal %biblsep%)
+ (literal "ISBN: ")
+ (process-node-list isbn))))))
+ (if biblio-number
+ (make sequence
+ (literal "[" (number->string (bibentry-number target)) "]"))
+ (if label
+ (make sequence
+ (literal "[" label "]"))
+ (if (equal? (gi abbrev) (normalize "abbrev"))
+ (make sequence
+ (process-node-list abbrev))
+ (make sequence
+ (literal "[" (id target) "]"))))))))
+<![ %output.html [
+(mode xref-title-mode
+ (element isbn ($charseq$)))
+ =20
+
+]]>
</style-specification-body>
</style-specification>
=20
--bp/iNruPH9dso1Pn
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename=diff2
Content-Transfer-Encoding: quoted-printable
Index: book.sgml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /home/ncvs/doc/en_US.ISO_8859-1/books/faq/book.sgml,v
retrieving revision 1.157
diff -u -r1.157 book.sgml
--- book.sgml 2001/03/15 02:02:41 1.157
+++ book.sgml 2001/03/16 18:59:08
@@ -617,48 +617,23 @@
=20
<itemizedlist>
<listitem>
- <para>4.4BSD System Manager's Manual <!-- <br> -->
- By Computer Systems Research Group, UC Berkeley <!-- <br> =
-->
- 1st Edition June 1994, 804 pages <!-- <br> -->
- <ulink
- URL=3D"http://www.amazon.com/exec/obidos/ASIN/1-56592-080-=
5">ISBN</ulink>:
- 1-56592-080-5 <!-- <br> --></para>
+ <para><xref linkend=3D"biblio-44sysman"></para>
</listitem>
=20
<listitem>
- <para>4.4BSD User's Reference Manual <!-- <br> -->
- By Computer Systems Research Group, UC Berkeley <!-- <br> =
-->
- 1st Edition June 1994, 905 pages <!-- <br> -->
- <ulink
- URL=3D"http://www.amazon.com/exec/obidos/ASIN/1-56592-075-=
9">ISBN</ulink>:
- 1-56592-075-9 <!-- <br> --></para>
+ <para><xref linkend=3D"biblio-44userman"></para>
</listitem>
=20
<listitem>
- <para>4.4BSD User's Supplementary Documents <!-- <br> -->
- By Computer Systems Research Group, UC Berkeley <!-- <br> =
-->
- 1st Edition July 1994, 712 pages <!-- <br> -->
- <ulink
- URL=3D"http://www.amazon.com/exec/obidos/ASIN/1-56592-076-=
7">ISBN</ulink>:
- 1-56592-076-7 <!-- <br> --></para>
+ <para><xref linkend=3D"biblio-44suppman"></para>
</listitem>
=20
<listitem>
- <para>4.4BSD Programmer's Reference Manual <!-- <br> -->
- By Computer Systems Research Group, UC Berkeley <!-- <br> =
-->
- 1st Edition June 1994, 886 pages <!-- <br> -->
- <ulink
- URL=3D"http://www.amazon.com/exec/obidos/ASIN/1-56592-078-=
3">ISBN</ulink>:
- 1-56592-078-3 <!-- <br> --></para>
+ <para><xref linkend=3D"biblio-44progman"></para>
</listitem>
=20
<listitem>
- <para>4.4BSD Programmer's Supplementary Documents <!-- <br> =
-->
- By Computer Systems Research Group, UC Berkeley <!-- <br> =
-->
- 1st Edition July 1994, 596 pages <!-- <br> -->
- <ulink
- URL=3D"http://www.amazon.com/exec/obidos/ASIN/1-56592-079-=
1">ISBN</ulink>:
- 1-56592-079-1 <!-- <br> --></para>
+ <para><xref linkend=3D"biblio-mckusick-1"></para>
</listitem>
</itemizedlist>
=20
@@ -11870,4 +11845,128 @@
<para>And to any others we've forgotten, apologies and heartfelt
thanks!</para>
</chapter>
+
+ <bibliography>
+ <title>Useful Books</title>
+
+ <biblioentry id=3D"biblio-44sysman">
+ <biblioset relation=3D"book">
+ <title>4.4BSD System Manager's Manual</title>
+=09
+ <corpauthor>Computer Systems Research Group, University of=20
+ California, Berkeley</corpauthor>
+=09
+ <publisher>
+ <publishername>O'Reilly and Associates</publishername>
+ </publisher>
+=09
+ <edition>1st</edition>
+=09
+ <pubdate>June 1994</pubdate>
+=09
+ <isbn>1-56592-080-5</isbn>
+ </biblioset>
+ </biblioentry>
+ =20
+ <biblioentry id=3D"biblio-44userman">
+ <biblioset relation=3D"book">
+ <title>4.4BSD User's Reference Manual</title>
+=09
+ <corpauthor>Computer Systems Research Group, University of=20
+ California, Berkeley</corpauthor>
+ =20
+ <publisher>
+ <publishername>O'Reilly and Associates</publishername>
+ </publisher>
+=09
+ <pubdate>1994</pubdate>
+=09
+ <isbn>1-56592-075-9</isbn>
+ </biblioset>
+
+ <biblioentry id=3D"biblio-44suppman">
+ <biblioset relation=3D"book">
+ <title>4.4BSD User's Supplementary Documents</title>
+=09
+ <corpauthor>Computer Systems Research Group, University of=20
+ California, Berkeley</corpauthor>
+=09
+ <publisher>
+ <publishername>O'Reilly and Associates</publishername>
+ </publisher>
+=09
+ <pubdate>1994</pubdate>
+=09
+ <isbn>1-56592-076-7</isbn>
+ </biblioset>
+ </biblioentry>
+ =20
+ <biblioentry id=3D"biblio-44progman">
+ <biblioset relation=3D"book">
+ <title>4.4BSD Programmer's Reference Manual</title>
+=09
+ <corpauthor>Computer Systems Research Group, University of=20
+ California, Berkeley</corpauthor>
+=09
+ <publisher>
+ <publishername>O'Reilly and Associates</publishername>
+ </publisher>
+=09
+ <pubdate>1994</pubdate>
+=09
+ <isbn>1-56592-078-3</isbn>
+ </biblioset>
+ </biblioentry>
+ =20
+ <biblioentry id=3D"biblio-mckusick-1">
+ <abbrev>McKusick et al, 1994</abbrev>
+=09
+ <biblioset relation=3D"manual">
+ <title>Berkeley Software Architecture Manual, 4.4BSD Edition</title>
+ =20
+ <authorgroup>
+ <author>
+ <firstname>M. K.</firstname>
+ <surname>McKusick</surname>
+ </author>
+ =20
+ <author>
+ <firstname>M. J.</firstname>
+ <surname>Karels</surname>
+ </author>
+ =20
+ <author>
+ <firstname>S. J.</firstname>
+ <surname>Leffler</surname>
+ </author>
+ =20
+ <author>
+ <firstname>W. N.</firstname>
+ <surname>Joy</surname>
+ </author>
+ =20
+ <author>
+ <firstname>R. S.</firstname>
+ <surname>Faber</surname>
+ </author>
+ </authorgroup>
+=09
+ <pagenums>5:1-42</pagenums>
+ </biblioset>
+
+ <biblioset relation=3D"book">
+ <title>4.4BSD Programmer's Supplementary Documents</title>
+
+ <publisher>
+ <publishername>O'Reilly & Associates, Inc.</publishername>
+ <address>
+ <city>Sebastopol</city>
+ <state>CA</state>
+ </address>
+ </publisher>
+
+ <pubdate>1994</pubdate>
+ </biblioset>
+ </biblioentry>
+ </bibliography>
</book>
--bp/iNruPH9dso1Pn--
--wq9mPyueHGvFACwf
Content-Type: application/pgp-signature
Content-Disposition: inline
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.4 (FreeBSD)
Comment: For info see http://www.gnupg.org
iEYEARECAAYFAjqyZGQACgkQk6gHZCw343UrbACfVEMKzEy0TsbkGexIlIpgGsWL
92kAoIAgyrm1kxA3yrjeLWcAdnsDrUri
=Mvmw
-----END PGP SIGNATURE-----
--wq9mPyueHGvFACwf--
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010316190808.A389>