Seitenumbrüche, Themennamen und kontextsensitive Hilfe

Wenn Sie ein FrameMaker-Dokument verknüpfen oder importieren, legen Sie fest, wie FrameMaker-Inhalte in RoboHelp als Themen dargestellt werden sollen. Mit der Technical Communication Suite können Sie Seitenumbrüche für Inhalte angeben, Themenbezeichnungen festlegen und kontextsensitive Hilfethemen für die Integration mit einem Produkt zuordnen.

    Überlegungen zu Seitenumbrüchen und Thementiteln

    Bestimmen Sie anhand folgender Faktoren, welche Seitenumbruchsoption in Ihrer Umgebung am besten geeignet ist:

    Vollständigkeit des Inhalts im Thema
    Stellen Sie sicher, dass der Inhalt des generierten Themas vollständig und für den Leser relevant ist. Wenn Sie Seitenumbrüche bei Überschrift 3 festlegen, enthält das Thema möglicherweise nur die Vorgehensweise ohne die Kontextinformationen, die in einem anderen Thema mit einer Überschrift 3 behandelt werden. Um dies zu vermeiden, legen Sie für Seitenumbrüche eine höhere Ebene fest, sodass die vollständigen Informationen in einem einzigen Hilfethema verfügbar sind.

    Dropdowntext
    Vergewissern Sie sich, dass im Absatzformat für den Dropdown-Textkörper keine Seitenumbrüche eingestellt sind. Die Absätze mit diesem Format müssen mit Absätzen verbunden sein, die als Dropdown-Beschriftungen formatiert sind.

    Seitenumbrüche und Thementitel können anhand der FrameMaker-Absatzformate einfach generiert werden. Dieser Ansatz unterliegt jedoch folgenden Einschränkungen:

    Keine Steuerungsmöglichkeit auf Themenebene
    Da die Seitenumbrucheinstellungen auf Projektebene festgelegt werden, gibt es keine Steuerungsmöglichkeit für einzelne Themen, die sich nicht auf den definierten Überschriftenebenen befinden. Beispiel: Sie möchten ein Thema auf der Ebene der Überschrift 3 in ein separates Thema umwandeln. Dies ist nicht möglich, wenn Sie in Ihrem Projekt Seitenumbrüche bei Überschrift 2 festlegen. Das Thema mit Überschrift 3 wird in das unmittelbar übergeordnete Thema aufgenommen.

    Einheitliche Themennamen
    Hilfethemen werden nach den Dateibenennungskonventionen benannt, die Sie in den Konvertierungseinstellungen angeben, besonders wenn Sie Dokumente in der strukturierten Version von FrameMaker erstellen. Sie können nicht von diesen Konventionen abweichen.

    Keine Flexibilität bei Thementiteln
    Sie können die Titel oder Dateinamen von Themen nur ändern, wenn Sie auch den Inhalt ändern. Wenn Sie in RoboHelp nach Inhalt suchen, werden Thementitel angezeigt. Intuitive Thementitel ermöglichen dem Leser, im Suchergebnis schnell die für ihn relevanten Informationen zu finden.

    Mögliche Inkonsistenzen in Dokumenten aus mehreren Büchern
    Wenn FrameMaker-Dokumente aus verschiedenen Büchern verknüpft und importiert werden, können die generierten Themen inkonsistente Überschriftenformate aufweisen.

    Beispiel: Sie verknüpfen oder importieren FrameMaker-Dokumente aus einem Benutzerhandbuch und einem Referenzhandbuch. Die Thementitel von Lerninhalten und Referenzinhalten können unterschiedliche Formate aufweisen. Wenn Thementitel auf dem Text des Absatzes basieren, bei dem der Seitenumbruch eingestellt ist, können die generierten Hilfethemen inkonsistente Titel enthalten.

    Vorteile der Einstellung von Seitenumbrüchen in FrameMaker

    Sie können die oben genannten Probleme in kleineren Projekten umgehen, indem Sie in FrameMaker benutzerdefinierte Markierungen verwenden und wie folgt vorgehen:
    Inhalte auf der Grundlage eines Arbeitsablaufs erstellen
    Durch sinnvolle Verwendung benutzerdefinierter Markierungen in FrameMaker können Sie RoboHelp-Themen erstellen, die Benutzern Informationen zum Arbeitsablauf bieten. Sie können Hilfethemen unabhängig von den im FrameMaker-Dokument angewendeten Überschriftenformaten erstellen.

    Thementitel definieren (optional)
    Dies ist sinnvoll, wenn Sie einem aus mehreren Themen zusammengestellten Thema einen aussagekräftigen Titel geben möchten, statt den Thementitel aus einem der Überschriftenformate abzuleiten.

    Themenlänge optimieren
    Wenn Sie in FrameMaker festlegen, wie Hilfethemen in RoboHelp erstellt werden, können Sie die Themenlänge für die Inhaltserstellung genau steuern. Wenn Sie für die Hilfethemen jedoch ein Mini-Inhaltsverzeichnis erstellen, schränken Sie die Anzahl der in ein Thema aufgenommenen Überschriften ein. In einem langen Mini-Inhaltsverzeichnis kann der Zugriff auf Themeninhalte nur durch Bildlauf möglich sein.

    Nachdem Sie die Markierungen in den FrameMaker-Dokumenten definiert haben, können Sie Konvertierungseinstellungen in RoboHelp festlegen, um Themen nach Ihren Wünschen zu erstellen und zu benennen.

    Seitenumbruchsoptionen

    Sie können festlegen, wie FrameMaker-Inhalte in RoboHelp in verschiedene Hilfethemen unterteilt werden.

    Separate HTML-Themen aufgrund von FrameMaker-Absatzformaten erstellen
    Sie geben in FrameMaker die Überschriftenformate an, bei denen ein Seitenumbruch erfolgen soll. Wenn die FrameMaker-Datei beispielsweise zehn Themen mit untergeordneten Themen, Aufgaben und Tabellen enthält, kann jedes Thema in eine eigene HTML-Datei konvertiert werden. Wenn jede Themenüberschrift als Überschrift 1 formatiert ist, können Sie festlegen, dass für alle Themen mit einer Überschrift 1 ein eigenes HTML-Thema erstellt wird. Wenn Sie jedoch den Seitenumbruch bei Überschrift 2 definieren, wird für alle Themen mit einer Überschrift 2 eine eigene HTML-Datei angelegt.

    Seitenumbruchsmarkierungen in FrameMaker-Inhalten definieren
    Sie können in FrameMaker-Dokumenten Seitenumbruchsmarkierungen zu Beginn eines Absatzes einfügen. Im Normalfall fügen Sie die Seitenumbrüche bei den gewünschten Überschriftenebenen ein. Bei dieser Lösung müssen Sie keine Seitenumbrucheinstellung basierend auf Absatzformaten festlegen.

    Benutzerdefinierte Markierungen in FrameMaker verwenden
    Diese Option eignet sich, wenn Sie in FrameMaker ältere Inhalte konvertieren, in denen benutzerdefinierte Markierungen für Seitenumbrüche mit anderen Werkzeugen festgelegt wurden. Vermeiden Sie in solchen Dokumenten die Verwendung von Seitenumbruchsmarkierungen.

    Optionen für Themennamen

    Sie können definieren, wie aus FrameMaker-Inhalten generierte Themen in RoboHelp benannt werden sollen. Standardmäßig wird der Text des Absatzes, für den Seitenumbrüche eingerichtet sind, als Themenname festgelegt. Darüber hinaus können Sie andere Namenskonventionen definieren. Wenn die Dateinamen fortlaufend nummeriert sind, beispielsweise „hilfethema001.html“ und „hilfethema002.html“, können Sie das Muster für diese Konvention definieren.

    Auf Grundlage des Absatztextes
    Wenn Sie Überschriftenformate für Seitenumbrüche festlegen, wird der Überschriftentext der standardmäßige Dateiname für die in RoboHelp erstellte Themendatei. Beispiel: Sie definieren für Seitenumbrüche Überschrift 2 und das FrameMaker-Dokument enthält zwei Themen vom Typ Überschrift 2, nämlich „Einführung“ und „Weitergehende Informationen“. In diesem Fall erstellt RoboHelp die Themen „Einführung.htm“ und „Weitergehende_Informationen.htm“. Somit erhalten Sie intuitiv benannte HTML-Dateien, die Rückschluss auf den Thementitel ermöglichen.

    Themen-Namensmuster
    Themen werden anhand des ausgewählten Musters benannt. Sie können eine der folgenden Optionen auswählen oder ein Themen-Namensmuster mithilfe der entsprechenden Bausteine von RoboHelp erstellen. Außerdem können Sie statischen Standardtext wie „Hilfethema“ gefolgt von einer laufenden Nummer als Themen-Namensmuster hinzufügen.

    Baustein

    Konvertiertes Themen-Namensmuster

    Standard

    Als Dateiname des generierten HTML-Themas wird der Absatztext verwendet.

    <$filename_no_ext>-<$paratext>

    Als Dateiname des generierten HTML-Themas wird der Dateiname des FrameMaker-Dokuments ohne die Erweiterung .fm und der Thementitel verwendet. Zwischen Dateiname und Thementitel befindet sich ein Trennstrich. Beispiel: Aus dem FrameMaker-Dokument „Kapitel.fm“ mit dem Absatztext „1-Einführung“ wird ein HTML-Thema mit dem Dateinamen „Kapitel-1-Einführung.htm“ erstellt.

    <$filename_no_ext>-<n>

    Als Dateiname des generierten HTML-Themas wird der Dateiname des FrameMaker-Dokuments ohne die Erweiterung .fm und die Absatznummer verwendet. Zwischen Dateiname und Absatznummer befindet sich ein Trennstrich. Beispiel: Aus dem FrameMaker-Dokument „Kapitel.fm“ wird ein HTML-Thema mit dem Dateinamen „Kapitel-1.htm“ erstellt.

    <$paratext_no_num>

    Als Dateiname des generierten HTML-Themas wird der Absatztext des Absatzformats verwendet, das für Seitenumbrüche eingestellt ist, und zwar ohne die Absatznummerierung. Beispiel: Der Absatz „Einführung 1“ vom Typ Überschrift 1 wird in ein HTML-Thema mit dem Dateinamen „Einführung.htm“ konvertiert.

    <$paratext>

    Als Dateiname des generierten HTML-Themas wird der Absatztext des Absatzformats verwendet, das für Seitenumbrüche eingestellt ist. Beispiel: Der Absatz „Einführung“ vom Typ Überschrift 1 wird in ein HTML-Thema mit dem Dateinamen „Einführung.htm“ konvertiert.

    Themen-Namensmarkierung
    Sie können Themennamensmarkierungen im FrameMaker-Dokument verwenden, um Thementitel und Dateinamen aus dem Markierungstext zu erstellen. Wenn Sie diese Option auswählen, werden die im Fenster „Absatzstile“ angewendeten Seitenumbrucheinstellungen ignoriert. Verwenden Sie diese Option, um die Erstellung getrennter Hilfethemen aus FrameMaker-Dokumenten genau zu steuern.

    Seitenumbruchsmarkierung
    Wenn Sie beim Erstellen neuer Inhalte in FrameMaker keine benutzerdefinierten Markierungen zum Definieren von Seitenumbrüchen verwenden möchten, können Sie Seitenumbruchsmarkierungen einsetzen. Wenn Sie den Thementitel definieren, erstellt FrameMaker automatisch den Themennamen anhand des Thementitels.

    Vermeiden Sie diese Option, wenn Ihr FrameMaker-Dokument schon benutzerdefinierte Markierungen für Seitenumbrüche enthält oder wenn Sie Seitenumbrüche anhand der FrameMaker-Absatzformate definieren möchten.

    Einstellungen für Themennamen definieren

    1. Wählen Sie „Datei“ > „Projekteinstellungen“.

    2. Klicken Sie im Dialogfeld „Projekteinstellungen“ auf der Registerkarte „Importieren“ unter „FrameMaker-Dokument“ auf „Bearbeiten“.

    3. Wählen Sie auf der Registerkarte „Andere Einstellungen“ die erforderliche Option:

    Kontextsensitive Hilfemarkierungen in FrameMaker-Dokumenten

    In der Technical Communications Suite können Sie neben anderen Markierungen auch Zuordnungs-IDs für die kontextsensitive Hilfe in FrameMaker definieren.

    Sie können die kontextsensitiven Hilfemarkierungen konvertieren, die Sie in FrameMaker-Dokumente einfügen, und als Zuordnungs-IDs verwenden. Sie legen die kontextsensitive Hilfemarkierung im Dialogfeld „Projekteinstellungen“ fest, bevor Sie FrameMaker-Dokumente verknüpfen. Sie können diese Einstellung auch festlegen, wenn Sie FrameMaker-Dokumente importieren. Kontextsensitive Hilfemarkierungen in FrameMaker-Dokumenten bieten die folgenden beiden Verwendungsmöglichkeiten:

    Automatische Konvertierung von Zuordnungs-IDs aus FrameMaker-Dokumenten
    Sie fügen kontextsensitive Hilfemarkierungen in Ihre FrameMaker-Dokumente ein und geben den Markierungstyp in den Konvertierungseinstellungen an. RoboHelp importiert die Markierungen aus FrameMaker-Dokumenten und fügt die Zuordnungs-IDs aus den Zeichenfolgen ein, die in den kontextsensitiven Hilfemarkierungen enthalten sind.

    Manuelles Hinzufügen von Zuordnungs-IDs
    Sie können die Zuordnungs-IDs, die Sie vom Entwicklungsteam erhalten, auf zwei Arten nutzen:

    • Geben Sie in FrameMaker mithilfe der CSH-Markierungsoption die Zuordnungs-IDs der Themen an, die Sie generieren möchten. Diese Option ist nur verfügbar, wenn Sie die Technical Communications Suite verwenden.

    • Verwenden Sie die Zuordnungs-ID in FrameMaker als Text für die kontextsensitive Hilfemarkierung. Geben Sie beim Verknüpfen oder Importieren von FrameMaker-Dokumenten die kontextsensitive Hilfemarkierung in den Konvertierungseinstellungen an.

    Bei Verwendung der ersten Option geben Sie die Angabe der kontextsensitiven Hilfemarkierung in den Konvertierungseinstellungen.

    Kontextsensitive Hilfemarkierung angeben

    1. Wählen Sie „Datei“ > „Projekteinstellungen“.

    2. Klicken Sie im Dialogfeld „Projekteinstellungen“ auf der Registerkarte „Importieren“ unter „FrameMaker-Dokument“ auf „Bearbeiten“.

    3. Wählen Sie im Dialogfeld „Konvertierungseinstellungen“ in der Gruppe „Andere Einstellungen“ die Option „Kontextsensitive Hilfemarkierung“.