Aufbau von Bookstack

Auf dieser Seite geht es um den Aufbau von Bookstack, da sich hieraus das Speichern und Auffinden der Inhalte ergibt. Begonnen wird mit der größten Einheit, einem Regal und geht bis zur kleinsten Einheit einer Seite. Letztlich ist Bookstack wie eine digitale Bibliothek aufgebaut.

Regale

Die Regale repräsentieren die Bücherregale einer Bibliothek. Mit diesem werden verschiedene Bücher logisch zusammengefasst und geordnet. Jedoch hat Bookstack eine Besonderheit, denn ein Buch kann nicht nur in einem Regal stehen, sondern in mehreren Regalen. So können beispielsweise Bücher mit Grundlagenwissen zu SQL sowohl in dem Regal IT-Basiswissen sowie in Datenbanken stehen. Dadurch wird das Auffinden der passenden Bücher einfacher, wenn ein Benutzer gerne in den Regalen stöbert, um z. B. etwas über Datenbanken zu erfahren ohne konkret nach SQL zu suchen. Zusätzlich können Regale noch mit Tags versehen werden, wodurch auch bei vielen Regalen die passenden gut auffindbar sind. Jedes Regal hat eine Beschreibung, um den Benutzern kurz die zu erwartenden Inhalte zu erklären.

Bücher

Ein Buch ist die neben einer Seite die wichtigste Einheit in Bookstack. Es hält letztlich die Informationen zusammen, die zusammen gehören. Ein Buch kann in keinem, einem oder mehreren Regalen stehen. Wobei versucht werden sollte, ein Buch wenigstens einem Regal zuzuordnen, um die Informationen auch den Benutzern zugänglich zu machen, die ggf. nur über die Regale arbeiten. Zusätzlich kann ein Buch auch ein oder mehrere Tags erhalten, wodurch ein Benutzer auch gezielt nach passenden Inhalten suchen kann ohne die Regale zu berücksichtigen. Jedes Buch hat eine Beschreibung, um den Benutzern kurz die zu erwartenden Inhalte zu erklären.

Kapitel

Kapitel sind wie Regale optional und müssen nicht verwendet werden. Es kann dabei helfen, wenn ein Buch viele Seiten enthält, diese besser zu strukturieren. Auch Kapitel können wieder mit Tags versehen werden, sodass diese auch unabhängig von den Büchern gefunden zu werden. Ein Kapitel verfügt ebenfalls über eine Beschreibung, um wieder kurz den Inhalt zu erläutern.

Seiten

Dies ist die kleinste Einheit, die letztlich die Informationen beinhaltet. Der Anfangstext der Seite wird im Kapitelverzeichnis mit angezeigt. Jede Seite kann wieder mit Tags versehen werden, um auch die Seiten unabhängig von den Büchern/Kapiteln wiederfinden zu können. Eine Seite kann völlig frei aufgebaut werden, Überschriften, Abschnitte, farbliche Hervorhebungen, Codeabschnitte, Tabellen, Grafiken, Medien, usw.

Tags

An dieser Stelle werden nochmals kurz die Tags aufgenommen, da diese bei allen Einheiten zum Einsatz kommen. Wird nach einem Tag gesucht, der sowohl bei einem Buch, bei einem Kapitel und einer Seite gesetzt ist, so werden alle Einheiten angezeigt. So lassen sich Informationen unabhängig von den Strukturen finden. Gleichzeitig sollte also vor allem bei Regalen oder Büchern (sofern diese einen großen Umfang haben) vorsichtig mit den Tags umgegangen werden. Denn Wenn jedem Regal alle Tags der Bücher zugewiesen werden, taucht bei jedem Tag auch das Regal auf, obwohl der Benutzer eigentlich die Bücher/Kapitel/Seiten gezielt ansteuern möchte. So wird die Suche ggf. unnötig komplex, da der Benutzer die Regale extra ausblenden muss.