Strukturering af rapport

Fra LaTeX
Skift til: Navigation, Søgning

Denne side beskriver hvordan vi (Adam og Mikkel fra Data/El 5 semester 2010) foretrækker at opbygge filstrukturen for vores gruppes rapporter. Dette er blot én mulighed da man kan strukturere det præcis som man har lyst til. Vi anbefaler at man finder på sin egen mappestruktur og navngiver filer så det giver mening i forhold til projektets indhold, så længe alle i gruppen har en idé om hvordan strukturen skal være. Fordelen ved at have faste rammer for filstrukturen er at det er mindre forvirrende at finde rundt i når rapporten begynder at have mange afsnit og figurer osv.

Indholdsfortegnelse

Mappestruktur

Først og fremmest er det rart at være enige om en mappestruktur som alle i gruppen følger. Som udgangspunkt skal man i hvert fald have en mappe til rapporten, eksempelvis "Report". Inde i Rapport mappen er der naturligvis en masse undermapper, f.eks. "images" til diverse figurer, "content" til rapportens indhold, evt. "other" som bruges hvis man har brug for andre dokumenter i sit appendiks, datablad/manualer eller lignende. I "report" mappen har man rapportens .tex fil, en .bib fil til sine kilder, evt. en TeXnicCenter .tcp fil (projekt fil), og til sidst har vi "junk.bat" filen til at rydde op i mappen når latex genererer midlertidige filer i forbindelse med compile af rapporten. Det bliver også i "report" mappen at den genererede PDF fil vil ligge når man compiler sin rapport. Inden vi kiggere nærmere på hvad der er i undermapperne (content, images, other) er der her en grafisk repræsentation af filstrukturen (klik på billedet for at se den i fuld størrelse).

Eksempel på rapport filstruktur.


Betragter vi ovenstående struktur så er "report.tex" vores rod fil, og indeholder preamble. Inde i report.tex filen bruger man \input{} som det er forklaret i opdeling i filer til at henvise til index.tex filen i "content" undermappen. content/index.tex henviser til alle de andre index.tex filer (frontmatter/index, chap1/index, appendix/index). Index.tex filen i frontmatter mappen henviser så til frontpage.tex filen og hvad man ellers skal bruge (forord, titelblad osv.). I figuren herunder har vi den samme filstruktur, men med røde pile der illustrerer hvordan filerne inkluderer hinanden med \input{}.

Eksempel på rapport filstruktur.


Tilføjelse af filer

Nyt afsnit

Lad os sige vi skal oprette et nyt afsnit med titlen "teori" og den skal være i rapportens første kapitel.

  1. Opret teori.tex i mappen content/chap1
  2. Åben content/chap1/index.tex filen
  3. Tilføj linjen \input{content/chap1/teori} i index filen.

Bemærk at det første input i filen vil være det første afsnit af kapitlet osv. Se opdeling i filer for nærmere forklaring i brugen af \input.

Nyt kapitel

Vi vil gerne lave en kapitel 2 til rapporten:

  1. Opret en mappe med navnet chap2 inde i report/content mappen.
  2. Opret index.tex inde i content/chap2 mappen.
  3. Åben chap2/index.tex filen og tilføj kapitlets overskrift med \chapter{Min Overskrift}
  4. Åben content/index.tex filen og tilføj: \input{content/chap2/index} der hvor kapitlet skal være, f.eks. lige under \input{content/chap1/index}

Relative stier

Husk at alle stier der angives skal være relative i forhold til report.tex filen. Det vil sige hvis man skal inkludere mitafsnit.tex i kapitel 1, så er stien til filen content/chap1/mitafsnit.

Skal img.jpg fra images/chap1 indsættes i rapporten (se figurer), skal man bruge stien images/chap1/img.jpg. Bruger man funktionen i texniccenter til at indsætte et billede (ctrl+alt+g), vil den bruge filens absolutte sti (f.eks. D:\SVN\report\images\chap1\img.jpg), og selvom dette virker fint på din egen PC, så vil det IKKE virke på din gruppes computere medmindre de har præcis samme sti til deres "report" mappe.