Arbeiten mit der PLANTA-Dokumentation (PLANTA-Wiki)
Allgemeines
Information
- PLANTA project-Dokumentation erfolgt ausschließlich online in Form eines Wiki. PLANTA verwendet hierfür die Dokumentations-Software TWiki
.
Aufbau des PLANTA-Wiki
Information
- Jedes Twiki-Wiki und somit auch das PLANTA-Wiki besteht aus Webs und Topics.
- Ein Web ist ein Gerüst (eine Website), das aus einzelnen Seiten (Topics) besteht.
- Topics sind Informationsträger. Ein Topic entspricht einer Seite im Web.
- PLANTA erstellt pro Release ein eigenes Web.
- Alle vorhandenen Webs sind in der Menüleiste links aufgelistet.
- In der Beschreibung des PLANTA-Wiki verwendet PLANTA außerdem 2 weitere Klassifizierungen: Themenbereiche und Kategorien.
- Themenbereiche und Kategorien sind zwar technisch gesehen ebenfalls Topics, doch dienen sie hauptsächlich der Strukturierung der Informationen im Web. In diesen Topics sind lediglich einleitende Information über den Inhalt und die Struktur der untergeordneten Objekte enthalten.
- Die PLANTA project-Dokumentation ist in 4 Themenbereiche eingeteilt: Allgemeine Dokumentation, Anwendungsdokumentation, Customizing-Dokumentation, Technische Dokumentation.
- Jeder dieser Themenbereiche enthält Kategorien, die wiederum einzelne Topics enthalten.
Beispiel
WikiWords
Eine Besonderheit von TWiki und somit des PLANTA-Wikis sind die sogenannten
WikiWords.
- Topic-Namen bestehen aus WikiWords, die der Benennung und Identifikation von Topics dienen.
- WikiWords haben ein festgelegtes Format, das CamelCase-Format. Dieses besteht aus zwei oder mehreren zusammengeschriebenen Wörter mit jeweils großgeschriebenen Anfangsbuchstaben.
- Topic-Überschriften sind frei gestaltbare Überschriften und können von den Topic-Namen abweichen.
- Da die Inhaltsverzeichnisse in den Themenbereichen und Kategorien automatisch aus den untergeordneten Topics generiert werden, werden hier die Topic-Namen und nicht die Überschriften angezeigt.
Inhalt
Information
- Wie bereits oben erwähnt, ist der gesamte Dokumentationsinhalt in einzelne Topics aufgeteilt. Der Aufbau von Topics ist sehr unterschiedlich. Folgende Arten gibt es:
- Modul-Topics
- Sie beinhalten Beschreibungen einzelner Module.
- Einem Modul im Programm enspricht eine Seite (ein Topic) im PLANTA-Wiki.
- Alle Modul-Topic-Namen enthalten die Modulbezeichnung und die Modulnummer mit der Abkürzung MOD davor.
- In den Inhaltsverzeichnissen sind sie alphabetisch sortiert.
- Datenfeld-Topics
- Sie beinhalten die Beschreibungen einzelner Datenfelder.
- In einem Datenfeld-Topic werden mehrere Datenfelder beschrieben. Alle in einem Datenfeld-Topic beschriebenen Datenfelder stammen aus einer Datentabelle. Aus diesem Grund werden die Datendeld-Topics nach der entsprechenden Datentabelle benannt.
- Der Name besteht aus der Abkürzung DT, der entsprechenden Datentabellen-Nummer und der Datentabellenbezeichnung.
- In den Inhaltsverzeichnissen sind die Datenfeld-Topics nach der Datentabellen-Nummer aufsteigend sortiert.
- FAQ-Topics
- Sie enthalten die Antworten auf häufig gestellte Fragen.
- Funktions-Topics
- Sie enthalten Beschreibungen einzelner, wichtiger Funktionen, z.B. AnordnungsBeziehungen.
- Die Beschreibungen kleinerer Funktionen sind oft nicht in eigenen Topics, sondern innerhalb von Modul-Topics zu finden.
- Workflow-Topics (Tutorials)
- Sie beinhalten workflow- und prozessbezogene Beschreibungen, die konkrete Anschauungsbeispiele, Arbeitsabläufe und Aufgaben beinhalten, wie z.B. der Projekt-Workflow.
- Sie können als Grundlage für Schulungen oder zum Selbststudium verwendet werden.
Details
- Zwischen den verschiedenen Topic-Arten findet eine Interaktion statt, d.h. sie sind miteinander verlinkt.
- Modul-Topics enthalten Links auf die in der Beschreibung erwähnten Datenfelder.
- In der Beschreibung von Datenfeldern gibt es wiederum Links auf die entsprechenden Module.
- In Funktions-Topics werden sowohl erwähnte Datenfelder als auch Module verlinkt.
Einstieg
Information
- Es bestehen mehrere Möglichkeiten, in das PLANTA-Wiki einzusteigen.
- Aus dem Programm heraus
- durch Betätigen der Taste F2 oder über den Menüpunkt ? Modulbeschreibung im gewünschten Modul wird die Beschreibung dieses Moduls aufgerufen
- durch Betätigen der Taste F1 im gewünschten Datenfeld oder über den Menüpunkt ? Datenfeldbeschreibung (das Datenfeld muss durch Betätigen mit der Maus fokussiert sein) wird die Beschreibung dieses Datenfeldes aufgerufen
- durch Betätigen der Tasten STRG+M oder über den Menüpunkt ? Handbuch öffnen. Die Startseite des PLANTA-Wiki wird geöffnet, von der aus über die Suchfunktion oder das Inhaltsverzeichnis zu den gewünschten Themen navigiert werden kann.
- Verwenden eine dieser 3 Möglichkeiten, wird automatisch das richtige Web (dem Web, das Ihrem Release entspricht) geöffnet.
- Aus dem Internet heraus über http://wiki.planta.de
- Nutzen Sie diese Möglichkeit, werden Sie automatisch auf die Dokumentation zu dem aktuellsten Release geleitet.
- Falls bei Ihnen nicht das aktuelle Release im Einsatz ist, wählen Sie bitte in der Menüleiste links unter der Überschrift Webs das richtige Release. Dadurch öffnet sich die Dokumentation zu diesem Release.
Details
- Der Pfad am oberen Rand eines Topics gibt Ihnen Auskunft darüber, auf welcher Struktur-Ebene sich das von Ihnen aufgerufene Topic befindet.
Startseite
Information
- Auf der Startseite finden Sie
- Links auf einige wichtige Topics
- den Überblick über die gesamte Dokumentationsstruktur (Inhaltsverzeichnis)
- Erläuterungen zu den 4 Themenbereichen der Dokumentation (die Links darauf führen Sie zu deren Kategorien und einzelnen Topics)
Navigation
Information
- In die Tiefe der Web-Struktur wird über das Inhaltsverzeichnis navigiert.
- In die umgekehrte Richtung navigiert man über den Topic-Namenpfad, der im Kopfteil jedes Topics erscheint.
- Möchte man zwischen zwei Objekten auf der gleichen Ebene navigieren, wechselt man zuerst in das übergeordnete Objekt und von da an zum gewünschten Objekt.
Suche
Information
- Suchmöglichkeiten
- Eingabefeld zum Topic
- Eingabefeld Suche
- Suche über das Inhaltsverzeichnis.
- Um einen Überblick über die Strukturierung der Inhalte im PLANTA-Wiki zu bekommen, empfiehlt es sich, die Einleitungskapitel der Themenbereiche und Kategorien durchzulesen.
Suche über Eingabefeld zum Topic
Informationen
- Dieses Feld wird genutzt, um die Topics nach ihren Namen zu durchsuchen.
- wenn man hier den genauen Namen (das WikiWord) des Topics, nach dem gesucht wird, eingibt, wird das gesuchte Topic direkt geöffnet.
- gibt man nur einen Teil des Namens ein, wird eine Liste mit Topics angeboten, die in ihren Namen den eingegebenen String enthalten. Durch Klick auf den Link mit dem Namen des gesuchten Topics springt man direkt zu diesem Topic.
Suche über Eingabefeld Suche
Informationen
- Dieses Feld wird benutzt, um den Inhalt der Topics zu durchsuchen.
- Gibt man im Feld den gewünschten String ein, wird eine Liste mit Topics angeboten, die in ihrem Inhalt den gesuchten String enthalten. In der Ergebnisliste werden unter dem Topic-Titel Textstellen angeführt, die den String enthalten. Der String selbst wird rot hervorgehoben.
- Klickt man den Link auf dem Topic-Titel, springt man direkt in das entsprechende Topic, jedoch nicht direkt zu der Stelle mit dem gesuchten String. Möchte man gezielt zu der Stelle gelangen, im geöffneten Topic mit Strg + F nach dem String zusätzlich suchen.
Details
- Bei Verwenden von Komposita (zusammengesetzte Wörter) bei der Suche soll beachtet werden, dass es unterschiedliche Schreibweisen zugelassen sind, so dass Ihre Schreibweise nicht unbedingt mit der Schreibweise bei PLANTA übereinstimmt. In diesem Fall empfiehlt es sich nur nach einem Teil des Kompositums zu suchen, was jedoch zu umfangreicheren Suchergebnissen führen kann.
- Bei Wörtern, die keine Umlaute enthalten, muss die Groß-und Kleinschreibung nicht beachtet werden, z.B. findet die Suche nach wechsel sowohl Wechsel als auch wechseln.
- Bei Umlauten muss sie dagegen eingehalten werden, z.B. findet die Suche nach änderungsantrag den Begriff Änderungsantrag nicht.
- Wird nicht nach einzelnen Begriffen gesucht, sondern z.B. nach Ausdrücken oder Wortkombinationen, müssen diese in Anführungsstriche genommen werden, z.B. "Ideen und Vorhaben" oder "Vorgang beenden".
- Gesucht wird nach exakt in dieser Reihenfolge und Form eingegebenen Textstring.
- Falls das Suchergebnis zu umfangreich ist, kann die Suche auf den Topic-Titel eingeschränkt werden, indem die Checkbox Topic-Titel aktiviert wird.
- Ist die gesuchte Information nicht dabei oder soll die Suche eingeschränkt werden, kann über den Link Advanced search unter der Ergebnisliste zu der erweiterten Suche gewechselt werden.
Suche über das Inhaltsverzeichnis
nach Beschreibungen von Funktionen
Vorgehensweise
Hinweis
- Bitte beachten Sie, dass kleinere Funktionen nicht in eigenen Topics (Seiten), sondern innerhalb von Modul-Topics beschrieben sind. Falls Sie die von Ihnen gesuchte Funktion nicht im Inhaltsverzeichnis finden, suchen Sie bitte nach möglichen Begriffen oder evtl. nach möglichen Modulen.
nach Modulbeschreibungen
Vorgehensweise
- wie im Einstieg beschrieben über die F2-Taste aus dem gewünschten Modul oder
- über das Inhaltsverzeichnis auf der Startseite der Dokumentation
nach Datenfeld-Beschreibungen
Vorgehensweise
- wie im Einstieg beschrieben über die F1-Taste aus dem gewünschten Datenfeld (Datenfeld muss durch Betätigen mit der Maus fokussiert sein) oder
- über das Inhaltsverzeichnis auf der Startseite der Dokumentation
Lesen und Bearbeiten
Information
- Jeder Benutzer hat ohne Weiteres den Lesezugriff auf das komplette Wiki.
- Die Bearbeitung ist zurzeit nur den PLANTA-Mitarbeitern gestattet.
Wiki in Word
Information
- Die folgende Vorgehensweise ermöglicht das Kopieren eines Wiki-Topics nach Word sowie dessen eventuelle Weiterbearbeitung.
Vorgehensweise
- In Google Chrome das gewünschte Wiki-Topic über den Kontextmenü-Befehl Speichern unter speichern.
- Die gespeicherte Datei nun in Word öffnen.
- Das Dokument als .docx speichern.
- Ein leeres Word-Dokument öffnen.
- Den Inhalt des .docx-Dokument via Copy&Paste in das leere Dokument einfügen.
- Die Tabellen rechts und links löschen.
- Die Schriftart im ganzen Dokument auf Arial ändern.
png 
