Princip:
Spusti Little help
Otevři si v editoru hlavičkový soubor, ke kterému chceš psát help.
Vyplň údaje v hlavním formuláři.
Stiskni tlačítko pro doplnění funkcí, promněných nebo událostí.
Přes schránku z editovaného hlavičkového souboru přenes název funkce do editačního pole
Stiskni Add
Přes schránku přenes popis do pole Introduce, když sis nic nenapsal, tak si napiš
Uprav text
A tak pokračuješ až máš vše, nezapomeň vždy při zadání nové fce stisknout Add ať se nepřepisuje Introduce k fci předchozí
Uzavři okno funkcí, promněných nebo událostí
Stiskni Export HTML
--- Zapíše se ini soubor (případně se zeptá na jméno) a vygenerují se v místě ini souboru html dokumenty. Pro spuštění slouží ten co má čistě název stejný s textem v poli Class
Hlavní dialog
Jednotlive editařní pole vyplň dle libosti. Pokud není pole vyplněno, není zapisováno do exportu (HTML).
Pole "Class" je povinné (nemusí to být nutně třída) - řídí se jím název souboru.
- kde jaké pole se vypisuje při exportu je nejlepší se podívat v exportovaném HTML dokumentu.
Pokud se ti nelíbí názvy polí (Header file,Library,Place in library,Class), tak na dvojklik na názvu je mozné je změnit.
Názvy tlačítek (Functions, Properties, Events), je mozné změnit pravým tlačítkem myši. Tyto názvy jsou použity jako názvy odkazů a doplněk názvu souboru. Proto NEPOUŽÍVEJ diakritiku a mezery, na lokale by ti to chodile, ale na webu ne :(.
-Menu Open otevře ini soubor.
-Menu Save uloží ini soubor.
-Menu ExportHtml(stejně jak tlačítko) uloží ini soubor a vygeneruje HTML dokumenty v místě ini souboru.
-Menu Open Macro menu (nebo Ctrl J) otevře PopupMenu pokud je aktivní pole Introduce. Toto menu umožňuje vložit jednořádkový template. Tyto template jsou uloženy v souboru template.ini. První template by měl být vždy <HTML>, protože přidává řádek.
Tři tlačítka v levo dole otvírají jednotlivé definice funkcí, promněných apod.
CheckBox NO proporcial font, nemá vliv na výsledný dokument, jen přepíná font pole Introduce.
Dialog funkcí, promněných, eventů
Add - přidá novou položku (funkci apod.).
Rename - přejmenuje aktuální vybranou položku na název v editačním řádku.
Delete - vymaže aktuální položku, včetně komentářů k této položce.
Up,Down - přesouvají aktuální položku (funkci apod.).
Pravým tlačítkem na položce je možné zkopírovat název položky do příkazového řádku.
Při aktivním poli Introduce pomocí stisku Ctrl+J je možné vyvolat nabídku předdefinovaných template.
Tip
Pokud jsi si jednou již jednou něco napsal a přejmenoval sis některé věci, tak si soubor zkopíruj případně vyprázdni a používej ho jako svůj předdefinovanou šablonu.
Stejně tak když píšeš help k nějakému potomku tak si zkopíruj ini soubor předka a jen doplň nové fce.
ALE POZOR před exportem html si vždy přejmenuj pole Class, ať si nepřepíšeš již vygenervané dokumenty. A když se to stane, tak otevři ini soubor přepsaných dokumnetu a z novu je přegeneruj.
Popis dialogu
Add - přidává vybraný soubor, vygenerovaný pomocí Little Help (případně jiný, čti Tip 2). Zadávej všechny včetně funkcí apod. .Pomocí CheckBoxu označíš, které se mají zobrazit v indexu (většinou, jen ty hlavni bez dodatku _functions apod.). POZOR přidávané musí být v adresářové struktuře ve stejné úrovni kde bude index nebo hlouběji - nesmí být nad ním.
Remove - vyjme vybraný soubor v horním poli.
Reset to template - při otevření jednou již generovaného indexu se při ukládání nemění kod HTML indexu dokumentu (jen označená část), takže si tam můžeš dopisovat co chceš. Tato funkce zruší vazbu na tento dokument, ale zanechá veškerý výběr. Při uložení bude vzat jako template tebou vybraný.
New - nový soubor
Open - otevře html dokument generovaný z tohoto programu (jmena souborů jsou tam definovány f poznámce).
Save - uloží html dokument ze všemi informacemi.
Up,Down - přesouvá soubory pro index
Sort - setřídí soubory pro index dle abecedy, ale pozor smaže všechny dopsané komentáře a odznačí všechny již označené indexy. Vhodné pro použití bezprostředně po nasázení souborů.
Tip
Fulltext pracuje korektně jen v IExploreru 5 a víc a jen z lokálního disku - NE z webu. A pod Netscape spíš nedělá nic.
Proto je tam už připravený soubor i pro web, Netscape(testováno ve verzi 4.51) nebo IE4 (IE3 jsem nezkoušel) - bez full text vyhledávání.
Tip 2 - pro aplikaci na již vytvořené html dokumenty (ne v LittleHelp)
Standardně je nastaveno že v souborech vyhledává tyto řetězce:
<li><a - pro určení začátku pro zařazení do klíče hledaných slov
> - ukončení začátku tagu, tag musí obsahovat href=", target je ignorováno, ukončení adresy musí být provedeno "
</a></li> - ukončení klíče
Je možno odstranit např tag <li></li> a tak budou vyhledány všechny odkazy
Je možné vyřadit adresy začínající na ... , tento řetězec musí následovat bezprostředně za " aby byla adresa ignorována
Je možné vyřadit adresy které mají mezi <a> a </a> text ..., tento text musí následovat bezprostředně za ukončením tagu, aby byla adresa ignorována
Tyto promněné je možno přestavit v souboru "setfind.ini"
POZOR - může se vyskytnout problém s uvozovkami, pokud jsou v html dokumentu mezi <a> a </a> a nejsou korektně zapsány ". To je potom musíš opravit, jinak bude generována při spuštění indexu chyba javacriptu
Rozpis jednotlivých template:
find_fulltext.html - kompletní vyhledávání včetně fulltextového (pro lokální použití pod IE5 a výš)
find_IE5.html - vyhledávání bez fulltextu pro prohlížeče podporující "iframe" (Netscape 4.51 nepodporuje), zádrhel je, že není možné se vrátit ze světa a je nutné znovu vyhledávání aktivovat.
find_IE5_cz.html - to stejné, jen počeštěné.
find_netscape.html - vyhledávání bez fulltextu, běžící na většině prohlížečů oproti následujícím je navíc možnost otevírání výsledku hledání v novém okně.
web.html - vyhledávání určené pro web
web_cz.html - vyhledávání určené pro web - počeštěné.
Domovská stránka autora (udělej kuk !!!)