All subheadings begin with subsection numbers

Bug #144811 reported by Matthew Paul Thomas on 2007-09-25
Affects Status Importance Assigned to Milestone
yelp (Ubuntu)

Bug Description

Ubuntu Gutsy, all updates installed

All subheadings currently begin with subsection numbers, which is unnecessary, and doesn't make sense since the sections themselves aren't numbered.

For example, in the "Installing a single package file" page, there are "7.1. Install/uninstall .deb files", "7.2. Convert .rpm files to .deb files", "7.3. Install tarballs", and "7.4. Install .run packages" subheadings.

Duncan Lithgow (duncan-lithgow) wrote :

I might be wrong, but I assume those dots are part of making a bulleted list. Of course without seeing the underlying XML I can't be sure.

Phil Bull (philbull) wrote :

If you go to the subsection itself, its title still includes the '. '. it looks fine when you have a list of subsections (just looks like a bullet-list), but when you're just looking at the subsection, I agree that it's ugly.

Changed in ubuntu-docs:
importance: Undecided → Wishlist
status: New → Confirmed
Matthew East (mdke) wrote :

Moving to yelp package - these tables of contents are automatically generated.

Sebastien Bacher (seb128) wrote :

What would you suggest? Those are items with bullet points which is a classic presentation

Matthew Paul Thomas (mpt) wrote :

I suggest nothing extra at all. Standard presentation for subheadings is to use a smaller font than the main headings, and Yelp already does this. (Actually, since the headings and subheadings are also bold and differently colored, they could both easily use even smaller fonts than they currently do.)

Since I reported the bug, the formatting has been changed so that the subheadings are numbered: for example "7.1. Install/uninstall .deb files", "7.2 Convert .rpm files to .deb files", "7.3. Install tarballs", and "7.4. Install .run packages". Numbering makes sense for paper books, which are often read sequentially, and have a single nested table of contents and cross-references to numbered sections instead of hyperlinks. Numbering does not make sense for help pages, which use hyperlinks instead and are designed around random access. And it especially doesn't make sense to have sections numbered "7.1", "7.2", etc when there is, correctly, no section numbered "7". Please remove the subheading numbering.

description: updated
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers