[wp-meta] [Making WordPress.org] #1810: Better formatting for FAQ

[Making WordPress.org]

#1810: Better formatting for FAQ
------------------------------+---------------------------------------
 Reporter:  samuelsidler      |       Owner:
     Type:  enhancement       |      Status:  new
 Priority:  normal            |   Milestone:  Plugin Directory v3 - M7
Component:  Plugin Directory  |  Resolution:
 Keywords:                    |
------------------------------+---------------------------------------

Comment (by dd32):

 @obenland Thanks for [attachment:1810.2.diff] I decided to pretty much go
 in the same direction as you did there.

 After a lot of tweaking of the functions to parse the majority of readme
 edgecase formats I could find, and also not breaking the parsing of the
 `upgrade_notice` for quite a few plugins I ended up with [3827].

 For an example of what happens when there exists freeform data prior to
 the Q&A section, [https://wordpress.org/plugins-wp/wp-table-reloaded/ wp-
 table-reloaded] is the first example I could find. In the event there's
 freeform data at the end of the Q&A, we have no way to detect that and
 include it in the last question.

 Freeform data at present includes a lot of numbered and ordered lists,
 paragraphs directing people elsewhere, and even random non-FAQ material. I
 decided to just display that as-is anyway as parsing it wasn't really
 possible.
 I'd suggest that the FAQ should get a readmore link added to it if no
 `<dl>` is present within the section - for consistency sake, and to
 prevent long FAQ's (which we can't parse) taking over the screen.

 I'm going to kick off a job to reparse all plugins, it'll probably take a
 day or so to complete.

--
Ticket URL: <https://meta.trac.wordpress.org/ticket/1810#comment:16>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org