WordPress.org

Making WordPress.org

Opened 2 years ago

Closed 22 months ago

#3319 closed enhancement (fixed)

Auto-generate anchor links to FAQ topic

Reported by: helgatheviking Owned by: joostdevalk
Milestone: Priority: normal
Component: Plugin Directory Keywords: needs-patch
Cc:

Description

Currently you have to tell a user to find the XYZ question in your FAQ and only able to link to the FAQ anchor link.

Additionally, you can't even copy the XYZ title as it's locked up in some javascript for the hide/show or because it's a button element, I'm not really sure why, just that's it's annoying.

So my proposal is for anchor links to every FAQ topic. In the readme.txt the FAQ is demarcated by == FAQ ==. Could every = Topic = in that section could be anchor-linked? Or possibly some new form of markdown introduced?

Attachments (1)

link-to-faq.patch (838 bytes) - added by joostdevalk 2 years ago.
Patch

Download all attachments as: .zip

Change History (13)

#1 @obenland
2 years ago

  • Keywords needs-patch added

I think that's a good idea. Shouldn't be too hard to have those questions run through a sanitization function and added as an id to the dt element.

This ticket was mentioned in Slack in #meta by tellyworth. View the logs.


2 years ago

@joostdevalk
2 years ago

Patch

#3 @joostdevalk
2 years ago

  • Keywords has-patch added; needs-patch removed

#4 @joostdevalk
2 years ago

  • Owner set to joostdevalk
  • Status changed from new to assigned

#5 @joostdevalk
2 years ago

Hey @helgatheviking, I've created a patch that adds ID's to every question. I was wondering whether you think we should also have a link there for easy reference. Maybe just a # sign next to every question?

#6 @helgatheviking
2 years ago

A small link icon would be great! That would make it very easy for me to copy/paste links when I need to direct users to specific parts of the FAQ.

#7 @casiepa
2 years ago

All handbooks already have the # sign (e.g. https://make.wordpress.org/polyglots/handbook/) so I would stick to that one, yes.

#8 @helgatheviking
2 years ago

Probably best to maintain consistency. # should work great.

#9 @obenland
2 years ago

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

In 6285:

Plugins: Make FAQ topics linkable.

Allows for faq topics to be linked to directly, and show up expanded and scrolled to.

Props joostdevalk for initial patch.
Fixes #3319.

This ticket was mentioned in Slack in #meta by obenland. View the logs.


2 years ago

#11 @ocean90
22 months ago

  • Keywords needs-patch added; has-patch removed
  • Resolution fixed deleted
  • Status changed from closed to reopened

This doesn't work for headlines with non-latin characters, see https://cn.wordpress.org/plugins/jetpack/ as an example.

#12 @obenland
22 months ago

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

In 6494:

Plugins: Encode faq title rather than rolling my own

Props ocean90.
Closes #3319.

Note: See TracTickets for help on using tickets.