Opened 14 years ago

Closed 14 years ago

#2725 closed enhancement (fixed)

Use native Docbook <orderedlist> instead of hardcoding it.

Reported by: willimm Owned by: Matthew Burgess
Priority: low Milestone: Future
Component: Book Version: SVN
Severity: normal Keywords:
Cc:

Description

In 5.3 (the General instructions), I've noticed you've used an ordered list near the end of the section. Well, Docbook has a element for creating ordered lists, <orderedlist>, and that is very useful for these types of lists.

It might seem more complicated, but trust me, it's easier to add on to the list, and to style it. I've attached an patch that adapts the book to use that for the list at the end of the book. (I've gotten rid of the screen, but if you want, you can add it back in.)

Change History (9)

by willimm, 14 years ago

Attachment: lfs-use-orderedlists.patch added

Use an ordered list instead of hardcoding it.

comment:1 by willimm, 14 years ago

The description for an ordered list is here:

http://www.docbook.org/tdg/en/html/listitem.html

Just so you know.

comment:2 by bdubbs@…, 14 years ago

I know about <orderedlists>, but I really wanted to use the gray background to make the block stand out. We already have three important notes on the page. This section needs to stand out differently from the notes. I added this section because we were getting too many support requests where users had not understood the build process.

Your patch applies fine, but the appearance does not have the desired effect.

I don't mind adding something to the css for this section, but I'd need a new <div class=...> or <div id=...> section and that requires a change to the xsl. I don't want to change the <orderedlist> every place in the book.

Note that the docbook <orderedlist id=...> does not work like you'd expect. It places an anchor in the html, not a id= in the html <ol> tag.

in reply to:  2 comment:3 by willimm, 14 years ago

Replying to bdubbs@…:

I know about <orderedlists>, but I really wanted to use the gray background to make the block stand out. We already have three important notes on the page. This section needs to stand out differently from the notes. I added this section because we were getting too many support requests where users had not understood the build process.

Well, then the easiest way to do this would be wrapping the ordered list inside a <screen> tag, and that would probably work.

comment:4 by bdubbs@…, 14 years ago

Milestone: 6.7Future
Priority: normallow

It already is in a screen tag. Using a tag for formatting purposes is, of course, not the 'correct' way to format a document. The proper way to do this is to change the xsl, remove the screen tag, and change the css. If we can't do all of that, a partial fix just doesn't make sense.

The proposed fix is incomplete and does not mean a lot because the presentation in both the html and the pdf is fine. It is hard to see where it adds value.

I considered just marking this as wontfix, but instead I'll move it to future in case someone wants to submit the needed xsl to create a complete fix.

by Matthew Burgess, 14 years ago

Attachment: 2725.patch added

comment:5 by Matthew Burgess, 14 years ago

Owner: changed from lfs-book@… to Matthew Burgess
Status: newassigned

I've just attached my attempt at a patch for this. I couldn't figure a way to get style an individual orderedlist. So, this patch removes two of the 'important' admonitions as they were repeated lower down in the really important bit on this page anyway. That leads to just 2 important admons, which has the effect of better emphasis on the section that needs it in my opinion. Bruce, what do you think?

comment:6 by bdubbs@…, 14 years ago

The patch didn't work for me, but I applied it manually.

It looks OK. We might want to add back:

Unpack ... as user lfs (although that's only for Chapter 5)

Delete ... unless specifically instructed otherwise

comment:7 by bdubbs@…, 14 years ago

Resolution: fixed
Status: assignedclosed

Fixed at revision 9495.

Used Matt's patch with a couple of minor changes.

Note: See TracTickets for help on using tickets.