<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Fri, May 2, 2014 at 2:16 PM, Andreas Jaeger <span dir="ltr"><<a href="mailto:aj@suse.com" target="_blank">aj@suse.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div class="">On 05/02/2014 07:53 PM, Anne Gentle wrote:<br>
</div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div class="">
I looked up Rackspace style and for a list that provides terms and more<br>
information that is not meant to be marked up as a variable list, it's:<br>
<br>
term space emdash space definition phrase period<br>
<br>
Example:<br>
<br></div>
* *Public* – This setting allows any two servers with public IP<div class=""><br>
addresses to be load balanced. These can be nodes outside of the<br>
Rackspace network, but if they are, standard bandwidth rates apply.<br>
<br>
<br>
I'd like to have someone at RedHat look up their style guide and let us<br>
know.<br>
</div></blockquote>
<br>
For the Operations Guide, we used - as specified by O'Reilly's guide - no spaces around the emdashes.<br>
<br></blockquote><div><br></div><div>Technical these examples ARE variable lists and O'Reilly's style wants it written as such. <a href="http://chimera.labs.oreilly.com/books/1230000000969/ch02.html#variable_list">http://chimera.labs.oreilly.com/books/1230000000969/ch02.html#variable_list</a></div>
<div><br></div><div><p id="frequently_bul" style="line-height:22.399999618530273px;margin-bottom:20px;color:rgb(25,25,25);font-family:Georgia,'Times New Roman',serif;font-size:16px">Frequently, bulleted lists should be converted to variable lists. Any bulleted list whose entries consist of a short term and its definition should be converted. For example, the following bulleted list entries:</p>
<div class="" id="spellchecking__id1" style="color:rgb(25,25,25);font-family:Georgia,'Times New Roman',serif;font-size:16px"><ul class="" style="margin-left:20px;margin-right:20px;margin-bottom:20px;list-style-position:initial">
<li class="" style="margin-bottom:8px;line-height:22.399999618530273px">Spellchecking: process of correcting spelling</li><li class="" style="margin-bottom:8px;line-height:22.399999618530273px">Pagebreaking—process of breaking pages</li>
</ul></div><p id="should_be_varia" style="line-height:22.399999618530273px;margin-bottom:20px;color:rgb(25,25,25);font-family:Georgia,'Times New Roman',serif;font-size:16px">should be variable list entries:</p><div class="" id="spellchecking_p" style="color:rgb(25,25,25);font-family:Georgia,'Times New Roman',serif;font-size:16px">
<dl class=""><dt style="font-style:italic;margin-bottom:4px"><span class="">Spellchecking</span></dt><dd style="margin-bottom:6px;line-height:22.399999618530273px">Process of correcting spelling</dd><dt style="font-style:italic;margin-bottom:4px">
<span class="">Pagebreaking</span></dt><dd style="margin-bottom:6px;line-height:22.399999618530273px">Process of breaking pages</dd></dl></div></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
What does the Rackspace guide say about the markup for term? Is it emphasis in "bold"?</blockquote><div><br></div><div>No additional markup for the term. </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<div class=""><br>
<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
Ideally we'll be able to answer these if Rackspace or RedHat gets their<br>
style guide externalized so we can look it up.<br>
</blockquote>
<br>
<br></div>
Andreas<br>
<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div class="">
Thanks,<br>
Anne<br>
<br>
<br>
On Fri, May 2, 2014 at 2:03 AM, Andreas Jaeger <<a href="mailto:aj@suse.com" target="_blank">aj@suse.com</a><br></div><div class="">
<mailto:<a href="mailto:aj@suse.com" target="_blank">aj@suse.com</a>>> wrote:<br>
<br>
I've seen various forms used during reviews in lists with many items:<br>
<br>
1)<br>
<listitem><para><guilabel>Boot from image</guilabel>—If you choose<br>
...<br>
<br>
2) And also:<br>
<listitem><br></div>
<para><code>scheduler_filter__<u></u>_classes</code> - Specifies the list<div class=""><br>
of filter<br>
<br>
And then the usage of<br>
3) <formalpara> with <title>,<br>
<br>
4) ":" instead of —,<br>
5) &ndash or "-"<br>
<br>
I've seen recently some patches using the first variant but there's<br>
a lot of variations. Do we want to have a consistent style for new<br>
changes? And which one?<br>
<br></div>
This was triggered by reviewing <a href="https://review.openstack.org/__91736" target="_blank">https://review.openstack.org/_<u></u>_91736</a><br>
<<a href="https://review.openstack.org/91736" target="_blank">https://review.openstack.org/<u></u>91736</a>>,<br>
<a href="https://review.openstack.org/__90625" target="_blank">https://review.openstack.org/_<u></u>_90625</a><div class=""><br>
<<a href="https://review.openstack.org/90625" target="_blank">https://review.openstack.org/<u></u>90625</a>> and then editing<br></div>
config-reference/compute/__<u></u>section_compute-cells.xml<br>
<br>
Andreas<br>
--<br>
Andreas Jaeger aj@{<a href="http://suse.com" target="_blank">suse.com</a> <<a href="http://suse.com" target="_blank">http://suse.com</a>>,<a href="http://opensuse.org" target="_blank">opensuse.org</a><br>
<<a href="http://opensuse.org" target="_blank">http://opensuse.org</a>>} Twitter/Identica: jaegerandi<div class=""><br>
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br>
GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG<br>
Nürnberg)<br>
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272<br>
A126<br>
<br></div>
______________________________<u></u>___________________<br>
Openstack-docs mailing list<br>
Openstack-docs@lists.__<a href="http://openstack.org" target="_blank">opensta<u></u>ck.org</a><br>
<mailto:<a href="mailto:Openstack-docs@lists.openstack.org" target="_blank">Openstack-docs@lists.<u></u>openstack.org</a>><br>
<a href="http://lists.openstack.org/__cgi-bin/mailman/listinfo/__openstack-docs" target="_blank">http://lists.openstack.org/__<u></u>cgi-bin/mailman/listinfo/__<u></u>openstack-docs</a><br>
<<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/<u></u>cgi-bin/mailman/listinfo/<u></u>openstack-docs</a>><br>
<br>
<br>
</blockquote><div class=""><div class="h5">
<br>
<br>
-- <br>
Andreas Jaeger aj@{<a href="http://suse.com" target="_blank">suse.com</a>,<a href="http://opensuse.org" target="_blank">opensuse.org</a>} Twitter/Identica: jaegerandi<br>
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br>
GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)<br>
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126<br>
<br>
______________________________<u></u>_________________<br>
Openstack-docs mailing list<br>
<a href="mailto:Openstack-docs@lists.openstack.org" target="_blank">Openstack-docs@lists.<u></u>openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/<u></u>cgi-bin/mailman/listinfo/<u></u>openstack-docs</a><br>
</div></div></blockquote></div><br></div></div>