Vzplanutí je online nástroj pro tvorbu pomoci tím, Madcap Software. Flare webové projekty generují výstup v XML a HTML, které lze upravovat v libovolném běžný text a HTML editor. Budeme se podrobně, jak přidávat, upravovat a odstraňovat obsah z on-line rezervovat spustit v textovém editoru.
Pro začátek je dobré mít pochopení pro architekturu výstupní struktura, která je vytvořena Flare. Typický záře pomoci výstup bude obsahovat HTML soubor jako jeho výchozí bod s názvem ApplicationHelp.htm. Dobrým příkladem je systém pomoci Flare System100 online nápověda, která je k dispozici na http://www.system100.com/demo/help/ApplicationHelp.htm (což jsem také stalo autora).
Soubor ApplicationHelp.htm, při otevření v prohlížeči, bude otevřený systém nápovědy a vytáhněte do potřebných stylů se webové stránky, XML, atd. soubor ApplicationHelp.htm umístěn v nadřazeném adresáři pro systém nápovědy. Kromě nadřazeného adresáře, podadresáře jsou tři hlavní nalezen uvnitř nadřazeného adresáře. Tyto tři podadresáře, jsou:
Se budeme zabývat později tyto podadresáře a pomůžeme Vám pochopit jejich užitečnost. Pro tuto chvíli bychom měli zmínit další podpůrné soubory, které jsou rovněž obsaženy v nadřazeném adresáři, které zahrnují:
- Default.js
- Default.mcwebhelp
- Default.xml
- Default_CSH.htm
- Default_Left.htm
Deafult.js
JavaScript Tento soubor obsahuje instrukce k výchozímu bodu / default téma systém nápovědy. Obsahuje také poznámky (připomínky, které byly v kódu tohoto souboru), které se týkají ID, Skin Název, vyhledávacích dotazů a první výběr v běhu knihy.
Poznámka: Pokud přejmenujete default / výchozí bod pomocí systému, musíte upravit řádku v souboru Default.js, aby odpovídaly novým názvem. Danou trať v otázce v souboru Default.js je linka číslo 54, který se zobrazí jako:
var gHelpSystemName = "Default.htm";
Takže pokud jste se přejmenovat výchozí východiskem pomoci systém od Default.htm na index.htm, budete muset upravit číslo řádku 54 Default.js takto:
var gHelpSystemName = "index.htm";
Uložte změny v souboru Default.js.
Default.mcwebhelp
To je WebHelp Madcap souboru, který by se neměly upravovat.
Default.xml
Tento soubor XML obsahuje pokyny pro instalaci zahájení / výchozí téma, kdykoliv je běh kniha první trh. To také určuje umístění a název souboru pro obsah, index, Koncepty, Slovník, Search Database, Alias, synonyma a kůže.
Default_CSH.htm
HTML soubor obsahující nastavení, které by se neměly upravovat.
Default_Left.htm
Tento soubor obsahuje HTML kód obsahu, který se zobrazí na levé straně v nápovědě online systému a slouží k navigaci témat Kliknutím na jednotlivé záznamy TOC.
Nyní, když jsme zavedli různé soubory v nadřazeném adresáři, pojďme obrátit svou pozornost na tři podadresáře, které byly již bylo zmíněno:
Obsah Data Kůže Obsah složky
Obsah složka obsahuje soubory HTML, každé z jednotlivých témat systém nápovědy. Kromě těchto HTML soubory, obsah adresáře obsahuje zdroje (obrázky a styly), SkinSupport (JavaScript editovatelné soubory, které podporují systémy pomáhají kůži, a Slovník souboru.
Datové složky
Složka obsahuje soubory dat týkajících se dat v systému nápovědy. Tato data jsou použita k vytvoření a zobrazení pomoc v použitelné módy. Jeden takový soubor ve složce Data, která je důležitá, je Toc.xml soubor. Můžete provést změny v TOC (Obsah) ze systému pomoci tím, že změní Toc.xml souboru. Se budeme zabývat revizí obsahu v dalších tématech.
Skin Schránka
Složka Skin obsahuje soubory, které jsou používány pro Kůže systém nápovědy. Skin definuje barev, písem a grafiky se podílejí na prezentaci systému nápovědy. Kromě adresáře kůže, jsou Skin související soubory obsažené v Data a obsah složky.