Zum Hauptinhalt springen

Doku einbinden

Ziel

Mit Drücken von F1 soll im netFrame die entsprechende Doku für den aktuellen Dialog auf der richtigen Seite geöffnet werden.
Die Hilfedateien sollten mit den Updates mit ausgeliefert werden.

Bearbeiten

Anforderung an die Hilfedateien - Textmarken einfügen

In den Worddateien werden an den entsprechenden Stellen Textmarken als Ziele eingefügt, zu denen in der Hilfe gesprungen werden soll. Diese haben den Vorteil, dass bei Änderungen am Text und Verschiebung der Seitenzahl die Textmarken immer gefunden werden, während Seitenzahlen immer manuell aktualisiert werden müssen. Wenn die gewünschten Textstellen über Seitenzahlen angesprungen oder nur Dokumente ohne Seitenauswahl geöffnet werden sollen, entfallen die folgenden Punkte (weiter ab Abspeichern - Ordnerstruktur auf dem Server CPSRVTIFF), weil ja keine Textmarken benötigt werden.

1. Textmarken werden immer am Beginn eines Kapitels eingefügt, in dem ein neuer Dialog beschrieben wird. Momentan haben wir noch keine Lösung, um auch einzelne Felder oder Register in einem Dialog anzusteuern, deshalb reicht es, die Textmarken einmal für den Dialog anzugeben (und dies natürlich am Anfang des Kapitels, in dem der Dialog besprochen wird). Die Textmarke bitte nicht in der Überschrift einfügen (sie wird sonst u.U. ins Inhaltsverzeichnis übernommen), sondern direkt danach in der ersten Zeile des Textes. Wo genau Sie eingefügt wird, ist egal, da sie im gedruckten Text nicht sichtbar ist. Bitte davor und danach keine zusätzlichen Leerzeichen einfügen, da diese sonst im Text als doppelte Leerzeichen sichtbar sind.  
2. Um Textmarken einzufügen, werden in MS Word 2010 zunächst die Feldfunktionen sichtbar gemacht: Datei \- Optionen \- Erweitert \- **Doku**mentinhalt anzeigen \- "Feldfunktionen anstelle von Werten anzeigen" (TRUE Setzen).  
   Dies dient der Anzeige und Bearbeitung der Feldfunktionen. Sonst ist die Textmarke, die gesetzt werden soll, zwar eingefügt, aber nicht sichtbar und kann entsprechend auch nicht bearbeitet werden.  
3. Um die gewünschte Textmarke einzufügen, werden folgende Schritte befolgt: Einfügen \- Schnellbausteine \- Feld... \- Feld auswählen \- Feldnamen "Print" (unter Feldfunktion steht PRINT; mit OK bestätigen).  
4. Ein graues Feld mit folgendem Inhalt wird eingefügt: { PRINT \\\* MERGEFORMAT }.  
5. Dies muss angepasst werden auf: { PRINT " \[ /Dest /*TEXTMARKENNAME* /DEST pdfmark " \\\*MERGEFORMAT }  
   *TEXTMARKENNAME* muss natürlich mit dem Namen der Textmarke ersetzt werden (Formatierung kursiv entfernen\!). Dabei sollten sich die Namen der Textmarken unterscheiden und möglichst eindeutig sein.  
6. Sind alle Textmarken eingefügt, wird das **Doku**ment gespeichert. Neben dem normalen Einchecken im Projektmanager wird dafür auf dem Server CPSRVTIFF eine Ordnerstruktur geschaffen.

Bearbeiten

Abspeichern - Ordnerstruktur auf dem Server CPSRVTIFF

Auf der Festplatte C:\ des Servers befindet sich der Ordner Dokumentation. Darin ist die Ordnerstruktur für die Ablage der Dateien enthalten (siehe Abbildung). Diese wird bei der Installation ins netFrame Verzeichnis übernommen und kann entsprechend auch bei der CP Immo oder Kunden nachgeahmt werden, so dass deren Dateien ebenfalls ins Programm eingebaut werden können.

Bild

Alle bearbeiteten Word-Dateien, also alle, die mit Textmarken versehen wurden, werden im Ordner Word\CPA\XX abgelegt. XX steht hier für den entsprechenden Sachbereich. Dadurch wird mehr Übersicht geschaffen. Die Dokumentation der CP Immo (und evtl. weitere Dokumente von Kunden) können entsprechend im Ordner CPI (bzw. in weiteren Ordnern) hinterlegt werden. Die als .doc oder .docx gespeicherten Dokus werden über einen automatischen Prozess in pdf-Dateien umgewandelt und in den entsprechenden Unterordner des Ordners PDF kopiert.

Bearbeiten

Ansteuern der Textmarken - XML-Dateien

Damit die netFrame Plattform auch weiß, an welcher Stelle im Programm in welche Dokumentation gesprungen werden soll, werden weiterhin xml-Dateien benötigt. Diese enthalten die entsprechende Zuweisung von Dokumentation und Textmarke zu Dialog (und evtl. auch Register, Feld, Button, usw.).

  • Die XML-Dateien sollten immer den gleichen Aufbau haben (Bsp.: Doku Person). Im Verzeichnis Dokumentation\Word\CPA ist ein weiteres Beispiel zu finden. Dabei wird für die normalen netFrame Dialoge der Bereich dialogs verwendet. Später können auch Bericht-Dokumentationen eingebaut werden (Teil ab reports). Dieses ist außerdem erweiterbar (noch nicht umgesetzt!) auf Komponenten wie Register, Buttons, Felder etc. (dafür die Angabe comp name in der Beispiel XML im Ordner Dokumentation\Word\CPA).
  • Für mehr Übersichtlichkeit sollte eine XML-Datei pro Dokumentation verwendet werden. Diese sollte genauso wie die Dokumentation benannt und zur Word-Datei dazu gespeichert werden. Beim Drucken per pdf-Drucker werden diese dann automatisch ins pdf-Verzeichnis übertragen (siehe unten).
  • Der Dokumentations-Schreiber muss nun noch in der XML die entsprechenden Angaben machen:
  dialog name \= Dialogname (zu ermitteln durch Drücken von Strg+I in netFrame)  
  pdf \= Dateiname der **Doku**mentation (mit Endung .pdf statt .doc oder .docx; die Umwandlung erfolgt automatisch)  
  dest \= Name der Textmarke (so wie er im PRINT Befehl im Word angegeben ist)  
  ODER  
  page \= Seitenzahl (sind dest und page befüllt, wird die dest bevorzugt behandelt)

Unbedingt beachten: Die Datei muss im Format XML mit Codierung UTF-8 gespeichert werden.

Bearbeiten

Umwandlung in pdf-Dateien und Einbindung in den Installationssatz

  1. Mithilfe der batch-Datei AutomatischerDruck, die sich im Verzeichnis Dokumentation befindet, muss noch der automatisierte Druck der Word-Dateien ins pdf-Format angeschoben werden. Dafür wird ein pdf-Drucker verwendet. ACHTUNG: Auch MS Word kann Dateien als pdf speichern, nur enthalten diese nicht die benötigten Textmarken. Ein Druck direkt aus Word bringt also nichts.
    Momentan muss dies per Hand angeschoben werden, nach Einrichtung eines entsprechenden Dienstes passiert die Umwandlung automatisch.
  2. Die pdf-Dateien werden nach dem Druck automatisch in den entsprechenden Unterordner des pdf-Verzeichnises gespeichert. Außerdem überträgt die batch-Datei die dazugehörigen xml-Dateien.
  3. Von dort werden die pdf- und xml-Dateien über einen automatischen Lauf in den Installationssatz übernommen und an die Kunden ausgeliefert.

Bearbeiten

Aufruf der Hilfedateien in netFrame

Um in einem Dialog eine Hilfedatei aufzurufen, wird lediglich die Taste F1 gedrückt. Das Programm geht dann nach und nach die XML-Dateien durch und schaut nach, ob der Dialogname des aktuellen Dialogs irgendwo steht. Wenn ja, öffnet er die angegebene pdf-Datei mit dem Standard-pdf-Viewer auf der angegebenen Seite oder bei der angegebenen Textmarke. Ist (noch) keine Hilfedatei für den aktuellen Dialog verfügbar, erscheint eine entsprechende Meldung.
Da die Hilfedateien beim Start des Programms indiziert werden, ist es nötig, bei Änderungen an den Hilfedateien (insbesondere zu Anfang beim Testen) das Programm neu zu starten. Um dies zu vermeiden gibt es den Befehl Strg+F1. Damit wird neu indiziert und dann die Hilfe aufgerufen.