[Openstack-docs] Consistency for "titles" in lists?

Summer Long slong at redhat.com
Mon May 5 20:08:12 UTC 2014


+1

cheers, Summer

-- 
Summer Long 
OpenStack Documentation Lead 
Engineering Content Services 

Red Hat Asia Pacific 
Brisbane, Australia 
slong at redhat.com | irc: slong 

----- Original Message -----
> From: "Diane Fleming" <diane.fleming at RACKSPACE.COM>
> To: "Andreas Jaeger" <aj at suse.com>, "Anne Gentle" <anne at openstack.org>
> Cc: openstack-docs at lists.openstack.org
> Sent: Tuesday, May 6, 2014 5:01:14 AM
> Subject: Re: [Openstack-docs] Consistency for "titles" in lists?
> 
> +1
> Diane
> ----------------------------------------------
> Diane Fleming
> Software Developer II - US
> 
> diane.fleming at rackspace.com
> Cell  512.323.6799
> Office 512.874.1260
> Skype drfleming0227
> Google-plus diane.fleming at gmail.com
> 
> 
> 
> 
> 
> 
> On 5/5/14 11:40 AM, "Andreas Jaeger" <aj at suse.com> wrote:
> 
> >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
> 
> 
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 



More information about the Openstack-docs mailing list