ZaΦßteΦnφk

PokroΦil²

Profesionßl

 

Budete pot°ebovat p°ibli₧n∞ 1 hodinu

OperaΦnφ systΘm pou₧it² v p°φsp∞vku: Windows XP

V²vojovΘ nßstroje: Visual Studio .NET, VSHIK

 

Vß₧enφ Φtenß°i,

 

dovolte mi, abych vßs p°ivφtal p°i poslednφm dφlu serißlu Pr∙vodce tvorbou nßpov∞dy. Kdy₧ se tak ohlφ₧φm zp∞t, musφm p°iznat, ₧e v zaΦßtcφch tvorby tohoto serißlu jsem ani v nejmenÜφm netuÜil, ₧e se tento rozroste do tak ob°φch rozm∞r∙. Informacφ, kterΘ serißl poskytnul, bylo opravdu hodn∞ (dohromady p°es 200 tisφc znak∙ bez mezer). SpoleΦn∞ jsme probßdali tajemnß zßkoutφ nejen nßpov∞dy stylu Windows 95 (WinHelp 4.0), n²br₧ i pokroΦilejÜφ HTML nßpov∞dy. V dneÜnφ Φßsti naÜφ pou¥ ukonΦφme, no jeÜt∞ p°ed tφm se podφvßme na zßkladnφ koncepci nßpov∞dy änovΘ generaceô, kterß je spoleΦnostφ Microsoft zatφm pracovn∞ oznaΦovßna jako MS Help 2.0 (n∞kde se m∙₧ete st°etnout i s pojmem HTML Help 2.0). Po p°elouskßnφ nezbytnΘ teorie se dostaneme i k vytvo°enφ jednoduchΘho souboru nßpov∞dy typu MS Help 2.0.

 

Obsah

Co budete pot°ebovat

P°ehled n∞kter²ch zm∞n, kterΘ p°inßÜφ nov² model nßpov∞dy

Struktura projektu nßpov∞dy MS Help 2.0

Tvorba nßpov∞dy MS Help 2.0: Krok 1 û Vytvo°enφ novΘho typu projektu (.HWProj)ááá

Tvorba nßpov∞dy MS Help 2.0: Krok 2 û P°idßnφ soubor∙ s tΘmaty (.HTM)

Tvorba nßpov∞dy MS Help 2.0: Krok 3 û P°idßnφ souboru s obsahem (.HxT)

Tvorba nßpov∞dy MS Help 2.0: Krok 4 û P°idßnφ souboru s rejst°φkem (.HxK)

 

 

Co budete pot°ebovat

 

Budete-li chtφt vytvß°et projekty a ostatnφ souΦßsti novΘ nßpov∞dy, bude pot°ebovat tzv. VSHIK, co₧ je zkratka pro Visual Studio .NET Help Integration Kit. Jde o sadu nßstroj∙, kterΘ se nainstalujφ do prost°edφ Visual Studia a dovolφ vßm vytvß°et projekty nßpov∞dy. Nejd∙le₧it∞jÜφm nßstrojem je Help Workshop, jen₧ vßm zp°φstup≥uje mo₧nost vizußlnφ editace nßpov∞dy p°φmo ve Visual Studiu .NET. Proto₧e program d∙sledn∞ napl≥uje myÜlenku komplexnφ integrace, od chvφle nainstalovßnφ se stane standardnφ souΦßstφ Visual Studia, a tedy ji₧ nebudete muset nßpov∞du vytvß°et v externφm prost°edφ, jak to bylo d°φve. Mφsto toho m∙₧ete vyu₧φt vÜech pozitivnφch vlastnostφ, kterΘ p°inßÜφ jednotnΘ integrovanΘ prost°edφ.

 

V prozatφmnφ (pre-release) verzi VSHIK Microsoft nßstroj na tvorbu nßpov∞dy stylu MS Help 2.0 pojmenoval jako Help Workshop. Neple¥te si prosφm uveden² nßzev se starÜφm programem pro generovßnφ nßpov∞dy stylu Windows 95 (jde takΘ o Help Workshop).

á

 

P°ehled n∞kter²ch zm∞n, kterΘ p°inßÜφ nov² model nßpov∞dy

 

Program Help Workshop, podobn∞ jako cel² systΘm novΘ nßpov∞dy, p°inßÜφ mnoho nov²ch prvk∙ a vlastnostφ. Zde jsou vyjmenovßny alespo≥ n∞kterΘ z nich:

 

 

ProjektovΘ soubory jsou od nyn∞jÜka zalo₧eny na standardu jazyka XML.

Nßpov∞du lze vytvß°et se ävÜφm vÜudy pod jednou st°echouô. Dovoluje to silnß integrace nßstroj∙ do IDE Visual Studia .NET.

Do nßpov∞dy se zavßd∞jφ prostory jmen (namespaces) a protokol ms-help. U₧ tedy nebude nutnΘ, abyste p°i volßnφ souboru nßpov∞dy museli znßt plnou cestu k souboru, bude staΦit, kdy₧ pou₧ijete platn² protokol a cφlov² jmenn² prostor.

DoÜlo k vylepÜenφ technologie informaΦnφch typ∙. TΘmat∙m nßpov∞dy lze p°i°adit identifikaci na zßklad∞ r∙zn²ch atribut∙, a tyto pak filtrovat libovoln²m zp∙sobem. Filtrovßnφ informacφ je nynφ mnohem ·Φinn∞jÜφ, jako tomu bylo u HTML nßpov∞dy. U₧ivatelΘ m∙₧ou dynamicky urΦovat obsah a rozsah po₧adovan²ch informacφ.

Jsou podporovßny mnohonßsobnΘ rejst°φky (multiple indexes). Pokud budete chtφt, m∙₧ete vytvo°it tolik instancφ rejst°φku, kolik budete pot°ebovat.

Byl vylepÜen i proces dekompilace, p°i kterΘm jsou vßm programem Help Workshop poskytnuty vÜechny nezbytnΘ zdrojovΘ soubory.

 

 

Struktura projektu nßpov∞dy MS Help 2.0

 

Projektov² soubor (.HWProj) novΘ nßpov∞dy obsahuje tyto typy soubor∙:

 

  1. XML soubory, popisujφcφ samotnou strukturu projektu (.HxC a .HxF).á
  2. Soubory slou₧φcφ pro navigaci v prost°edφ systΘmu nßpov∞dy. Zde pat°φ soubor s obsahovou strukturou nßpov∞dy (.HxT) a soubor s rejst°φkem (.HxK).
  3. Soubory s tΘmaty nßpov∞dy (.HTM), grafickΘ soubory (.JPEG, .GIF, .AVI, .WAV a dalÜφ, kterΘ jsou kompatibilnφ s prohlφ₧eΦem Internet Explorer verze 5.0), soubory se skripty a soubory s kaskßdov²mi styly (.CSS).

 

P°i procesu kompilace (obr. 1) program zpracuje vÜechny vstupnΘ soubory a vygeneruje z nich kompilovan² soubor nßpov∞dy MS Help 2.0. Tento soubor mß koncovku HxS.

 

 

Obr. 1 û Proces kompilace souboru nßpov∞dy MS Help 2.0á

 

 

Tvorba nßpov∞dy MS Help 2.0

Krok 1: Vytvo°enφ novΘho typu projektu (.HWProj)

 

Abyste vytvo°ili projekt nßpov∞dy stylu MS Help 2.0, ud∞lejte nßsledovnφ:

 

  1. Z nabφdky File vyberte polo₧ku New a klepn∞te na Project. V dialogovΘm okn∞, v sekci Project Types, poklepejte na polo₧ku Other Projects.
  2. PokraΦujte vybrßnφm slo₧ky Help Projects.
  3. V sekci Templates vyberte polo₧ku New Help Project.
  4. Zadejte jmΘno pro nov² projekt a aktivujte volbu Create directory for Solution. Okno by m∞lo nynφ vypadat jako na obr. 2.

 

 

Obr. 2 û V²b∞r novΘho projektu pro tvorbu nßpov∞dy

 

  1. Kdy₧ jste se vÜemi nßle₧itostmi spokojeni, aktivujte tlaΦφtko OK. á

 

Help Workshop vytvo°φ zßkladnφ strukturu projektu nßpov∞dy. Okno Pr∙zkumnφka °eÜenφ (Solution Explorer) by m∞lo mφt tuto podobu (obr. 3).

 

 

Obr. 3 û Podoba Pr∙zkumnφka °eÜenφ po vytvo°enφ projektu

áá

Jak si m∙₧ete vÜimnout, program vygeneroval dva soubory, Nßpov∞da_02.HxC a Nßpov∞da_02.HxF. Prvnφ soubor (.HxC) obsahuje odkazy na vÜechny projektovΘ souΦßsti nßpov∞dy, zatφmco druh² soubor (.HxF) sdru₧uje informace o souborech s tΘmaty, grafikou, rejst°φkem Φi obsahem.

 

UvedenΘ soubory jsou automaticky aktualizovßny v₧dy, kdy₧ ulo₧φte projekt s nßpov∞dou nebo provedete kompilaci nßpov∞dnΘho souboru.

 

 

Tvorba nßpov∞dy MS Help 2.0

Krok 2: P°idßnφ soubor∙ s tΘmaty (.HTM)

 

Budeme pokraΦovat p°idßnφm n∞kolika .HTM soubor∙, kterΘ budou p°edstavovat jednotlivß tΘmata nßpov∞dy. Pro p°idßnφ novΘ souΦßsti do stßvajφcφho projektu postupujte takto:

 

  1. Vyberte nabφdku Project a klepn∞te na polo₧ku Add New Item. Okam₧it∞ se objevφ dialogovΘ okno, kterΘ vßm dovolφ vybrat typ souΦßsti, kterou si p°ejete p°idat do projektu.
  2. V Φßsti Categories vyberte polo₧ku Help Workshop Topic Items.
  3. V sekci Templates oznaΦte ikonu HTMLFile a zadejte jmΘno pro vytvß°en² soubor.
  4. P°φklad dialogovΘho okna m∙₧ete vid∞t na obr. 4.

 

 

Obr. 4 û P°idßnφ .HTM souboru do projektu s nßpov∞dou

á

  1. Klikn∞te na tlaΦφtko Open.á

 

Vytvo°en² soubor se nßsledn∞ otev°e v integrovanΘm v²vojovΘm prost°edφ, kde jej m∙₧ete podle libosti dßle upravovat jak v re₧imu WYSIWYG, tak i pomocφ p°φmΘ zm∞ny HTML k≤du. Zkuste p°idat do projektu nßpov∞dy jeÜt∞ dva .HTM soubory. Okno Pr∙zkumnφka °eÜenφ by m∞lo mφt podobu, kterß je zobrazena na obr. 5.

 

 

Obr. 5 û Obsah Pr∙zkumnφka °eÜenφ po p°idanφ n∞kolika .HTM soubor∙

 

Pokud jste hotovi, m∙₧eme p°ikroΦit k tvorb∞ obsahovΘ struktury (angl. TOC, Table Of Contents) nßpov∞dy.

 

 

Tvorba nßpov∞dy MS Help 2.0

Krok 3: P°idßnφ souboru s obsahem (.HxT)

 

  1. Z nabφdky Project vyberte polo₧ku Add New Item.
  2. V dialogovΘm okn∞ vyberte slo₧ku Help Workshop Project Items.
  3. V sekci Templates vyberte ikonu Table of Contents (obr. 6).

 

 

Obr. 6 û Tvorba souboru s obsahem (HxT)

 

  1. Soubor pojmenujte a klepn∞te na tlaΦφtko Open.

 

Help Workshop vytvo°φ soubor s obsahovou strukturou a ihned jej otev°e pro editaci (obr. 7).

 

 

Obr. 7 û Podoba TOC po vytvo°enφ souboru s obsahem

 

V obsahovΘ struktu°e se nachßzejφ jenom jeden uzel s nßzvem Global TOC. Tento definuje vlastnosti pro celou stromovou strukturu obsahu. P°φstup k t∞mto vlastnostem zφskßte, kdy₧ klepn∞te na polo₧ku Global TOC prav²m tlaΦφtkem myÜi a z kontextovΘ nabφdky vyberete polo₧ku Properties. V okn∞ Properties se zßhy objevφ vlastnosti, kterΘ m∙₧ete modifikovat. Jde o tyto vlastnosti: Font, FontSize, CharacterSet, IconFile, IconScheme, ID, Language a Version.

 

Abyste mohli vytvo°it polo₧ky obsahu pro jednotlivΘ soubory s tΘmaty, prove∩te toto:

 

  1. OznaΦte polo₧ku New Topic a p°ejmenujte ji na äObsahô. Polo₧ku snadno p°ejmenujete tak, ₧e v okn∞ Properties zm∞nφte jejφ vlastnost Title. á
  2. Otev°ete nabφdku TOC a klepn∞te na polo₧ku Add Blank Node.
  3. Novou polo₧ku pojmenujte jako äTΘma1ô.
  4. Do vlastnosti URL polo₧ky TΘma1 zadejte nßzev souboru s tΘmaty (.HTM), kter² se pozd∞ji bude zobrazovat v₧dy, kdy₧ u₧ivatel klepne na tuto polo₧ku.

 

P°i zadßvanφ jmΘna souboru s tΘmaty (.HTM) do vlastnosti URL polo₧ky obsahu musφte za jmΘnem souboru zapsat i teΦku a platnou souborovou p°φponu, tedy nap°. Soubor_01.htm.

á

  1. Zopakujte uveden² postup pro p°idßnφ dalÜφch polo₧ek do obsahovΘ struktury nßpov∞dy. Po skonΦenφ by m∞l mφt obsah nßpov∞dy podobu uvedenou na obr. 8.

 

 

Obr. 8 û Ukßzka TOC po p°idßnφ dodateΦn²ch polo₧ek

 

  1. Klepn∞te na polo₧ku s nßzvem TΘma1 prav²m tlaΦφtkem myÜi a z kontextovΘ nabφdky vyberte p°φkaz Move Node Right. Po provedenφ p°φkazu si m∙₧ete vÜimnout, ₧e se odehrßlo n∞kolik udßlostφ. P°edem, polo₧ka se posunula sm∞rem doprava a doÜlo tak k vytvo°enφ samostatnφ hierarchickΘ ·rovn∞ stromovΘ struktury. DalÜφ d∙le₧itou skuteΦnostφ je, ₧e k polo₧ce Obsah se p°idala ikona knihy a z tΘto polo₧ky se stal tematick² celek. V²sledkem je tedy vytvo°enφ samostatnΘho tematickΘho celku Obsah, jen₧ obsahuje jedno tΘma (TΘma1). Situaci lze pozorovat na obr. 9.

 

 

Obr. 9 û Posun polo₧ky obsahu a vytvo°enφ tematickΘho celku

 

Abyste mohli rychleji posouvat polo₧ky obsahovΘ struktury, pou₧ijte tlaΦφtko se Üipkou , kterΘ se nachßzφ na panelu nßstroj∙ TOC Editor. Nevidφte-li tento panel, vyberte nabφdku View, uka₧te na polo₧ku Toolbars a zaÜkrtn∞te volbu TOC Editor.

 

  1. PokraΦujte tφm, ₧e posunete i polo₧ky TΘma2 a TΘma3 sm∞rem doprava, Φφm₧ je takΘ za°adφte do vytvo°enΘho tematickΘho celku.
  2. Ulo₧te projekt, prove∩te jeho sestavenφ a spus¥te jej (obr. 10).

 

 

 

Obr. 10 û Nßpov∞da MS Help 2.0 v akci

áá

Po ·sp∞ÜnΘ kompilaci projektu nßpov∞dy a vÜech ostatnφch nezbytn²ch souΦßstφ je vytvo°en jedin² soubor nßpov∞dy (HxS), nßpov∞da je zaregistrovßna v systΘmu a zobrazena v integrovanΘm prohlφ₧eΦi. Jestli₧e poklepete na polo₧ku Obsah, zp°φstupnφ se vÜechna tΘmata, kterß jste vytvo°ili. Kliknete-li na nßzev tΘmatu, jeho informaΦnφ obsah se zobrazφ v pravΘ Φßsti okna prohlφ₧eΦe. V²born∞, prßv∞ jste vytvo°ili svou prvnφ nßpov∞du novΘ generace.

 

 

Tvorba nßpov∞dy MS Help 2.0

Krok 4: P°idßnφ souboru s rejst°φkem (.HxK)

 

Sestavenφ rejst°φku je, ve srovnßnφ s tvorbou obsahovΘ struktury, o n∞co slo₧it∞jÜφ. V nßsledujφcφm p°φkladu se pokusφme stßvajφcφ projekt nßpov∞dy opat°it jednoduch²m rejst°φkem. Postupujte dle uveden²ch instrukcφ.

 

  1. Otev°ete nabφdku Project a klepn∞te na polo₧ku Add New Item.
  2. Vyberte ikonu Keyword Index, zadejte jmΘno pro rejst°φk a aktivujte tlaΦφtko Open. InicializaΦnφ podobu XML dokumentu pro rejst°φk zobrazuje obr. 11.

 

 

Obr. 11 û PoΦßteΦnφ schΘma XML podoby rejst°φku

ááá

  1. Aby rejst°φk obsahoval klφΦovß slova pro t°i tΘmata, upravte jeho podobu tak, jak ji vidφte na obr. 12.

 

 

Obr. 12 û V²slednφ XML podoba rejst°φku

 

Pokud provedete rekompilaci souboru nßpov∞dy, uvidφte, ₧e rejst°φk plnφ svou funkci znamenit∞ (obr. 13).

 

á

Obr. 13 û V²slednφ podoba rejst°φku nßpov∞dy

 

 

Na zßv∞r bych rßd p°ipomenul, ₧e v²sledn² soubor nßpov∞dy MS Help 2.0 lze v dob∞ psanφ tohoto Φlßnku prohlφ₧et jenom integrovan²m prohlφ₧eΦem Visual Studia (abstrahuji od r∙zn²ch sharewarov²ch Φi jin²ch utilit podobnΘho typu). OstrΘ verze novΘ nßpov∞dy, p°φsluÜn²ch nßstroj∙, exekuΦnφ kni₧nice a dalÜφch softwarov²ch souΦßstφ, kterΘ budou dovolovat spouÜt∞t nßpov∞du MS Help 2.0 odkudkoliv, by m∞ly b²t (alespo≥ podle redmonÜtφch v²vojß°∙) dostupnΘ n∞kdy v roce 2003.

 

 

V∞°φm, ₧e serißl o nßpov∞d∞ vßm byl v mnoha ohledech u₧iteΦn² a pomohl vßm vy°eÜit, kdy₧ u₧ ne vÜechny, tak alespo≥ v∞tÜinu vaÜich änßpov∞dnφchô problΘm∙.

 

Jßn Hanßk