<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Mar 31, 2015 at 4:11 AM, Bernd Bausch <span dir="ltr"><<a href="mailto:berndbausch@gmail.com" target="_blank">berndbausch@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div lang="EN-US" link="#0563C1" vlink="#954F72"><div><p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri",sans-serif;color:#1f497d">I believed this is answered in <a href="https://wiki.openstack.org/wiki/Documentation/Markup_conventions" target="_blank">https://wiki.openstack.org/wiki/Documentation/Markup_conventions</a>:<u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri",sans-serif;color:#1f497d"><u></u> <u></u></span></p><p class="MsoNormal"><b>RST</b>: Use <code><span style="font-size:10.0pt">:command:</span></code>, <code><span style="font-size:10.0pt">``</span></code>, <code><span style="font-size:10.0pt">:option:</span></code>, or <code><span style="font-size:10.0pt">:samp:</span></code>. <code><span style="font-size:10.0pt">:samp:</span></code> allows to mark variables with curly braces.<span style="font-size:11.0pt;font-family:"Calibri",sans-serif;color:#1f497d"><u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri",sans-serif;color:#1f497d"><u></u> <u></u></span></p><p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri",sans-serif;color:#1f497d">Double backtick yes, double asterisk no.</span></p></div></div></blockquote><div><br></div><div><br></div><div>Thanks Bernd! Yes, we definitely need to stick to the documented conventions and be consistent. Thanks for bringing it up Olga. </div><div><br></div><div>Thanks,</div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div lang="EN-US" link="#0563C1" vlink="#954F72"><div><p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri",sans-serif;color:#1f497d"><u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri",sans-serif;color:#1f497d"><u></u> <u></u></span></p><p class="MsoNormal"><b><span style="font-size:11.0pt;font-family:"Calibri",sans-serif">From:</span></b><span style="font-size:11.0pt;font-family:"Calibri",sans-serif"> Olga Gusarenko [mailto:<a href="mailto:ogusarenko@mirantis.com" target="_blank">ogusarenko@mirantis.com</a>] <br><b>Sent:</b> Tuesday, March 31, 2015 5:52 PM<br><b>To:</b> openstack-docs<br><b>Subject:</b> [OpenStack-docs] [User Guides] Conversion of the <command> tag<u></u><u></u></span></p><div><div class="h5"><p class="MsoNormal"><u></u> <u></u></p><div><div><p class="MsoNormal">Hi to all!<br><br>We have contrary opinions regarding the translation of the <command> XML tag to RST.<u></u><u></u></p></div><div><p class="MsoNormal">It will be great to have a single solution for everyone to keep the consistency in the docs.<u></u><u></u></p></div><div><p class="MsoNormal"><u></u> <u></u></p></div><div><p class="MsoNormal" style="margin-bottom:12.0pt">Should the commands be wrapped in double asterisk symbol that stands for the bold text (as the commands in the xml files are bold when the sources are built)?<u></u><u></u></p></div><div><p class="MsoNormal" style="margin-bottom:12.0pt">Or should they be wrapped in double backtick symbol that stands for the monospaced text? And if so, we will have the same output for commands, options, parameters  and literal.<u></u><u></u></p></div><div><p class="MsoNormal" style="margin-bottom:12.0pt">So, should it be:<u></u><u></u></p></div><div><p class="MsoNormal">a. **command**<u></u><u></u></p></div><div><p class="MsoNormal">       or<u></u><u></u></p></div><div><p class="MsoNormal">b. ``command``<u></u><u></u></p></div><div><p class="MsoNormal"><u></u> <u></u></p></div><div><p class="MsoNormal">Thanks for your answers in advance!<u></u><u></u></p></div><div><p class="MsoNormal">Best regards,<u></u><u></u></p></div><div><p class="MsoNormal">Olga<u></u><u></u></p></div><div><p class="MsoNormal" style="margin-bottom:12.0pt"><u></u> <u></u></p></div></div></div></div></div></div><br>_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature">Anne Gentle<br><a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a></div>
</div></div>