[Search for users] [Overall Top Noters] [List of all Conferences] [Download this site]

Conference vaxuum::document_ft

Title:DOCUMENT T1.0
Notice:**New notesfile (DOCUMENT.NOTE) now available (see note 897)**
Moderator:CLOSET::ADLER
Created:Mon Feb 09 1987
Last Modified:Thu Oct 31 1991
Last Successful Update:Fri Jun 06 1997
Number of topics:897
Total number of notes:4397

324.0. "<XSUBENTRY> or <SUBENTRY> for index subentries?" by DSSDEV::EPPES (Dignity, always dignity) Thu Apr 30 1987 18:48

    A fellow writer just came to me and asked whether I knew what the
    <XS> tag was.  My guess was that it was an abbreviation for the index
    subentry tag, but it is not documented in the DOCUMENT User's Guide,
    Part 1.  Further investigation revealed that not only is <XS> or
    <XSUBENTRY> not documented, there is also confusion about whether the
    tag is <XSUBENTRY> or <SUBENTRY>.  The description of the <X> tag on
    page 13-239 of the UG Part 1 mentions the <SUBENTRY> tag in the example
    in the description of the index-entry argument.  However, there is no
    separate description of the <SUBENTRY> tag in that reference section.
    And, in Chapter 9 (Creating an Index or Table of Contents), on page
    9-4, the subentry tag is listed as <XSUBENTRY>, which is also not
    documented separately in the tag reference section.  We finally figured
    out that <XSUBENTRY> is the correct tag because it is mentioned in the
    release notes (thank heaven for them!).  So, it would be good to go
    through Part 1 of the UG and check all reference to index subentry tags
    and check that the right one (<XSUBENTRY>, apparently) is documented
    and also that it has its own description in the tag reference section.
    (Maybe this is taken care of already...?)

    							-- Nina
T.RTitleUserPersonal
Name
DateLines
324.1<xs> and <xsubentry> ok; here's another questionCOOKIE::JOHNSTONThu Apr 30 1987 19:4838
There is another note in this conference describing <xsubentry> and <xs>, 
either of which can be used within an <x> or <y> tag to indicate a subentry.
I think I added the keyword INDEX to that note, so you might try doing a
directory.  Note that subentries are limited to two levels, for which I would 
like to thank the developers.  Someone else out there will disagree with me,
but I think it's a case where restrictions are necessary to help people
write useful indexes.  

Now I have a question:  Does document break a page before it reads an index 
entry or after?  This was a problem I consistently ran into with DSR; I never 
knew if an index entry would be referenced in final output on page 1 or page 2,
if the referenced text itself was as the bottom of page 1 or page 2; it
was usually incorrect, regardless.  This is a hard thing to explain, but if
you worked with DSR indexes for any length of time, you probably understand what
I'm trying to say.

Consider the following example:


Van Gogh 
<x>(Van Gogh)
was an artist given to strange behaviors, like cutting off his ear.  Picasso
<x>(Picasso)
was also an artist given to strange behaviors, though some would say he was
eccentric and not strange.  Many people look at Picasso's paintings,
now hanging in famous museums, and they think that maybe he had nightmares
as a child.  
<x>(Picasso<xs> his childhood nightmares)



If the last sentence "Many people..." is placed at the top of page 2, 
is it likely or possible that DOCUMENT will reference it on page 1, and why? 
(DSR *would* do things like that.)

Thanx

Rose
324.2To be done shortly.VAXUUM::CORMANFri May 01 1987 12:005
    Will do. I know the description is missing... it will be explained
    under the <x>tag, since it only works in the context of the <x>
    tag (I believe; have to check on this one). 
    
    -Barbara
324.3DSSDEV::EPPESDignity, always dignityFri May 01 1987 12:155
    RE .1 -- I did do a DIR/KEY=INDEX, and got two other notes listed, 64
    and 261.  The <XSUBENTRY>/<SUBENTRY> issue is mentioned in passing
    in a reply to 64.  It is not mentioned at all in 261.

							-- Nina
324.4Also <Y> TagCLOSET::ETZELMikeFri May 01 1987 16:552
    <xs> also works under the <y> tag.
    
324.5dedicated to eliminating confusionATLAST::BOUKNIGHTEverything has an outlineWed May 06 1987 11:504
    For consistency, wouldn't it be better for the tag to be <YS> under
    <Y>?
    
    jack
324.6a wishlist item?VAXUUM::OTTEWed May 06 1987 12:006
    For consistency it should probably be <SUBENTRY> since it works
    in both <X> and <Y> tags.  Maintaining the code and documentation for two
    tags that are exactly the same but which have different names sounds
    like trouble waiting to happen. 
    
    -randy
324.7wishing with hindsightCLOSET::ANKLAMThu May 07 1987 01:347
    
    renaming tags could get dangerous. for what it's worth, we
    did consider <subentry>, but opted for <xsubentry> so the
    tag would appear in the documentation next to <x>. if I were
    to really rename them, they'd end up <index_entry>, <index_subentry>,
    and <index_reference>.
    
324.8CLOSET::ADLERTue May 19 1987 19:3640
RE: .1

> Now I have a question:  Does document break a page before it reads an index 
> entry or after?  This was a problem I consistently ran into with DSR; I never 
> knew if an index entry would be referenced in final output on page 1 or page 
> 2, if the referenced text itself was as the bottom of page 1 or page 2; it
> was usually incorrect, regardless.  This is a hard thing to explain, but if
> you worked with DSR indexes for any length of time, you probably understand 
> what I'm trying to say.

> Consider the following example:

> Van Gogh 
> <x>(Van Gogh)
> was an artist given to strange behaviors, like cutting off his ear.  Picasso
> <x>(Picasso)
> was also an artist given to strange behaviors, though some would say he was
> eccentric and not strange.  Many people look at Picasso's paintings,
> now hanging in famous museums, and they think that maybe he had nightmares
> as a child.  
> <x>(Picasso<xs> his childhood nightmares)
> 
> If the last sentence "Many people..." is placed at the top of page 2, 
> is it likely or possible that DOCUMENT will reference it on page 1, and why? 
> (DSR *would* do things like that.)

In the above example, DOCUMENT will reference "Many people..." on page 2 if the
sentence is placed on page 2. However, even if the sentence started on page 1
and continued over to page 2, the index entry would still come out as page 2.

DOCUMENT will break the page off when it accumulates enough material to
fill the current page. Index entries that occur in the input stream prior
to that breakoff point will reference the current page. Index entries that
occur in the input stream subsequent to the breakoff point will reference
the subsequent page. That means, of course, that it *is* possible for
a breakoff point to occur between text and its associated <x> tag. Putting
<x> tags immediately adjacent to their associated text will cut down on
this occurring.

--Brian
324.9Thanx, that helped--one more questionCOOKIE::JOHNSTONTue May 19 1987 20:0112
You *did* understand what I was asking (whew!).

If we can get to a finer granule of explanation, when you say "place the 
entry adjacent to", is it preferable to place it immediately before or 
immediately after it's associated text?

I could be guilty of splitting hairs on this one, but thought I'd ask 
anyway.

Thanx

Rose