Tilrettelegging av emacs-info-sider

Enkelte applikasjoner (særlig GNU applikasjoner) har medfølgende dokumentasjon i emacs-info-format. Denne dokumentasjonen består av filer som ender på .info, .info-1, .info-2, etc, og ender som oftest opp i /store/info-katalogen når ``make install'' har gjort seg ferdig.

For at disse filene skal dukke opp i info-menyene vi ser i f.eks. XEmacs og Emacs, må vi lage en liten fil som inneholder et meny-entry. Denne filen skal være navngitt på formen

<navn>.dir.<doktype>

og befinne seg under /store/info. Navn er her navnet på dokumentasjonen (f.eks. bash eller gcc). Doktype forteller hvilket emne dokumentasjonen inneholder. Dette benyttes for å plassere meny-entryet på en fornuftig plass i menyen, og kan ha følgende verdier:

emacs: Benyttes for dokumentasjon som omhandler bruken av Emacs/XEmacs.
elisp: Benyttes for emacs-lisp-dokumenasjon.
packages: Benyttes for dokumentasjon som omhandler bruken av en tillegspakke til emacs (f.eks. AUC-TeX eller GNUS).
compilers: Benyttes for dokumentasjon til kompilatorer eller utviklingsverktøy (f.eks. GCC eller Make).
library: Benyttes for dokumentasjon som omhandler diverse biblioteker (f.eks. Libg++ eller Mmalloc).
standard: Benyttes for dokumentasjon av diverse standarder og formater (f.eks. GNU coding standards).
program: Benyttes for dokumentasjon av andre programpakker (f.eks. Bash og Zsh).

For å lage en meny-entry for Bash, lager vi f.eks. en fil ``info/bash.dir.program'' i bash-filsettet som inneholder følgende tekst: * Bash: (bash). Bourne Again Shell Dette fører til at linjen dukker opp under overskriften; ``Other programs and packages'' neste dag (etter at nightly-jobbene til Emacs eller XEmacs har kjørt).

Mulig forslag til meny-entry

Mange dokumentasjoner på info-format inneholder selv forslag til hva som burde stå i meny-entryen. Disse forslagene kan i så fall finnes mot toppen av den aktuelle info-filen. Flex har f.eks. følgende tekst i toppen av ``flex.info'': START-INFO-DIR-ENTRY * Flex: (flex). A fast scanner generator END-INFO-DIR-ENTRY Den aktuelle linjen kan derfor bare klippes og limes rett inn i den aktuelle dir-filen. I dette tilfellet ``flex.dir.compilers''. Man bør derimot passe på å starte forklaringen av dokumentasjonen (i vår tilfelle ``A fast...'') på kolonne 33. Dette fører til at alle forklaringene blir pent alignet ca. langs midten av emacs-vinduet, xtermen, eller hvor nå enn dokumentasjonen skal leses.

eSk