WordPress.org

Making WordPress.org

Opened 5 months ago

Closed 5 months ago

Last modified 5 months ago

#5191 closed defect (fixed)

Plugin FAQ headings should use H3 tags

Reported by: jonoaldersonwp Owned by: dd32
Milestone: Priority: low
Component: Plugin Directory Keywords: seo
Cc:

Description

Plugins FAQ sections, like https://wordpress.org/plugins/wordpress-seo/, should use <h3> tags to mark up the 'names' of questions in the <dl> structure.

This is transformed on load using JavaScript, but should instead be correct in the HTML response.

Specifically, the markup should be altered to:

<dl>
  <dt><h3>{{Question}}</h3></dt>
  <dd>{{Answer}}</dd>
  {...}
</dl>

Note that {{answer}} typically already contains formatting (such as paragraph structures), and shouldn't therefore need changing.

Change History (4)

#1 @dd32
5 months ago

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

In 9826:

Plugin Directory: FAQ: Alter the markup to be <dt><h3>{{Question}}</h3></dt> to match the Javascript FAQ implementation.

This is run on import, so it'll only affect plugins upon their next commit rather than immediately.

Fixes #5191.

#2 @dd32
5 months ago

Example: https://wordpress.org/plugins/eber/ (The first plugin commit when I checked that had a FAQ)

#3 @dd32
5 months ago

In 9827:

Plugin Directory: API: Update to respect the new markup format introduced in [9826].

See #5191.

#4 @ocean90
5 months ago

In 9828:

Plugin Directory, i18n import: Update to respect the new readme markup format introduced in [9826].

See #5191.

Note: See TracTickets for help on using tickets.