Pentru a crea un fișier de referință, trebuie mai întâi să pregătiți fișierele de conținut, partiții și proiecte. Fișierul de conținut este stocat în format ASCII și definește structura și aspectul fila Cuprins. Fișierul secțiunii conține text și grafică, din care este compus documentul final. În cele din urmă, fișierul proiectului combină secțiunile și fișierele de conținut, precum și toate celelalte fișiere incluse în proiect. De asemenea, definește aspectul, aspectul și plasarea ferestrei de ajutor la pornire.
Atunci când proiectați un fișier de conținut, merită să scrieți identificatorii și anteturile secțiunilor. Elementele de identificare a partițiilor sunt utilizate de compilatorul de ajutor pentru a "asambla" fișierul de referință cu aplicația. Ele pot fi utile când creați note de subsol într-un fișier de secțiune. Să începem cu fișierul de conținut:
Testați fișierul de ajutor rezultat
Primul fișier de conținut este gata, puteți trece la fișierul de partiție. Sper că vă amintiți să scrieți identificatorii și anteturile secțiunilor - acestea vor fi necesare atunci când creați note de subsol în secțiunea fișier. Dacă nu le-ați înregistrat, faceți-o acum.
Rulați comanda Fișier | Nou în Atelierul de ajutor.
Să ne oprim și să vedem ce am făcut. În primul rând, am creat un titlu - pe acesta utilizatorul determină ce se discută în această secțiune. În acest exemplu, secțiunea este despre crearea unui fișier de conținut. Apoi am introdus textul principal al secțiunii. În această etapă, puteți crea imagini și linkuri grafice (această caracteristică nu este utilizată în fișierul nostru de referință). Dacă sunteți interesat de acest subiect, în documentația Ajutor Online Workshop veți găsi mai multe informații decât exhaustive.
Următoarele sunt regulile de bază pentru includerea notelor de subsol în subiectele de ajutor:
Asigurați-vă că vă salvați lucrarea înainte de a introduce o secțiune nouă. Acum cunoașteți principiile de bază ale notelor de subsol și putem finaliza crearea unui fișier de referință:
- Introduceți pauza de pagină "greu" la sfârșitul secțiunii apăsând CTRL + ENTER. Înainte de a introduce o partiție nouă, trebuie să terminați pauza de pagină anterioară. Datorită acestui fapt, fiecare secțiune va începe cu o nouă pagină.
- Introduceți următorul text:
Adăugați titluri
Pentru a adăuga titluri, utilizați butoanele Adăugați mai sus și Adăugați mai jos. Când se afișează caseta de dialog Edit File Entry Tab, faceți clic pe butonul radio Heading și apoi introduceți o descriere pentru antet.
Utilizând titlurile, puteți clasifica secțiunile unui fișier de referință. De exemplu, acest fișier are trei antete - unul pentru fiecare etapă a lucrării pe fișierul de referință. În fiecare titlu adăugăm secțiuni care descriu operațiile individuale care alcătuiesc diferitele etape.Creați fișierul de proiect
Ultima componentă a fișierului de referință este fișierul proiectului. Definește diferitele caracteristici ale fișierului de referință, conține legături către fișierul secțiunii și fișierul de conținut și alte informații necesare pentru a construi fișierul de referință.
În atelierul de ajutor, faceți clic pe Fișier | Nou. Selectați linia Conținut ajutor și faceți clic pe OK.
Introduceți numele fișierului de ajutor în câmpul Ajutor fișier. În exemplul nostru, a fost utilizat numele Skill11.hlp.Creați fișierul de proiect
Setați parametrii proiectului
Faceți clic pe butonul Opțiuni pentru a specifica diferite setări ale proiectului.
Introduceți descrierea fișierului de ajutor în câmpul Help Title.
Selectați caseta de selectare Personalizată și caseta de selectare Compresie în hol. Aceasta oferă, de asemenea, posibilitatea de a căuta după cuvinte cheie în fișierul de referință.
Selectați din prima listă fișierul de partiție creat anterior (în format RTF). În câmpul Cuprins, introduceți numele fișierului de conținut.Setați parametrii proiectului
Adăugați fișiere la proiect După setarea parametrilor proiectului, trebuie să adăugați fișiere de partiții și de conținut, precum și grafică.
Adăugați fișiere la proiect
Definirea opțiunilor ferestrei
Faceți clic pe butonul Fereastră. În caseta de dialog Proprietăți ferestre, faceți clic pe butonul Adăugați. Introduceți numele stilului ferestrei și specificați faptul că fereastra ar trebui să fie creată pe baza ferestrei standard a procedurii.
În final, închideți caseta de dialog cu butonul OK.Definirea opțiunilor ferestrei
Salvați și compilați proiectul
Înainte de a trece mai departe, trebuie să salvați proiectul și fișierul de conținut. Pentru a face acest lucru, puteți face clic pe butonul Salvați și compilați în partea de jos a casetei de dialog a proiectului.
Compilatorul de ajutor procesează fișierele de secțiuni, conținut și proiect. Rezultatele sunt afișate în fereastră. Dacă compilația a trecut fără erori, puteți trece la testarea fișierului de ajutor.Salvați și compilați proiectul
Testați fișierul de ajutor rezultat Când totul funcționează corect, fișierul de ajutor poate fi conectat la aplicație.
Testați fișierul de ajutor rezultat
Tocmai ați creat primul fișier de partiție. Rețineți - acesta a fost un fișier normal, care arată doar o schemă generală de acțiuni. După ce introduceți toate secțiunile și notele de subsol, acest proces va rămâne în memorie pentru o perioadă lungă de timp. După cum știți, practica este cel mai bun profesor. Să trecem la etapa finală de lucru pe un fișier de referință - crearea unui fișier de proiect.
Pentru a asocia fișierele și partițiile de conținut, trebuie să creați un fișier de proiect:
Fișierul de referință trebuie testat imediat pentru a vă asigura că funcționează bine. Pentru aceasta, urmați acești pași:
Asta e tot ce trebuie să faceți pentru a crea cel mai simplu fișier de referință. Deschideți fișierul Skill11.hlp rezultat de fiecare dată când aveți nevoie pentru a crea un fișier de ajutor în formatul HLP.
- Creați un nou proiect standard EXE în Visual Basic.
- Setați proprietatea Nume din Form1 la frmMain. iar proprietatea Caption este valoarea aplicației cu ajutor.
- Faceți clic dreapta pe linia Project1 din fereastra proiectului și selectați Project1 Properties din meniul contextual.
- În caseta de dialog Proprietăți proiect, în câmpul Ajutor fișier, tastați numele fișierului de referință din exemplul anterior, apoi faceți clic pe OK.
- Creați un element de meniu din formular și adăugați următoarele elemente și comenzi:
Puteți conecta fișierul de ajutor HLP în Borland Delphi 7 în mai multe moduri.
Prima cale este implementată prin utilizarea ShellAPI (deci mai întâi trebuie să o conectați la modul), de exemplu, după cum urmează:
A doua cale. După crearea fișierului * .hlp, atribuiți-i numele proprietății ApplicationFile a obiectului Application. Acest lucru se poate face numai în timp ce programul se execută (de exemplu, în modulul de gestionare a evenimentului OnCreate al formularului). Pentru aceasta, introduceți un operator în dispozitivul de tratare, similar cu următoarele:
Pentru a atribui un anumit subiect de ajutor unui anumit obiect sau formular de aplicație, aveți nevoie de următoarele:
O altă modalitate de a ajunge la subiect este să folosiți metoda HelpJump, care trebuie să treacă ca parametru un șir de tip sensibil la context:
În funcție de faptul dacă obiectul Application are un fișier Ajutor asociat, metoda HelpJump returnează True sau False. Folosind această caracteristică, putem afișa un mesaj de eroare dacă HelpJump returnează False:
Handlerul evenimentului OnClick