Flare ist ein Tool zur Erstellung einer Online-Hilfe von MadCap. Flare Web-Projekte generieren Ausgabe in XML und HTML, die in jedem normalen Text oder HTML-Editor bearbeitet werden können. Wir werden detailliert, wie man hinzufügen, bearbeiten und entfernen Sie Inhalte von einer Web-basierten Run Book mit einem Texteditor.
Zu Beginn ist es eine gute Idee, ein Gespür für die Ausgabe Struktur Architektur, die von Flare erzeugt wird. Ein typisches Flare helfen Ausgabe enthält eine HTML-Datei als Ausgangspunkt Titel ApplicationHelp.htm. Ein gutes Beispiel für ein Flare-Hilfe ist die System100 Online-Hilfe, um http://www.system100.com/demo/help/ApplicationHelp.htm zur Verfügung steht (die auch ich zufällig an Autor).
Die ApplicationHelp.htm-Datei, wenn in einem Web-Browser geöffnet, wird das Hilfe-System zu öffnen, und ziehen Sie in die benötigten Stylesheets, ist Web-Seiten, XML, etc. Die ApplicationHelp.htm-Datei in das übergeordnete Verzeichnis für die Hilfe-System befindet. Zusätzlich zu den übergeordneten Verzeichnis, gibt im Wesentlichen drei Unterverzeichnisse innerhalb der übergeordneten Verzeichnis. Diese drei Unterverzeichnisse:
Wir decken diese Unterverzeichnisse später und helfen Ihnen, ihre Nützlichkeit. Denn jetzt sollten wir erwähnen, zusätzliche Support-Dateien, die auch in dem übergeordneten Verzeichnis, zu denen enthalten sind:
- Default.js
- Default.mcwebhelp
- Default.xml
- Default_CSH.htm
- Default_Left.htm
Deafult.js
Diese JavaScript-Datei enthält Anweisungen zum Ausgangspunkt verwandte / default Thema des Hilfesystems. Es enthält auch Hinweise (die wurden auskommentiert in den Code der Datei) im Zusammenhang mit der ID, Skin Name, Suchanfragenleistung und First Pick of the Run Book.
HINWEIS: Wenn Sie benennen Sie die default / Ausgangspunkt für das Hilfesystem, müssen Sie einen Posten in der überarbeiten Default.js Datei auf den neuen Namen übereinstimmen. Die betreffende Zeile in Frage zu Default.js Datei Linie Nummer 54, die als angezeigt:
var gHelpSystemName = "Default.htm";
Also, wenn Sie die Standard Ausgangspunkt für ein Hilfesystem von Default.htm zu index.htm umbenennen wollen, müssen Sie die Linie Nummer 54 der Default.js Bearbeiten wie folgt:
var gHelpSystemName = "index.htm";
Speichern Sie die Änderungen an der Default.js Datei.
Default.mcwebhelp
Dies ist ein MadCap WebHelp Datei, die nicht bearbeitet werden sollte.
Default.xml
Diese XML-Datei enthält Anweisungen zum Einstellen der Start / Standard-Thema, wenn der Run Book zum ersten Mal gestartet. Es legt auch den Speicherort und den Dateinamen für das Inhaltsverzeichnis, Index, Konzepte, Glossar, Suche Datenbank, Alias, Synonyme, und die Haut.
Default_CSH.htm
HTML-Datei mit Einstellungen, die nicht bearbeitet werden sollte.
Default_Left.htm
Diese HTML-Datei enthält den Code für das Inhaltsverzeichnis auf der linken Seite der Online-Hilfe wird angezeigt und wird verwendet, um von Thema zu Thema navigieren, indem Sie auf einzelnen TOC-Inserate.
Jetzt, da wir die verschiedenen Dateien in das übergeordnete Verzeichnis eingeführt haben, wenden wir unsere Aufmerksamkeit auf die drei Unterverzeichnisse, die zuvor erwähnt wurden:
Inhalt Data Haut Content-Folder
Das Content-Ordner enthält die HTML-Dateien von jedem der einzelnen Themen des Hilfesystems. Zusätzlich zu diesen HTML-Dateien enthält das Verzeichnis Content-Ressourcen (Bilder und Stylesheets), SkinSupport (editierbare JavaScript-Dateien, die der Haut helfen, Systeme zu unterstützen und ein Glossar-Datei.
Folder
Die Data-Ordner enthält Dateien, die Daten in das Hilfesystem in Zusammenhang stehen. Diese Daten werden verwendet, um zu bauen und die Hilfe in einer brauchbaren Weise anzuzeigen. Eine solche in dem Ordner Data die von Bedeutung ist, befindet sich die Datei befindet sich Toc.xml Datei. Sie können Änderungen an der TOC (Table of Contents) einer Hilfesystem können durch Veränderung der Toc.xml Datei. Wir werden Änderungen der TOC-Abdeckung in späteren Themen.
Skin-Ordner
Die Skin-Ordner enthält die Dateien, die für die Haut der Hilfe-System verwendet werden. Ein Skin definiert die Farben, Schriftarten und Grafiken in der Präsentation des Hilfe-Systems beteiligt. Zusätzlich zu den Skin-Verzeichnis, es gibt Haut zugehörigen Dateien im Data-und Content-Ordner enthalten sind.