[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

164.0. "Table of Contents questions" by ATLAST::NICODEM (Eschew obfuscation) Fri Mar 27 1987 13:51

    	I'm having a problem with the Table of Contents processing.
    One particular table in my .GNC file happens to have a two-line
    table name.  (I created this by inserting a <line> in the middle
    of the <table>(...) entry; that is, I hard-coded the fact that
    it's two lines long.)
    
    	When I run that .GNC file through document, everything works
    just fine.  That is, until I run the full document, which includes
    table-of-contents processing.  (I've read all the other notes on
    table-of-contents, and my file *is* set up properly.)
    
    	When that particular table is processed, it generates a number
    of TeX errors of the form "%TEX-E-TEXERROR, Error found by TeX".
    The particular error in the .LIS file tells me that "a number should
    have been here; I inserted '0'. (If you can't figure out why I needed
    to see a number, look up 'weird error'..." etc.
    
    	What I need is one of two things:  either how to fix this
    particular table so that it doesn't goof up the table-of-contents
    processing, or how to "pass over" this table when doing
    table-of-contents processing.
    
    	(Actually, while the former is the better approach, I really
    *DO* need to know how to do the latter.  Can I "turn off" TOC
    processing for parts of the .GNC file, much as RUNOFF would allow
    me to ".ENABLE TOC" and ".DISABLE TOC" in the middle of the text?
    Can I *entirely* disable Tables from going into the TOC?  I'd actually
    be happiest with this last approach; how can I create a Table of
    Contents that lists all *other* aspects of my document, but *NOT*
    Tables???)
    
    	Any suggestions?
    
    	Frank
T.RTitleUserPersonal
Name
DateLines
164.1Well, it works...ATLAST::NICODEMEschew obfuscationMon Mar 30 1987 15:1515
    	Not having heard anything yet, I'll just throw in what amounts
    to a "hack" that I'm now using.  Basically, since I've  found no
    other way of "disabling" certain Table-of-Contents entries
    (particularly Tables), I now process my file as follows:
    
    	I do the "DOC/CONTENTS" command to create the file_CONTENTS.TEX
    file; then I edit the flippin' file!  Crude, I know, but it's the
    only way I've come up with so far.  It's not all that bad, especially
    if I'm just looking for certain Tables, since I search the .TEX
    file for a "\begintables" and start deleting from there.
    
    	After that's done, I continue processing normally.  Not great,
    but it works.  Anybody know if there's a simpler way to do this?
    
    	Frank
164.2Me too!CLOSET::KAIKOWTue Mar 31 1987 11:206
I've also edited file_CONTENTS.TEX.

However, that is not a very user friendly mechanism in a released product.

The equivalent of DSRs .enable TOC and .disable TOC are mandatory.
It would also significantly improve conversion from DSR(PLUS) to DOCUMENT.
164.3Do it in the doctypeCRAYON::GENTParty gone out of bounds -- B52&#039;sTue Mar 31 1987 12:0913
    Whether tables appear in the TOC would seem to be a classic example
    of a formatting issue that should be handled in the doctype, not
    in the writer's source file.  Similarly, if you want a format that
    specifies two-line headings for tables, you probably need to define 
    that in the doctype file as well. (Currently, I believe most doctypes 
    will wrap extra-long headings, but do not expect explicit multiple
    lines.)
    
    As a hack, table headings in tables-of-contents can be disabled 
    by defining part of the \toctexentry macro (identified by a first 
    argument of 8) as null in the DTP file. However, that is a hack...
    
    --Andrew
164.4GENERAL TOCs? Where? How?JAWS::STRYKERStew StrykerTue Mar 31 1987 12:1813
    It seems that DOCUMENT T1.0 won't generate a table of contents for
    the GENERAL doctype.  I say this because I can't get DOCUMENT to
    build one for me, though I'm following what appear to be the
    directions:
    
    	DOCUMENT filespec GENERAL LN03 /CONTENTS
    
    Could someone tell me what I'm doing wrong (and preferably, how to
    fix it, as well)?
    
    Thanks,
    
    Stew
164.5Why not do it right?CLOSET::KAIKOWTue Mar 31 1987 13:3013
re: 164.3

It is NOT an issue of the doctype.

For example, in doctype MOO you might automatically include n levels in the TOC.
However, a situation may arise in which certain of those levels should not 
appear, e.g. you want 1.1.1 but not 2.2.2.

It makes no sense to have to edit the file_CONTENTS.TEX file to achieve this as
an enable/disable mechanism surely must be easy to implement.

This is particularly important for general purpose doctypes such as GENERAL
that will be used by many authors for many different styles of books.
164.6IndeedCUPOLA::HAKKARAINENAlbatross!Tue Mar 31 1987 14:3720
    <set flame simmer>
    
    This is an old, and as yet quite unresolved problem of control.
    The software issue is minimal. The hard stuff comes from the desire
    of some writers to have full control over their documents, the desire
    of tool-makers, often as representatives of management, to make
    sure that the documents are standardized. Many of the limitations
    in the software are not oversights; multi-line titles don't work
    because multi-line titles are not useful to the reader. Similarly
    I would find it confusing if sections were left out of the contents,
    whatever the reason might be.
    
    Document was designed and built to ensure standards for documentation.
    It is not intended to be a ``compose-as-you-go'' software package.
    The use of centralized doctypes is very deliberate, helping to meet
    the needs of team publishing. 
    <set flame off>

    
164.7Could we deal with the practical question here?JAWS::STRYKERStew StrykerTue Mar 31 1987 16:2810
    [not meaning to sound sarcastic, but...] Thanks for resolving that
    simmering issue.  I'd like to call it a draw.  You're both right.
    Sometimes people want total control of their documents, but that's
    not always appropriate in a corporate environment.
    
    Now back to the question at hand...  Where's my table of contents?
    
    Thanks,
    
    Stew
164.8Again, the quick and dirty wayATLAST::BOUKNIGHTEverything has an outlineTue Mar 31 1987 17:2411
    DO
    	DOCUMENT/NODEVICE       file          style device /CONTENTS
    	DOCUMENT/NOTAG/NODEVICE file_CONTENTS style device
    	DOCUMENT/NOTAG/NOTEXT   file          style device
    
    And voila!
    
    The final product will do all this in one easy operation, so I
    understand.
    
    jack
164.9Try this way..UBEAUT::MANDERSONthe wind don&#039;t blow..... it suxTue Mar 31 1987 20:1021
    Stew,
    
    Besides the method Jack indicated in the previous reply I have also
    found that /CONTENTS (and /INDEX) don't seem to like a preceding space.
    
    DOC file design LN03 /cont/index/nodev  may not always work whereas

    DOC file design LN03/cont/index/nodev   has always worked (aside from the
                                            fun I've been having with the 
                                            index.......)
 
    It's also just as easy (and less processor time) to do the following:
    
    DOC file design LN03/cont/index
    DOC file_contents design LN03/notag
        
    The first pass prints the document minus contents and index, the
    second pass produces the contents - without the need for the third
    pass just to get the contents to print in the correct place in the
    file. It is a trivial matter to put the contents in the correct
    place by hand.
164.10$SET FLAME ETERNALCLOSET::KAIKOWWed Apr 01 1987 10:5517
re: 164.6

    <set flame ON>

There is NO conflict with what 164.6 wants and what I, and others, have 
proposed. General purpose doctypes such as GENERAL, functional specs,
ANSI/ISO/etc. standards documents, military specs, etc. have no business making
such choices for the user.

In specific doctypes, or those for specific books, do whatever you want, but I
won't use them.

If DOCUMENT is to be (more) successful, then doctype GENERAL has to provide
nearly every widget and gadget that is reasonable. Other doc types can then be
built by adding to, modifying or deleting those gizmos.

    <set flame ETERNAL>
164.11???VAXUUM::DYERAdventures in SuccessWed Apr 01 1987 15:136
> I have also found that /CONTENTS (and /INDEX) don't seem to like a preceding
> space.

This sounds very unlikely to me.  You can put those qualifiers everywhere and
 anywhere (e.g., "DO/CONTENTS file/INDEX design destination").
  <_Jym_>
164.12Here a qualifier, there a qualifier, everywhere...JAWS::STRYKERStew StrykerThu Apr 02 1987 10:495
 re .11
    
    Yes.  You can put the qualifiers anywhere.  The question is:  
    
    		Do they work? 
164.13ATLAST::NICODEMEschew obfuscationThu Apr 02 1987 11:1633
    	<no_flame_intended>
    
    	I have to agree with .10 (and, hence, disagree with .6).  I
    understand the need -- and motivation -- for document consistency.
    However, I would hasten to point out that *NOT* all documents have
    the same requirements.  And no single application can determine
    what *every* document should look like.
    
    	Yes, I understand the concept of document types!  But by the
    same token, I don't believe that we should force the creation of
    new document types on each user who has something slightly different
    to write/format.  In fact, I don't at all disagree with the concept
    of standard document *types* used by everyone in an organization.
    But then give me more flexibility within the *TAGS* to do the things
    I need to do.
    
    	In the particular case mentioned in my original (.0) query,
    for example, the Tables I am using are not really being used in
    the ordinary sense of tables at all!  However, in order to accomplish
    the formatting that I was looking for, my only alternative -- given
    the current capabilities -- was to use the table processing which
    currently exists.  What spawned my original question, then, was
    the fact that I *don't* want these tables to appear as "Tables"
    in the TOC.
    
    	If I had more formatting control, I would not have had to resort
    to using one of the few, fixed formatting techniques available.
    And I would not have had the original problem.  I appreciate all
    of the replies; I believe, however, that for the present, my "solution"
    of manually editing the file_CONTENTS.TEX file is going to have
    to do.  Maybe some day...
    
    	Frank
164.14Informal vs. formal tablesCRAYON::GENTParty gone out of bounds -- B52&#039;sThu Apr 02 1987 11:565
    If you don't want them to appear in the TOC, can't you use an informal
    table (without a numbered caption)? I believe that is exactly what
    informal tables are for.
    
    --Andrew
164.15{RE .12}VAXUUM::DYERAdventures in SuccessThu Apr 02 1987 12:546
{RE .12} - I've tested the qualifiers.  I put them everywhere, with or without
 spaces.  They work.  I've looked at the code.  There's no reason why they
  wouldn't work.

If the problem can be reproduced, I'd like to see it.
 <_Jym_>
164.16agree with .14CLOSET::ANKLAMThu Apr 02 1987 13:456
    
    Andrew is correct (.14). The format of a table is the same regardless
    if it has a caption. Why not precede the tables with <subhead1>(text)
    tags instead of using a table caption?
    
    patti anklam
164.17I'm so confused! What's new?CLOSET::KAIKOWThu Apr 02 1987 14:275
Hmmmmmmmmmmmmmmmm!

It appears that this topic has diverted into at least 2 discussions.

It would be a lot easier if we split them up.
164.18Generating CONTENTS, one last timeJAWS::STRYKERStew StrykerThu Apr 02 1987 15:3810
    Back to my question about generating the contents file...
    
    I always though that you could tell it /CONTENTS, and it would generate
    it automatically.  Then the tag <CONTENTS_FILE> would pull the file
    in for me.  I consider having to do two or three passes to be
    suboptimal, to put it diplomatically.
    
    Thanks for explaining the proper procedure.
    
    Stew
164.19CLOSET::ANKLAMThu Apr 02 1987 16:596
    
    Agreed that it's not the best way, but it was as close as we could
    get in order to get FT1 out. It all comes together as documented
    in the update. The restrictions were documented in the release notes.
    
    
164.20Will try and get the problem again.UBEAUT::MANDERSONthe wind don&#039;t blow..... it suxFri Apr 03 1987 03:1612
    Re the space problem.
    
    I haven't had it happen lately as I don't put any spaces in....
    
    It may have been tied up with the indexing problem I have been
    having. Since it is all a while ago that I had the space problem,
    and with no spaces I don't get it, I can't be much more use. I do
    know it effected contents for me. I'll try and duplicate it and
    say some more then.
    
    Regards
    Kevin M
164.21Sould I turn left or right?CLOSET::KAIKOWFri Apr 03 1987 16:035
re: 164.19

What are you discussing here?

See 164.17.