>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #2943370. --> Reported by: [francewhoa](https://www.drupal.org/user/204003) >>> <h2 id="proposal">Proposal</h2> <p>This ticket is a proposal about automatically adding clickable anchor links and table of contents links for documentation headings on Drupal.org.</p> <p><a id="user-story" name="user-story" href="https://www.drupal.org"></a></p> <h2>User Story</h2> <p>As non-developers &amp; newcomers to Drupal we need clickable anchor icons in the documentation pages, so that:</p> <ul> <li>we can easily and quickly copy a link/url to a specific documentation page section</li> <li>we have a visual reminder about available clickable anchor icons</li> </ul> <p><a id="assumptions" name="assumptions" href="https://www.drupal.org"></a></p> <p><strong>Assumptions</strong></p> <ul> <li>Assumes the clickable anchor icons is clear and meaningful to <em>all</em> audience. Not just some audience(s).</li> </ul> <hr> <p><a id="options" name="options" href="https://www.drupal.org"></a></p> <h2>Options</h2> <p>The following shows options to choose from about clickable anchor icons. To test simply click on any anchor below.</p> <hr> <h3><a id="option-1" name="option-1" href="https://www.drupal.org"></a>Option 1: Clickable Anchor Character</h3> <p>Example</p> <h4><a id="option-1---anchor" name="option-1---anchor" href="https://www.drupal.org"></a>Section Header <a href="https://www.drupal.org#option-1---anchor">&#9875;</a></h4> <p>Examples in context</p> <ul> <li><a href="https://www.drupal.org/docs/7/update/introduction#update-drupal-7-modules">https://www.drupal.org/docs/7/update/introduction#update-drupal-7-modules</a></li> </ul> <p>Code</p> <p><code>&lt;h4&gt;&lt;a id="option-1---anchor" name="option-1---anchor"&gt;&lt;/a&gt;Section Header &lt;a href="#option-1---anchor"&gt;&#9875;&lt;/a&gt;&lt;/h4&gt;</code></p> <hr> <h3><a id="option-2" name="option-2" href="https://www.drupal.org"></a>Option 2: Clickable Prefix Hastag</h3> <p>Example</p> <h4><a id="option-2---anchor" name="option-2---anchor" href="https://www.drupal.org"></a><a href="https://www.drupal.org#option-2---anchor">#</a> Section Header</h4> <p>Examples in context</p> <ul> <li><a href="https://www.drupal.org/docs/develop/standards/coding-standards#indenting">https://www.drupal.org/docs/develop/standards/coding-standards#indenting</a></li> </ul> <p>Code</p> <p><code>&lt;h4&gt;&lt;a id="option-2---anchor" name="option-2---anchor"&gt;&lt;/a&gt;&lt;a href="#option-2---anchor"&gt;#&lt;/a&gt; Section Header&lt;/h4&gt;</code></p> <hr> <p><a id="option-3" name="option-3" href="https://www.drupal.org"></a><strong>Option 3: Clickable Hastag Suffix</strong></p> <p>Example</p> <h4><a id="option-3---anchor" name="option-3---anchor" href="https://www.drupal.org"></a>Section Header <a href="https://www.drupal.org#option-3---anchor">#</a></h4> <p>Examples in context</p> <ul> <li>TBD</li> </ul> <p>Code</p> <p><code>&lt;h4&gt;&lt;a id="option-3---anchor" name="option-3---anchor"&gt;&lt;/a&gt;Section Header &lt;a href="#option-3---anchor"&gt;#&lt;/a&gt;&lt;/h4&gt;</code></p> <hr> <h3><a id="option-4" name="option-4" href="https://www.drupal.org"></a>Option 4: Full Text Anchor</h3> <p>Example</p> <h4><a id="option-4---anchor" name="option-4---anchor" href="https://www.drupal.org">Writing and contributing documentation</a></h4> <p>Examples in context</p> <ul> <li><a href="https://www.drupal.org/drupalorg/docs/content/documentation#write">https://www.drupal.org/drupalorg/docs/content/documentation#write</a></li> </ul> <p>Code</p> <p><code>&lt;h4&gt;&lt;a id="option-4---anchor" name="option-4---anchor"&gt;Writing and contributing documentation&lt;/a&gt;&lt;/h4&gt;</code></p> <hr> <h3><a id="option-5" name="option-5" href="https://www.drupal.org"></a>Option 5: Use the TOC</h3> <ol> <li>Don't add visible anchor links to short pages without a TOC</li> <li>If a page has a TOC, the items in the TOC are visible anchor links.</li> </ol> <hr> <h2>Deployed solution</h2> <p>Option 2 with Clickable Prefix Hastag is used in the implementation that has gone live on drupal.org.</p> > Related issue: [Issue #2942745](https://www.drupal.org/node/2942745) > Related issue: [Issue #2983144](https://www.drupal.org/node/2983144)