HowTo Wiki

Ein kleiner Überblick zum Lesen, Schreiben und zurechtfinden in diesem Wiki. Dieses Wiki basiert auf der Software namens Bookstack. Die Sortierung ist angelehnt an der Idee von Büchern.

Bücher und Regale: Was ist hier was?

Es gibt Bücherregale ("shelves"), Bücher ("Books"), optionale Kapitel ("Chapter") und Seiten ("Pages").

Bücherregale: Sind eine Art Linksammlung zu Büchern. Bücher können auf mehreren Regalen oder auf keinem Regal einsortiert sein. Sie sollten idealerweise aber mindestens auf einem Regal zu finden sein.
Bücher sind quasi Ordner bzw. Kategorien, in denen Inhalte (Seiten) erstellt werden können.
Kapitel innerhalb von Büchern können, müssen aber nicht verwendet werden. Sie bilden eine weitere Verschachtelungsebene und stellen Unterordner oder Unterkategorien dar. Sie können bei sehr umfangreichen Büchern mit vielen Inhalten (Seiten) verwendet werden. Bei sehr komplexen Themen kann es aber auch sinnvoll sein stattdessen einfach mehrere thematische Bücher zu erstellen und diese Bücher dann auf einem eigenen Regal zusammenzufassen.
Auf Seiten sind die eigentlichen Inhalte zu finden.

Einzelne Seiten ohne Zuordnung gibt es in diesem Wiki nicht, d.h. es ist nicht möglich eine Seite direkt in einem Bücherregal zu erstellen. Seiten stehen immer in Büchern, Bücher stehen auf Regalen.

Im Wiki navigieren und Zurechtfinden

Im Hauptmenü kannst du über Regale/Shelves zu thematisch sortierten Büchern finden, oder durch Klick auf Bücher/Books direkt eine Liste aller Bücher bekommen.

Des weiteren kannst du im Menü über LightMode und DarkMode die Farbdarstellung wechseln. Im Mobilen Menü findest du die Option auf der Startsteite (oben links auf unser Logo klicken), dann unter Info > Actions.

Mobilen Ansicht: Die Option LightMode/DarkMode ist im Menü leider nur(!) auf der Startseite zu finden.

Die wichtigsten Bücherregale

... ohne Anspruch auf Vollständigkeit, da das Wiki ständig wächst und lebt:

Über die Haecksen: Hier findest du allgemeine Infos über die Haecksen. Die meisten davon sind vollständig öffentlich lesbar und auch und vor allem für NeuHaecksen lesenswert. Auch eine kleine Chronik ist dort unter "Vergangenes" zu finden.
Haecksen-Internes: Hier findest du Plenumsprotokolle und andere wichtige Informationen oder Dokumentationen. Diese Inhalte sind nur sichtbar wenn du mit eingeloggt bist.
HowTo's: Eine Sammlung verschiedener Anleitungenzu verschiedenen Themen inkl. dieser Seite hier.

Haecksen-Interne Inhalte, wie z.B. Plenumsprotokolle, sind nur sichtbar wenn du eingeloggt bist!

Wie bekomme ich einen Wiki-Account?

Aktuell legen wir Accounts manuell an. Das wird sich ändern, sobald wir ein Haecksen-SSO haben werden. Bis dahin: Schreibe am besten in den #Wiki oder #adminfoo Channel in unserem Rocket-Chat, dass du dir einen Account wünschst.

Account-Einstellungen

Die Sprache ist standardmässig auf Englisch gesetzt. Falls du damit nicht gut zurecht kommst kannst du die Sprache in deinen Accountsettings anpassen, sowie dein Passwort ändern oder ein Profilbild hochladen. Es gibt keine persönlichen Links oder Infos auf Nutzer*innenprofilseiten, d.h. du findest dort nur ein paar Statistikinfos zu der Nutzer*in.

Sprache anpassen: Klicke auf deinen Accountnamen oben rechts, dann "Edit Profile" und unter "Preferred Language" kannst du dann Deutsch oder eine andere Sprache auswählen.

Wie erstelle oder editiere ich Inhalte?

Inhalte können natürlich nur erstellt oder editiert werden wenn du eingeloggt bist und für den entsprechenden Bereich auch die nötigen Rechte hast. Mehr zu Berechtigungen im Abschnitt Permissions.

Die nachfolgende Beschreibung ist mit Screenshots im DarkMode aufgeommen und mit englischer Spracheinstellung erstellt worden.

Do's und Don'ts

Du musst nicht den ganzen Text auf dieser Seite durchlesen, aber es wäre schön wenn du einmal durchscrollen würdest und die Infoboxen und Warnhinweise hier im Wiki beachtest beim bearbeiten von Inhalten.

Regale erstellen, bearbeiten, löschen

Neue Regale solltest du nur anlegen, wenn es wirklich nötig ist und deine Inhalte nirgendwo anders hinein passen. Die Ansicht der Regale ist die wichtigste und sollte möglichst übersichtlich bleiben. Im Zweifelsfall kannst du im #adminfoo oder #Wiki Channel im Rocketchat bei uns nachfragen.

Um ein neues Regal zu erstellen wählst du im Menü zuerst Regale/Shelves aus und dann rechts "+ New Shelve". Um ein existierendes Regal zu editieren klickst du das Regal an und am rechten Rand auf "Edit".

Als nächstes gibst du einen Regalnamen an sowie eine Kurzbeschreibung was hier zu finden ist.
Du kannst auch bereits existierende Bücher diesem Regal hinzufügen. Die Bücher verbleiben weiterhin auf anderen Regalen auf denen sie bereits einsortiert wurden. Um ein Buch von einem Regal wieder zu entfernen kann es per Drag&Drop einfach wieder zurück nach rechts zu "Add books to this shelf" verschoben werden.
Du kannst und solltest auch ein Coverimage für das Regal erstellen und hochladen. Das macht das Navigieren im Wiki sowohl hübscher als auch übersichtlicher.
"Tags" verwenden wir im Moment nicht.
Wenn das Regal öffentlich sichtbar sein soll musst du nichts weiter tun. Falls es nur intern sichtbar sein soll, dann lies den Abschnitt zu Permissions.
Ein Bücherregal kann gelöscht werden mit "Delete". Die sich darauf befindenden Bücher werden nicht gelöscht. Bitte sortiere die verbleibenden Bücher anschließend auf andere Bücherregale ein.

Bitte erstelle immer ein aussagekräftiges Coverimage für Regale!

Reihenfolge der angezeigten Bücher auf dem Regal bearbeiten/sortieren

Die Reihenfolge der Bücher, die auf einem Regal stehen, ist nicht alphabetisch sortiert sondern ist einstellbar. Um die Reihenfolge zu ändern können die Bücher einfach per Drag+Drop auf der linken Seite verschoben werden.

Bücher erstellen, bearbeiten, löschen

Neue Bücher anlegen oder editieren

Neue Bücher können unter Bücher ("+ Create New Book") oder besser direkt innerhalb eines Regals ("+ New Book") neu erstellt werden. Wenn du ein Buch direkt über "Books" erstellst, dann achte bitte darauf es später mindestem einem Regal hinzuzufügen. Wenn du ein Buch innerhalb eines Regals erstellst wird es automatisch (am Ende des Regals) hinzugefügt. Die Reihenfolge der Bücher auf einem Regal kannst du in den Regaleigenschaften editieren.

Bitte achte bei der Erstellung von Büchern darauf, dass du sie mindestens einem Bücherregal zuordnest! Das passiert nicht automatisch!

Das Menü sieht ähnlich aus wie bei den Regalen. Du kannst einen aussagekräftigen Buchnamen sowie eine Kurzbeschreibung angeben. Ausserdem wäre es gut wenn du ein Buchcover erstellen würdest. Hierzu kannst du unsere Vorlagen verwenden, siehe Abschnitt Coverimage. Im Moment verwenden wir "Tags" nicht.

Bücher bearbeiten, Kapitel oder Seiten hinzufügen, Buch löschen

Um ein existierendes Buch zu editieren wählst du zuerst das Buch aus und klickst dann rechts im Menü auf "Edit". In diesem Menü kannst du auch direkt neue Seiten oder Kapitel für dieses Buch erstellen.

Klick auf Edit: Hier kannst du den Buchnamen, Kurzbeschreibung sowie Coverbild ändern.
Um Kapitel oder Seiten zu editieren musst du zuerst das Kapitel oder die Seite auswählen und dann dort auf "Edit". Das sind keine Bucheigenschaften.
Um ein Buch und all dessen Inhalte (Kapitel und Seiten) vollständig zu löschen, klicke auf "Delete". Um einzelne Inhalte zu erhalten müssen diese zuerst wo andershin verschoben werden.

Buchinhalte (Kapitel und Seiten) sortieren

Die Reihenfolge der Buchinhalte ist nicht automatisch alphabetisch oder anderweitig sortiert, sondern kann verändert werden. Klicke hierzu zuerst das Buch an und dann rechts im Menü auf "Sort".

Hier hast du wieder ein Drag+Drop Menü auf der linken Seite:

Du kannst Seiten in Kapitel reinschieben oder herausholen,
sowie die Reihenfolge von Kapiteln oder Seiten verschieben.

Ausserdem kannst du Inhalte auch mit den entsprechenden Buttons automatisch sortieren lassen:

Buch auf ein anderes Regal verschieben

Soll ein Buch von einem Regal auf ein anderes "verschoben" werden, muss es dem neuen Regal hinzugefügt und vom alten Regal entfernt werden. Das sind zwei unabhänige Arbeitsschritte. Das sind Regaleigenschaften und keine Bucheigenschaften!

Kapitel erstellen, bearbeiten, löschen, verschieben

Innerhalb von Büchern können Kapitel erstellt, bearbeitet oder gelöscht werden. Wähle hierzu das entsprechende Buch oder Kapitel aus und klicke dann auf "+ New Chapter" im Buch oder auf "Edit" im Kapitel. Genau wie Seiten können Kapitel auch woanders hin verschoben werden mit Klick auf "Move" im Menü rechts.

Seiten erstellen, bearbeiten, löschen, verschieben

Seiten können nur in Büchern erstellt werden, nicht in Regalen. Wähle ein existierendes Buch aus oder lege ein neues an um dort eine Seite zu erstellen. Klicke im ausgewählten Buch rechts auf "+ New Page".

Du bekommst dann einen WYSIWYG Editor angezeigt. Ganz oben trägst du den Seitennamen ein, der im Buch angezeigt werden soll. Die Oberfläche ist relativ selbsterklärend. Es gibt jedoch ein paar Kleinigkeiten zu beachten die unten beschrieben sind.

Um eine existierende Seite zu bearbeiten oder zu löschen klickst du die Seite an und dann auf "Edit" oder "Delete" rechts im Menü. Seiten können auch in andere Bücher verschoben werden mit "Move". Ausserdem kannst du dir die Bearbeitungshistorie über "Revisions" anzeigen lassen.

Header für Überschriften verwenden

Bitte verwende für Überschriften immer die Vorlagen unter Format > Header Large/Medium/Small/Tiny entsprechend der Hierarchie. Daraus wird später das Inhaltsverzeichnis erstellt, das in der Leseansicht auf der linken Seite zu sehen ist. Wenn du einfach nur die Schriftgrößen per Hand änderst, dann erscheinen die Überschriften später nicht im Inhaltsverzeichnis der Seite.

Relative Pfade für Wiki-interne Links verwenden

Wenn du auf andere Inhalte im Wiki verlinken möchtest, dann kannst du den Text auswählen und auf das Linksymbol (Kettensymbol) klicken. Dort kannst du über die Suchfuktion die entsprechende Seite im Wiki finden und auswählen. Leider erzeugt Bookstack jedoch einen absoluten Pfad. Absolute Pfade beinhalten den Domainnamen am Anfang des Pfades und beginnen mit https://

Bitte verlinke auf andere Seiten in diesem Wiki immer nur mit relativen Pfaden!

Beispiel: Der relative Pfad zu dieser "HowTo Wiki" Seite lautet, /books/sonstige-howtos/page/howto-wiki , der Pfad zum Buch in dem sich diese Seite befindet lautet /books/sonstige-howtos und ein Link auf das Bücherregal "HowTo" wäre mit /shelves/how-tos richtig angegeben.

Warum relative Pfade? Ein Domainumzug wüde alle Links mit absolutem Pfad ungültig machen. Zum Zeitpunkt der Erstellung dieser Anleitung wird sich die Wiki Subdomain wahrscheinlich bald ändern.

Bilder, Videos und andere Anhänge einfügen

ToDo: Beschreibung folgt bald :-)

Permissions/Berechtigungen für öffentliche oder interne Bereiche setzen

Berechtigungen können für Regale, Bücher, Kapitel und Seiten sehr flexibel und einzeln eingerichtet werden. Wenn bei neuen Inhalten nichts weiter verändert wird sind die Inhalte alle öffentlich lesbar. Das Permissions-Menü eines öffentlichen Bücherregales sieht dann z.B. so aus.

Für öffentliche Inhalte ist der Haken bei "Enable Custom Permissions" nicht gesetzt.

Soll eine Seite nur intern für Haecksen sichtbar sein muss der Haken bei "Enable Custom Permissions" gesetzt werden. Nachfolgend klappt ein Menü auf, dort muss dann die Usergroup "Haeckse" alle Rechte bekommen, die Usergroups "Public" und "Viewer" gehen jedoch leer aus.

Interner Bereich: "Enable Custom Permissions": Nur Usergroup "Haeckse" erhält Berechtigungen.

Sobald die Maus sich auf eine Zeile bewegt wird diese gehighlighted und eine zusätzliche Funktion "Toggle All" erscheint. Ein Klick hierauf setzt oder löscht alle Berechtigungen für diese Nutzer*innengruppe.

Keine automatische Vererbung von Berechtigungen bei Regalen

Wenn neue Bücher in "versteckten" Regalen erstellt werden, sind sie per Default öffentlich zugänglich. Zugriffsberechtigungen werden nicht automatisch von Regalen auf Bücher vererbt!

Es gibt zwei Möglichkeiten:

Berechtigungen des neuen Buches manuell anpassen und setzen.
Nach dem Erstellen des neuen Buches kannst du das übergeordnete Regal ausgewählen und dann bei Permissions auf "Copy Permissions to Books" klicken. Dann werden allen Büchern in diesem Regal die gleichen Berechtigungen einmalig(!) vererbt. Diese Funktion solltest du natürlich nur verwenden, wenn du dir sicher bist dass alle Bücher gleiche Berechtigungen haben sollen. Wenn nach dem Vorgang weitere neue Bücher auf dem Regal erstellt werden, dann muss der "Copy Permissions" Vorgang wiederholt werden.
Sollte das neue Buch zusätzlich auch auf anderen Regalen einsortiert sein, dann hat es dort natürlich auch nicht automatisch die gleichen Berechtigungen des Regales, sondern die, die du zuvor gesetzt hast!

Weitere Berechtigungsgruppen

... können von Admins bei Bedarf angelegt werden. Das ist z.B. nützlich für Arbeitsgruppen zu bestimmten Themen und wenn Inhalte im Wiki dokumentiert werden sollen z.B. mit sensiblen Inhalten, die entweder nicht sichtbar für alle Haecksen, oder z.B. nur lesbar aber nicht editierbar sein sollen.

Ausserdem ist es möglich auch externen Wesen einen Account zu geben, aber ohne Zugang zu Haecksen-internen Bereichen aber dafür zu Projektbezogene Inhalten. Ein Beispiel wäre die Zusammenarbeit mit anderen Hackspaces bei Events.

Cover Images für Bücher und Regale

Wir wollen gerne eine übersichtliche und einheitliche Menüführung beibehalten. Deshalb wäre es gut, wenn alle Bücherregale mit einer ähnlichen Farb- und Style-Gestaltung Coverimages erhalten und Bücher einen anderen Style bekommen. Damit sind Bücher von Regalen besser zu unterscheiden.

Regale sollen alle ein Coverimage in einem ähnlichen Style tragen. Die Images werden vom Wiki-Team bei Bedarf erstellt.
Bücher müssen nicht zwingend Coverimages haben, sieht aber besser aus. Ein Style der sich von Regalen abhebt wäre vorteilhaft.

Wir arbeiten daran Graphik-Vorlagen zu erstellen. Weitere Infos folgenden bald hier an dieser Stelle.

Wenn ihr Schwierigkeiten damit habt ein passendes Cover für euer neues Wiki-Buch zu zaubern, dann hilft euch vielleicht jemand im #Wiki Channel in unserem Rocketchat weiter.