#1802 closed enhancement (fixed)
Restructure reference pages more logically and apply the TOC to allthethings
Reported by: | DrewAPicture | Owned by: | drewapicture |
---|---|---|---|
Milestone: | Priority: | normal | |
Component: | Developer Hub | Keywords: | has-patch has-screenshots |
Cc: |
Description
In [3563] for #1548, we implemented a table of contents for the explanation or "More Information" section of reference pages. With this ticket I'm proposing three extensions of that effort:
- Apply the table of contents to most if not all of the sections of any given reference page
- Slightly restructure the reference page sections and in some cases consolidate to provide a more logical flow of information within that table of contents.
- Slightly modify the TOC class in the handbook plugin to accept dynamic header text, defaulting to 'Topics'.
For #1, making it possible to apply the table of contents logic to multiple reference page sections requires splitting that content into pieces. My attached patch proposes splitting them all into individual template parts that we therefore capture in output buffering to output all at once.
For #2, I've also slightly restructured the ordering and consolidation of information, namely, made "Description" the top-level section, and moved Parameters, Return, Source, and Changelog under "Description". I've consolidate to two Source sections into one.
I've also grouped Uses and Used By under a new top-level "Related" section that we can further extend in the future with related functionality.
Finally this leaves us with roughly four top-level sections for any given reference page: Description, More Information, Related, and User Contributed Notes.
Before and after screenshots attached.
Attachments (8)
Change History (20)
#2
@
8 years ago
1802_handbook.diff includes the handbook plugin changes.
#6
@
8 years ago
- Owner set to drewapicture
- Resolution set to fixed
- Status changed from new to closed
In 3627:
#9
@
8 years ago
@drewapicture I'd like to recommend that the ToC links be styled in a way that better affords interaction. There is currently no indication that the black text is clickable, and the only hover effect is the default cursor change.
See the old styling of the Codex content menus for a possible quick fix.
Handbook changes