Re: [docbook-apps] Set Index

Thanks for the incite into <setindex/> I will be able to employ this in a project I am working one. DocBook is awesome.

On Wed, Feb 17, 2016 at 8:08 PM, Bob Stayton <> wrote:
Hi Emily,

The setindex element that is normally empty also supports a "preamble", which would be block elements which appear after the Index title and before the first entries.  So you could put your abbreviation key in your <set> document:

<setindex>

  <para>Book key:</para>

  <variablelist>

    <varlistentry>

      <term>BK1</term>

      <listitem><para>Book Number 1</para></listitem>

    </varlistentry>

    ...

  </variablelist>

I've also seen where such a key is squeezed into the footer of the index pages, so the reader doesn't have to page back to the beginning of the index to find the key.

I'll send more info about how to generate the abbreviations on index page numbers later.

Bob Stayton

Sagehill Enterprises



On 2/17/2016 1:22 PM, Forsyth, Emily B. wrote:

Think I will try to put an abbreviated name of the book with each

index item.  May get bulky, but think that might be the best with my

limited knowledge of dockbooks and the language.  Maybe I can figure

out some way to get the abbreviated names of each book in a list.  I

think there will be about 6 books within a set, so that may work.

Thank you,

Emily Forsyth Fluids & Machinery Engineering Department Propulsion &

Energy Machinery Southwest Research Institute Tel:  210.522.2045

Email:  

-----Original Message----- From: Bob Stayton

[mailto:] Sent: Wednesday, February 17, 2016 12:44

PM To: Forsyth, Emily B.; Pc Thoms Cc:

 Subject: Re: [docbook-apps] Set

Index

Hi Emily, First, the stylesheet parameter 'index.links.to.section'

applies to the HTML stylesheet, not the PDF stylesheet.  And

stylesheet parameters are set in a stylesheet customization file, not

in the document itself.

It sounds like what you want is to add a prefix to each page number

in the setindex to indicate which book it is in.  As you say, some

index entries may appear in both books, so the designation would have

to be associated with the page number, not the indexterm.

DocBook XSL does not yet have a feature to generate such a prefix,

but it is possible to write an XSL customization for it.  If you are

new to DocBook and XSL, then that would be challenging because the

index templates are among the most complex templates in the

stylesheet.

I could help with some of the specifics, but if you are going to get

into customization I would suggest you learn a bit about it so you

can set it up properly.  You might start with this description of

DocBook customization:

http://www.sagehill.net/docbookxsl/CustomMethods.html

Do you know what the index would look like with the book

designations? Using the book title seems a bit long for a prefix on

every page number.

Bob Stayton Sagehill Enterprises 

On 2/17/2016 10:04 AM, Forsyth, Emily B. wrote:

I appreciate your help, but I’m so new at this and fumbling my way

through that I don’t know where to put these commands you have

provided me.  I tried in the Thermo Guide at the beginning.  This

is what I have:

<info>

<mediaobject>

<imageobject>

<imagedata fileref="Logo/NPSSLogo.jpg"/>

</imageobject>

</mediaobject>

<title><trademark class="registered">NPSS</trademark> Fluid Network

Thermo

Guide</title>

</info>

<chapter>

<title>Introduction</title>

<param name="index.links.to.section" select="1"/>

Not sure where to put the endtag.  Seems no matter where I locate

it I get an error message.  Will this work for PDF documents?

/Thank you,/

//

/Emily Forsyth/

/Fluids & Machinery Engineering Department /

/Propulsion & Energy Machinery/

/Southwest Research Institute/

/Tel:  210.522.2045/

/Email:/ <mailto:>_

*From:*Pc Thoms [mailto:] *Sent:* Wednesday,

February 17, 2016 11:54 AM *To:* Forsyth, Emily B. *Subject:* Re:

[docbook-apps] Set Index

Hi Emily

Please send you comments to the



<https://urldefense.proofpoint.com/v2/url?u=http-3A__lists.oasis-2Dope

n.org&d=BQMFaQ&c=l_IU86Q8JTGnHn9K9kRmRlrLmhfeE6S9tCyr6T8mzvM&r=nkJ2prS

gVIC5A7kfAOwaXnr8Ot9TBbdZ7zH33apMFcM&m=U-ZCauLoTpgZ8Jk8wCc7ULKsCcU0eWc

n7ingy_AOTd4&s=tALua3NkilaTWtpKkci4j0Tktp8x0N1rnd8Gf2WHSDM&e=>

as well.

Have you changed the setting to the parameter?

index.links.to.section

http://docbook.sourceforge.net/release/xsl/1.78.0/doc/html/index.links

.to.section.html

<https://urldefense.proofpoint.com/v2/url?u=http-3A__docbook.sourcefor

ge.net_release_xsl_1.78.0_doc_html_index.links.to.section.html&d=BQMFa

Q&c=l_IU86Q8JTGnHn9K9kRmRlrLmhfeE6S9tCyr6T8mzvM&r=nkJ2prSgVIC5A7kfAOwa

Xnr8Ot9TBbdZ7zH33apMFcM&m=U-ZCauLoTpgZ8Jk8wCc7ULKsCcU0eWcn7ingy_AOTd4&

s=Fns8tG-75euzcSipTv4fVtDguvRFICDucfAnDrjz2aI&e=>

On Wed, Feb 17, 2016 at 1:55 PM, Forsyth, Emily B.

< <mailto:>> wrote:

I can get the index in the book.

My problem is I have a series of books that we are combining into

a set so they all print together and our members only gets one file

with all the documentation.  I have the indexterms in each of the

books, but when I go into the set and have the books combined, this

is what I get:

This is the Bookmarks for my PDF File:

1^st Page – Combined Guides

2^nd Page – Table of Contents (which is a TOC for the entire set,

lists both books and their sections and page numbers)

Then I get the 1^st Book which is the User Guide and within that

it has all the sections and subsections along with the Index for

that Guide

Next,  I get the Thermo Guide and within that it has all the

sections and subsections along with the Index for that Guide

Last, I get the Set Index for both the guides and it lists all the

items in the combined indices, but does not list the book they may

be in.  If we have a member that doesn’t know which book an index

item may be in, we want him to be able to go to the Set Index and

click on the Item and know which book he is going to.  Some of the

items may cross both books and he may just want the one in a

certain book

Does that make sense what I said?

/Thank you,/

//

/Emily Forsyth/

/Fluids & Machinery Engineering Department /

/Propulsion & Energy Machinery/

/Southwest Research Institute/

/Tel: 210.522.2045 <tel:210.522.2045>/

/Email:/ <mailto:>_

*From:*Pc Thoms [mailto:

<mailto:>] *Sent:* Wednesday, February 17, 2016

11:15 AM *To:* Forsyth, Emily B.;



<mailto:> *Subject:* Re:

[docbook-apps] Set Index

Hi Emily

If you place the

<indexterm><primary>defaultComposition<primary><indexterm> in the

docbook xml file User Guide it will generate an index similiar to

what like the following:

defaultComposition, User Guide

This will require searching through the text for the specific point

at which to insert the <indexterm/>.

Beware of white space - especially in long paragraphs.

I usually place the indexterms exactly where they will be placed.

However, if there are several to added to a paragraph - for ease

of reading I place them at the start of the paragraph - moving them

into place in one of the final checks.

Happy indexing!

On Wed, Feb 17, 2016 at 9:37 AM, Forsyth, Emily B.

< <mailto:>> wrote:

Not sure if this is the correct list, but I’ve tried another one I

thought I had subscribed to.

In process of converting our word documents into docbooks.  I’m

very new at this and been printing information and going through

documentation on the website.

Scenario:

I have 5 different documents that converting.  Each one will be

their own book.  I know how to create the index for each book.

However, I will be combining them into a set so that it will be

easier for our members to have one large set of books instead of 5

different books.

I can create the set index and it shows, but my question is:

How do I get each indexed item to reflect the book it is in.

The Set Index shows the following:

Set Index:

D

defaultComposition, 3

F

Fluid Network, 11

FluidPorts, 2

U

Unique variable attributes,3

There are 2 different books, but I don’t know which book the index

item points to and that is what we are trying to get to.  For

example, I would like for the indexed item defaultComposition to

show User Guide and maybe the FluidPorts to show the Thermo Guide.

Is there a way?

Thanks much for your help.

/Thank you,/

/Emily Forsyth/

/Fluids & Machinery Engineering Department /

/Propulsion & Energy Machinery/

/Southwest Research Institute/

/Tel: 210.522.2045 <tel:210.522.2045>/

/Email:/ <mailto:>