Create directive for glossary/terminology overviews (A-Z)

[garvinhicking]

In https://docs.typo3.org/m/typo3/writing-guide/main/en-us/writing-principles-and-guidelines/spelling-and-typo3-terminology.html we can see that display is not optimal for an alphabetical list.

We could use a directive that allows to dynamically format such A-Z jump lists, complete with head. Something like:

..  alphabetic-list::
    ..  alpbhapbetic-title: Something something

        lorem ipsum...
    ..  alpbhapbetic-title: Darkside

        lorem ipsum2 ...

that could produce HTML like:

<div class="jumplist" id="jumplist-index">
<a href="#jumplist-d">D</a>
<a href="#jumplist-s">S</a>
</div>
<div class="jumplist-body">
  <div id="jumplist-d">
    <h2>D</h2>
    <div class="body">
        <dl>
           <dt><strong>Darkside</strong> <a href="#jumplist">Back to TOC</a></dt>
          <dd>Lorem ipsum...</dd>
        </dl>
    </div>
  </div>

  <div id="jumplist-s">
    <h2>S</h2>
    <div class="body">
        <dl>
           <dt><strong>Somethingn Something</strong> <a href="#jumplist">Back to TOC</a></dt>
          <dd>Lorem ipsum...</dd>
        </dl>
    </div>
  </div>

</div>

[jaapio]

This seems to be a list of definition lists to me. Which can be written like:

- A 
  
  Admin
    description
  Allow Fields
    description
- B
  
  Admin
    description
  Allow Fields
    description

Can you give that a try to see if it works for you?

[linawolf]

Yes it can but it is not nice to have to do that manually, because if you want to change the layout you have to change the list

[linawolf]

I wonder if we should enhance the glossary directive with some options:

https://sublime-and-sphinx-guide.readthedocs.io/en/latest/glossary.html

[jaapio]

I agree that it is better to have something autogenerated. Like a registry? But how to select what should be added?

[linawolf]

Just all definitions within the glossary directive