Workshop: JavaScript im Wiki

[Matthias Scharwies]

Servus!

Wir haben über 800 Seiten in der Kategorie:JavaScript - Tutorials, Referenz- und Grundlagenartikel.

Wie können wir diese sortieren und Übersichtsseiten (z.B.: JavaScript und JavaScript/Tutorials) auch übersichtlich gestalten?

Erst jetzt bin ich dazu gekommen, ein Ergebnisprotokoll vom Mittwoch zu schreiben. Es waren wieder 4 Aktive anwesend und wir schauten uns den Ist-Zustand unserer Portalseiten an.

Portalseiten

Ich schaue immer wieder gerne in die alte Doku und vergleiche Struktur und Begriffe mit unserem Wiki.^[1] Mit den Cards haben wir nun ein Gestaltungselement, um bessere Übersicht zu verschaffen.

Dabei hat sich im Gespräch ein Zwischenergebnis herauskristallisiert:

Ziel:

Sowohl der Erstnutzer, als auch Semi-Profis beim Nachschlagen nach bestimmten Begriffen sollen schnell zu den gewünschten Inhalten (!= Seiten) kommen.

Mittel:

1. Die Card Sprachelemente soll auf JavaScript/Sprachelemente verlinken - Referenz/ Grundlagenartikel zu Aufbau und Syntax der Sprache.
2. Daneben gibt es mit „JavaScript im Browser" und „Document Object Modul“ zwei Übersichtsseiten, die in unsere JS-Referenz verlinken.^[2]
3. Für eine Suche nach vorhandenen Begriffen/Seiten gab es bis jetzt 2 Möglichkeiten:
   • den Schnellindex
   • die (automatisch erstellen) Kategorien-Übersichten

Exkurs: Inhaltsverzeichnisse und Linklisten

@Rolf B und ich sind am Tag vorher über HTML/Attribute#Attribute_.(alphabetisch) gestolpert. Dies sind Linklisten die bei neuen Unterseiten immer wieder aktualisiert werden müssen. Einfacher wäre es, die bereits vorhandenen Kategorien-Seiten mit JS und CSS so zu gestalten, dass ihre automatisch erzeugten Inhalte ansprechend präsentiert werden.^[3]

Dies führte uns zu den Schnell-Index-Seite(n) und zum Inhaltsverzeichnis.^[4] Die Existenz dieser Seite war selbst einigen Profis nicht mehr geläufig.

@all Wer nutzt den Schnellindex und das Inhaltsverzeichnis und würde es gerne behalten?

Sonst würde ich diese Seiten zum 01.03. depublizieren und durch die Kategorien-Übersichten ersetzen.

Sprachelemente

In einem zweiten Schritt werden wir die JavaScript/Sprachelemente sichten, um zu schauen, ob/was wir dort ändern müssen/können.

Auch hier besteht eigentlich Konsens:^[5]

Wir bieten hier eine Einführung in JS - Aufbau, Syntax und Elemente der Sprache. Diese Artikel müssen den Spagat schaffen, dass sie dem Anfänger Sachverhalte in einfacher Sprache und mit guten Snippets - keinen LiveBeispielen - erklären, um dann auch komplexere Aspekte zu erwähnen und zu erklären. Wenn ein Anfänger etwas nicht versteht, kann er später zum Nachschlagen wiederkommen.

Wichtig ist, dass jeder Artikel nicht nur einen Beginn hat, in dem das Thema vorgestellt wird, sondern auch so abgegrenzt wird, dass man zu einem Ende kommt und im Siehe auch Cards für weitere Artikel anbietet.

Einige der Neufassungen habe ich bereits rübergezogen. JavaScript/Variable mache ich bis Ende des Monats soweit fertig, dass man es in einer peer review diskutieren kann.

@all

1. Wer hat Vorschläge, wie man einzelne Cards, die Texte und die Icons besser gestalten kann?
2. Wer hat Vorschläge, welche Artikel unbedingt in die Cards müssen? Welche Artikel fehlen noch im "Siehe auch"?
3. Wer würde sich um einzelne Artikel kümmern?
   • Bestehendes sichten
   • Mängel notieren
   • Verbeserungsvorschläge machen und bestenfalls selbst tätig werden

@Rolf B hat mit JS/Array in seinem Benutzernamensraum angefangen; ich arbeite an JS/Variable im Test-Wiki.

---

Der nächste Stammtisch ist am Mittwoch, den 12.03. um 20:15 auf Discord.

Herzliche Grüße

Matthias Scharwies

---

1. In der Doku 8.0 vom März 2005 war der JS-Bereich noch übersichtlich klein:
   Dies wurde schrittweise immer komplexer, sodass unsere Linklisten teilweise Unterlisten und kurze Erklärungen enthalten: Mittlerweile haben wir Cards, die eine bessere Übersicht verschaffen: ↩︎

2. Nicht mehr auf der Portalseite finden sich APIs wie WebGL und XMLHttpRequest; andere wie Canvas und Geolocation sind bereits unter Tutorials gelistet. ↩︎

3. Die Kategorien-Seiten listen jetzt 200 Einträge pro Seite in einer mehrspaltigen Liste.
   .mw-category { -webkit-column-count: 3; -moz-column-count: 3; column-count: 3; -webkit-column-width: 24em; -moz-column-width: 24em; column-width: 24em; }
   Dabei verhindert die Maximalbreite des Inhalts eine 3. Spalte.
   Auch wenn man sich bei JavaScript durch mehrere Seiten klicken muss, sind diese doch vollständiger als eine kuratierte Liste.
   Falls jemand einen bestimmten Begriff in den Kategorien-Übersichten unterbringen möchte, kann er eine Weiterleitung mit der entsprechenden Kategorie anlegen. ↩︎

4. Das Inhaltsverzeichnis war ursprünglich eine in die Startseite eingebundene Seite, die man aufklappen konnte. Dies führt immer wieder zu Diskussionen, ob diese Inhalte wichtig genug wären, sie aufgeklappt zu präsentieren, bzw. wegzulassen, da sie im eingeklappten Zustand ja nicht sichtbar/erreichbar seien. ↩︎

5. Frage zum Wiki-Artikel „Anweisung“ vom 17.01.2025
   Wenn selbst jemand wie @Auge den Text nicht versteht, sollten wir uns fragen, ob wir /jemand anderes anders formulieren kann, bzw. ob wir diesen Aspekt woanders unterbringen wollen. ↩︎