Open Source Dokumentenmanagement
Dokumentation
Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht
Navigation: Dokumentationen agorum core
Dokumentation verwenden
Durch die Dokumentation navigieren
Auf der linken Seite der Dokumentation steht Ihnen ein Inhaltsverzeichnis in Form einer Baumstruktur zur Verfügung. Klicken Sie mit der linken Maustaste auf eine Dokumentation, um sie zu öffnen, oder klicken Sie auf einen der Pfeile, um die Baumstruktur zu erweitern.
Im oberen Bereich können Sie zudem die agorum core-Version wählen, mit der Sie aktuell arbeiten, und sich die dazugehörige Dokumentation anzeigen lassen. Sofern eine Dokumentation in verschiedenen Sprachen zur Verfügung steht, können Sie auch diese im oberen Bereich wählen.
Symbole in der Baumstruktur
Links in der Baumstruktur des Dokumentationssystems befinden sich verschiedene Symbole mit unterschiedlicher Bedeutung:
Repräsentiert ein eigenständiges Dokument innerhalb der Dokumentation.
Repräsentiert eine Überschrift innerhalb eines Dokuments.
Repräsentiert ein eigenständiges Kapitel. Ein Kapitel können Sie an Kollegen und Kolleginnen weitergeben, damit diese sich die Dokumentation gezielt anschauen können.
Die Volltextsuche verwenden
Verwenden Sie die Volltextsuche links, um schneller zu einer Dokumentation zu gelangen.
- Das System durchsucht alle Dokumentationen zu Ihren gesuchten Begriffen.
- Das System zeigt nur diejenigen Dokumentationen als Treffer an, die zur gewählten Version und Sprache passen.
Tipp: Sind Sie Entwickler, Administrator oder ein IT-affiner Benutzer, können Sie anhand der Solr-Suchsyntax nicht nur nach einzelnen Begriffen suchen, sondern ODER-Funktionen, RegEx oder Verneinungen in die Suche aufnehmen.
Auf die Homepage von agorum zurückkehren
Haben Sie die Dokumentation über die agorum-Website geöffnet, können Sie jederzeit auf diese Website zurückkehren. Klicken Sie mit der linken Maustaste auf das agorum-Logo oben links auf der Seite Ihres Webbrowsers:
Die Hilfe zur Dokumentation aufrufen
Oben rechts befindet sich ein Hilfesymbol in Form eines Fragezeichens. Dieses Symbol öffnet die aktuelle Seite in einem neuen Fenster, sodass Sie sich an jeder Stelle im Dokumentationssystem über dessen Bedienung informieren können:
Die Verlaufszeile verwenden
Öffnen Sie ein Dokument, zeigt das System oberhalb des Inhalts eine Verlaufszeile an. Klicken Sie in der Verlaufszeile auf eine Dokumentation, um sie zu öffnen:
Dokumentationen weitergeben
Wenn Ihnen die Informationsflut innerhalb der Dokumentation zu groß ist oder Sie nur eine bestimmte Dokumentationsseite an Ihre Kollegen weiterreichen wollen, können Sie sich diese Dokumentation rechts oben neben dem Hilfesymbol über das Symbol 
gezielt anzeigen lassen, sie weitergeben und durchsuchen.
Wenn Sie in der ausgewählten Dokumentation die Suche links oben verwenden, durchsucht das System nur diese Auswahl. Die restlichen Dokumentationsseiten zeigt es in den Treffern nicht an.
Sie können außerdem den Link der aktuell geöffneten Dokumentation weitergeben, indem Sie oben rechts auf 
klicken und Öffentlichen Link kopieren (als URL) oder Öffentlichen Link kopieren (mit Titel) wählen und diesen Link an Ihre Kollegen oder Kolleginnen weiterreichen. Dieses Vorgehen funktioniert auch für einzelne Überschriften innerhalb einer Dokumentation. Klicken Sie also eine Überschrift links in der Baumstruktur an und kopieren Sie anschließend den Link, dann kopieren Sie in diesem Falle den Link zu dieser Überschrift, nicht zur gesamten Dokumentation.
Allgemeine Hinweise zur Dokumentation
Die Inhalte dieser Dokumentation werden sorgfältig recherchiert und geprüft. Dennoch übernehmen wir keine Gewähr für die Richtigkeit, Vollständigkeit und Aktualität der bereitgestellten Informationen. Fehler und Ungenauigkeiten können nicht vollständig ausgeschlossen werden. Jegliche Haftung für Schäden materieller oder immaterieller Art, die durch die Nutzung oder Nichtnutzung der dargebotenen Informationen bzw. durch die Nutzung fehlerhafter und unvollständiger Informationen unmittelbar oder mittelbar verursacht werden, ist ausgeschlossen.
Diese Dokumentation dient ausschließlich Informationszwecken und stellt keine rechtsverbindliche Auskunft dar. Produktansprüche können aus den Inhalten dieser Dokumentation nicht abgeleitet werden. Alle beschriebenen Vorgehensweisen und Code-Abschnitte müssen stets in einer geeigneten Testumgebung geprüft werden, bevor sie in einer Produktionsumgebung angewendet werden.
Wir behalten uns das Recht vor, die Inhalte dieser Dokumentation jederzeit und ohne vorherige Ankündigung zu ändern, zu ergänzen oder zu entfernen.
Alle in dieser Dokumentation erwähnten Marken- und Produktbezeichnungen sind eingetragene Marken oder sonstige Schutzrechte der jeweiligen Inhaber, auch wenn dies nicht explizit gekennzeichnet ist.
Bei Fragen oder Anmerkungen zu dieser Dokumentation wenden Sie sich bitte an dokumentation@agorum.com.