Dokumentation in Latex

[snaegg]

Hallo!

Habe meine bisherigen Dokumentation in Latex verfasst und habe auch vor dies in der Abschlussdokumentation zu tun.

Ich habe mir die Regeln auf der IHK Seite angeschaut und diese für mein Latex Format weitesgehend übernommen.

Mich würde mal interssieren, ob noch irgendjemand vor hat seine Dokumentation damit zu verfassen?

Werde auch gerne meinen Quelltext bereitstellen und würde andere Vorschläge diskutieren wollen!

Es handelt sich beim Anhang natürlich um eine tex Datei, aber die will das VBulletin ja nicht hochladen...

Gruß

snaegg

doku.txt

[ITwork]

Ich habe mir die Regeln auf der IHK Seite angeschaut und diese für mein Latex Format weitesgehend übernommen.

Nur so als Hinweis: Hast du die Vorlage von deiner zuständigen IHK genommen? Da ja jede der vielen IHKs da ihr eigenes Süppchen kocht.

[snaegg]

Ja habe ich gemacht...

Ist mir bereits auch schon aufgefallen, dass die IHKs teilweise andere Vorstellungen habe.

Auch die Sache mit den Bildern (wo die Bilder von den Text-Seiten abgezogen werden) fand ich etwas befremdlich. Obwohl ja wörtlich in der Vorschrift was von "12 Seiten Textform" geschrieben steht.

Naja, ging mir ja hier eigentlich mehr um die Sache mit Latex. Weiß ja nicht so genau ob man das direkt sieht bzw. ob es jemanden stören könnte-> Wer weiß...;-)

[allesweg]

Kommt auf die Vorgaben der IHK an. Manche wollen am Ende nur Papier, andere *.pdf und vielleicht gibt es welche, die MS-Word-Dokumente wollen (bitte mit Versionsnummer für Kompartibilitätscheck... *schauder*).

Ob die Rohdaten vorher mit Latex, OOWriter, MSWord oder Paint erfasst werden, sollte meines Erachtens keine Rolle spielen.

[snaegg]

Also bei der IHK Koblenz wird ein Ausdruck in dreifacher Form erwartet. Die Abgabe sollte deshalb unkritisch sein.

Einziges Problem das mir bis jetzt aufgefallen ist der Anhang.

Ich bin mir nicht ganz sicher, aber normalerweise würde ich im Inhaltsverzeichnis der Dokumentation auch die Seiten aus dem Anhang angeben. Allerdings habe ich auch schon gehört, dass manche ein gesondertes "Anhangsverzeichnis" am Ende der Doku (bzw. Anfang des Anhangs) mit neuer Nummerierung z.B. "A1, A1.2" usw. bevorzugen. Im Inhaltsverzeichnis steht dann nur "Anhang" sonst nichts.

Das ist in Latex natürlich alles möglich, aber umständlich und schöner finde ich es ehrlich gesagt auch nicht.

Deswegen wollte ich mal nachfragen, wer das denn auch mit Latex vor hat zu dokumentieren. Da könnte man solche Sachen nämlich mal vergleichen

[allesweg]

Zu Latex kann ich nichts sagen, jedoch zur Seitennummerierung: Beginnend nach dem Inhaltsverzeichnis mit der ersten Textseite, den Anhang getrennt zählen.

[Ntl]

(...) den Anhang getrennt zählen.

Einer meiner Lehrer sagte, es sei wichtig, die Dokumentation komplett durchzunummerieren und dem Anhang keine eigene Nummerierung zu geben :confused:

Ich bin sowieso der Meinung, dass man es nie allen recht machen kann

Zumindest bei den Sachen, die nicht in den formalen Anforderungen der IHK drin stehen.

[snaegg]

Also habe mir nun eine Zwischenlösung überlegt. Geht in Latex auch ganz einfach mit "appendix":

Im Inhaltsverzeichnis werden die einzelnen Kapitel des Anhangs mit aufgeführt, allerdings in der Anhangsnummerierung A.1 usw.

sieht dann im Inhaltsverzeichnis so aus...

Inhaltsverzeichnis


1 Einleitung

  1.1 Vorwort



A Anhang

   A.1 Quellenangabe

   A.2 Glossar

[allesweg]

Ja, so kenne ich es als gewünschte Form - und die Seitenzählung fängt dann neu an - wahlweise wieder bei 1 oder i, I, 00000001 (gefolgt von 00000010) ...

[snaegg]

Ja, bei der Seitenzählung sind wir natürlich schon wieder bei der nächsten Frage angelangt ;-)

Ich kenne es aus Dokumentation so, dass auf dem Deckblatt keine Seitenangabe ist, aber trotzdem bei "Seite 1" angefangen wird zu zählen. Somit landet das Inhaltsverzeichnis auf "Seite 2" und die Einleitung auf "Seite 3". Dies entspricht ja auch eigentlich dem logischen Denken. Man fängt ja schließlich nicht mit der Einleitung auf "Seite 1" an. Gibt allerdings auch Prüfer, die es gerne in der letzteren Variante hätten.

Dafür am Ende Punkte ab zuziehen finde ich übrigens mehr als lächerlich!

Das man beim Anhang neu anfängt zu zählen, darüber kann man denke ich genauso geteilter Meinung sein. Wenn man dem obigen Beispiel treu bleiben will müsste man die Seiten weiter durchzählen.

Wenn man eine neue Seitennummierung (z.B. I,II,III) beginnt, ist die Angabe "A.1" aber eigentlich wieder überflüssig :confused:

[Ntl]

Das mit der Anhangsnummerierung (A.1, A.2, usw.) hab ich auch so. Die Seitennummerierung fang ich aber nicht nochmal an. Ich finde, man braucht nur eines davon. Beides zusammen schaut irgendwie seltsam aus ^^

Wo man nun anfängt zu zählen, also beim Deckblatt oder bei der Einleitung, weiß ich allerdings auch nicht :confused:

[Navy]

Ich werde meine Abschlussdokumentation auch mit \LaTeX verfassen, allein schon auf Grund der vielen Arbeit die mir abgenommen wird, vor allem jedoch ist das Aussehen das Ergebnisses sehr viel besser als das von Word, OpenOffice oder anderen WYSIWYMG-Editoren (echter Blocksatz, Ligaturen, "lebende" Kolumnentitel, etc).

Zudem bleibt mir unter \LaTeX die Möglichkeit jederzeit irgendwo etwas einzuschieben ohne das mir die Formatierung des Dokumenten nachteilig verändert wird.

[snaegg]

Hallo Navy!

Latex hat schon wirkliche Vorteil! Auch das ich mir nicht jedes Mal Gedanken machen muss, wie jetzt die Abbildung, die Tabelle heißt, auf welcher Seite welches Kapitel steht, sondern alles mit "\ref" machen kann! Allerdings finde ich die Vorgaben der IHK etwas merkwürdig, und bin mir nicht sicher wie ich das alles in Latex machen soll.

1. Die Nummerierung soll mit dem Textblock (da sind die 10 Seiten Doku) beginnen. Also keine Nummerierung des Deckblattes und Inhaltsverzeichnisses. Keine Ahnung wie das gehen soll. Kann zwar den Wert wieder auf "1" setzten, aber dann hab ich immer noch die Seite "2" auf meinem Inhaltsverzeichnis... :-(

2. Das Inhaltsverzeichnis des Anhang soll an das Ende der Doku, oder an den Anfang des Anhangs (wie auch immer). Finde ich jetzt zwar nicht so eingenartig wie 1. aber bekomme es trotzdem nicht vernünftig hin.

Ansonsten habe ich glaube ich alle Vorgaben der IHK berücksichtigt... wie sieht das bei dir aus?

[Navy]

Ich habe mit den Vorgaben der IHK /eigentlich/ keine Probleme, nur die IHK hat manchmal Probleme damit, wenn man wirklich das macht was die wollen. Der Zeilenabstand wird bei LaTeX ja nicht nach Zeilenhöhe berechnet, Leerzeilen gibt es, nur (vernünftige) Textabstände, usw. -- die meisten Leute der IHK kennen aber wohl nur Office-Textverarbeitungen und an erster Stelle das mehr als grottenschlechte Word. Diese Leute stellen sich dann auch quer und meinen die Arbeit auf Grund der Nichteinhaltung an die Vorgaben abzuwerten.

In einem sehr erfreulichen Gespräch mit einer Dame der IHK in HH konnte ich aber herausfinden, dass die Vorgaben dazu dienen eine Minimum an Qualität zu erreichen und \LaTeX gar kein Problem darstell[t|en sollte].

Wie auch immer, ich hab hier eine kleine Vorlage für Dich, die ich fix zusammenschustert habe die Deine Ansprüchen genügen sollte.

project.txt

[Youser]

Ich hab auch latex benutzt. Allerdings hat meine IHK auch keine Vorgaben zur Form gemacht.

Ansonsten haette ich lieber Word benutzt.

Aber so lang is die Doku ja eh nicht. Da kommts kaum drauf an womit man das macht.

[snaegg]

Habe nochmal mit meinem Lehrer gesprochen und er ist nicht von seiner Vorstellung der Seitenzahlen abzubringen. So solls aussehen und nicht anders:

keine Nummer - Deckblatt

römisch II - Inhaltsverzeichnis der Doku

arabisch 1 - (Kapitel 1) Vorwort

...Doku...

arabisch 12 - (Kapitel 5) Fazit

arabisch 13 - Anhang

Alphabetisch A - Kapitel A Inhaltsverzeichnis des Anhangs

Alphabetisch B - Kapitel B Installation

Damit genau die 12 Seiten die unsere Doku haben darf nummeriert sind und der Rest andere Nummern bekommt...

Was meint ihr? In Latex machbar ja/nein... wenn ja wie?

usw.

[Grandmasta]

Also Latex hin oder her. Wer sich gut damit auskennt, kann damit bestimmt eine schöne Doku erstellen. Aber warum Stunden mit der Einarbeitung oder der Formatierung zu verbringen, wenn es mit MS Word oder OpenOffice auch ganz einfach funktioniert? Ihr macht hier ja keine Doktorarbeit, sondern einfach nur eine 10 - 15 Seiten Doku.

Ich habe damals zuerst einfach meinen Text geschrieben. Als ich dann so ziemlich fertig war, schnell alles formatiert. Danach noch ein paar Änderungen gemacht und fertig. Probleme mit dem Layout hatte ich keine und meine Doku wurde auch mit über 90% bewertet.

[Navy]

Damit genau die 12 Seiten die unsere Doku haben darf nummeriert sind und der Rest andere Nummern bekommt...

Was meint ihr? In Latex machbar ja/nein... wenn ja wie?

usw.

Definitiv: Ja. Du suchst den Befehl \pagenumbering. Guck Dir mal meine Vorlage an, da habe ich ähnliches schon realisiert.

Also Latex hin oder her. Wer sich gut damit auskennt, kann damit bestimmt eine schöne Doku erstellen. Aber warum Stunden mit der Einarbeitung oder der Formatierung zu verbringen, wenn es mit MS Word oder OpenOffice auch ganz einfach funktioniert? Ihr macht hier ja keine Doktorarbeit, sondern einfach nur eine 10 - 15 Seiten Doku.

Ganz einfach. Weil Latex sehr viel bessere Ergebnisse liefert als es Word und OpenOffice können. Auch wenn es keine Doktorarbeit ist kann man dem Leser einen gewissen Grad an Qualität gönnen. Dazu gehört u.A. daß der Grauwert einer Seite Absatzweise berechnet wird, ein optischer Randausgleich durchgeführt wird, Ligaturen benutz und ein allgemein optischer Einheit erzeugt wird. Das ist so unter Textverarbeitungsprogrammen nicht möglich.

Ich habe damals zuerst einfach meinen Text geschrieben. Als ich dann so ziemlich fertig war, schnell alles formatiert. Danach noch ein paar Änderungen gemacht und fertig. Probleme mit dem Layout hatte ich keine und meine Doku wurde auch mit über 90% bewertet.

Wenn Du mit 90% zufrieden bist, dann ist das Deine Sache. Ich bin der Meinung, dass man bei einem sehr guten Inhalt noch einige Arbeit in das Layout stecken muss. Und zum Layout gehört nicht nur Bilder und Schnörkel einzufügen und sich dem CD der Firma anzupassen, sondern auch dem Leser des Lesefluß zu vereinfachen und das macht man mit oben genannten Mitteln (und noch einigen anderen, bei denen man sich bei Latex keine große Gedanken machen muß, Word & Co aber nicht können).

[Grandmasta]

Ganz einfach. Weil Latex sehr viel bessere Ergebnisse liefert als es Word und OpenOffice können. Auch wenn es keine Doktorarbeit ist kann man dem Leser einen gewissen Grad an Qualität gönnen. Dazu gehört u.A. daß der Grauwert einer Seite Absatzweise berechnet wird, ein optischer Randausgleich durchgeführt wird, Ligaturen benutz und ein allgemein optischer Einheit erzeugt wird. Das ist so unter Textverarbeitungsprogrammen nicht möglich.

Ich weiß, was mit Latex möglich ist. Nur finde ich es nicht besonders angebracht, sich stundenlang nur mit dem Layout der Doku zu beschäftigen und dann eventuell weniger Wert auf den Inhalt zu legen. Natürlich macht so etwas Eindruck, wird aber die Note garnicht oder kaum beeinflussen.

Wenn Du mit 90% zufrieden bist, dann ist das Deine Sache. Ich bin der Meinung, dass man bei einem sehr guten Inhalt noch einige Arbeit in das Layout stecken muss. Und zum Layout gehört nicht nur Bilder und Schnörkel einzufügen und sich dem CD der Firma anzupassen, sondern auch dem Leser des Lesefluß zu vereinfachen und das macht man mit oben genannten Mitteln (und noch einigen anderen, bei denen man sich bei Latex keine große Gedanken machen muß, Word & Co aber nicht können).

Du glaubst doch wohl nicht ernsthaft, dass du mit einer Doku, welche mit Latex erstellt worden ist, ein besseres Ergebnis bekommst, als wenn du Sie mit Word geschrieben hättest? Das Layout wird natürlich bewertet. Aber wenn man sich da ganz genau an die Vorgaben hält, bekommt man ohne Probleme dort die volle Punktzahl.

Wer der Meinung ist, mit Latex sehr viel mehr Punkte zu bekommen, der muss schon wenig Vertrauen in seine Doku haben.

Also nicht das du mich jetzt hier falsch verstehst. Ich finde es lobenswert, wenn jemand seine Doku mit Latex schreibt. Nur vergessen Einige dann wahrscheinlich, sich auf das Wesentliche zu konzentrieren und vergeuden damit einige Punkte. Die lassen sich mit Latex dann auch nicht wieder herzaubern.

[snaegg]

Oh, da hab ich wohl eine Grundsatz Diskussion gestartet.

Also ich benutze seit Jahren Latex und muss gestehen das ich mit Word keinen Meter umgehen kann. Wenn ich also meine Arbeit in Word schreibe hab ich ein Problem!

Ich stecke eben nicht Stunden in das Layout, das ist ja das was Latex für mich aus macht. Dumm nur, dass die IHK nix von DIN hält. Nun das macht die Sache natürlich etwas schwieriger.

Fact ist: Man darf höchstens 12 Seiten abgeben. Hat man eine Thema (wie ich) was sehr umfangreich ist und normalerweise gar nicht auf 12 Seiten dargestellt werden kann, muss man anfangen und hin und her zuschreiben, bis jedes Kapitel auf einer neuen Seite beginnt und man möglichst gut die Seiten ausfüllt.

Und das ist... für mich zumindest... mit Latex 1000 mal einfacher als mit Word. Weil man sich eben nicht um die Formatierung kümmern muss.

Schade finde ich, dass die IHK (zumindest die in Koblenz) sich auf irgendwelche Vorstellungen versteift wie etwas zu sein hat. Klar macht das Sinn für jemanden der noch nie ne Doku geschrieben hat. Der weiß dann nämlich wie sie auszusehen hat.

Ich habe mich über die drei Jahre Ausbildung mit Latex befasst und werde das auch nicht aufgeben, nur weil irgendein Prüfer meint im gefalle meine Nummerierung der Seiten nicht... tut mir Leid, das ist einfach arm!

[snaegg]

So, jetzt nochmal zu Latex. Darum gings mir nämlich eigentlich ;-)

Pagenumbering ist mir bekannt, und ich habe es auch fast gelöst. Einziges Problem bleibt nach wie vor das Inhaltsverzeichnis des Anhangs. Ich bekomme da keine gute Lösung hin den an den Schluss der Doku zu bringen. Es gibt eine Möglichkeit die ich glaube ich bald verwenden werde, wollte es aber eigentlich umgehen.

Ich mache einfach zwei Dokumente. Doku und Anhang und füge diese dann so zusammen wie ich es brauche.

[Navy]

So, jetzt nochmal zu Latex. Darum gings mir nämlich eigentlich ;-)

Pagenumbering ist mir bekannt, und ich habe es auch fast gelöst. Einziges Problem bleibt nach wie vor das Inhaltsverzeichnis des Anhangs. Ich bekomme da keine gute Lösung hin den an den Schluss der Doku zu bringen. Es gibt eine Möglichkeit die ich glaube ich bald verwenden werde, wollte es aber eigentlich umgehen.

Ich mache einfach zwei Dokumente. Doku und Anhang und füge diese dann so zusammen wie ich es brauche.

Dafür bietet sich \minitoc an. Das bietet auch noch eine Menge mehr Möglichkeiten.

[snaegg]

Also für alle Latex Fans zur Info:

Die Sache mit den IHk (Lehrer)- Richtlinien. Habe es jetzt mit einem PDF-Merge gelöst. Inhaltsverzeichnis komplett erstellen. Die richtigen Seiten dran schreiben und dann einfach die Seiten an die gewünschte Stelle schieben. Sieht dann jetzt so aus:

---------------------------------------

Inhaltsverzeichnis

1. Einleitung...........................1

Anhangsverzeichnis 13

Seite I (die Seite des Inhaltsverzeichnisses-römisch)

---------------------------------------

Doku....

---------------------------------------

Anhangsverzeichnis

1. Anhangskapitel...........................1

Seite 13 (Seite des Anhangsverzeichnisses)

---------------------------------------

Super Sache... werd ich in meinem Leben nie mehr brauchen, aber wenns denn so sein soll... was soll man machen, die Punkte verschenken?

bei Fragen wie ich das genau in Latex realisiert habe stehe ich natürlich jederzeit zur Verfügung. Aber ich glaube die Zahl derer die das interessiert hält sich hier in Grenzen... An alle anderen: Viel Spaß mit Word! ;-)

[Navy]

Du hast es Dir viel zu umständlich (und unschön, weil Du jetzt im pdf eine Durchnummerierung der Seiten hast, anstatt sie mit ihren tatsächlichen Formatierung zu referenzieren) gemacht. Hättest Du "Minitoc" angesehen, hättest Du das wunderbar einfach und vor allem schnell rekompilierbar gemacht...

[snaegg]

Hi!

Das ist richtig. Allerdings hatte ich mir Minitoc angeschaut und auch einige Beispiele im Internet durchgeguckt. Ich befürchte allerdings, dass ich nicht genau das bekomme was ich will (oder ich habs falsch verstanden). Du hast Recht, es ist unschön. Brauche immer zwei Dokumente (Hauptdoku und Anhang) und muss die beiden dann kombinieren. Andereseits brauche ich es ja nur für die Abschlussprüfung ;-)

Mit den Referenzen hat aber alles geklappt... denke ich mal. Oder ich hab das falsch verstanden was du meintest.

Wenn ich in der Doku z.B. auf Anhang D. Seite 22 verweise, dan funktioniert das und stimmt mit den Seitenzahlen auf den Seiten überein. Natürlich nicht mit den Seitenzahlen des PDFs...