[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Learning Manual TOC missing subsubsubsections

From: Carl D. Sorensen
Subject: Re: Learning Manual TOC missing subsubsubsections
Date: Fri, 2 Jan 2009 12:56:18 -0700

On 1/2/09 12:30 PM, "Trevor Daniels" <address@hidden> wrote:

> Carl D. Sorensen wrote Friday, January 02, 2009 1:44 PM
>> On 1/2/09 2:32 AM, "Trevor Daniels" <address@hidden> wrote:
>>> Carl D. Sorensen wrote Thursday, January 01, 2009 10:52 PM
>>>> On 1/1/09 11:25 AM, "Trevor Daniels" <address@hidden> wrote:
>>> Yes, NR 1 & 2 are fine.  I was suggesting a slight variation
>>> on them for the LM and later chapters of the NR, since here
>>> a lot of the text does not need to be subdivided or ToC'd.
>>> The formatting of NR 1 & 2 is clear; it is the rest of the
>>> manual and the LM which is rather variable at present and I
>>> wanted to have a clear policy written down before these sections
>>> are firmed up.
>> I think we should maintain the NR standards throughout the NR.  For
>> example,
>> NR 6 is currently *not* organized according to the NR standards, so there
>> are places where an additional menu layer needs to be added.  But I had
>> the
>> same problem when writing chords.itely, and I think the resulting
>> consistency in the manual is well worth maintaining.
> I agree; that's why it is important to set out the standards
> clearly and to ensure they are consistent with clarity.  Look
> at chapter 3.  It would be silly to invent @unnumberedsubsubsecs
> for the sections there; they don't need it.  I think the standards
> must accommodate the needs of the documentation, and must not
> be so rigid that clarity is compromised.

As I've reviewed NR 3, 4, 5, and 6, it appears to me that these chapters are
inherently less deep than chapters 1 and 2.

I'd be in favor of a policy that says the equivalent of the following:

"Each chapter has a defined section structure.

The structure consists of chapter, section, and subsection.

If subsubsections are desired, they should be unnumbered, and all
subsections in the chapter should include subsubsections.

All substantive information in the chapter should be at the lowest section

IMO, if one part of chapter needs more headings than other parts, there's
probably a potential for reorganization.

Also, as I've looked more into it, I may want to recommend that NR 5 and NR
6 be combined (but I'm not sure yet).

Keep up the good work!


> Trevor

reply via email to

[Prev in Thread] Current Thread [Next in Thread]