[Openstack-docs] Consistency for "titles" in lists?
Andreas Jaeger
aj at suse.com
Mon May 5 18:40:48 UTC 2014
On 05/02/2014 10:19 PM, Diane Fleming wrote:
> Generally, we (or at least I do) "bold" the terms in variable lists
> because they look a little weird without the bolding.
>
> However, someone could open a bug to make <term>xx</term> items bold by
> default.
So, what about the following proposal:
1) File a bug against our tools asking David Cramer to mark <term> as
bold in variable lists.
2) Add to conventions (with proper markup examples, enhancing current
entry about variable list):
For lists that consist of a short term and its definition, variable
lists should be used.
Any current usage as bulleted list should be converted. For example, the
following bulleted list entries:
Spellchecking: process of correcting spelling
Pagebreaking—process of breaking pages
should be variable list entries:
Spellchecking
Process of correcting spelling
Pagebreaking
Process of breaking pages
Andreas
--
Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
More information about the Openstack-docs
mailing list