This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Re: <type> and <link> in <funcsynopsis>
- To: docbook at lists dot oasis-open dot org
- Subject: Re: DOCBOOK: <type> and <link> in <funcsynopsis>
- From: Norman Walsh <ndw at nwalsh dot com>
- Date: Thu, 30 Mar 2000 11:55:49 -0500
- References: <38DE3DF3.8037FA14@uswest.net>
- Reply-To: docbook at lists dot oasis-open dot org
/ Eric Lemings <elemings@uswest.net> was heard to say:
| Consider the following DocBook <funcsynopsis>:
|
| <funcsynopsis>
| <funcsynopsisinfo>
| #include <Support.h>
| </funcsynopsisinfo>
| <funcprototype>
| <funcdef>
| <link linkend="Const-Text"><type>Const_Text</type></link>
| <function>Status_To_Text</function>
| </funcdef>
| <paramdef>
| <link linkend="Status"><type>Status</type></link>
| <parameter>status</parameter>
| </paramdef>
| </funcprototype>
| </funcsynopsis>
[...]
| I consider the exclusion of <link> (and <xref>) and <type> (especially)
| in <funcdef> and <paramdef> to be a bug. A type is almost always the
| first part of these elements and sometimes refers to a type definition
| in another part of the document.
I agree that type and the linking elements probably belong in there,
I'm less sure about xref. I'll add an RFE about this.
Be seeing you,
norm
--
Norman Walsh <ndw@nwalsh.com> | Wandering in a vast forest at
http://www.oasis-open.org/docbook/ | night, I have only a faint light
Chair, DocBook Technical Committee | to guide me. A stranger appears
| and says to me: "My friend, you
| should blow out your candle in
| order to find your way more
| clearly." This man is a
| theologian.--Diderot