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

Making WordPress.org noreply at wordpress.org
Wed Aug 17 04:34:38 UTC 2016

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

Comment (by dd32):

 The more correct method to do this would be to parse the FAQ prior to
 markdown occurring, which you can see in the `upgrade_notice` section
 above the proposed change in [attachment:1810.diff], I'm not entirely sure
 why screenshots are being parsed afterwards though..

 You would then expose it as a `Readme\Parser::$faq[ $question ] =>
 $answer` property on the object, `CLI\Parser` would then be responsible
 for storing it however you wanted, which could be a `<dl>` in the post
 content, or as custom meta fields (as we do with screenshots, etc).

 Whichever way you approach it, it's worth remembering that not all FAQ's
 are using `<h4>`'s some use `<h3>` (`members`) and others use `<strong>`
 (`share-this`) or `<h9>` (, some include free form data before the
 headings (for example, `wp-user-avatar`), others (`cookie-notice`) just
 include a paragraph, and then there's those who use free-form "invalid"
 formats (`wpremote` &`jquery-updater`).

 Those plugins were just me opening a bunch of random plugins in the
 database and looking at their post_content, I'd say it was a 50% hit rate
 on "edge cases" while looking for examples. Ignoring, truncating, or
 reformatting plugins like this is fine, we just need to plan that out
 before we parse stuff.

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

More information about the wp-meta mailing list