WordPress.org

Making WordPress.org

Opened 14 months ago

Closed 7 months ago

#2638 closed defect (wontfix)

Linebreaks in FAQ section

Reported by: ccprog Owned by:
Milestone: Priority: normal
Component: Plugin Directory Keywords: has-patch
Cc:

Description

The FAQ section shows all linebreaks from the readme.txt instead of interpreting them according to Markdown rules. Related to #2622?

Attachments (2)

faq-linebreak.png (24.8 KB) - added by ccprog 14 months ago.
From https://wordpress.org/plugins/crosswordsearch/
2638.diff (483 bytes) - added by obenland 14 months ago.

Download all attachments as: .zip

Change History (8)

#1 @ccprog
14 months ago

  • Summary changed from Linebraks in FAQ section to Linebreaks in FAQ section

@obenland
14 months ago

#2 @obenland
14 months ago

  • Keywords has-patch added

Patch would replace line breaks with a space to mitigate instances where line breaks appear after commas of periods.
This is likely not the best approach, maybe there is a setting in our markdown parser that deals with that?

#3 @dd32
14 months ago

I think I looked into something like 2638.diff, but unfortunately IIRC it had unintended consequences (which I can't recall now that it's been so long) - probably specifically about intentional new lines.

Here's how that readme was parsed in the old directory:

<p>There is limited support for use in multisite environments. There is no option for a network
wide installation; the plugin <strong>must</strong> be enabled for each individual site. Projects and
their associated rights are also specific to the individual site, local administrators have
access to these settings as usual.</p>

Here's the readme being parsed in the new directory:

<p>There is limited support for use in multisite environments. There is no option for a network
wide installation; the plugin <strong>must</strong> be enabled for each individual site. Projects and
their associated rights are also specific to the individual site, local administrators have
access to these settings as usual.</p>

I'm assuming that the difference is that we now have WordPress display filters running over the content - probably wpautop() specifically.

I think I'm okay with this, and am happy to intentionally break anyone who is reliant upon this specific markdown format of new lines. A bunch of plugins will need to update to match the new directory in many ways, I don't see this as being one of those ways as being a bad thing.
If we leave it as-is, it'd probably be best to add a nl2br() call into the parser to solidify that we're intentionally doing this.

#4 @dd32
14 months ago

I think I looked into something like 2638.diff​, but unfortunately IIRC it had unintended consequences (which I can't recall now that it's been so long) - probably specifically about intentional new lines.

Looks to be [4386]

#5 @jdgrimes
14 months ago

I'm seeing this in the plugin descriptions as well (https://wordpress.org/plugins/wordpoints/):

https://cldup.com/D3HyWmIFWZ.png

Related: #2257 ?

#6 @tellyworth
7 months ago

  • Resolution set to wontfix
  • Status changed from new to closed

Absent a patch that doesn't cause other issues, I think the correct solution is not to use explicit newlines in readme.txt.

Note: See TracTickets for help on using tickets.