Flare è uno strumento online per la creazione di aiutare Madcap Software. Flare progetti web generare l'output in formato XML e HTML, che può essere modificato in qualsiasi editor di testo normale o HTML. Ci dettaglio come aggiungere, modificare e rimuovere contenuti da un web-based libro utilizzando un editor di testo.
Per cominciare, è una buona idea avere una stretta su architettura struttura di output generato da Flare. Una produzione tipica Flare aiutare conterrà un file HTML come punto di partenza dal titolo ApplicationHelp.htm. Un buon esempio di un sistema di aiuto Flare è la guida in linea System100 che è disponibile a http://www.system100.com/demo/help/ApplicationHelp.htm (che mi è capitato anche di autore).
Il file ApplicationHelp.htm, quando aperto in un browser web, si aprirà il sistema di aiuto e tirare nel foglio di stile necessario, pagine Web, XML, ecc ApplicationHelp.htm Il file si trova nella directory principale per il sistema di aiuto. In aggiunta alla directory genitore, tre sottodirectory principali si trovano all'interno della directory principale. Questi tre sottodirectory sono le seguenti:
Ci sarà copertura di queste sottodirectory tardi e ti aiuterà a capire la loro utilità. Per ora, possiamo citare i file di supporto aggiuntivi che sono anche contenute all'interno della directory principale, che includono:
- Default.js
- Default.mcwebhelp
- Default.xml
- Default_CSH.htm
- Default_Left.htm
Deafult.js
Questo file JavaScript contiene le istruzioni relative al punto di partenza / tema di default del sistema di aiuto. Esso contiene inoltre le note (che sono stati commentati nel codice di questo file) riguardanti l'ID, Nome della pelle, di ricerca e di prima scelta del libro di esecuzione.
NOTA: Se si rinomina il default / punto di partenza del sistema di aiuto, è necessario modificare una voce nel file default.js modo che corrisponda al nuovo nome. La linea specifica in questione nel file default.js è il numero di linea 54, che mostra come:
var gHelpSystemName = "Default.htm";
Quindi se state per rinominare il valore predefinito punto di partenza di un sistema di aiuto da Default.htm a index.htm, si avrebbe bisogno di modificare il numero di linea 54 del default.js come segue:
gHelpSystemName var = "index.htm";
Salvare le modifiche al file default.js.
Default.mcwebhelp
Questo è un file WebHelp Madcap che non dovrebbe essere modificato.
Default.xml
Questo file XML contiene le istruzioni per impostare il punto di partenza / tema di default ogni volta che il libro è il primo run lanciato. Si specifica inoltre il percorso e il nome del file per la Table of Contents, Index, Concepts, Glossario, Ricerca Database, Alias, Sinonimi, e la pelle.
Default_CSH.htm
File HTML contenente le impostazioni che non dovrebbe essere modificato.
Default_Left.htm
Questo file HTML contenente il codice per il TOC che appare sul lato sinistro del sistema di aiuto in linea e viene utilizzato per spostarsi da un argomento all'altro cliccando sui singoli annunci TOC.
Ora che abbiamo introdotto i vari file nella directory principale, passiamo la nostra attenzione su tre sottodirectory che sono stati citati in precedenza:
Contenuto Data Pelle Il contenuto delle cartelle
La cartella contiene i file contenuti HTML di ciascuno dei singoli argomenti del sistema di aiuto. In aggiunta a questi file HTML, il contenuto di directory contiene risorse (Immagini e Fogli di stile), SkinSupport (modificabile file JavaScript che sostengono la pelle sistemi di aiuto, e un file Glossario.
Cartella dati
La cartella contiene i file di dati relative ai dati del sistema di aiuto. Questi dati vengono usati per costruire e visualizzare l'aiuto in modo utilizzabili. Uno di questi file che si trova nella cartella dei dati che è di importanza è il file Toc.xml. È possibile apportare modifiche al TOC (Table of Contents) di un sistema di aiuto, modificando il file Toc.xml. Si tratteranno le revisioni della TOC in argomenti successivi.
Skin Folder
La cartella contiene i file di pelle che vengono utilizzati per la pelle del sistema di aiuto. A Skin definisce i colori, i caratteri e la grafica che partecipano alla presentazione del sistema di aiuto. In aggiunta alla directory di pelle, la pelle ci sono i relativi file contenuti all'interno dei dati e le cartelle contenuti.