WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#24295 closed enhancement (duplicate)

Allow ReadMe to support in-document links

Reported by: MattyRob Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: WordPress.org site Keywords:
Focuses: Cc:

Description

The current Plugin ReadMe files use MarkDown syntax and over time these can contain a great deal of information for users, for example in the FAQs.

The length of these sections sometimes makes finding the part you need a case of trawling through the entire document or searching for words in the browser window and hoping you are using the same vocabulary as the ReadMe author.

I think a useful enhancement would be to add the capability to define in-document links to allow for things like a table of contents at the top of the FAQ section. Currently you can create a link in such a table like this:

[FAQ 1](#1)

But I cannot find a way to create the linked section later in the document as any HTML, name or id parameters seem to get stripped out.

If this is already possible, please can you tell me how to accomplish this and accept my apologies from opening a ticket.

Change History (5)

#1 @SergeyBiryukov
6 years ago

This appears to be already possible, see #14143.

#2 @MattyRob
6 years ago

This doesn't help me at the moment. An id gets added to anything contained within == wrappers which translates to an H3 header. But it doesn't work for anything wrapped in single = wrappers which translate to an H4 header tag.

Also, since the "Frequently Asked Questions" area is defined by that header wrapped in ==, adding further == wrapped stringed beneath this simply creates a new section essentially breaking out the FAQs into another area.

What seem to be needed is the same solution in the ticket you've linked being applies to anything wrapped in single = markup.

#3 @SergeyBiryukov
6 years ago

  • Milestone changed from Awaiting Review to WordPress.org

#4 @samuelsidler
6 years ago

  • Milestone WordPress.org deleted
  • Status changed from new to closed

Migrated to #meta156.

#5 @SergeyBiryukov
6 years ago

  • Resolution set to duplicate
Note: See TracTickets for help on using tickets.