store/doc-espensk/emacs-dir.html

   1 <HTML><HEAD>
   2 <TITLE> Tilrettelegging av emacs-info-sider </TITLE>
   3 <!-- Changed by: Espen Skoglund, 24-Apr-1996 -->
   4 </HEAD><BODY>
   5
   6 <H1> Tilrettelegging av emacs-info-sider </H1>
   7
   8 Enkelte applikasjoner (særlig GNU applikasjoner) har medfølgende
   9 dokumentasjon i emacs-info-format.  Denne dokumentasjonen består av
  10 filer som ender på <CODE>.info</CODE>, <CODE>.info-1</CODE>,
  11 <CODE>.info-2</CODE>, etc, og ender som oftest opp i
  12 <CODE>/store/info</CODE>-katalogen når ``<CODE>make install</CODE>''
  13 har gjort seg ferdig.
  14
  15 <P>For at disse filene skal dukke opp i info-menyene vi ser i
  16 f.eks. XEmacs og Emacs, må vi lage en liten fil som inneholder et
  17 meny-entry.  Denne filen skal være navngitt på formen
  18
  19 <BLOCKQUOTE>
  20   <CODE>&lt;navn&gt;.dir.&lt;doktype&gt;</CODE>
  21 </BLOCKQUOTE>
  22
  23 og befinne seg under <CODE>/store/info</CODE>.  <EM>Navn</EM> er her
  24 navnet på dokumentasjonen (f.eks. <CODE>bash</CODE> eller
  25 <CODE>gcc</CODE>).  <EM>Doktype</EM> forteller hvilket emne
  26 dokumentasjonen inneholder.  Dette benyttes for å plassere
  27 meny-entryet på en fornuftig plass i menyen, og kan ha følgende
  28 verdier:
  29
  30 <DL>
  31 <DT><CODE>emacs</CODE>
  32 <DD>Benyttes for dokumentasjon som omhandler bruken av Emacs/XEmacs.
  33
  34 <DT><CODE>elisp</CODE>
  35 <DD>Benyttes for emacs-lisp-dokumenasjon.
  36
  37 <DT><CODE>packages</CODE>
  38 <DD>Benyttes for dokumentasjon som omhandler bruken av en tillegspakke til
  39   emacs (f.eks. AUC-TeX eller GNUS).
  40
  41 <DT><CODE>compilers</CODE>
  42 <DD>Benyttes for dokumentasjon til kompilatorer eller utviklingsverktøy
  43   (f.eks. GCC eller Make).
  44
  45 <DT><CODE>library</CODE>
  46 <DD>Benyttes for dokumentasjon som omhandler diverse biblioteker
  47   (f.eks. Libg++ eller Mmalloc).
  48
  49 <DT><CODE>standard</CODE>
  50 <DD>Benyttes for dokumentasjon av diverse standarder og formater (f.eks.
  51   GNU coding standards).
  52
  53 <DT><CODE>program</CODE>
  54 <DD>Benyttes for dokumentasjon av andre programpakker (f.eks. Bash og Zsh).
  55
  56 </DL>
  57
  58 For å lage en meny-entry for Bash, lager vi f.eks. en fil
  59 ``<CODE>info/bash.dir.program</CODE>'' i <CODE>bash</CODE>-filsettet
  60 som inneholder følgende tekst:
  61
  62 <LISTING>
  63     * Bash: (bash).                 Bourne Again Shell
  64 </LISTING>
  65
  66 Dette fører til at linjen dukker opp under overskriften; ``<EM>Other
  67 programs and packages</EM>'' neste dag (etter at
  68 <EM>nightly</EM>-jobbene til Emacs eller XEmacs har kjørt).
  69
  70 <H3> Mulig forslag til meny-entry </H3>
  71
  72 Mange dokumentasjoner på info-format inneholder selv forslag til hva
  73 som burde stå i meny-entryen.  Disse forslagene kan i så fall finnes
  74 mot toppen av den aktuelle info-filen.  Flex har f.eks. følgende tekst
  75 i toppen av ``<CODE>flex.info</CODE>'':
  76
  77 <LISTING>
  78     START-INFO-DIR-ENTRY
  79     * Flex: (flex).         A fast scanner generator
  80     END-INFO-DIR-ENTRY
  81 </LISTING>
  82
  83 Den aktuelle linjen kan derfor bare klippes og limes rett inn i den
  84 aktuelle <CODE>dir</CODE>-filen. I dette tilfellet
  85 ``<CODE>flex.dir.compilers</CODE>''.  Man bør derimot passe på å
  86 starte forklaringen av dokumentasjonen (i vår tilfelle ``<EM>A
  87 fast...</EM>'') på kolonne 33.  Dette fører til at alle forklaringene
  88 blir pent <EM>alignet</EM> ca. langs midten av emacs-vinduet, xtermen,
  89 eller hvor nå enn dokumentasjonen skal leses.
  90
  91
  92 <HR>
  93 <ADDRESS><A HREF="/~espensk/">eSk</A></ADDRESS>
  94
  95 </BODY></HTML>