ProDocWiki¶

Das Programm "ProDoc"¶

ProDoc ist ein Programm zur Erstellung von Dokumentationen für beliebige Projekte, wie zum Beispiel von Schaltanlagen oder komplexen Installationen mit dokumentationspflichtigen Elementen.
Das Programm unterstützt die Erstellung dieser Dokumentation in Form von HTML-Stukturen zum digitalen Veröffentlichen, als auch in der Papiervariante. Dabei können unabhängig von der Sprache der Installation, Dokumentationen in beliebige Sprachen erstellt werden. Dabei werden außschließlich Dokumentationen in PDF-Form verarbeitet.

Wichtiger Hinweis zu Urheberrechten¶

ProDoc verarbeitet PDF-Dokumente für den Druck, in dem es die PDF-Dokumente seitenweise als Bilder erstellt, die beim Druck in verkleinerter Form (ca. 98%) ausgegeben werden. Das entspricht einem Kopiervorgang eines Papierdokuments mit 98% Verkleinerung. Ebenso muss bei der Ausgabe in HTML-Form berücksichtigt werden, dass dadurch die originalen Dokumentation kopiert werden.

Der Benutzer des Programms hat sicher zu stellen, dass die durch die Verarbeitung des Programm keine Rechte der Urheber verletzt werden.

Die Firma MCS - Marx Computerservice übernimmt keinerlei Haftung für Urheberrechtsverletzungen durch die Verwendung des Programms.

Installation¶

Das Programm wird als Installationsprogramm in Form einer setup.exe ausgeliefert. Starten Sie diese mit Doppelklick und folgen Sie den Anweisungen.
Nach der Installation sind zunächst ein paar Einstellungen für die Arbeit mit dem Programm zu tätigen.

Begriffe¶

Projekt¶

Ein Projekt ist die organisatorische Klammer von Projektverzeichnissen.

Projektverzeichnis¶

Ein Projektverzeichnis entspricht einer Gliederung von Projektverzeichniseinträgen - vergleichbar mit einen Inhaltsverzeichnis. Das Verzeichnis hat als Eingenschaften

• die Sprache, die bestimmt, welche Vorlagen und Bezeichnungen bei der Ausgabe verwendet werden
• eine Bezeichnung, die spachspezifisch vergebene werden sollte
• eine Dokumentationsart, die bestimmt, welche Dokumentationen bei der Generierung der Projektartikeldokumentation den Projektverzeichniseinträgen zugeordnet werden.

Projektverzeichniseintrag¶

Ein Projektverzeichniseintrag ist ein Gliederungspunkt im Projektverzeichnis. Ein Eintrag kann verschiede Typen darstellen

• ohne spezielle Zuordnung nur zur Gliederung
• Inhaltsverzeichnis
• Inhaltsverzeichnis eine Ordners
• Projektartikeldokumentation
• spezielle Indizies

Dokumentation¶

Eigenschaften¶

Ein Dokumentation repräsentiert eine PDF-Datei, die um folgende Eigenschaften erweitert wurde

• Bezeichnung
• Hersteller
• Sprache
• Dokumentationsart

Konfiguration des Imports¶

Import der Dokumentationen¶

Dokumentationarten¶

Die Dokumentationsarten dienen zur Strukturierung der Dokumentationen. Jedes Projektverzeichnis besitzt als Eigenschaft einen bestimmte Dokumentationsart, die bestimmt, welche Dokumentationen diesem Projektverzeichnis zugeordnet werden.

z.B. "Elektro" oder "Allgemeines"

Projektartikeldokumentation¶

Eine Projektartikeldokumentation ist ein Projektverzeichniseintragstyp, unter dessen Eintrag ein Index aller Dokumentationen nach Herstellern gruppiert, erstellt wird.
Die Basis dieses Indizes sind die Projektartikel.

Projektartikel¶

Projektartikel sind Artikel, die zur einem Projektverzeichnis durch Import oder manuelle Eingabe zugeordnet werden. Ein Projektartikel besitzt eine den System bekannte Artikelnummer, ein Hersteller, sowie für spezielle Indizies zwei weitere Gruppierungsfelder.

Sprache¶

Für jede Sprache kann eingestellt werden, ob sie nur zur Verwaltung der Dokumente dient oder ob sie eine Sprache ist, die in Projekten verwendet wird (aktiv) und zu dieser Sprache Bezeichnungen von Artikeln, Dokumentationen und Herstellern geplegt werden können. Dabei gilt, dass wenn für einen Sprache keine sprachspezifische Bezeichnung gepflegt wurde, werden die Bezeichnungen der Programmsprache verwendet.
Mit der Eigenschaft ABC kann in einen sprachspezifischen Projektverzeichnis die alphanumerischen Nummerierung vorgegeben werden.

z.B. für deutsch: "abcdefghijklmnopqrstuvwxyz"

Hersteller¶

Der Hersteller ist der Produzent des Artikels und wurde im Programm um die sprachspezifische Bezeichnung erweitert. Weiterhin ist der Hersteller eine Eigenschaft eines Artikels.

Artikel¶

Eigenschaften¶

Der Artikel hat als Eigenschaften eine systemweite eindeutige Artikelnummer, Bezeichnung , einen Hersteller sowie die Herstellerartikelnummer.
Jedem Artikel können sprachspezifische Bezeichnungen zugeordnert werden. Jedem Arikel können beliebige Dokumentationen zugeordnet werden.
Neben der manuellen Eingabe von Artikeln existiert ein Prozess, der es erlaubt, aus anderen Systemen die Daten zu importieren.

Import des Artikel¶

Der Artikeldatenimport erfolgt über eine separate Datenbank (prodocif.mdb), in der die Artikeldaten entweder vorhanden sind oder über externe Verknüpfungen zu weiteren Datenbanken zur Verfügung gestellt werden.
Der Importprozess unterteilt sich dabei in einen Vorbereitungsprozess, der frei konfiguriert werden kann und dem eigentlichen Import.
Der Eindeutigkeit eines Artikels wird über die Artikelnummer sichergestellt.
Ist ein Artikel bereits vorhanden, werden Bezeichnung und Herstellerartikelnummer aktualisiert.
Wird kein Artikel mit dem Hersteller gefunden, wird dieser angelegt. Existiert der Hersteller noch nicht im System wird dieser auch angelegt.
Eine Änderung des Herstellers ist im Import nicht zulässig und wird als Fehler protokolliert.

Folgende Spalten werden berücksichtigt:

• Artikelnummer (Spaltenbezeichnung siehe Konfiguration)
• Hersteller (Spaltenbezeichnung siehe Konfiguration)
• Herstellerartikelnummer (Spaltenbezeichnung siehe Konfiguration)
• Artikelbezeichnung (Spaltenbezeichung ist der Sprachcode z.B "de")
• sprachspezifische Bezeichnung (Spaltenbezeichung ist der Sprachcode z.B "en") Es werden alle im Programm verwalteten Sprachcodes berücksichtig!

Konfiguration des Imports¶

Die Konfiguration ist unter dem Menüpunkt Prodoc > Einstellungen und dort unter dem Eintrag Importkonfigurationen>Artikelstammdaten abgelegt.

Artikeltabelle

• Tabellenbezeichnung in der Datenbank mit den Artikeldaten

Spalte Artikelnummer

• Spalte mit den Artikelnummern

Spalte Hersteller

• Spalten mit den Bezeichnungen der Hersteller

Spalte Herstellerartikelnummer

• Spalten mit den Herstellerartikelnummer

Testtabelle (optional)

• Namen einer Tabelle, die zum Test der Verbindung dient

Verbindungskonfiguration

• Verbindungskonfiguration zur Interface-Datenbank

Vorbereitungsprogramm (optional)

• Programm für die Bereitstellung der Artikeldaten

Vorbereitungsprogrammparameter (optional)

• Parameter für das Programm für die Bereitstellung der Artikeldaten

Projekte¶

Projektartikel¶

Konfigurieren des Imports¶

Import der Projektartikel¶

Arbeiten mit ProDoc¶

Systembild¶

Druckerverwaltung¶

Dokumentationsdrucker¶

Der Dokumentationsdrucker ist der Drucker, auf dem die Dokumentationen (PFD-Datei) gedruckt werden.
In den Einstellungen kann dieser Drucker festgelegt werden.

Einlegerdrucker¶

Die Einlegerdrucker sind die Drucker, in deren Druckereinstellungen spezielle Einstellungen für Papierkasetten, Papierformate usw. für die Trennseiten bzw. Einlegern zwischen den Dokumenten festgelegt werden. Es können beliebig viele Einlegerdrucker definiert werden. Dabei könnte der Einlegerdrucker ein physisch anderen Drucker sein, aber auch der selbe Drucker, wie der Dokumentationsdrucker. Die Trennseiten würden dann an den richtigen Stellen in der gedruckten Dokumentatations liegen!
Die Drucker können unter dem Menüpunkt Stammdaten->Drucker verwaltet werden. Neben einer internen Bezeichnung, der Bezeichnung des Druckers im System, besitzt ein Drucker den Eigenschaft Seiten. Diese Eigenschaft legt fest, wievielen "normalen" Seiten eine Trennseite entspricht. Wenn die Trennseite lediglich eine anders farbige A4-Seite ist, wäre die Eigenschaft 1. Die Eigenschaft dient zur Ermittlung, wieviele Dokumentationen in einen Ordner passen.

Organisation der PDF-Dateien¶

Um das Programm effektiv nutzen zu können, sollten die PDF-Dateien in bestimmten Strukturen im Dateisystem des Rechners abgelegt werden. Das Programm unterstützt mehrere Ordnungen, die in den Einstellungen festgelegt werden müssen.
Es gibt drei definierte Strukturelemente, die Teil des Verzeichnispfades sein könnnen. Die Elemente sind die Dokumentationsart, der Hersteller und optional der Sprachcode. Die Folge der Strukturelemente ist dabei in den Einstellungen unter Importkonfigurationen->Dokumentationsstammdaten konfigurbar. Weitere Möglichkeiten des Dokumatationsstammdatenimports werden unter dem Punkt "Import der Dokumentationsstammdaten" beschrieben.

Beispiele für mögliche Konfigurationen:¶

Beispiel 1:
Die PDF-Dateien sind nach Dokumentationsart,Hersteller und Sprache abgelegt.

Ablage im Dateisystem:
X:\dokus\Elektrogeräte\Siemens AG\de\pdf-datei.pdf-datei

Konfiguration:
Dokumentationsverzeichnis: X:\dokus
Verzeichnisstruktur Teil 1: Dokumentationsart
Verzeichnisstruktur Teil 2: Hersteller
Verzeichnisstruktur Teil 3: Sprache

Beispiel 2:
Die PDF-Dateien sind nach Hersteller,Dokumentationsart und Sprache abgelegt.

Ablage im Dateisystem:
X:\dokus\Siemens AG\allgemeines\de\pdf-datei.pdf-datei

Konfiguration:
Dokumentationsverzeichnis: X:\dokus
Verzeichnisstruktur Teil 1: Hersteller
Verzeichnisstruktur Teil 2: Dokumentationsart
Verzeichnisstruktur Teil 3: Sprache

Beispiel 3:
Die PDF-Dateien sind nach Dokumentationsart und Hersteller abgelegt. Die Sprache ist im Dateinamen der PDF-Datei definiert und durch eine Trennzeichenfolge von der Bezeichnung getrennt.
Dabei kann ein Dokument nur eine Sprache (AGB#de.pdf), mehrere Sprachen durch ein Trennzeichen (SPS#de_en.pdf) oder alle definierte Sprachen (Relais_ABC3.pdf) enthalten.

Ablage im Dateisystem:
X:\dokus\allgemeines\Siemens AG\AGB#de.pdf
X:\dokus\Elekrogräte\Siemens AG\SPS#de_en.pdf
X:\dokus\Elekrogräte\Siemens AG\Relais_ABC3.pdf

Konfiguration:
  Dokumentationsverzeichnis:  X:\dokus
  Verzeichnisstruktur Teil 1: Hersteller
  Verzeichnisstruktur Teil 2: Dokumentationsart
  Verzeichnisstruktur Teil 3: undefiniert
  Titeltrennzeichen: #
  Sprachentrenzeichen: _

Arbeiten¶

Importieren von Projektartikeln¶

Anlegen eines Projektes¶

Erstellen eines Projektverzeichnisses¶

Importieren von Projektartikeln¶

Bearbeiten des Projektverzeichnisses¶

Erzeugen einer Projektdokumentation im HTML-Format¶

Erstellen von projektspezifische HTML-Seiten¶

Drucken einer Projektdokumentation¶

Drucken von Ordnerediketten¶

Erstellen von projektspezifische Ordnerediketten¶

Erstellen von Einlegern¶