Opened 9 years ago
Closed 8 years ago
#1548 closed enhancement (fixed)
New style docs pages don't have any in-page navigation
Reported by: | theMikeD | Owned by: | DrewAPicture |
---|---|---|---|
Milestone: | Priority: | normal | |
Component: | Developer Hub | Keywords: | has-patch |
Cc: |
Description
The current page for get_posts https://codex.wordpress.org/Template_Tags/get_posts has an in-page navigation to make finding what you want easier. I don't see this functionality in the new-style pages. Is this by design?
Attachments (3)
Change History (10)
This ticket was mentioned in Slack in #meta-devhub by sam. View the logs.
9 years ago
#3
@
9 years ago
- Owner set to DrewAPicture
- Status changed from new to accepted
- Type changed from defect to enhancement
Hi @theMikeD, thanks for the suggestion. I'm actually working on a proof of concept for this very thing right now! I was waiting until I had an MVP to create a ticket but you beat me to it :-)
Not all references are going to be as complete as some of the larger ones (like get_posts()
or WP_Query
, etc.), so my best suggestion and approach is going to make it possible to selectively enable a ToC for the explanations module (also known as the "More Information" section in a particular reference.
Over the holidays, I did a ton of work converting the WP_Query
docs from the Codex to something we could use on DevHub, and with a Table of Contents, that reference page would look something like this: http://cl.ly/1D2V2Z2z392i
#4
@
9 years ago
That looks great! I'd love to help if I can, even if it's just proofing. But if we could abstract that somehow that would be really good. How can I help?
#5
@
8 years ago
- Keywords has-patch added
1548.diff implements the Handbooks table of contents functionality for the "More Information" sections on all four parsed post types.
Spoke with @coffee2code in person about it and we think this is the best first-step. It might later be worth looking at injecting the other sections (currently output as <section>
tags) into the TOC logic to include them.
#6
@
8 years ago
1548.2.diff Incorporates further feedback from @coffee2code to handle the post content filtering inside of get_explanation_field()
instead of within the template.
get_posts in-page navigation block