Hvordan skrive HTML-hjelpefiler for Delphi.Writing HTML-hjelp filesby Vegard A. Larsen (opprinnelig skrevet for UNDU, Unofficial nyhetsbrev for Delphi brukere, tilpasset www.HowToDoThings.com) Etter at jeg hadde skrevet søknaden Diary Defender jeg føler behov for å skrive en anstendig hjelpefilen for å gå med pakken. Vel, jeg gjorde det jeg alltid gjør, som jeg er en freeware utbygger, som opererer med nesten ingen penger tilgjengelig. Jeg fant ut som hjelp til å skrive programmer eksisterte, og sjekket om noen av dem var freeware. Vel, som det viser seg, det nærmeste jeg fikk var HelpScribble, som er shareware. På den siden jeg la merke til HTML Help Workshop, fra Microsoft, som var faktisk gratis. Dette er det som normalt har vært brukt som kompilatoren for disse tredjeparts hjelpe forfattere, men som jeg nå så, det var ikke mulig å skrive hjelpefiler med bare dette verktøyet. Noen av dere har kanskje hørt om Help Workshop, som gjør nesten det samme, bare for normal hjelp (HLP) filer. Etter hva jeg husker, var dette svært komplisert, og det var la ned dårlig av dokumentasjon (og hei: dette er en hjelp forfatter program) .Vel, bestemte jeg meg for at det skal være mulig å skrive denne hjelpefilen bare ved hjelp av HTML Help Workshop og en HTML editor. Jeg rolig satte meg ned og lese gjennom hjelpefilene som fulgte med det, men denne gangen også, ingen tutorial var tilgjengelige (skam deg, Microsoft!). Så det var da jeg bestemte meg for å skrive denne artikkelen. Jeg har besluttet å gjøre dette så enkelt som mulig, som hjelp til å skrive er ikke alltid så lett som det seems.What du trenger før du begynner: HTML Help Workshop, En anstendig HTML editor (eller du kan bruke Notepad hvis du er talentfull nok)). For å komme i gang, anbefaler jeg at du tilordne en egen katalog for denne opplæringen. Lag din første HTML-fil (jeg anbefaler det å være velkommen /innholdssiden) og lagre det i denne katalogen. Jeg ringte min welcome.htm. Etter at du har rett og slett skapt siden (det trenger ikke å inneholde noe, bare trengte < BODY >, < HTML >, og lignende koder for det å være en komplett HTML-fil). Fyr opp HTML Help Workshop (fra nå av: HHW). Velg Fil, Ny, og deretter Project. Hopp i det første skjermbildet ved å klikke på Neste, og angi hvor du vil at hjelpefilen som skal opprettes (bruk samme katalogen du opprettet ovenfor). Klikk på Neste, og velg den siste boksen (HTML-filer), og klikk på Neste igjen. Legg inn HTML-fil, og klikk på Neste og deretter Fullfør. Du vil nå bli brakt til hovedvinduet i HHW, var du skal tilbringe mye tid fra nå av. Under [FILES] seksjonen i den venstre rammen, kan du se at HTML-filen du opprettet tidligere er til stede. Du må legge alle HTML-filene i prosjektet til denne delen, og dette gjøres ved å klikke på den andre knappen, regnet fra toppen. Nå klikker du på kategorien Innhold av HHW. Velg Opprett en ny innholdet fil når du blir spurt, og klikk OK. Lagre den i samme katalog som før (jeg kommer til å anta at du har forstått dette fra nå av) .Du vil se en helt tom liste, og dette er hva vi kommer til å endre neste. Høyreklikk i det tomme listeboksen og klikk på Sett inn emne. I Entry Tittel redigeringsboksen, skriv hva du vil (" Velkommen " ville være passende), og klikk på Legg til. Velg den eneste filen i listen (det vil bli oppført med samme navn som du oppgav i HTML < title > tag), og klikk på OK to ganger. Nå har du ett element i listen. Nå, klikk på fanen Index of HHW, og velg Opprett en ny indeks fil når du blir spurt. Du vil se en ny tomt listeboksen. Jeg skal fylle ut dette i grunn time.Now du kan begynne å lage andre HTML-fil (og din tredje, fjerde ...). Legg dem til i listen prosjektfilen (andre knappen fra toppen). Du trenger ikke å lage alle filene før du begynner å bygge filen, det er ofte en god idé å legge en fil om gangen til prosjektet, med komplett søkeord og ble de er ment å være på listen innholdet. Når du har opprettet og lagt til en eller to filer mer, flytte tilbake til fanen Index. Høyreklikk og velg Sett inn søkeord. Skriv inn søkeordet, og klikk deretter Legg til. Du kan knytte flere filer med ett søkeord. Legg til flere søkeord som du går. Du kan også opprette under stikkord, ved å opprette en normal søkeord, og flytte den ved hjelp av piltastene (på verktøylinjen) .Kjør tilbake til kategorien Innhold. Legg Tema og innhold for de filene du ønsker å bruke. Du kan flytte disse på samme måte ved hjelp av verktøylinjen pilen buttons.Although dette er ikke en veldig grundig tutorial på hvordan å skrive hjelpefiler, føler jeg det dekker det du trenger å vite når du er i ferd med å dokumentere programmet. Eksperimentering er ikke en dårlig ting, spesielt med en dokumentasjon som aldri plager å lære brukerne grunnleggende HTML-hjelp skriftlig. Dokumentasjonen av HHW har fått en enkel del (for eksempel " designe et hjelpesystem ") og en over-tekniske delen (" HTML-hjelpe Referanser "). Anyhow, er HHW ikke et dårlig program, er det rett og slett la ned ved det er dokumentasjon, og du vil merke dette når du blir vant til det grensesnittet. Håper du likte denne mini-tutorial.Microsoft måtte endre API brukes til å få tilgang til hjelpefunksjoner når de skapte HTML-hjelp (HH) system, og derfor gjennomføringen av hjelp i Delphi har blitt noe ugyldig. For å komme rundt dette problemet jeg lastet ned et gratisprogram kit fra www.helpware.net. Det er ment for å gjøre prosessen med å implementere en HH-fil inn din søknad en breeze.When jeg først så på dokumentasjonen for dette settet, så jeg at alt som kom sammen med det var en enkel tekstfil. Men jeg skjønte raskt at det var den eneste dokumentasjonen som trengs. I denne artikkelen, jeg kommer til å sette fokus på funksjon Htmlhelp, som brukes for å få opp en HH vindu som viser hvilket som helst tema du ønsker. Temaene er funnet ved hjelp av filnavnet på emnet du ønsker å ta opp, f.eks hvis en av filene i HH filen heter " versionhistory.htm ", følgende samtalen vil få opp HH filen med versjon historie emne: Htmlhelp (GetDesktopWindow, 'C: \\ help.chm :: /versionhistory.htm ', HH_DISPLAY_TOPIC, 0), kan GetDesktopWindow erstattes av en enkel, 0, men det Helpware Group anbefaler bruk av GetDesktopWindow. Husk eksempelet ovenfor er en dårlig måte å gjøre det, du må ha en variabel bane til filen (ikke bruk Application.HelpFile direkte).