Flare är ett online hjälp att skapa verktyg som Madcap Software. Flare webbprojekt genererar produktion i XML och HTML, som kan redigeras i en vanlig text eller HTML-editor. Vi kommer detalj hur du lägger till, redigera och ta bort innehåll från en webb-baserad köra bok med en textredigerare.
Till att börja med är det en bra idé att ha ett grepp om produktionen struktur arkitektur som genereras av Flare. En typisk Flare hjälpa produktionen kommer att innehålla en HTML-fil som utgångspunkt titeln ApplicationHelp.htm. Ett bra exempel på en Flare hjälpsystem är System100 online-hjälp som finns på http://www.system100.com/demo/help/ApplicationHelp.htm (som jag också hänt att författare).
Den ApplicationHelp.htm fil, när de öppnas i en webbläsare, kommer att öppna hjälpsystemet och dra de nödvändiga stylesheet, webbsidor, XML, etc. ApplicationHelp.htm filen finns i den överordnade katalogen för hjälpsystemet. Förutom moderbolaget katalogen finns tre underkataloger hittades inne underkatalogen. Dessa tre underkataloger:
Vi kommer att täcka dessa underkataloger senare och hjälpa dig att förstå deras användbarhet. För nu ska vi nämna ytterligare stöd filer som även ingår i underkatalogen, som omfattar:
- Default.js
- Default.mcwebhelp
- Default.xml
- Default_CSH.htm
- Default_Left.htm
Deafult.js
Denna JavaScript-fil innehåller instruktioner avseende utgångspunkten / default ämne av hjälpsystemet. Den innehåller också anteckningar (som har kommenterats i koden i denna fil) som hör till ID, Skin Namn, sökfråga och First Pick of inför boken.
OBS: Om du byter namn på default / utgångspunkten för hjälpsystemet, måste du ändra en rad i Default.js filen för att matcha det nya namnet. Den särskilda budgetposten i fråga i Default.js filen är linje nummer 54, som visar följande:
Var gHelpSystemName = "Default.htm";
Så om du skulle byta namn på standard utgångspunkten för ett hjälpsystem från Default.htm to index.htm, skulle du behöva ändra radnumret 54 Default.js på följande sätt:
Var gHelpSystemName = "index.htm";
Spara dina ändringar till Default.js filen.
Default.mcwebhelp
Detta är en Madcap WebHelp fil som inte bör redigeras.
Default.xml
Denna XML-fil innehåller instruktioner för inställning av start / default ämne när springa boken först lanseras. Den anger också platsen och filnamnet för innehållsförteckningen, index, Concepts, Ordlista, Search Database, Alias, synonymer och hud.
Default_CSH.htm
HTML-fil som innehåller inställningar som inte bör redigeras.
Default_Left.htm
Denna HTML-filen innehåller koden för innehållsförteckningen som finns på den vänstra sidan av hjälpsystem online och används för att navigera från ämne till ämne genom att klicka på enskilda TOC listor.
Nu när vi har infört olika filer i underkatalogen, låt oss vända vår uppmärksamhet till de tre underkataloger som nämndes tidigare:
Innehåll Data Hud Innehållsmapp
Innehåll mappen innehåller HTML-filer för varje enskild frågor av hjälpsystemet. Utöver dessa HTML-filer innehåller Content Directory-resurser (bilder och stilmallar), SkinSupport (redigerbara JavaScript-filer som stöder hjälpsystem huden, och en ordlista fil.
Data-mappen
Data-mappen innehåller filer som avser uppgifter i hjälpsystemet. Dessa data används för att bygga och visa hjälp i ett användbart sätt. En sådan fil finns i mappen Data som är av betydelse är Toc.xml filen. Du kan göra ändringar i TOC (innehållsförteckningen) av ett hjälpsystem genom att ändra Toc.xml filen. Vi kommer att omfatta revideringar av TOC i senare inlägg.
Skin Folder
The Skin mappen innehåller filer som används för huden av hjälpsystemet. En Hud definierar färger, teckensnitt och grafik deltar i presentationen av hjälpsystemet. Förutom de Skin katalogen finns Hud relaterade filer som finns inom data och innehåll mappar.