Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 1185 - Code Listing Enumeration
Summary: Code Listing Enumeration
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-developer
Classification: Unclassified
Component: Guide XML (show other bugs)
Hardware: x86 Linux
: High normal (vote)
Assignee: Stoyan Zhekov (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2002-03-16 15:18 UTC by Michael Lang
Modified: 2003-02-04 19:42 UTC (History)
3 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Michael Lang 2002-03-16 15:18:32 UTC
Rather than going: Code Listing 1, Code Listing 2, ..., Code List n, it would be
clearer to say Code Listing 1.1, Code Listing 1.2, Code Listing 2.1, ..., Code
Listing X.Y where X is current Chapter No. and Y restarts with each new chapter.

Again, a shorthand crossreference should be able to intelligently fill in
correct caption for the code listing to avoid editing issues.

The reason I suggest this is because it felt weird telling everyone to look at
"Code Listing 24" in install instructions with no context (i.e. which chapter
and section).  "Code Listing 15.1" an improvement in two ways:

1) Readers generally know it's the first code listing of Chapter 15.

2) 15.1 is less likely to change than 23, 24, etc. throughout the life of the
document so archives referencing 15.1 has a chance of being relavent down the
road...even if the chapter number changes, the code listing count within a
chapter is likely to remain the same so a user reading an old email saying "See
Code Listing 15.1 in Configuring a boot loader" can probably still find the
first code listing in the referenced chapter even if two new chapters were added
making it now Code Listing 17.1.

I thought about suggesting a 15.1.1 series, but we don't number the
sections...only the chapters (which I happen to prefer this way) so a section
number would be moot.
Comment 1 John Davis (zhen) (RETIRED) gentoo-dev 2002-10-02 18:11:57 UTC
Zhware, 
You seem to know what you are doing w/ xsl. See what you can do with this, it 
is a very good idea.

Keep me updated,
//ZhEN
Comment 2 John Davis (zhen) (RETIRED) gentoo-dev 2002-10-13 12:21:10 UTC
This is done already.

//ZhEN