From d9c675fba5dbc6249a0df96d266f17c86cfa95f1 Mon Sep 17 00:00:00 2001 From: Cedric Spindler Date: Thu, 5 Sep 2019 12:47:05 +0200 Subject: Lint-fix markdown syntax - no content/semantic changes! - trim trailing whitespace - fix header levels - # header style - link syntax - list syntax - code / no-format syntax --- Wiki/Starship_Factory_Seitenstruktur.mdwn | 48 ++++++++++++++++--------------- Wiki/Tipps_und_Tricks_zum_Wiki.mdwn | 30 ++++++++++++------- 2 files changed, 44 insertions(+), 34 deletions(-) (limited to 'Wiki') diff --git a/Wiki/Starship_Factory_Seitenstruktur.mdwn b/Wiki/Starship_Factory_Seitenstruktur.mdwn index 7758395e..b9d1c942 100644 --- a/Wiki/Starship_Factory_Seitenstruktur.mdwn +++ b/Wiki/Starship_Factory_Seitenstruktur.mdwn @@ -1,10 +1,10 @@ -Da es im wiki bereits Anzeichen für Wildwuchs gibt und nicht klar ist, wie Ordnung geschaffen weden könnte, wird nun **der Versuch unternommen**, hier eine Übersicht zu erstellen und diese als Dikussionsgrundlage für eine zukünftige Struktur anzubieten. +Da es im wiki bereits Anzeichen für Wildwuchs gibt und nicht klar ist, wie Ordnung geschaffen weden könnte, wird nun **der Versuch unternommen**, hier eine Übersicht zu erstellen und diese als Dikussionsgrundlage für eine zukünftige Struktur anzubieten. (!) Alle im Moment dargestellten Texte sind subjektiv von einer Person formuliert. Es ist allerdings jeder dazu aufgerufen, bei diesem Ordnungsprozess mitzuwirken oder seine Ideen einzubringen ;) -Seiten-Struktur -=========== -* Die "wichtigste Seite" ist unsere Homepage [[http://www.starship-factory.ch]]. Diese ist ein Blog, welches von Mitgliedern verändert und aktualisiert werden kann. Eine genaue Anleitung dazu fehlt allerdings noch. Knappe Hinweise lassen sich in [[Howtos/IT-Infrastruktur]] finden. Wenn vom "BLOG" gesprochen wird, dann ist diese Seite gemeint. +## Seiten-Struktur + +* Die "wichtigste Seite" ist unsere Homepage Diese ist ein Blog, welches von Mitgliedern verändert und aktualisiert werden kann. Eine genaue Anleitung dazu fehlt allerdings noch. Knappe Hinweise lassen sich in [[Howtos/IT-Infrastruktur]] finden. Wenn vom "BLOG" gesprochen wird, dann ist diese Seite gemeint. Aufgabe dieser Seite soll sein, auf die Starship Factory aufmerksam zu machen, Veranstaltungen und Workshops anzukündigen, Teaser zu liefern und auch sonst unser PR-Sprachrohr zu sein. @@ -12,8 +12,8 @@ Seiten-Struktur Aufgabe des Wiki sollte sein, unser Equipment aufzuschlüsseln, Anleitungen zu **allen** Gerätschaften aufzuführen (per QR-Code kann dann an jedem Gerät die Wiki-Adresse mit weiterführenden Infos und Dokumentation aufgeklebt werden), Projekte und Workshops zu entwickeln und im weiteren Sinne als Wissensdatenbank und Nachschlagemöglichkeit dienen. -Redundanz (=Wiederholung) -===================== +## Redundanz (=Wiederholung) + Beim Thema Redundanz scheiden sich die Geister :) Wer den Inhalt des Wiki auswändig kennt, für den sind Wiederholungen blöd. Aber solche Leute sollten nicht unsere Zielgruppe sein. Selbst wenn man für ein paar Monate nicht mehr aktiv mitschreibt, dann ist es schwer alle Infos zu finden. Die Suchfunktion hilft dann auch nicht, weil man eben die Treffer-Begriffe eines Artikels kennen muss. @@ -22,8 +22,8 @@ Wer den Inhalt des Wiki auswändig kennt, für den sind Wiederholungen blöd. Ab Die ikiwiki-Software stellt auch sehr leistungsstarke Direktiven zur Verfügung (insbesondere [[ikiwiki/directive/inline/]]), um das Ganze zu vereinfachen. Will sagen: Wir können Informationen auf /!\ kurzen Seiten darstellen und diese dann automatisch in andere Seiten einbinden. So muss nicht an zwei Stellen die Info geändert werden, sondern nur an einer. -Seitenhierarchien bzw. Ordnung -======================= +## Seitenhierarchien bzw. Ordnung + Das Blog selbst benötigt keine "Unterstruktur". Alle Infos werden historisch (neustes zuerst) aufgeführt. Wünschenswert wäre aber, dass alle Artikel weiterführende Links ins Wiki enthalten. Das wäre beim Eintrag [Laserhackathon](https://www.starship-factory.ch/2016/01/17/laser-hackathon) eine gute Idee gewesen. Im Wiki ist bisher begonnen worden, eine Seiten-Hierarchie aufzubauen. Diese wurde aber nicht durchgehend eingehalten. Hier sollte noch mehr passieren. Vom Grundsatz her ist ikiwiki in der Lage, Dateien zu verabeiten, die alle in ein Verzeichnis geklatscht wurden. Besser wäre aber die Verwendung von Unterordnern. @@ -32,25 +32,27 @@ Der Vorteil von Unterodnern ist, dass diese mit verschienden Filterfunktionen bz Vorschlag für Unterseiten im Wiki: -##Ordner für Informationsseiten +### Ordner für Informationsseiten + Wir benötigen Ordnung, um die technische Umsetzung des Wiki möglich zu machen, davon trennen kann man alle Seiten, die den eigentlich Informationsgehalt (also Content) beinhalten. Die meisten (mitschreibenden bzw. aktiven) Benutzer werden hauptsächlich hier miteditieren. -* **Benutzer/Xy**: -Hier können alle Mitglieder eine Kurzbeschreibung von sich hinterlassen. Schön wäre, wenn man bei verschiedenen Themen abschätzen könnte, wer hier welche Kenntnisse besitzt. Automatische Übersichtsseite dazu: [[Benutzer]]. Tagging würde das Ganze auch noch vereinfachen. -* **Howtos/Xy**: Hier sollten Anleitungen zu allen Gerätschaften hineinkommen. Momentan sind aber solche Beschreibungen teilweise noch beim Equipment zu finden. Das sollte einheitlicher gestaltet werden. Sinnvoll wäre auch eine Trennung in "Anleitung für xy" und "Reparaturanleitung für xy", wenn es denn nötig sein sollte. Automatische Übersichtsseite dazu: [[Howtos]]. -* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] -* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] -* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] -* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] +* **Benutzer/Xy**: +Hier können alle Mitglieder eine Kurzbeschreibung von sich hinterlassen. Schön wäre, wenn man bei verschiedenen Themen abschätzen könnte, wer hier welche Kenntnisse besitzt. Automatische Übersichtsseite dazu: [[Benutzer]]. Tagging würde das Ganze auch noch vereinfachen. +* **Howtos/Xy**: Hier sollten Anleitungen zu allen Gerätschaften hineinkommen. Momentan sind aber solche Beschreibungen teilweise noch beim Equipment zu finden. Das sollte einheitlicher gestaltet werden. Sinnvoll wäre auch eine Trennung in "Anleitung für xy" und "Reparaturanleitung für xy", wenn es denn nötig sein sollte. Automatische Übersichtsseite dazu: [[Howtos]]. +* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] +* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] +* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] +* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] + +### Ordner für die Wiki-Infrastruktur -##Ordner für die Wiki-Infrastruktur Von den eigentlichen Inhaltsseiten sind alle Seiten zu trennen, die das Drumherum ums Wiki ermöglichen. -* **tags/Xy**: Bisher werden nur sehr wenige Tags verwendet. Allerdings zeigen sie teilweise auf verschiedene Unterordner. Laut der Hilfeseite [[ikiwiki/directive/tag]] sollte aber ein Unterordner tags/ im Urverzeichnis verwendet werden, damit die sog, tagbases verwendet werden können. Sinnvolle Tags sind z.B. Fähigkeitsbeschreibungen oder Stichworte. Später lassen sich dann sogar Tag-Wolken darstellen. Automatische Übersichtsseite dazu: [[tags]]. -* **ikiwiki/Xy**: Hier sind alle Erläuterungen (auf englisch) zum Wiki zu finden. Leider sind diese manchmal nicht ganz eindeutig oder nicht ganz einfach zu verstehen. Ausserdem interessiert uns ja eigenltich nicht so sehr, was ikiwi kann, sondern, was in unserem Wiki sinnvoll ist. Daher möchte ich vorschlagen, zwar den ikiwiki-Ordner beizubehalten, aber alle für uns relevanen Wiki-Infos in ein eigenes Verzeichnis zu packen. Dann ist es auch sehr einfach das ganze zu filtern. Siehe auch die automatische Übersichtsseite dazu: [[ikiwiki]]. -* **Wiki/Xy**: Hier sollten alle Infos zum Wiki hineinkommen, die von den Standard-Seiten im ikiwiki-Ordner abweichen oder diese genauer erklären und die für unsere Verhältnisse angepassten Informationen enthalten. Automatische Übersichtsseite dazu: [[Wiki]]. -* **Discussion/Xy**: Auf der Wikipedia gibt es zu jeder Seite eine sog. Diskussionsseite. Es soll getrennt werden können zwischen der Informationsdarstellung (=die eigentliche Artikelseite) und der kontroversen Diskussion über Genauigkeit, Richtigkeit, Quellentreue, Relevanz usw. In unserem Wiki gibt es bisher noch gar keine Diskussionsseiten. ikiwiki sieht dies aber im Unterordner Discussion bereits vor. Automatische Übersichtsseite dazu: [[Discussion]] -* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] -* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] +* **tags/Xy**: Bisher werden nur sehr wenige Tags verwendet. Allerdings zeigen sie teilweise auf verschiedene Unterordner. Laut der Hilfeseite [[ikiwiki/directive/tag]] sollte aber ein Unterordner tags/ im Urverzeichnis verwendet werden, damit die sog, tagbases verwendet werden können. Sinnvolle Tags sind z.B. Fähigkeitsbeschreibungen oder Stichworte. Später lassen sich dann sogar Tag-Wolken darstellen. Automatische Übersichtsseite dazu: [[tags]]. +* **ikiwiki/Xy**: Hier sind alle Erläuterungen (auf englisch) zum Wiki zu finden. Leider sind diese manchmal nicht ganz eindeutig oder nicht ganz einfach zu verstehen. Ausserdem interessiert uns ja eigenltich nicht so sehr, was ikiwi kann, sondern, was in unserem Wiki sinnvoll ist. Daher möchte ich vorschlagen, zwar den ikiwiki-Ordner beizubehalten, aber alle für uns relevanen Wiki-Infos in ein eigenes Verzeichnis zu packen. Dann ist es auch sehr einfach das ganze zu filtern. Siehe auch die automatische Übersichtsseite dazu: [[ikiwiki]]. +* **Wiki/Xy**: Hier sollten alle Infos zum Wiki hineinkommen, die von den Standard-Seiten im ikiwiki-Ordner abweichen oder diese genauer erklären und die für unsere Verhältnisse angepassten Informationen enthalten. Automatische Übersichtsseite dazu: [[Wiki]]. +* **Discussion/Xy**: Auf der Wikipedia gibt es zu jeder Seite eine sog. Diskussionsseite. Es soll getrennt werden können zwischen der Informationsdarstellung (=die eigentliche Artikelseite) und der kontroversen Diskussion über Genauigkeit, Richtigkeit, Quellentreue, Relevanz usw. In unserem Wiki gibt es bisher noch gar keine Diskussionsseiten. ikiwiki sieht dies aber im Unterordner Discussion bereits vor. Automatische Übersichtsseite dazu: [[Discussion]] +* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] +* **/Xy**: Automatische Übersichtsseite dazu: [[ ]] ... stay tuned ... mehr kommt bald... diff --git a/Wiki/Tipps_und_Tricks_zum_Wiki.mdwn b/Wiki/Tipps_und_Tricks_zum_Wiki.mdwn index ee2b642d..f3d76621 100644 --- a/Wiki/Tipps_und_Tricks_zum_Wiki.mdwn +++ b/Wiki/Tipps_und_Tricks_zum_Wiki.mdwn @@ -1,23 +1,26 @@ Hier wird eine lose, zusammenhanglose Auflistung von verschiedenen Tipps rund ums Wiki aufgeführt. Es soll quasi als Nachschlagewerk bzw. Schnellübersicht dienen. -[[!toc levels=2]] +[[!toc startlevel=2 levels=2]] + +## Gibt es keinen Robot für das Wiki? -##Gibt es keinen Robot für das Wiki? Noch nicht :) Wer einen für ikiwiki kennt, bitte sofort mitteilen. Dann kann man sich den ja auf unsere Verhältnisse zusammenstutzen. -Da es aber in jedem Wiki ab einer Größe von mehreren Hundert Seiten auch (langweilige und langwierige) Routineaufgaben gibt, wäre ein Robot eine gute Idee. Für Mediawiki gibt es bereits zahlreiche Robots. +Da es aber in jedem Wiki ab einer Größe von mehreren Hundert Seiten auch (langweilige und langwierige) Routineaufgaben gibt, wäre ein Robot eine gute Idee. Für Mediawiki gibt es bereits zahlreiche Robots. Standardaufgaben, bei denen ein Robot sinnvolle Unterstützung liefern kann sind z.B. automatisches Tagging, Rechtschreibkontrolle, Kategorisierung, automatische Verlinkung von Schlagworten mit vorhandenen Seiten, Ändern/Vereinheitlichung der Formatierung (z.B. bei Listboxen etc.), automatisisiert Gendermainstreaming betreiben, also "man" durch "man/frau" ersetzen, usw. Oft macht der Roboteinsatz allerdings nur interaktiv Sinn. Es ist aber viel einfacher "J" und "N" zu tippen, als die Änderungen von Hand durchzuführen ;) Ausserdem Hand aufs Herz: Wir sind doch ein Makerspace! Da *muss* doch alleine schon aus Geek-Gründen ein Robot her, oder? -##Das Hochladen von Bildern funktioniert nicht -Das geht bei mir auch nicht. Ich habe es mit SVG, PNG, JPG und einer ZIP-Datei probiert. Da müssen wir wohl warten, bis unser IT-Spezialist Zeit und Musse hat, das zur reparieren. +## Das Hochladen von Bildern funktioniert nicht + +Das geht bei mir auch nicht. Ich habe es mit SVG, PNG, JPG und einer ZIP-Datei probiert. Da müssen wir wohl warten, bis unser IT-Spezialist Zeit und Musse hat, das zur reparieren. Und ich rede nicht von der "failed!"-Meldung, es funktioniert auch nicht, wenn man alle Schritte aus der Beschreibung [[Howtos/bilder-ins-wiki]] befolgt. -##Auflistung zählt falsch +## Auflistung zählt falsch + Nein, das Wiki zählt richtig. Deine Markup-Formatierung ist falsch. Wenn eine Zahl von einem Punkt gefolgt wird, führt dies (egal welche Zahl dasteht !) zu einer nummerierten Auflistung (ordered list). Will man das nicht, z.B. wenn 3. auf 1. folgen soll, dann muss man den Punkt "escapen", also einen Backslash davor setzen. @@ -34,17 +37,20 @@ Oder mit Backslash escapet (dann muss aber ein Absatz durch HTML
erzwunge 3\. man keine aufsteigende
29\. Nummerierung
-##Warum führen aller Verlinkungen auf die englische Wikipedia? +## Warum führen aller Verlinkungen auf die englische Wikipedia? + Die Direktive \[[!wikipedia xyz]] führt auf die englische Wikipedia (siehe [[shortcuts]]). Für die deutsche Wikipedia habe ich \[[!wikipediade xyz]] erstellt. Wenn wir einen Robot haben, dann kann man das gerne irgendwann mal global ändern, natürlich mit automatischer Anpassung des Artikelnamens... -##Das Inhaltsverzeichnis ist falsch +## Das Inhaltsverzeichnis ist falsch + Mit \[[!toc]] wird in der Preview das vollständige Inhaltsverzeichnis angezeigt. Irgendwo in der Konfig ist aber wohl eingestellt, dass nach dem Abspeichern nur noch Level 1 dargestellt wird. Abhilfe schafft Angabe von Parameteren z.B. \[[!toc levels=2]]. -##Addons auf Vorhandensein überprüfen +## Addons auf Vorhandensein überprüfen + Bei den Helpfiles zu den Dirktiven fehlt noch die automatische Feststellung, ob das Plugin überhaupt aktiviert ist. Das sollte bei jedem Helptext oben ergänzt werden und wäre auch eine gute Idee, direkt bei ikiwiki als Verbesserungsvorschlag beizusteuern. \[[!if test="enabled(Name_der_Direktive)" @@ -53,8 +59,10 @@ Bei den Helpfiles zu den Dirktiven fehlt noch die automatische Feststellung, ob Vielleicht bastel ich auch noch ein template daraus. Mal sehen. -##Das Wiki zeigt bestimmte Direktiven in der Vorschau nicht an +## Das Wiki zeigt bestimmte Direktiven in der Vorschau nicht an + Nur in der Vorschau (Preview). Entweder ist das ein Bug im ikiwiki oder die Seitencompilation ist in der Vorschau überfordert. Wenn die Seite gespeichert wird, dann wird die Direktive auch angezeigt. Ist halt etwas blöd zum Testen. -##Der Sidebar-Plugin funktioniert nicht +## Der Sidebar-Plugin funktioniert nicht + Da bin ich selbst noch am knobeln. Aber das ist Prio -20 auf meiner endlosen Todo-Liste :-) Wer sich hier auskennt, darf gerne eine Beispielsseite erstellen, die hier funktioniert. -- cgit v1.2.1