| Opret din egen dokumentation |
| forrige | Udvidelse af Quanta Plus | næste |
Formodentlig de mest bemærkelsesværdige tilføjelser til Quanta Plus for den almindelige bruger, tilføjelse af dokumentation for de mærke- eller scriptsprog som er mest populære. Med dette formål, forklarer dette kapitel hvordan jeg laver PHP-dokumentationstræet til min egen personlige brug.
Inden du begynder på at oprette din egen dokumentation, vil du måske kigge på Quanta Pluss arkiv for at se om nogen allerede har lavet denne opsætning.
Der findes to dele i processen. Først skal du skaffe eksisterende dokumentation for mærkesproget, scriptsproget eller et andet sprog som du er ude efter. Derefter skal du oprette docrc-filen. Det første må du klare selv, det andet er hvad vi dækker her.
Den almindelige form for docrc-filen er følgende:
#KDE konfigurationsfil
[Tree]
Doc dir=søgesti, relativt til denne fil, for dokumentationens HTML-filer t.ex. php42/
#toppniveauelement
Top Element=Din beskrivelse af disse dokumenter t.ex. PHP 4.2 dokumentation
Section 1=Section1.html
Section 2=#Sec2.1,#Sec2.2,#Sec2.3
Sec2.1=Sec2.1.html
Sec2.2=Sec2.2.html
Sec2.3=Sec2.3.html
...
[Context]
ContextList=func1,func2,tag1,tag2,tag3
func1=func1.html
func2=func2.html
tag1=tag1.html
tag2=tag2.html
tag3=tag3.html
Filen docrc er opdelt i to afdelinger: Tree (træ) og Context (Sammenhæng).
Afdelingen Tree definerer præsentationsaspekter for dokumentet under dokumentationsfanebladet. Du ser for eksempel at i PHP-dokumentationen, har du noget som ligner dette:
Med reference til ovenstående, ser min PHP docrc sådan her ud:
#KDE indstillingsfil [Tree] Doc dir=php42/ #toppniveauelement Top Element=PHP 4.2 dokumentation PHP 4.2 dokumentation=Indholdsfortegnelse,#Kom i gang,#Sprogreference Indholdsfortegnelse=index.html Kom i gang=Indledning, ... Indledning=introduction.html ... Sprogreference=Grundlæggende syntaks, ... Grundlæggende syntaks=language.basic-syntax.html ...
Bemærk # foran “Kom i gang” og “Sprogreference”. Det angiver at disse er delindhold i træet og har deres eget indhold. Jeg tror ikke der findes en angiven grænse for dybde (bortset fra det som dikteres af sund fornuft) — brug din egen dømmekraft.
For indholdsfortegnelsen, ser du at den direkte refererer til en fil (og som en konsekvens, vises den længst ned i trævisningen, mapper kommer først).
Mellemrum påvirker ingenting negativt, men pas på med tegnene & og <. Disse skal formodentlig erstattes med & og < i alle Quanta Plus XML™-baserede ressourcefiler.
Sammenhængsafsnittet er afsnittet i docrc-filen som bruges til at muliggøre sammenhængsafhængig hjælp. Hvis du for eksempel skriver et PHP-script og vil se dokumentationen for funktionen mysql_fetch_array, markerer du helt enkelt funktionen og trykker derefter på Ctrl+H for sammenhængsafhængig hjælp. Dokumentationen om mysql_fetch_array vises umiddelbart. Der findes kun to typer af indgange her: sammenhængslisten og filassociationslinjerne.
Meget enkel. Dette er kun en liste af sammenhængsindgange adskilte af kommategn, som du vil have tilgængelige (for PHP er det funktionerne i PHP).
De er på formen sammenhængspunkt = HTML-dokumentside. F.eks. acos=function.acos.html.
En renset version af mit docrc sammenhængsafsnit ser ud som følger:
#Nøgleord for sammenhængsafhængig hjælp [Context] ContextList=abs,acos,acosh,addcslashes,addslashes,... abs=function.abs.html acos=function.acos.html acosh=function.acosh.html addcslashes=function.addcslashes.html addslashes=function.addslashes.html ...
Nu skal du blot gemme din docrc-fil. Gem den i $ eller HOME/.kde/share/apps/quanta/doc$ for henholdsvis lokal eller global brug. Opret derefter en mappe (den som angives i KDEDIR/share/apps/quanta/docdocrc-filen) i samme mappe som docrc-filen findes, og kopiér HTML-dokumentationssiderne derhen.
Du skal genstarte Quanta Plus, for at se din dokumentation.
decimaltalr sikker på at de er gode, og værd at dele, send så docrc-filen sammen med med en beskrivelse af passende information om hvilket dokument du brugte til Quanta Pluss arkiv til brug for Quanta Plus' brugere. Du bliver ikke rig, men du føler dig godt tilpas ved at vide at du bidraget til det bedste internetudviklingsmiljø som findes.
| forrige | hjem | næste |
| Opret værktøjslinjer | op | Del ressourcer |