<html><body><div style="color:#000; background-color:#fff; font-family:HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif;font-size:12px">Are you saying to not use the :ref: construction?<br><div id="yui_3_16_0_1_1431578625183_44770"><span></span></div><br> <blockquote id="yui_3_16_0_1_1431578625183_44800" style="border-left: 2px solid rgb(16, 16, 255); margin-left: 5px; margin-top: 5px; padding-left: 5px;"> <div id="yui_3_16_0_1_1431578625183_44799" style="font-family: HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif; font-size: 12px;"> <div id="yui_3_16_0_1_1431578625183_44798" style="font-family: HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif; font-size: 16px;"> <div id="yui_3_16_0_1_1431578625183_44797" dir="ltr"> <hr size="1"> <font id="yui_3_16_0_1_1431578625183_44801" face="Arial" size="2"> <b><span style="font-weight:bold;">From:</span></b> Andreas Jaeger <aj@suse.com><br> <b><span style="font-weight: bold;">To:</span></b> Meg McRoberts <dreidellhasa@yahoo.com>; "openstack-docs@lists.openstack.org" <openstack-docs@lists.openstack.org> <br> <b><span style="font-weight: bold;">Sent:</span></b> Wednesday, May 13, 2015 10:30 PM<br> <b><span style="font-weight: bold;">Subject:</span></b> Re: [OpenStack-docs] Anchor tag conventions<br> </font> </div> <div id="yui_3_16_0_1_1431578625183_44802" class="y_msg_container"><br>On 05/13/2015 11:50 PM, Meg McRoberts wrote:<div class="qtdSeparateBR"><br><br></div><div class="yqt7222536533" id="yqtfd49925"><br clear="none">> Hi all,<br clear="none">> I am creating files for the ha-guide content and have a question about<br clear="none">> what the OpenStack docs call<br clear="none">> "embedded anchor pointers" and the Sphinx docs call labels. Basically,<br clear="none">> this is the string that you use<br clear="none">> in a :ref: construct to link to a section. It is coded just above the<br clear="none">> section title. For example:<br clear="none">><br clear="none">> .. _anchor-for-ha-intro:<br clear="none">><br clear="none">> ============================================<br clear="none">> Introduction to Highly Available OpenStack environments<br clear="none">> ============================================<br clear="none">><br clear="none">> It makes sense to use the file name (minus the .rst extension) for the<br clear="none">> labels, except that the Structure<br clear="none">> standard specifies using underbar as the space delimiter, and underbars<br clear="none">> in these labels can confuse<br clear="none">> Sphinx.<br clear="none">><br clear="none">> I would suggest one of the following:<br clear="none">><br clear="none">> - Use hyphen rather than underscore for RST source file names, then use<br clear="none">> that name as the top-level label<br clear="none">> for that section, so the filename would be intro-ha.rst rather than<br clear="none">> intro_ha.rst (preferred)<br clear="none">> - Replace the underbars in file names with hyphens for labels.<br clear="none">><br clear="none">> What does everyone else think?</div><br clear="none"><br clear="none">You can reference files by name, can't you?<br clear="none"><br clear="none">Andreas<br clear="none">-- <br clear="none"> Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi<br clear="none"> SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br clear="none"> GF: Felix Imendörffer, Jane Smithard, Dilip Upmanyu, Graham Norton,<br clear="none"> HRB 21284 (AG Nürnberg)<br clear="none"> GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126<div class="yqt7222536533" id="yqtfd86388"><br clear="none"><br clear="none"></div><br><br></div> </div> </div> </blockquote> </div></body></html>