Flare is een online help creatie tool door Madcap Software. Flare web projecten genereren van de output in XML en HTML, die kunnen worden bewerkt in een gewone tekst-of HTML-editor. We zullen detail over het toevoegen, bewerken en verwijderen van inhoud van een web-based lopen boek met behulp van een tekst editor.
Om te beginnen is het een goed idee om een greep op de uitgang van de structuur architectuur die wordt gegenereerd door Flare. Een typisch Flare helpen uitgang bevat een HTML-bestand als uitgangspunt getiteld ApplicationHelp.htm. Een goed voorbeeld van een Flare Help-systeem is de System100 online hulp die beschikbaar is op http://www.system100.com/demo/help/ApplicationHelp.htm (die ik ook toevallig auteur).
De ApplicationHelp.htm bestand, wanneer geopend in een webbrowser, opent het Help-systeem en trek in de stylesheet nodig, webpagina's, XML, enz. De ApplicationHelp.htm bestand bevindt zich in de bovenliggende directory voor het Help-systeem. In aanvulling op de bovenliggende map, zijn drie belangrijke submappen gevonden in de bovenliggende map. Deze drie submappen zijn:
We zullen deze subdirectories later en u helpen te begrijpen het nut ervan te dekken. Voor nu moeten we vermelden extra ondersteuning bestanden die ook zijn vervat in de bovenliggende directory, waaronder:
- Default.js
- Default.mcwebhelp
- Default.xml
- Default_CSH.htm
- Default_Left.htm
Deafult.js
Het JavaScript-bestand bevat instructies met betrekking tot het beginpunt / default onderwerp van het Help-systeem. Het bevat ook de toelichting (die zijn commentaar in de code van dit bestand) met betrekking tot de ID, Skin Naam, zoekopdrachtprestaties en First Pick of the run boek.
OPMERKING: Als u de naam van de standaard / startpunt van het Help-systeem, moet u een regel herzien item in de Default.js bestand naar de nieuwe naam overeenkomen. De specifieke regel in kwestie in de Default.js bestand is regel nummer 54, die wordt weergegeven als:
var gHelpSystemName = "Default.htm";
Dus als je de standaard uitgangspunt van een help systeem van Default.htm tot index.htm hernoemen, zou je regel nummer 54 van Default.js bewerken als volgt:
var gHelpSystemName = "index.htm";
Sla uw wijzigingen aan de Default.js bestand.
Default.mcwebhelp
Dit is een Madcap WebHelp bestand die niet mag worden bewerkt.
Default.xml
Dit XML-bestand bevat instructies voor het instellen van de start / default onderwerp wanneer de run boek voor het eerst wordt gelanceerd. Het bepaalt ook de locatie en de bestandsnaam voor de inhoudsopgave, index, Concepts, Woordenlijst, Search Database, Alias, Synoniemen, en de huid.
Default_CSH.htm
HTML-bestand met instellingen die niet worden bewerkt.
Default_Left.htm
Deze HTML-bestand bevat de code voor de inhoudsopgave, die verschijnt op de linkerkant van de online help systeem en wordt gebruikt om te navigeren per onderwerp door te klikken op individuele TOC aanbiedingen.
Nu we de verschillende bestanden in de bovenliggende directory hebben ingevoerd, laten we onze aandacht richten op de drie submappen die eerder zijn genoemd:
Inhoud Data Huid Content Map
De inhoud map bevat de HTML-bestanden van elk van de afzonderlijke onderwerpen van het Help-systeem. Naast deze HTML-bestanden, de inhoud map bevat Resources (Afbeeldingen en Stylesheets), SkinSupport (bewerkbare JavaScript-bestanden die de help-systemen huid ondersteunen, en een verklarende woordenlijst bestand.
Data Folder
De Data map bevat dossiers met betrekking tot de gegevens in het Help-systeem. Deze data wordt gebruikt om te bouwen en de hulp op een bruikbare manier weer te geven. Een dergelijk bestand in de map Data die van belang is de Toc.xml bestand. U kunt wijzigingen aanbrengen aan de TOC (inhoudsopgave) van een help-systeem door wijziging van de Toc.xml bestand. We herzieningen dekking van de inhoudsopgave in latere onderwerpen.
Skin Folder
De Skin map bevat de bestanden die worden gebruikt voor de huid van de help-systeem. Een huid definieert de kleuren, lettertypen en afbeeldingen die betrokken zijn bij de presentatie van het Help-systeem. In aanvulling op de huid directory, er zijn huid-gerelateerde bestanden binnen de Data en Content mappen.