EmployMentality

Vzplanutia je online nástroj pre tvorbu pomôcť tým, třeštidlo Software . lemovacieho webové projekty generujú výstup v XML a HTML, ktoré možno upravovať v akomkoľvek bežný text alebo HTML editor. Budeme podrobne, ako pridať, upraviť a odstrániť obsah z on-line rezervovať spustiť pomocou textového editora.

Ak chcete začať, je to dobrý nápad, mať pochopenie pre štruktúru architektúry výstup, ktorý je tvorený svetlicu. Typický žiara pomôcť výstup bude obsahovať HTML súbor ako jeho východiskový bod s názvom ApplicationHelp.htm. Dobrým príkladom systému, pomôže erupcie je System100 online pomocníka, ktorá je k dispozícii na http://www.system100.com/demo/help/ApplicationHelp.htm (čo som tiež náhodou autor).

Súbor ApplicationHelp.htm, pri otvorení vo webovom prehliadači, otvorí systému nápovedy a doinstaluje potrebné stylesheet, je webové stránky, XML, atď Súbor ApplicationHelp.htm umiestnený v nadradenom adresári na systéme nápovedy. Vedľa nadradeného adresára, sú tri hlavné podadresára nájdený vnútri nadradeného adresára. Tieto tri podadresáre, sú:

• Obsah
• Data
• Kože

Budeme pokrytie týchto podadresárov neskôr, a ktoré vám pomôžu pochopiť ich užitočnosť. Pre túto chvíľu by sme mali spomenúť ďalšie podporné súbory, ktoré sú tiež zahrnuté vo nadradeného adresára, ktoré zahŕňajú:

• Default.js
• Default.mcwebhelp
• Default.xml
• Default_CSH.htm
• Default_Left.htm

Deafult.js
Tento súbor obsahuje inštrukcie týkajúce JavaScript do východiskového bodu / default tému systému Pomocníka. Obsahuje tiež poznámky (ktoré boli komentované v kóde tohto súboru) vzťahujúce sa na ID, Skin Meno, vyhľadávacieho dotazu a prvý pick behu knihy.

POZNÁMKA: Ak premenujete default / východiskom systému Pomocníka, musíte upraviť riadok položku v Default.js súboru, aby zodpovedal novým názvom. Osobitná položka v otázke v súbore Default.js je číslo riadka 54, ktorý zobrazuje ako:

var gHelpSystemName = "default.htm";

Takže ak ste sa premenovať predvolený východiskovým bodom systém pomocníka od default.htm na index.htm, budete musieť upraviť riadok číslom 54 na Default.js takto:

var gHelpSystemName = "index.htm";

Uložte zmeny v súbore Default.js.

Default.mcwebhelp
To je WebHelp třeštidlo súbor, ktorý nesmie byť editované.

Default.xml
Tento súbor XML obsahuje inštrukcie pre nastavenie východiskovej / default tému kedykoľvek spustiť kniha je prvýkrát zahájený. To tiež určuje umiestnenie a názov súboru Obsah, Register, Koncepty, Slovník, hľadanie databázy, Alias, synoným a kože.

Default_CSH.htm
HTML súbor obsahujúci nastavenia, ktoré by nemali byť editované.

Default_Left.htm
Tento súbor HTML obsahuje kód pre TOC, ktorý sa zobrazí na ľavej strane online systému pomocníka a slúži k navigácii od témy k téme kliknutím na jednotlivé záznamy TOC.

Teraz, keď sme zaviedli rôzne súbory v nadradenom adresári, nech to obrátiť svoju pozornosť na tri podadresára, ktoré boli predtým uvedené:

Obsah zložky
Obsah priečinka obsahuje HTML súbory každého z jednotlivých tém Pomocníka systému. Okrem týchto HTML súbory, adresáre obsahu obsahuje prostriedky (obrázky a štýly), SkinSupport (editovateľné JavaScript súborov, ktoré podporujú pomoc systémy pokožky, a Slovníček súbor.

Data zložky
Zložka Data obsahuje súbory týkajúce sa údajov v systéme nápovedy. Tieto dáta sú využívané na zostavenie a zobrazenie nápovedy v uplatniteľné módy. Jeden taký súbor sa nachádza v zložke Data, ktorá je dôležitá, je Toc.xml súbor. Môžete vykonať zmeny v TOC (Obsah) v systéme nápovedy zmenou Toc.xml súboru. Budeme pokrývať revízia TOC v ďalších témach.

Skin zložky
Zložka Skin obsahuje súbory, ktoré sú používané pre kožu systému pomocníka. Skin definuje farieb, písiem a grafiky sa podieľajú na prezentácii systému Pomocníka. Okrem adresára Skin existujú Skin súvisiacich súborov obsiahnutých v dátových a obsahových zložiek.