[PEAR-DOC] DocBook tags: <literal> versus <firstterm>

[Richard Quadling]

 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>
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.

[Robert P. J. Day]

On Thu, 25 Feb 2010, Richard Quadling wrote:

... snip ...

Post by Richard Quadling
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.

i can submit a patch that adjusts a number of those tagged terms.
can someone explain the proper "svn diff" incantation to post, along
with the proper subject line, etc?

i'm familiar with the concept of submitting patches, having
submitted quite a number of them to the linux kernel mailing list. i
just need to know the proper recipe for submitting them here.
if there's a web page that explains that, all i need is the link.
thanks.

rday
--

========================================================================
Robert P. J. Day Waterloo, Ontario, CANADA

Linux Consulting, Training and Kernel Pedantry.

Web page: http://crashcourse.ca
Twitter: http://twitter.com/rpjday
========================================================================

[Richard Quadling]

Post by Robert P. J. Day
... snip ...

Post by Richard Quadling
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.

 i can submit a patch that adjusts a number of those tagged terms.
can someone explain the proper "svn diff" incantation to post, along
with the proper subject line, etc?
 i'm familiar with the concept of submitting patches, having
submitted quite a number of them to the linux kernel mailing list.  i
just need to know the proper recipe for submitting them here.
if there's a web page that explains that, all i need is the link.
thanks.
rday
--
========================================================================
Robert P. J. Day                               Waterloo, Ontario, CANADA
           Linux Consulting, Training and Kernel Pedantry.
Web page:                                          http://crashcourse.ca
Twitter:                                       http://twitter.com/rpjday
========================================================================

svn diff should be enough for the diff.

You can read the commit messages by looking at any of the commits
online (http://svn.php.net/viewvc?view=revision&revision=295501 for
example).

If you are fixing a bug, then using fix# or bug# followed by the
actual number will allow the the svn hooks update the bug for you.