Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.With longer help pages, I think it is helpful to have an automatically generated table of contents block.
Before including such a mechanism in advanced_help proper, I've created one as a tiny separate module, to gather opinions/comments. The initial version if attached, and the repository is live on http://git.osinet.eu/drupal/modules/ah_toc.git/
| Comment | File | Size | Author |
|---|---|---|---|
| #4 | ah_toc_7.x.tgz | 3.26 KB | fgm |
| #3 | ah_toc.tgz | 3.14 KB | fgm |
| #2 | ah_toc.tgz | 22.62 KB | fgm |
| #1 | ah_toc.tgz | 1.98 KB | fgm |
Comments
Comment #1
fgmHmm, attachment didn't stick ?
Comment #2
fgmThis version seems to more or less feature-complete, now. It even includes a french translation.
Any comments ? Is it just useless ? Silly ? Useful, but should remain separate from advanced_help proper ? To be included in advanced_help ?
Comment #3
fgmHmm, some junk left in previous upload.
Comment #4
fgmAnd here is an equivalent 7.x version
Comment #5
fgm(updating title)
Comment #6
giorgio79 CreditAttribution: giorgio79 commentedHow about this?
http://drupal.org/project/tableofcontents
Comment #7
gisle12 years without activity.
Comment #8
fgm@gisle AFAICS it's still a missing feature on the D8+ version. Interested in my rerolling it ?
Comment #9
gisleYes, this feature is still missing.
Since this feature was initially suggested (in 2010, for Drupal 6) the ambitions for this module has become significantly lower. Back in 2010, the then main maintainer (merlinofchaos) envisaged that this module should become part of core, and also that it would be used on Drupal.org itself for creating handbooks and online user manuals. This is no longer the case. Instead the Help Topics and the Tour modules are being developed, and will probably at one point obsolete this project for all new online help. To be frank, I don't see much need for such a feature for the relatively short help texts that this module is being used for.
As the current main maintainer, I think that Advanced Help still need to be developed for Drupal 10. However, its main use case now is to allow the Drupal 7 projects that depends on it for online help to be upgraded to Drupal 10 without having to convert their help files to the newer help formats that is now provided by core. For that end, fixing Drupal 7 regressions is my highest priority. Take a look at the child issues of #3366294: [meta] Regressions vis-à-vis Drupal 7. If you have some time available, helping out getting those resolved would be most appreciated.
As for rerolling your table of contents feature for Drupal 10, feel free to reopen this issue if you still feel the module will benefit from it being added. Note that both
.htmland.mdare supported for help text, so a table of contents should work with both markup formats. If this feature can be implemented as a submodule that can be installed independently, I would prefer that solution.PS: In comment #6, it is suggested that those looking for this may use Table of Contents – but that module looks pretty abandoned. See Comparison of TOC modules for possible alternatives.
Comment #10
fgmI understand your decision, thanks.
The main reason why I implemented it was for client projects where modules had significant/longer documentation in A.H.. I'll have a look at what it entails on the current version. IIRC it's just a small bit of JS, probably using jQuery at the time but no longer needing it these days.