Erstellen von Topics

Neue Topics erstellen

Neue Topics erstellen

Information: Im ersten Teil des Artikels „Topics auf Basis der offiziellen Vorlage erstellen“ wird der offizielle Weg dargestellt, um ein neues Topic zu erstellen.

Wenn für eine neue App-Dokumentation bereits Topics vorhanden sind oder ein Topic aus einer anderen App als Grundlage für ein neues Topic dienen kann, dann ist womöglich die Vorgehensweise aus dem zweiten Teil „Topics auf Basis eines bestehenden Topics erstellen“ effizienter.

Topics auf Basis der offiziellen Vorlage erstellen

  1. Auf Datei klicken.

  2. Auf Neu > Dokument... klicken.

  3. Im Ordner DokuModular\00_FM+XML-App\1_Templates die Datei Topic_Template.fm auswählen. Dies ist die Vorlage für alle Topics und Fragmente.

  4. Auf Neu klicken.

  5. Auf Datei > Speichern unter klicken.

  6. Entsprechenden Ablageort auswählen.

  7. Bei Dateiname: den Dateinamen des Topics eintragen.

  8. Auf Speichern klicken.

  9. Element Beschreibung oder Handlungsanweisung (Handlungssequenz) einfügen.

  10. In der Strukturansicht das Element Titel aus dem Element Beschreibung bzw. Handlungsanweisung (Handlungssequenz) direkt hinter das Element Metadaten verschieben.

    Information: Titel innerhalb des Elements Beschreibungen bzw. Handlungsanweisung (Handlungssequenz) werden nur für Unterüberschriften verwendet.
  11. Im ersten Element Titel im Attribut ID Datum und Zeitpunkt der Erstellung nach dem Schema „DJJJJMMTTThhmmss“ eintragen. Bsp.: „D20210810T115800“

  12. In der Strukturansicht prüfen, ob die Sprache des Topics korrekt ausgewählt ist. Standardmäßig ist de ausgewählt.

  13. Restliche Metadaten ausfüllen.

  14. Im Element Titel den Titel des Topics eintragen.

  15. Weitere Elemente einfügen und mit Text und Bildern füllen.

    Information: Um Text aus einem anderen Programm aus der Zwischenablage einzufügen auf Bearbeiten > Einfügen Spezial > Unicode-Text klicken.
  16. Auf Datei > Speichern klicken.

Topics auf Basis eines bestehenden Topics erstellen

  1. Auf dem Laufwerk im entsprechenden Ordner das gewünschte Topic duplizieren.

    Information: Am besten darauf achten, ob ein BTX- oder ein HAW-Topic benötigt wird und ein entsprechendes Topic duplizieren.
  2. Dateinamen des Topics ändern.

  3. Das neue Topic öffnen.

    Hinweis: Wenn ein Topic aus einer anderen App-Dokumentation dupliziert und in einen anderen Ordner verschoben wird, sucht FrameMaker evtl. nach verknüpften Screenshots und meldet ungelöste Querverweise. Im ersten Fall auf Alle fehlenden Dateien übergehen klicken. Bei der Meldung vor ungelösten Querverweisen auf OK klicken. Im Topic müssen die Screenshots und Querverweise dann ausgetauscht oder entfernt werden.
  4. Im ersten Element Titel im Attribut ID Datum und Zeitpunkt der Erstellung nach dem Schema „DJJJJMMTTThhmmss“ eintragen. Bsp.: „D20210810T115800“ LB: Satz umgestellt

  5. Restliche Metadaten ausfüllen.

  6. In der Strukturansicht prüfen, ob die Sprache des Topics korrekt ausgewählt ist.

  7. Im Element Titel den Titel des Topics anpassen.

  8. Weitere Elemente einfügen und mit Text und Bildern füllen.

    Information: Um Text aus einem anderen Programm aus der Zwischenablage einzufügen auf Bearbeiten > Einfügen Spezial > Unicode-Text klicken.
  9. Auf Datei > Speichern klicken.