[Openstack-docs] The look of 'literal' vs 'emphasis'

David Cramer david.cramer at rackspace.com
Tue Aug 6 03:30:35 UTC 2013


Ok, I've prepared a demo with three ways you might format something like
this (there are probably others, but these are three to consider):

The first is a variablelist formatted as a table (you can control the
presentation with PIs, like so: <?dbhtml list-presentation="table"?> You
can find more info about variablelist formatting here:
http://www.sagehill.net/docbookxsl/Variablelists.html):

http://feline.thingbag.net/docbook/dbexample/variablelist-table-ch_limitations.xml

http://feline.thingbag.net/docbook/dbexample/limitations/content/ch_limitation-variablelist-table.html

Honestly, I'm not wild about it though.

Here's another presentation of the same variablelist but instead using
the PIs: <?dbhtml list-presentation="list"?><?dbfo
list-presentation="blocks"?>

http://feline.thingbag.net/docbook/dbexample/variablelist-list-ch_limitations.xml

http://feline.thingbag.net/docbook/dbexample/limitations/content/ch_limitation-variablelist-list.html

Actually, in this case, I'd actually prefer to use formalparas:

http://feline.thingbag.net/docbook/dbexample/formalpara-ch_limitations.xml

http://feline.thingbag.net/docbook/dbexample/limitations/content/ch_limitation-formalpara.html

Note that the formalpara automatically adds the locale-appropriate
punctuation to the runinhead.

I find myself using the itemizedlist + formalpara construct frequently,
in cases like the one we have here and also when converting content from
some unstructured format where the original author created a bunch of
headings with one sentence or one para as its content. What they really
wanted was some kind of list with some bold text introducing it so they
abuse headings.

Regards,
David

On 08/05/2013 05:48 PM, David Cramer wrote:
> On 08/05/2013 05:36 PM, Tom Fifield wrote:
>> On 06/08/13 01:57, Christian Berendt wrote:
>>> On 08/04/2013 07:03 PM, Anne Gentle wrote:
>>>> Christian, does that sound good to you? Tom and Stephen and other
>>>> knowledgeable docbook markup folks, does that markup sound right to you?
>>>
>>> Sounds good to me. I'll abandon change #39712 and will open a new one
>>> transforming the list to a table tomorrow.
>>
>> Just registering OKness with the result :)
> 
> Actually wait, don't use a table. Let me work up an email with some
> suggestions using either variablelist or itemizedlist with formalparas.
> I need to look up something in variablelists first though.
> 
> David
> 




More information about the Openstack-docs mailing list