Flare jest online narzędzia do tworzenia pomocy przez Madcap Software. Flare projekty internetowe generują wyjście w formacie XML i HTML, który można edytować w dowolnym edytorze zwykłego tekstu lub HTML. Będziemy szczegółowo, jak dodawać, edytować i usuwać treści z internetowych książki uruchamiane przy użyciu edytora tekstu.
Aby rozpocząć, to jest dobry pomysł, aby uchwycić na architekturze struktury wyjściowe wygenerowane przez Flare. Typowe wyjście pomóc Flare będzie zawierał plik HTML jako punkt wyjścia pt ApplicationHelp.htm. Dobrym przykładem systemu Flare pomocy jest pomoc online System100 który jest dostępny na http://www.system100.com/demo/help/ApplicationHelp.htm (które również stało się autor).
Plik ApplicationHelp.htm, po otwarciu w przeglądarce internetowej otworzy system pomocy i pociągnij w potrzebne stylów, strony WWW, XML, itp. Plik ApplicationHelp.htm znajduje się w katalogu nadrzędnego systemu pomocy. W uzupełnieniu do katalogu nadrzędnego, trzy główne podkatalogów znajdują się wewnątrz katalogu nadrzędnego. Te trzy podkatalogi są:
Będziemy na pokrycie tych podkatalogów później i pomóc w zrozumieniu ich użyteczność. Na razie należy wymienić dodatkowe pliki pomocy, które są również zawarte w katalogu nadrzędnego, które obejmują:
- Default.js
- Default.mcwebhelp
- Default.xml
- Default_CSH.htm
- Default_Left.htm
Deafult.js
Ten plik JavaScript zawiera instrukcje dotyczące punktu wyjścia / topic domyślny system pomocy. Zawiera także uwagi (które były komentowane w kod tego pliku), odnoszące się do ID, Nazwa skóry wyszukiwanego hasła i pierwsze Pick książki biegać.
UWAGA: W przypadku zmiany nazwy default / punkt wyjścia dla systemu pomocy, należy zmienić pozycji w Default.js plik zgodny z nową nazwą. Konkretnej pozycji, o których mowa w pliku Default.js jest numer linii 54, który pokazuje jak:
var gHelpSystemName = "default.htm";
Więc jeśli miałby zmienić domyślny punkt wyjścia dla systemu pomocy Default.htm do index.htm, musisz zmienić numer linii 54 Default.js następujące brzmienie:
var gHelpSystemName = "index.htm";
Zapisz zmiany w pliku Default.js.
Default.mcwebhelp
Plik WebHelp Madcap które nie powinny być zmieniane.
Default.xml
Ten plik XML zawiera instrukcje dotyczące konfiguracji uruchamiania / default temat książki, gdy prowadzony jest po raz pierwszy uruchomiona. Określa także lokalizację i nazwę pliku do spisu treści, indeks, koncepcje, Słownik, wyszukiwania danych, Alias, synonimy i skóry.
Default_CSH.htm
Plik HTML zawierający ustawienia, które nie powinny być zmieniane.
Default_Left.htm
Ten plik HTML zawiera kod TOC, które znajduje się po lewej stronie system pomocy i służy do poruszania tematu klikając na poszczególne aukcje TOC.
Teraz, kiedy wprowadzono różne pliki w katalogu nadrzędnym, let's zwrócić uwagę na trzy podkatalogi, które zostały wymienione wcześniej:
Treść Dane Skóra Zawartość katalogu
Zawartości folderu zawierającego pliki HTML każdego z poszczególnych tematów systemu pomocy. Oprócz tych plików HTML w katalogu treści zawiera zasoby (obrazy i stylów), SkinSupport (edytowalne pliki JavaScript, które wspierają skóry systemów pomocy i Słownik pliku.
Dane Folder
Dane folderze znajdują się pliki związane z danymi w systemie pomocy. Dane te są wykorzystywane do tworzenia i wyświetlania pomocy w użytkowa mody. Jednym z takich plików znajduje się w folderze Dane, które mają znaczenie jest Toc.xml pliku. Można dokonać zmian w spisie treści (Spis treści) na system pomocy, zmieniając Toc.xml pliku. Omówimy zmiany w TOC w dalszych tematach.
Skin Folder
Skin folder zawierający pliki, które są wykorzystywane do skóry z systemu pomocy. Skin określa kolorów, czcionek i grafiki udział w prezentacji systemu pomocy. Oprócz katalogu skóry, skóry związane są pliki znajdujące się w folderach danych i treści.