Re: DocBook tags: <literal> versus <firstterm>

On 25 February 2010 14:24, Robert P. J. Day <rpjday@crashcourse.ca> wrote: > >  working my way thru the PEAR manual, and i've already noticed a few > examples of the introduction of a new term being tagged as <literal> > rather than <firstterm>.  proposed fix as output of "svn diff": > > Index: en/guide/users/concepts/package.xml > =================================================================== > --- en/guide/users/concepts/package.xml (revision 295501) > +++ en/guide/users/concepts/package.xml (working copy) > @@ -4,7 +4,7 @@ > >  <para> >   The smallest unit that can be managed by Pyrus or the PEAR Installer is > -  a <literal>package</literal>.  A package is a collection of files > +  a <firstterm>package</firstterm>.  A package is a collection of files >   that are organized and defined by a meta-information file called >   <link linkend="guide.developers.package2.intro">package.xml</link>. >  </para> > > >  to be semantically proper, things like that really should be > <firstterm>, should they not?  is there any rendering problem with > using <firstterm> in cases like that? > > rday > -- > > ======================================================================== > Robert P. J. Day                               Waterloo, Ontario, CANADA > >            Linux Consulting, Training and Kernel Pedantry. > > Web page:                                         >  http://crashcourse.ca > Twitter:                                       > http://twitter.com/rpjday > ======================================================================== > > -- > PEAR Documentation List Mailing List (http://pear.php.net/) > To unsubscribe, visit: http://www.php.net/unsub.php > > firstterm : "This element marks the first occurrence of a word or term in a given context. " (TDG) That certainly sounds like the tag to be used. The example TDG has is ... <article xmlns='http://docbook.org/ns/docbook'> <title>Example firstterm</title> <para>In an <firstterm>Object Oriented</firstterm> programming language, data and procedures (called <glossterm>methods</glossterm>) are bound together. </para> </article> So, the tag is good and it is supported as part of the Generic package which both the PEAR and PHP PhD packages extend. -- ----- Richard Quadling "Standing on the shoulders of some very clever giants!" EE : http://www.experts-exchange.com/M_248814.html EE4Free : http://www.experts-exchange.com/becomeAnExpert.jsp Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498&r=213474731 ZOPA : http://uk.zopa.com/member/RQuadling