Verwendung von H1 vs. H2 Überschriften im Composer

Wenn bei der Verwendung einer Markdown-Überschrift erster Ebene (#) in einem Thema wird dadurch h1 oder h2 in der HTML-Ausgabe erzeugt?

1 „Gefällt mir“

Es wird ein <h1> ausgegeben :slight_smile:

1 „Gefällt mir“

Bedeutet das also, dass Discourse davon ausgeht, dass es in Ordnung ist, mehrere <h1>-Tags auf einer Seite zu haben? Wenn der Thementitel h1 ist, sollten die Überschriften erster Ebene innerhalb dieses Themas standardmäßig h2 sein, oder?

1 „Gefällt mir“

Discourse geht von nichts aus, es gibt aus, was Sie es auszugeben bitten.
Es ist bessere Praxis, ## stattdessen ### als oberste Überschriften innerhalb eines Beitrags zu verwenden, ganz sicher :slight_smile:

edit: siehe Use of H1 vs. H2 headings in composer - #16 by Canapin

2 „Gefällt mir“

Das ist definitiv eine „Benutzerschulung“, die wir uns ersparen könnten, indem wir # nicht zu einer Überschrift der Stufe 1 machen… :anxious_face_with_sweat:

Wissen Sie, ob es eine Möglichkeit gibt, das zu ändern? Oder zumindest Überschriften der Stufe 1 in der Werkzeugleiste auszublenden? (Ich vermute, dass Leute, die direkt in Markdown schreiben, ein realistisches Schulungsziel sind …)

1 „Gefällt mir“

Ja, das ist ziemlich einfach. Das Listenelement hat ein data-name="heading-1"-Attribut, das Sie mit CSS ansprechen können :slight_smile:

1 „Gefällt mir“

Heh – ich habe es mir gerade auch angesehen. In einem schnellen Test verbirgt dies die H1-Option sowohl im Markdown- als auch im Rich-Text-Editor:

button[data-name="heading-1"] {
  display: none;
}

(Ich behalte das vielleicht einfach bei! Ich sehe keinen großen Grund, H1 im Editor anzubieten.)

2 „Gefällt mir“

Ich kann Ihren Standpunkt verstehen, aber das ist nichts, worüber Discourse notwendigerweise entschieden hat. Discourse folgt einer Markdown-Konvention namens CommonMark, und diese spezifiziert, dass # in ein H1 umgewandelt werden soll. Ich denke, diese Konvention, wie Markdown-Überschriften in HTML-Tags umgewandelt werden, ist bei den meisten wichtigen Markdown-Spezifikationen ziemlich Standard.

2 „Gefällt mir“

Nun, zwei <h1>-Überschriften sind eigentlich keine so große Frage. Es ist ein wirklich altes SEO-Meme, das schon lange kein Problem mehr darstellt. Google und Co. verwenden die erste oder was auch immer sie für am besten geeignet halten.

Wir können diskutieren, ob zwei Hauptüberschriften inhaltlich die klügste Entscheidung sind, aber wenn eine Plattform unterschiedliche Stile für den Them_ennamen und Überschriften in Beiträgen verwendet, spielt das keine wirkliche Rolle.

Dennoch ist es angebrachter, in Beiträgen ##/<h2> zu verwenden. Aber da es keine tatsächliche Rolle spielt, ist es meiner Meinung nach besser, wenn Benutzer Überschriften verwenden, die diese vermeiden, weil sie Angst haben, die „falsche“ Überschrift zu verwenden :man_shrugging:

2 „Gefällt mir“

Überschriften sind heute vielleicht nur noch ein kleines Signal für SEO – aber weil ich ein Nerd bin, mag ich trotzdem keine doppelten H1s. :nerd_face:

Ich denke auch darüber nach, wie Steph druckbare Dokumentationen für die Seitenerstellung erstellt, bei denen H1s im Beitrag sogar noch größer dargestellt werden als die H1 der Seite selbst:

Bild

Wenn man diese zu H2 macht, bleiben sie etwas kleiner als die obere H1:

Bild

1 „Gefällt mir“

Ja, das ist das Problem. Für mich ist es natürlich, zuerst die Überschrift erster Ebene zu verwenden, aber wenn das Theme nicht mit derselben Annahme gestaltet ist, ist es unordentlich. Hier gibt es eine Art Trennung.

(Nebenbemerkung: Wird dir das Dokument auf Englisch angezeigt, ohne dass du etwas unternommen hast?!?)

Das ist natürlich, ja, und es ergibt Sinn, wenn man eine Webseite von Grund auf neu erstellt. Aber ein CMS oder ein Veröffentlichungssystem bezieht die H1 der Seite fast immer aus einem Titel-Feld, sodass man normalerweise zu H2 für die Inhaltsabschnitte greifen würde.

(Und ich habe das Übersetzungstool des Webbrowsers verwendet, um Englisch zu erhalten.)

1 „Gefällt mir“

Ich stimme zu. Aber wir sollten nicht erwarten, dass Community-Mitglieder das wissen müssen, meiner Meinung nach.

Yep – und ich sehe keinen Nachteil darin, einfach die H1-Option auszublenden.

Obwohl ich nicht viele Überschriften von den meisten Benutzern sehe, die typische Beiträge erstellen. Leute, die längere Dokumentationsthemen erstellen, haben wahrscheinlich (oder werden schnell haben) etwas mehr Erfahrung mit ## und diesem „TT“-Symbol.

(Außerdem: Mir ist gerade diese interessante alte Diskussion aufgefallen, in der vorgeschlagen wird, dass Überschriften nur in Themen verwendet und in Antworten deaktiviert werden sollten: Disable headers in replies like h1 and h2)

2 „Gefällt mir“

Außerdem: Mir ist gerade diese interessante alte Diskussion aufgefallen, in der vorgeschlagen wird, dass Überschriften nur in Themen und nicht in Antworten verwendet werden sollten: Überschriften in Antworten wie h1 und h2 deaktivieren

Falls das für jemanden von Interesse ist, blendet dieser kleine Codeausschnitt das „TT“-Überschriften-Symbol im Composer nur beim Antworten komplett aus:

.composer-action-reply button.heading {
  display: none;
}
1 „Gefällt mir“

Überschriften dienen nicht nur der Suchmaschinenoptimierung (SEO), sondern auch der Barrierefreiheit.

Vorleseprogramme können von einer Überschrift zur nächsten springen, und wir können die Überschriften-Tiefe mit Tastenkombinationen festlegen.

Themen haben ihre <h1>-Titel, aber jede Antwort wird mit einer eigenen ausgeblendeten <h2> vorangestellt, die für Vorleseprogramme sichtbar ist:

<h2 aria-hidden="false" class="sr-only" id="post-heading-9">
  post by Jagster 4 hours ago
</h2>

In jedem Fall ist eine von Ihnen im Inhalt verwendete <h1>- oder <h2>-Überschrift immer ein Nachfahre einer bereits existierenden <h2>: :upside_down_face:

Ich würde sagen, dass die Verwendung von Überschriften über <h3> in einem Beitrag die Navigation mit Vorleseprogrammen etwas seltsam machen könnte.

Obwohl dies bei bestehenden Themen nicht ganz konsistent ist, verwenden die Beitragsvorlagen aus Customization > Plugin <h3> als oberste Überschriften:

| | | |
| - | - | - |
| :information_source: | **Summary** | In a few words, what does this plugin do? |
| :hammer_and_wrench: | **Repository Link** | <> |
| :open_book: | **Install Guide** | [How to install plugins in Discourse](https://meta.discourse.org/t/install-plugins-in-discourse/19157) |

<br>  

### Features
 
Describe the major features of the plugin
 
### Configuration

Include detailed steps on how to configure the plugin (include screenshots where necessary)

### Settings 

Include a table of settings and setting descriptions

| Name | Description
|-|-|
|

Interessanterweise ist dies bei den Vorlagen für Customization > Theme und Customization > Theme component nicht der Fall, aber ihre Vorlagen enthalten keine Überschriften. Vielleicht sollte dies geändert werden.

4 „Gefällt mir“

Zustimmung. Ich bin auch etwas nerdig und mag eine saubere Überschriftenhierarchie.
Also sollten wir in einem Beitrag eigentlich nur h3, h4, h5 verwenden, wenn wir es richtig machen wollen – es könnte interessant sein, eine Art Theme-Komponente zu haben, die das „korrigiert“, was bedeuten würde, höhere Überschriftenebenen aus den Schaltflächen zu entfernen und das Styling für h3 und darunter in Themen zu „übersetzen“, damit es richtig aussieht, wenn wir sie verwenden…?

Es gibt auch h6, falls Sie eine weitere Ebene in Beiträgen benötigen, aber es ist winzig

H5 ist auch kleiner als der normale Text im Beitrag, daher bin ich mir nicht sicher, ob ich es verwenden würde

das ist h5
2 „Gefällt mir“

Ah, das wusste ich nicht! Erklärt wahrscheinlich Pfaffmans Kommentar, dass „die erste Ebene der Überschrift in einem Beitrag ein h3 sein sollte“ [1]
Der CSS-Hack lautet dann:

button[data-name="heading-1"], button[data-name="heading-2"] {
  display: none;
}

Vielen Dank, dass Sie sich mit Barrierefreiheit befassen – ich versuche, dies zu berücksichtigen.


  1. Quelle ↩︎

3 „Gefällt mir“

Sie könnten die Stile für H3-5 sicherlich anpassen … oder sie sind möglicherweise so in Ordnung:

2 „Gefällt mir“