WordPress.org

Making WordPress.org

Opened 6 years ago

Closed 3 years ago

#181 closed enhancement (fixed)

Close tie-in between code reference and theme/plugin developer handbooks

Reported by: samuelsidler Owned by:
Milestone: Priority: normal
Component: Developer Hub Keywords:
Cc:

Description

We need to ensure that the code reference gets closely tied into the theme and plugin developer handbooks (among others). There is a design side to this, but also a function-side, requiring the inclusion of information from the code reference into the handbooks (or however we decide to do that).

Change History (9)

#1 @samuelsidler
6 years ago

  • Priority changed from low to normal

#2 @siobhan
6 years ago

  • Cc siobhan added

#3 @Rarst
6 years ago

This is a little vague in current form. Do we have any specific functionality ideas or requirements for it? I spent little time with handbooks, so not how would they want to incorporate code reference bits.

#4 @Rarst
6 years ago

Since Hanni is more on handbooks side of DevHub I had asked her to take a look and ponder this.

#5 @DrewAPicture
5 years ago

During today's DevHub chat, it was requested that I share the tags we're using to auto-link classes, hooks, and functions in the Code Reference explanations and parsed content. We're actually just using inline @see tags and a filter on the output converts it into a link to the corresponding class, hook, or function reference page depending on the presence of certain characters.

For instance:

In other words:

  • Absence of (), ::, and '' (single quotes) – the tagged-entity is linked as a class, e.g. {@see WP_Query}
  • Presence of () but not :: – the tagged-entity is linked as a function, e.g. {@see absint()}
  • Presence of :: – the tagged-entity is linked as a class method, e.g. {@see WP_Query::parse_query()}
  • Presence of '' (single quotes) – the tagged-entity is linked as a hook, e.g. {@see 'pre_get_search_form'}
Last edited 5 years ago by DrewAPicture (previous) (diff)

This ticket was mentioned in Slack in #meta-devhub by siobhan. View the logs.


5 years ago

This ticket was mentioned in Slack in #meta-devhub by drew. View the logs.


3 years ago

#8 @Kenshino
3 years ago

Noting down that Theme Handbook needs to use the autolinks too

#9 @coffee2code
3 years ago

  • Resolution set to fixed
  • Status changed from new to closed

Fixed as of [2814] (for #1483). Plaintext references to class names, functions, and methods are auto-linked.

Any other sort of tie-in between the handbooks and the code reference should be requested via new ticket(s).

Note: See TracTickets for help on using tickets.