Re: [off list] RE : Nested lists hierarchy and style

Subject: Re: [off list] RE : Nested lists hierarchy and style
From: "Lech Rzedzicki" <xchaotic -at- gmail -dot- com>
To: "Yves JEAUROND" <jingting -at- rogers -dot- com>
Date: Tue, 26 Feb 2008 16:05:34 +0000

Cross-references are usually made straight to the paragraph level:
Chapter 10, paragraph 12.

But when a reference needs to be made to an entire section or a tiny
list item, that where this complex numbering scheme comes in.

Another advantage is that it allows for unique references in cases
where headings repeat themselves.

Besides it's legacy and it can't be removed, so it's stays for now. So
rather than philosophically whining about it - I just try to manage
the inconsistent mess that exist in the content right now.

Hope that clarifies it.


Lech


On Tue, Feb 26, 2008 at 2:39 PM, Yves JEAUROND <jingting -at- rogers -dot- com> wrote:
> Lech Rzedzicki:
>
> If it isn't a reference work, why add all of that paratext?
> Are readers offered complex cross-references such as?
> "See 4.3.F.56).g.6.(3).b"?
>
> If text is deeply structured, then readers will read it more easily.
> Adding so much paratext adds clutter when it isn't needed.
>
> Regards,
>
> YJ
>
> Lech Rzedzicki <xchaotic -at- gmail -dot- com> a écrit :
>
> Hi.
>
> We have a content that is deeply structured.
>
> Chapters
> Sections
> Subsection
> subsubsections
> Paragraphs
> (within paragraph)
> Top level Lists
> level 2 lists etc
>
> With a few exceptions, they are all prefixed with either a letter or a
> number.
>
> I'd like to be able to standardize the numbering prefixing scheme, so
> that it is consistent across the document set.
>
> My first idea is to alternate numbers and letter to minimize the
> confusion and use different style to indicate each level.
>
> So it would look like:
>
> Chapter 10
> Section 1.
> Subsection A.
> subsubsection 1)
> subsubsubsection b)
> Paragraph 15
> Item (2)
> subItem (c)
> etc
>
> My question is: Given that both Chapter and Paragraph are likely to
> keep using numbers, how to make this scheme:
> a) consistent
> b) extensible
>
> Has any of you have any remarks on that in their style guides?
> Perhaps it's better to use just numbers?
>
> Regards, Lech
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create HTML or Microsoft Word content and convert to Help file formats or
> printed documentation. Features include support for Windows Vista & 2007
> Microsoft Office, team authoring, plus more.
> http://www.DocToHelp.com/TechwrlList
>
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
>
> ---
> You are currently subscribed to TECHWR-L as jingting -at- rogers -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> http://lists.techwr-l.com/mailman/options/techwr-l/jingting%40rogers.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwr-l.com/ for more resources and info.
>
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


References:
Nested lists hierarchy and style: From: Lech Rzedzicki
[off list] RE : Nested lists hierarchy and style: From: Yves JEAUROND

Previous by Author: Nested lists hierarchy and style
Next by Author: RE: OT? Community and tech writing in real life (was Re: Ambiguouswords and Phrases)
Previous by Thread: [off list] RE : Nested lists hierarchy and style
Next by Thread: Word to the wise


What this post helpful? Share it with friends and colleagues:


Sponsored Ads