Re: A slight problem with collateindex.pl...

Re: A slight problem with collateindex.pl...

[Edward C. Bailey]

>>>>> "Norman" == Norman Walsh <ndw@nwalsh.com> writes:

Norman> Sounds like a collateindex bug to me. Send me a small test file
Norman> that demonstrates the bug and I'll take a crack at it.

Sure -- here 'tis:

<!DOCTYPE BOOK PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY GENERATED-INDEX SYSTEM "generated-index.sgml">
]>

<Book id="index">
  <chapter>
    <title>Using the <replaceable>&lt;foo&gt;</replaceable> Parameter</title>
    <indexterm>
      <primary><replaceable>&lt;foo&gt;</replaceable> parameter</primary>
    </indexterm>
    <para>
      This is a <emphasis>really</emphasis> short book.
    </para>
  </chapter>
  &GENERATED-INDEX;
</book>

Re: A slight problem with collateindex.pl...

[Jorge Godoy]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain, Size: 952 bytes --]

On Mon, Feb 07, 2000 at 04:12:58PM -0500, Edward C. Bailey wrote:
> Hello all,

Hi,

(SNIP)

>               -n <string> -- Use <string> as the default name

(SNIP)

> Has anyone run into this and either know of a fix or a workaround?

Ed,

I see two solutions: using the parameter element (and then configure
it's output format in the DSL file) or using <sgmltag
class="starttag"> as a workaround. 

The <sgmltag> will format it with the angle brackets but I think it's
the wrong solution. 
--
Godoy.	<godoy@conectiva.com.br>               GPG Fingerprint
                                         851B B620 626D 2AD0 E783
"Ser poeta não é minha ambição,          E932 1330 BE6D A4A3 0625 
 é minha maneira de estar sozinho"
              - Fernando Pessoa.       Publicações @ Conectiva S.A. 

Except where explicitly stated I speak on my own behalf.
Exceto onde explicitado as declarações aqui feitas são apenas minhas.

Re: A slight problem with collateindex.pl...

[Norman Walsh]

/ "Edward C. Bailey" <ed@redhat.com> was heard to say:
| We use &lt; and &gt; to represent the angle brackets, and wrap the whole
| thing in something like <replaceable>.  So far so good.  We then might use
| this convention in a section's title, so it says something like:

I would be tempted, myself, to generate the &lt; and &gt; automatically
for <replaceable> content, if that's what you want, but anyway...

| generated, the &lt; and &gt; get replaced with "<" and ">".  Then when jade
| is re-run, it gets very unhappy at all these <string> tags sprinkled
| throughout the index...
| 
| Has anyone run into this and either know of a fix or a workaround?

Sounds like a collateindex bug to me. Send me a small test file that
demonstrates the bug and I'll take a crack at it.

                                        Be seeing you,
                                          norm

-- 
Norman Walsh <ndw@nwalsh.com>      | Everything in the univese goes by
http://nwalsh.com/                 | indirection. There are no straight
                                   | lines.--Emerson

A slight problem with collateindex.pl...

[Edward C. Bailey]

Hello all,

    We're currently using collateindex.pl to produce indexes for the HTML
versions of our DocBook documents.  However I found a slight problem, and
was wondering if anyone has seen (and hopefully fixed) it:

    One of our documents uses the convention of describing command formats
in this manner:

                              foo -n <string>

Where -- in actual use -- <string> is meant to be replaced with a string of
some sort.  Likewise, if we were to document the "ls" command, we might
write it like this:

                                 ls <file>

We use &lt; and &gt; to represent the angle brackets, and wrap the whole
thing in something like <replaceable>.  So far so good.  We then might use
this convention in a section's title, so it says something like:

              -n <string> -- Use <string> as the default name

(Of course, in our source document, we use &lt; and &gt;)

Still with me?  Ok, here is where things go wrong.  Let's say that I have
an <indexterm> that points to this section.  The index will then include
the text from the <indexterm>, and include a link to the section, using the
section's title as the link text.  Unfortunately, when the index SGML is
generated, the &lt; and &gt; get replaced with "<" and ">".  Then when jade
is re-run, it gets very unhappy at all these <string> tags sprinkled
throughout the index...

Has anyone run into this and either know of a fix or a workaround?

                            Thanks,

                                Ed
-- 
Ed Bailey        Red Hat, Inc.          http://www.redhat.com/