Bug 69646

Comment 1 Ceri Davies 2004-07-27 12:27:50 UTC

Responsible Changed
From-To: freebsd-doc->ceri

Grab this.  I'm not sure that I'll commit it with the descriptions 
missing, but I'll do something with it.

Comment 2 Ceri Davies 2004-08-04 19:26:27 UTC

On Mon, Jul 26, 2004 at 09:03:44PM -0600, Warren Block wrote:
> The FreeBSD-Glossary has only a few terms listed and defined.
> >How-To-Repeat:
> See /usr/doc/en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml
> >Fix:
> This patch adds all the terms wrapped in <acronym> tags currently
> found in the Handbook.  Definitions are still missing for most and
> cursory for others; this is just a start.

Warren,

The id attributes defined in your patch seem to conflict with some
section id attributes - would it be easy for you to resubmit the patch
with the string "-glossary" appended to each of the ID tags?

Second, the smtp_auth id attribute is invalid - it cannot contain an '_'
character.

And finally,  the current glossary entries do not contain <acronym>
entries, but make use of <glossseealso>: would you be able to code that
up too?

Apologies for throwing more work your way, but you are probably on more
intimate terms with the script used to generate this than I am.

Thanks,

Ceri

On Wed, 4 Aug 2004, Ceri Davies wrote:

> On Mon, Jul 26, 2004 at 09:03:44PM -0600, Warren Block wrote:
>> The FreeBSD-Glossary has only a few terms listed and defined.
>>> How-To-Repeat:
>> See /usr/doc/en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml
>>> Fix:
>> This patch adds all the terms wrapped in <acronym> tags currently
>> found in the Handbook.  Definitions are still missing for most and
>> cursory for others; this is just a start.
>
> Warren,
>
> The id attributes defined in your patch seem to conflict with some
> section id attributes - would it be easy for you to resubmit the patch
> with the string "-glossary" appended to each of the ID tags?

Well, yes and no--the script generates the framework, but not the 
term.  In other words, the script makes the ACPI entry, but I 
hand-entered the Advanced Configuration And Power Interface term.  This 
should not be a problem in the future, because updates will all be done 
by hand (and be far fewer).

> Second, the smtp_auth id attribute is invalid - it cannot contain an '_'
> character.

I can filter out -_/ and other characters from the ID string.

> And finally,  the current glossary entries do not contain <acronym>
> entries, but make use of <glossseealso>: would you be able to code that
> up too?

You mean the <glossee otherterm="term"> instead of <acronym>?

> Apologies for throwing more work your way, but you are probably on more
> intimate terms with the script used to generate this than I am.

It's kind of into handwork territory now, but some automation may be 
possible.  After the glossary is more complete, it should be easier.

-Warren Block * Rapid City, South Dakota USA

On Wed, 4 Aug 2004, Ceri Davies wrote:

> On Mon, Jul 26, 2004 at 09:03:44PM -0600, Warren Block wrote:
>> The FreeBSD-Glossary has only a few terms listed and defined.
>>> How-To-Repeat:
>> See /usr/doc/en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml
>>> Fix:
>> This patch adds all the terms wrapped in <acronym> tags currently
>> found in the Handbook.  Definitions are still missing for most and
>> cursory for others; this is just a start.
>
> The id attributes defined in your patch seem to conflict with some
> section id attributes - would it be easy for you to resubmit the patch
> with the string "-glossary" appended to each of the ID tags?
>
> Second, the smtp_auth id attribute is invalid - it cannot contain an '_'
> character.

The attached patch addresses both points.

> And finally,  the current glossary entries do not contain <acronym>
> entries, but make use of <glossseealso>: would you be able to code that
> up too?

This does not make sense to me; the existing glossary entry on "Berkely 
Software Design" does use <acronym> tags, although the "BSD" entry has a 
<glosssee> entry.  The previously-existing glossary entries are 
inconsistent; a sample or template for what is desired would help. 
Perhaps you are saying there should just be entries for both the whole 
term and the acronym, with the acronym entry pointing to the whole term 
entry with a <glossseealso>?

Further clarification has not been forthcoming, so I'm submitting this 
as-is.

> Apologies for throwing more work your way, but you are probably on more
> intimate terms with the script used to generate this than I am.

At this point, it's done by hand anyway.  I don't know of a way to 
generate the expanded terms with the information currently available 
(i.e., "Advanced Configuration and Power Interface" from ACPI).  There 
were only 111 new terms, so I looked up the ones I didn't know.

-Warren Block * Rapid City, South Dakota USA

On Fri, Aug 13, 2004 at 10:50:10PM -0600, Warren Block wrote:
> On Wed, 4 Aug 2004, Ceri Davies wrote:
> >
> >The id attributes defined in your patch seem to conflict with some
> >section id attributes - would it be easy for you to resubmit the patch
> >with the string "-glossary" appended to each of the ID tags?
> >
> >Second, the smtp_auth id attribute is invalid - it cannot contain an '_'
> >character.
> 
> The attached patch addresses both points.

Thank you Warren - I apologise for not getting back to you earlier this
week; real life, etc...

> >And finally,  the current glossary entries do not contain <acronym>
> >entries, but make use of <glossseealso>: would you be able to code that
> >up too?
> 
> This does not make sense to me; the existing glossary entry on "Berkely 
> Software Design" does use <acronym> tags, although the "BSD" entry has a 
> <glosssee> entry.  The previously-existing glossary entries are 
> inconsistent; a sample or template for what is desired would help. 
> Perhaps you are saying there should just be entries for both the whole 
> term and the acronym, with the acronym entry pointing to the whole term 
> entry with a <glossseealso>?

That's what I meant, yes.  I can add these, it's no problem.

Thanks very much for following up on this; I'm sorry that I didn't have
time to help you out.

Ceri

Comment 6 Ceri Davies 2004-08-14 16:13:31 UTC

State Changed
From-To: open->closed

Committed, with minor changes.  Thank you so much.