Add a block description

[laryn]

It might be nice to add a block description if we can think of a nice short one:

[olafgrabienski]

@laryn Thanks for your suggestion! A block description would be nice, indeed! What do you think of the following descriptions? Do you like a particular one, or do you have other ideas?

• An automatic table of contents (TOC).
• A table of contents (TOC), generated from HTML headings.
• A table of contents (TOC) based on the headings of your content.

[olafgrabienski]

Voilà a mockup to see if one of the descriptions from above is short enough:

---

[olafgrabienski]

Coming back to this. @laryn What do you think about the description text ideas? As you see in the mockup, even the longer descriptions don't need very much space.

I like the one in the second screenshot:

A table of contents (TOC) built from your content headings.

Do you have a favorite (or other ideas)?

[laryn]

I like that one, too.

[olafgrabienski]

@laryn Thanks for your feedback! Are you maybe up to provide a PR? (Or a hint, where and how to add a block description?)

[laryn]

@olafgrabienski You can add a ‘description’ entry after the one for ‘info’ here:

https://github.com/backdrop-contrib/tocbot/blob/1.x-1.x/tocbot.module#L32

[olafgrabienski]

Thanks for the hint, @laryn! I've added a PR at https://github.com/backdrop-contrib/tocbot/pull/55 and merged it right away.

[olafgrabienski]

@laryn Are you interested to address one of the other open issues before I make a new release?

[laryn]

@olafgrabienski No, feel free to release, I don't think I'll be working on anything on this module in the near future. 👍