| Linux - Friheden til at skrive dokumentation: Version 2.7.20040524 - 2020-12-31 | ||
|---|---|---|
| forrige | Kapitel 6. Fremstilling af "Friheden til at vælge" bøgerne | næste |
Læs DocBook
Hver bog er organiseret gennem bog.sgml og indhold.sgml pga. integration med "alle-upgaven" (alle bøgerne samlet) så er det smart at jeg i bog.sgml anfører filernes kobling til et SGML-tag - eksempler
<!entity java-indledning SYSTEM "indledning.sgml"> <!entity java-indhold SYSTEM "indhold.sgml"> <!entity java-appendixRevHist SYSTEM "apprevhist.sgml"> <!entity java-forord SYSTEM "forord.sgml">
og at jeg sidst i filen bog.sgml siger at NU kommer java-indhold - i praksis skriver du &java-indhold; og dermed kopieres filen indhold.sgml ind (jfr. ovenstående).
Hvis du så kigger i indhold.sgml så vil jeg i bunden bruge din indhold.sgml ved at skrive
&java-forord; <---- defineret i bog.sgml &java-indledning; <---- do. &java-appendixRevHist; <---- do. versionshistorien.
Dermed kommer de tre filer ind i følgende rækkefølge
forord.sgml
indledning.sgml
apprevhist.sgml
Når I har indført en ny fil VM.sgml og den skal med i f.eks. java bogen, så skal I indføje en linie i bog.sgml
<!entity java-VM SYSTEM "VM.sgml">
og i indhold.sgml skal I på passende sted referere
&java-VM;
Dernæst skal I tilføje en linie under den rette bog i linuxbog/alle/bog.sgml - samme som i bog.sgml for den enkelte bog - men med ../../../ sat foran stien. På den måde vil alle-bogen også være opdateret.
<!entity java-VM SYSTEM "../../../VM.sgml">
XML versionen kræver, at alle tags skrives med små bogstaver og alle tags har formen <tag [attributer]>tagged text</tag>
Afsnit tags, fx. <sect1 id="xx-beskrivende-navn"> bliver brugt til at give html-filerne navne, så det beskrivende navn vælges med omhu. Det er vistnok en god ide at bruge en bogstavkode for selve bogens navn, altså: erstat xx med den identifikation, som benyttes for den bog, du skriver på.
For at bøgerne ligner hinanden mest muligt i de viste eksempler, skal der anvendes samme brugernavn og maskinnavn i alle bøger.
Den primære bruger er 'tyge' og hans fulde navn er 'Tyge Brahe'. Denne bruger symbolisere brugeren selv. Skal der illustreres andre brugere der kommunikeres med, eller der skal oprettes på et system, bruges:
otto 'Otto Brahe' axel 'Axel Brahe'
Valget af 'tyge', 'otto' og 'axel' udemærker sig ved at de alle har 4 tegn i navnet, og giver overskuelig liste når de bliver brugt i eksempler.
Den primære maskine som brugeren fysisk sidder ved hedder 'hven.sslug.dk', hvor normalt brug så blot er 'hven'. Skal der kommunikeres med andre maskiner, hedder de:
saltholm.sslug.dk peberholm.sslug.dk
Tabel 6-1. E-mail eksempler
| Navn | |
|---|---|
| Tyge Brahe | <tyge@sslug.dk> |
| Tyge Brahe | <tyge@hven.sslug.dk> |
| Otto Brahe | <otto@saltholm.sslug.dk> |
| Axel Brahe | <axel@peberholm.sslug.dk> |
En normal-prompt (bash) i homedir bliver så:
[tyge@hven ~]$
Det er ikke på forhånd givet at 'otto' og 'axel' har login på 'hven.sslug.dk', det skal fremgå af eksemplet.
Baggrund: Tyge Brahe[1] (latinsk: Tycho) er en kendt dansk astronom der blev født på Sjælland og voksede op i Skåne. Sidst bosat på Hven. Otto er hans far og Axel er hans bror.
| [1] |
Valget af Tyge Brahe som eksempel betyder ikke at alle medlemmer af LinuxBog-redaktionen anerkender det Tychoniske-verdensbillede (jorden i midten). Jvf. afsnittet om tidszoner, tror heller ikke alle at jorden er flad, det ville dog have gjort det hele lidt nemmere. |