Ordered lists with non-number markers

Merkmal
1

Request: Add “type” attribute of <ol> to whitelist. Suggestion to do the same with “reversed” for <ol>, and “value” for <li>, for similar but less common reasons.

Purpose: These attributes are intended for use where the marker of ordered list items itself conveys meaning to the content of the list. Typically this is the case when list items are intended to be referred to via this marker. This is in contrast to CSS list-style-type which is intended where the choice of marker carries no significant purpose. (Though I did see it recommended for forum-wide localization, which is pretty great!)

Background: While attempting to quote an official reference document, I discovered an apparent limitation in list formatting which prevents doing so accurately. Quite often, list markers are purely stylistic. However, they are occasionally used to facilitate reference in list-heavy documents. For example, in official and legal documents, a list item (or sub-item) might be referred to by list marker: “Official Document Article I, section 1(a)(i)”

For Markdown, there’s no mention in the CommonMark specification, and indeed it specifies only digits, 0-9. But while most interpreters don’t permit letters for lists(including markdown-it), a couple do:

I’m uncertain of whether a standard method is available in BBCode, to the extent anything is standard in BBCode. I was unable to find anything more advanced than starting at an arbitrary digit. BBCode list tags don’t appear used by Discourse, anyway.

With HTML and HTML+style, neither produce the correct result:

3 „Gefällt mir“
2

Looking at GitHub, implementing this would likely be simply a matter of adding them to this list:
https://github.com/discourse/discourse/blob/master/app/assets/javascripts/pretty-text/white-lister.js#L181-L183

Though I do notice that introducing these will leave the HTML-to-markdown converter unaware of these attributes. But as demonstrated above, markdown-it currently can’t handle markdown syntax representing these anyway. For that, it may be desirable to go a step further and implement list types in CommonMark…

2 „Gefällt mir“
3

There are no plans for this.

4

The lack of this makes it very difficult to quote official documents, legal documents, software licenses, or anything else which use non-number markers for document references.

1 „Gefällt mir“
5

Add a wrapper to those lists and some CSS

In posts use:

[wrap="letterlist"]
1. is the first
2. is the second.
3. is the third
[/wrap]

IN your theme add:

.cooked div[data-wrap="letterlist"]
  list-style: upper-alpha;
}
1 „Gefällt mir“
6

That’s a good solution if the goal is arbitrary list decorations, but the HTML type attribute is specifically meant for semantically-meaningful situations where the difference between list markers are more than decorative. From <ol>: The Ordered List element - HTML: HyperText Markup Language | MDN

Unless the type of the list number matters (like legal or technical documents where items are referenced by their number/letter), use the CSS list-style-type property instead.

It’s a common enough need that although the HTML attribute was deprecated in HTML 4.01 (with justification of it being purely stylistic), it was subsequently re-introduced in HTML5 for the specific purpose of encoding reference lists as described by MDN.

1 „Gefällt mir“
7

Ich habe versucht, diese Lösung zu verwenden, und sie funktioniert, indem das CSS wie folgt korrigiert wird (der ersten Zeile fehlte ein ol {):\n\n```css
.cooked div[data-wrap="letterlist"] ol {
list-style: upper-alpha;
}

1 „Gefällt mir“
8

Ich glaube, HTML wird jetzt unterstützt:

  1. This thing
  2. Another thing
  3. Something else 
<ol type="A">
<li> This thing
<li> Another thing
<li> Something else
</ol>

Und die Typen A, a, I und i.

Auch <ol reversed> und <ol start=> ebenfalls:

  1. Bread
  2. Chips
  3. Watermelon 
<ol reversed start=36>
<li> Bread
<li> Chips
<li> Watermelon
</ol>
9

Es scheint, dass die Verwendung von HTML auf diese Weise die Markdown-Interpretation innerhalb der <li>-Tags deaktiviert, was für mich nicht wirklich akzeptabel ist, um es Benutzern vorzuschlagen.

1 „Gefällt mir“
10

Um zusätzliche Formatierungen darin zu nutzen, müssten Sie wahrscheinlich auch die HTML-Version davon verwenden, da sie keine Mischung mag:

  1. Brot
  2. Chips
  3. Wassermelone 
<ol reversed start=36>
<li> <b>Brot</b>
<li> <i>Chips</i>
<li> <strike>Wassermelone</strike>
</ol>
11

Ich weiß. Wie ich sagte, halte ich das für meine Benutzer nicht akzeptabel – es ändert die Auszeichnung komplett, nur weil Sie eine etwas andere Liste wünschen.

12

Es tut mir leid, dass das keine akzeptable Option für Sie ist.

Vielleicht kann Ihnen jemand helfen, wenn Sie ein #dev-Thema starten und um Hilfe bei der Anpassung Ihrer bestehenden Lösung bitten. :+1:

1 „Gefällt mir“