Forum: PC Hard- und Software [S] Software zur Erstellung von Dokumentationen -> LaTeX einzige brauchbare Option?


von Ralf (Gast)


Lesenswert?

Hallo,

ich schreibe mir gerade in einem Dokument Informationen zu einem 
bestimmten Thema, mit dem ich mich beschäftigen möchte, zusammen.

Das Dokument wächst und gedeiht, allerdings verliert es seine "Form", 
oder besser gesagt das Format. Ich arbeite mit Word bzw. OpenOffice.
Einrückungen gehen mitunter verloren oder verschieben sich an Stellen, 
an denen man gerade nicht editiert hat, Aufzählungen rücken mitunter 
auch einfach eine Stufe hoch/runter, etc. Ich freue mich schon auf den 
Zeitpunkt, an dem ich das Inhaltsverzeichnis erstelle...

Einen Teil des "Chaos" kann ich mit Sicherheit mir selbst zuschreiben, 
es bleibt aber sich auch was für Word bzw. Writer übrig.
Kurzum: Ich suche eine für die Erstellung von Dokumentationen 
geeignetere Software.
Logischerweise hab ich mir zuerst mal LaTeX angeschaut (vorsichtshalber 
erstmal auf Wiki :)
Was mich da nun etwas abschreckt ist die Einarbeitung und der Umstand, 
dass man wohl einiges an Zusatzpaketen braucht, um beispielsweise einen 
WYSIWYG-Editor zu erhalten, ich möchte mich weder allzu tief in die 
(La)TeX-Doku vergraben noch einen Riesenpulk an Softwarepaketen 
installieren müssen, ich will ja eigentlich "nur" eine ordentliche 
Dokumentation schreiben.

Die Frage ist nun, sollte es doch LaTeX sein, lohnt sich der 
Zeitaufwand? Oder gibt es eine (ähnliche) Software, die weniger 
Einarbeitungszeit etc. braucht?

Ralf

von Alexander S. (alexander_s45)


Lesenswert?

Wenn dir eine HTML Dokumentation reicht schau dir mal Markdown, 
Resturcture Text oder Textile an, die bieten zwar auch kein WYSIWYG, 
dafür haben die eine einfache Syntax. Mit Pandoc kriegst des dann auch 
noch in jedes beliebiges Format.

von Mullwark (Gast)


Lesenswert?

LaTeX und WYSIWYG gehören nicht zusammen.
Wenn WYSIWYG, dann Word/Writer, aber genau die Probleme, die Du 
schilderst, treten bei großen Dokumenten auf.

Der Vorteil von LaTeX ist ja gerade, daß Du Dich beim Schreiben nicht um 
die Form scheren musst. Gut, klar, einige wollen direkt am Anfang schon 
Schrift und Form editieren, aber darum geht es nicht. Bei LaTeX schreibt 
man mit Blick auf den Inhalt. Ob nun Bild 3 auf Seite drei oder vier 
ist, ist da unerheblich, die ganzen Bezüge, Seitenzahlen, Referenzen, 
etc. bleiben automatisch aktuell. Erst am Ende überlegt man sich, ob man 
an den Schrift- und Formparametern noch rumschraubt oder ob das 
automatische Layout ausreicht.

Entweder WYSIWYG oder LaTeX.


In die grundlegende Syntax hat man sich schnell eingearbeitet, ich würde 
sagen, nach einigen Stunden ist man schon so schnell wie im Word/Writer. 
Einen riesigen Pulk an Softwarepaketen braucht man da eigentlich nicht.
Ob sich der Aufwand für Dich lohnt, kannst nur Du entscheiden, aber je 
größer Dein Dokument, umso lohnenswerter ist der Umstieg.

Eine andere Software? Da kenn ich nur HTML, und zwar in der ursprünglich 
gedachten Form des Publizierens von Wissen. Nicht das BlinkiBunti Web2.0 
mit PHP und Java. Ich glaube aber, daß LaTeX da in jedem Fall die 
bessere Wahl ist, wenn der Inhalt nur einem kleinen Personenkreis 
zugänglich sein soll.

von Frank K. (fchk)


Lesenswert?

Viele Firmen verwenden Framemaker. Das ist auch für sehr große Dokumente 
geeignet und auf technische Dokumente ausgelegt.

Ich weiß nur nicht, ob Du Dir das leisten kannst und willst.

fchk

von Michael S. (captain-stone)


Lesenswert?

Hallo Ralf,

> Die Frage ist nun, sollte es doch LaTeX sein, lohnt sich der
> Zeitaufwand? Oder gibt es eine (ähnliche) Software, die weniger
> Einarbeitungszeit etc. braucht?

definitiv von mir ein JA, zu dieser Frage.

Fakt ist, eine Dokumentation schreiben ist nun mal viel Arbeit. Ich 
beschäftige mich lieber ein paar Stunden mit Latex und habe es dann 
genau so, wie ich es möchte, anstatt die Formatierung immer wieder von 
vorne angehen zu müssen. Und so schwer ist das nicht. Nach dem ersten 
Dokument führst Du Dich schon wohl damit.

Außerdem hält das WYSIWYG vom tatsächlichen Schreiben ab. Obwohl es auch 
WYSIWYG Editoren gibt, die mit Latex arbeiten können 
(http://www.lyx.org/)

Ich hab meinen (bevorzugten Editor) und immer zwei Fenster offen, ein 
Knopfdruck compiliert und dann siehst auch das Ergebnis sofort, wenn Du 
etwas kontrollieren möchtest (z.B. bei Formeln).

Der Captain

von Latex (Gast)


Lesenswert?

Wenn sowas öfter benötigt wird, dann lohnt die Einarbeitung in Latex.

http://www.texniccenter.org/ bündelt fast alles für Windows inkl. 
WYSIWYG - einlesen musst du dich trotzdem.

Ansonsten sollte das mit Writer auch gehen. Wobei man das Dokument immer 
mit der gleichen Version bearbeiten sollte und nicht zwischendurch mit 
Word. Und sich an Gliederungsebenen und Formatvorlagen halten muss.

von W.S. (Gast)


Lesenswert?

Ralf schrieb:
> Das Dokument wächst und gedeiht, allerdings verliert es seine "Form",
> oder besser gesagt das Format.

Hmm... Wie formatierst du deinen Text? und wieviel hundert Seiten sind 
es denn so bislang?

Ich weiß, daß sowohl Word als auch Openoffice zwar prinzipiell in Sachen 
Absatzlayouts und deren Verwaltung recht gut sein können, aber die 
allermeisten benutzen das kaum bis garnicht (weil es nicht einfach und 
bequem benutzbar ist), sondern behelfen sich mit Leerzeile für 
Absatzabstand, markieren und Eigenschaften zuweisen und so weiter.

Es ist auch ne Schwierigkeit gerade bei Open Office, daß man sich nie so 
richtig sicher sein kann, ob man gerade ein nur im Dokument enthaltenes 
Absatzlayout ändert oder aus Versehen eines der Standardlayouts, die 
dann dokumentübergreifend an völlig unbeabsichtigten Stellen gleich noch 
was anderes mitändern.

W.S.

von D. I. (Gast)


Lesenswert?

Lyx ist WYSIWYG + Latex, das verwenden hier viele am Lehrstuhl. Ich bin 
ein Freund von TexMaker, links den Latex-Source, rechts nach einem Druck 
auf F5 das PDF. Kein Gefummel und die grundlegenden Sachen hat man auch 
in Latex schnell raus, fürs Meiste gibts in TexMaker auch schon fertige 
Knöpfe, selbst für so eklige Sachen wie Tabellen.
Richtig krank wirds erst wenn du anfängst mit TikZ deine Bilderchen zu 
machen :)
Für Dokus einfach wunderbar geeignet und es sieht professionell aus.

Aber ich finde auch plain HTML + DokuCSS (weiß nicht mehr genau wie es 
heißt, jedenfalls ein CSS-Sheet welches HTML so formatiert dass es für 
Dokumentationen ansprechend ist) ganz nett als Alternative.

von Georg A. (georga)


Lesenswert?

TeX verträgt sich auch gut mit CVS, SVN, git, etc. Und damit wird 
verteiltes Arbeiten an einem gemeinsamen Dokument noch einfacher...

von Ralf (Gast)


Lesenswert?

Guten Morgen,

@Alexander S.:
Danke, ich schau mir Markdown mal an.

@Frank:
Nein, investieren wollte ich für die Hobbydokumentationen eigentlich nix 
:)

@Mullwark, Michael & Latex:
Gut, dann werd ich mich mal mit den Details zu LaTeX beschäftigen.

@W.S.:
Groß formatiert habe ich nichts, dass dürfte eben auch eines der 
(selbstgemachten) Probleme sein. Bei solchen Sachen arbeite ich i.d.R. 
nur über Aufzählungen.
Oh, und es ist keine Masterarbeit oder etwas in der Art, aktuell sind es 
22 Seiten :) Für mich viel, für andere vielleicht gerade das 
Inhaltsverzeichnis selbst.

@D.I. & Georg:
Ich werd mir nun erstmal LaTeX zu Gemüte führen, und schauen ob ich 
damit zurecht komme. HTML fasse ich als Alternative ins Auge.

Besten Dank an alle.

Ralf

von Freddy (Gast)


Lesenswert?

Guten Morgen,

ich habe mit LaTeX im Studium viel gearbeitet. Viele Laborberichte, 
Studienarbeit, Diplomarbeit, etc. geschrieben. Gerade auch beim 
Schreiben im Team (Laborberichte) ein Super Werkzeug.
Aber ich muss zugeben, es hat wie jede Software auch Haken und Ösen. Man 
braucht nicht viel Zeit ein Text-Dokument zu erstellen. Bilder und 
Tabellen sind schnell eingebunden, aber man braucht einiges an Zeit sich 
daran zu gewöhnen, dass in LaTeX das Layout halt mehr oder weniger 
gegeben ist.
Und das ist auch (fast immer) gut so.
Formeln kann man super in LaTeX setzen (wobei der OO Formeleditor auch 
wesentlich besser ist als der von MS-Office).

Was mich persönlich immer ein wenig gestört hat, ist das es beim 
Kontrollieren (ich drucke es meist aus) die falsche Textstelle im PDF im 
Textcode wiedergefunden werden muss. Auch bei großen Tabellen die 
beispielsweise aus einem anderen Programm übernommen wurden (z.B. Excel 
oder Calc) ist der Aufwand nicht zu unterschätzen diese nachträglich zu 
bearbeiten. In Excel oder Calc die Formel geändert und schon kannst Du 
alles neu exportieren (am besten per CVS, dann alle ',' durch '|' 
ersetzen...).

Aber im es kommt immer auf die Anwendung an.

Mittlerweile im Beruf sehen die zu schreibenden Berichte nicht mehr ganz 
so aufwändig und wissenschaftlich aus wie im Studium und werden mit OO 
Writer oder Word geschrieben. Alleine schon wegen der Möglichkeit, dass 
Kollegen diese Dokus ändern können müssen.
Mit ein wenig (einmaligen) Aufwand in der Vorlage, Dokumentenstile, etc. 
kann man auch hiermit arbeiten. Zugegeben Dokumente mit mehr als 30 
Seiten habe ich noch nicht geschrieben. Und wenn man in der 
Dokumentenvorlage Bilder direkt mit Bildunterschrift definiert geht auch 
Copy&Paste einigermaßen schnell.

Kurzum: Es gibt keine perfekte Software. Entweder Du investierst Zeit 
dich in Writer oder Word in die Dokumentenvorlage oder LaTeX richtig 
einzuarbeiten. Bei LaTeX kann es sinnvoll sein sich einen Laborbericht 
oder eine ähnliche Vorlage anzusehen damit die Lernkurve nicht allzu 
flach ist.

Freddy

PS: FrameMaker ist wohl im beruflichen Alltag eine gute Alternative, 
aber soweit ich mal von einem ehemaligen Airbus Kollegen gehört habe, 
sollen wohl die Dokumentenvorlagen bei WordPerfect wesentlich besser 
gewesen sein als bei Word... und dann wurde irgendwann zu Word 
gewechselt.

von Rolf Magnus (Gast)


Lesenswert?

Als Dateiformat für Dokumentationen eignet sich auch docbook, aber ich 
weiß nicht, ob es dafür einen WYSIWYG-Editor gibt. Das ist XML-basiertes 
Markup, speziell auf Dokumentationen zugeschnitten. Mit den passenden 
Tools bzw. Stylesheets kann man dann daraus verschiedene Formate wie 
html oder pdf erzeugen.

von Peter L. (luidoltp)


Lesenswert?

Ich hab mal vor kurzem einem Freund ein Mail betreffend Latex-Einstieg 
geschrieben ... vielleicht helfen dir die Tipps auch:

Die TUGraz bietet eine eigene Webseite nur zum Thema Latex an ... ein 
guter Punkt um anzufangen:
http://latex.tugraz.at/

Auf dieser Seite gibt es auch eine Liste die nochmals die Vorteile von 
Latex auflistet. -> Um dich restlos zu überzeugen ;-)
http://latex.tugraz.at/latex/warum
http://latex.tugraz.at/dokumentation/mythen


Die größte Hürde bei Latex ist meiner Meinung nach, das ganze zu 
installieren. Wichtig zu wissen ist, dass es bei Latex zwei (fast 
gänzlich) getrennte Komponenten gibt. Einmal den Editor (in dem du deine 
Texte schreibst) und einmal das Latex-System (das sorgt dafür, dass aus 
deinem Quelltext - den du im Editor geschrieben hast - ein schönes 
Dokument wird).

Als Latex-System gibt es unter Windows das Programm "MiKTeX". Unter 
folgendem Link findest du das Programm ... einfach herunterladen und 
installieren:
http://www.miktex.org/download

Grundsätzlich kannst du jeden Text-Editor verwenden (auch Notepad unter 
Windows reicht aus ;-)) aber ich würde ich das "TechnixCenter" 
empfehlen. Dieser Editor ist relativ einfach zu bedienen, arbeitet gut 
mit MiKTeX zusammen und ist kostenlos.
http://www.texniccenter.org/resources/downloads/29
(unten auf der Seite gibts die Datei zum Download "TeXnicCenter 2 Beta 1 
Installer")

Wichtig:
Installiere unbedingt VORHER das MiKTeX-System und erst danach das 
TechnixCenter. Wenn man das in dieser Reihenfolge macht, dann erkennt 
das TechnixCenter bereits eine Latex Umgebung und hilft dabei alles 
richtig zu konfigurieren.

Sobald du alles installiert hast, kannst du eigentlich loslegen und dein 
erstes Dokument erstellen. Hier die ersten Schritte:
http://latex.tugraz.at/latex/tutorial

Du wirst merken, dass am Anfang vieles unverständlich ist und man keine 
Ahnung hat warum, wie, was und wo ... aber das bekommt man recht schnell 
in den Griff ... und der Aufwand lohnt wirklich!! :-))

von Tom K. (ez81)


Lesenswert?

Freddy schrieb:
> die falsche Textstelle im PDF im
> Textcode wiedergefunden werden muss.

Dazu bietet sich ein Editor+PDF-Viewer an (ich benutze TexWorks, da sind 
auch sämtliche Pakete mit drin und es ist deppensicher zu installieren, 
dafür nicht so bunt), der mit Strg+Klick ins PDF zur entsprechenden 
Stelle im Quelltext springt (und umgekehrt). Ohne dieses Feature kann 
man in längeren Dokumenten nicht vernünftig arbeiten.

> Auch bei großen Tabellen die
> beispielsweise aus einem anderen Programm übernommen wurden (z.B. Excel
> oder Calc) ist der Aufwand nicht zu unterschätzen diese nachträglich zu
> bearbeiten.

Latex funktioniert hervorragend mit make und anderen automatisierenden 
kleinen Helferchen. Aus einem .csv kann man mit wenigen Zeilen einer 
Scriptsprache ein in Latex includebares File für die Tabelle generieren 
lassen, mit gnuplot die Grafik dazu u.s.w.. Einfach ändern, was zu 
ändern ist, alles was daraus abgeleitet ist, wird dann automatisch 
erzeugt. Allerdings ist sowas unter benutzerfreundlichen und 
automatisierungsfeindlichen BSen ein widerwärtiges Gebastel, bis es 
funktioniert.

von Freddy (Gast)


Lesenswert?

@ Tom K.

TexWorks kannte ich noch nicht. Aber den gab es auch noch zu Zeiten 
meiner Diplomarbeit. Da war noch Emacs und Konsole angesagt...

Natürlich ist mit Make einiges möglich. Gerade im automatisierten 
Bereich ist es kein großes Problem tausende Daten mittels LaTeX zu 
verarbeiten.
Soweit ich weiß ist werden die Telekomrechnungen auch mit LaTeX 
erstellt.
Aber für jemanden, der 20 Seiten Doku mit LaTeX mit unregelmäßiger 
Nutzung erstellen will ist es wohl mit ein wenig Aufwand verbunden...

Freddy

von Chris D. (myfairtux) (Moderator) Benutzerseite


Lesenswert?

Ralf schrieb:

> Das Dokument wächst und gedeiht, allerdings verliert es seine "Form",
> oder besser gesagt das Format. Ich arbeite mit Word bzw. OpenOffice.
> Einrückungen gehen mitunter verloren oder verschieben sich an Stellen,
> an denen man gerade nicht editiert hat, Aufzählungen rücken mitunter
> auch einfach eine Stufe hoch/runter, etc. Ich freue mich schon auf den
> Zeitpunkt, an dem ich das Inhaltsverzeichnis erstelle...

Das hört sich danach an, als wäre Dir das Vorlagensystem von OO nicht 
vertraut - dann passiert nämlich genau das Obige.

> Einen Teil des "Chaos" kann ich mit Sicherheit mir selbst zuschreiben,
> es bleibt aber sich auch was für Word bzw. Writer übrig.

Sei ehrlich: welches vernünftige Buch über OpenOffice Writer hast Du 
durchgearbeitet? Hast Du Dir eine vernünftige Vorlage bzw. 
Vorlagenhierarchie erstellt? Mit einer guten Vorlage erhält man auch ein 
gutes Ergebnis. Oder war es doch eher "Ich fange einfach mal an."? ;-)

> Die Frage ist nun, sollte es doch LaTeX sein, lohnt sich der
> Zeitaufwand? Oder gibt es eine (ähnliche) Software, die weniger
> Einarbeitungszeit etc. braucht?

Das ist der Knackpunkt. Ich habe früher auch LaTeX verwendet, aber das 
ist zeitlich nicht tragbar, wenn man nur ab und zu etwas macht. Nach 
einem Vierteljahr ohne Benutzung fange ich fast wieder von vorn an.

Bei Openoffice ist das mMn leichter - aber: auch da muss man sich 
zumindest einmal richtig einarbeiten und vor allem auch das 
Vorlagensystem verwenden. Das ist nämlich richtig gut.

Wir erstellen sämtliche Dokumentationen unter OO mit entsprechenden 
Vorlagen, dazu Rechnungen etc. automatisiert - das ist nicht wirklich 
schwer.

Und wenn man dann möchte, kann man sich zum Schluß auch LaTeX-Quelltext 
generieren lassen :-)

Chris D.

von xfr (Gast)


Lesenswert?

Wenn Du WYSIWYG willst, ist Latex nicht das richtige für Dich. Oder wenn 
Du volle Kontrolle darüber willst, wie das Dokument am Ende aussieht. 
Das kann unter Umständen ziemlich kompliziert werden. Latex ist dann 
nützlich, wenn man sich nicht um Layout-Details kümmern möchte, sondern 
einfach nur seinen Inhalt schreiben will, das Ergebnis aber trotzdem 
professionell aussehen soll.

Wenn man ein wenig Programmiererfahrung hat (also es gewohnt ist, mit 
Textdateien zu arbeiten) sollte der Einstieg nicht allzu schwer fallen. 
Unter Windows würde ich TeXstudio empfehlen. Sehr nützlich ist der 
interne PDF-Viewer, der nach dem Compilieren an die Stelle im PDF 
springen kann, an der man gerade sich auch gerade im Quelltext befindet. 
Möchte ich nicht mehr missen.

Sobald man Miktex und TeXstudio eingerichtet hat, muss man nur noch auf 
Compilieren klicken und das PDF fällt raus. Eventuell zusätzlich 
benötigte Pakete kann Miktex selbständig runterladen, man muss nur ein 
"\usepackage{paket}" ins Dokument schreiben.

von Ralf (Gast)


Lesenswert?

Hallo zusammen,

vielen Dank für eure Antworten. Bin hin und her gerissen, die 
Entscheidung fällt schwer :)

@Chris:
> Das hört sich danach an, als wäre Dir das Vorlagensystem von OO nicht
> vertraut - dann passiert nämlich genau das Obige.
Nein, ist es nicht ;)

> Sei ehrlich: welches vernünftige Buch über OpenOffice Writer hast Du
> durchgearbeitet?
Keins.

> Hast Du Dir eine vernünftige Vorlage bzw. Vorlagenhierarchie erstellt?
Nein.

> Mit einer guten Vorlage erhält man auch ein gutes Ergebnis. Oder war es
> doch eher "Ich fange einfach mal an."? ;-)
War es. In der Regel schreib ich mal ein Briefchen oder so, dafür langt 
das Wissen über Word/Writer :) Mein Fokus liegt nicht grad auf dem 
professionellen Erstellen von Dokus ;)
Das o.g. Zusammenschreiben der Infos, um brauchbar damit arbeiten zu 
können, hat halt andere Rahmenbedingungen geschaffen.

> Das ist der Knackpunkt. Ich habe früher auch LaTeX verwendet, aber das
> ist zeitlich nicht tragbar, wenn man nur ab und zu etwas macht. Nach
> einem Vierteljahr ohne Benutzung fange ich fast wieder von vorn an.
Das Risiko sehe ich eben bei mir auch.

> Bei Openoffice ist das mMn leichter - aber: auch da muss man sich
> zumindest einmal richtig einarbeiten und vor allem auch das
> Vorlagensystem verwenden. Das ist nämlich richtig gut.
Hmmm... naja, allzu weit bin ich mit der LaTeX-Portierung des Dokuments 
noch nicht gekommen. Vielleicht mache ich auch nochmal einen Break und 
schau mir das OO-Vorlagensystem an. Dann kann ich immer noch entscheiden 
bei welcher Variante ich bleibe.

Ralf

von Erwin (Gast)


Lesenswert?

Für OO kann ich folgendes Buch empfehlen:
Wissenschaftliche Arbeiten schreiben mit Word, Nicol, Albrecht, 
Addison-Welsey, 2004, München

Kann man ganz gut auf OO übertragen, auch wenn man im Menü das ein oder 
andere mal prüfen muss wo man es dort findet.

Erwin

von Mullwark (Gast)


Lesenswert?

Nach Allem, was hier geschrieben wurde, denke ich auch, daß OO für Dich 
die richtige Wahl ist.

von Andreas M. (amesser)


Lesenswert?

Ich benutze verschiedene Systeme, je nach Einsatzzweck - jedoch 
normalerweise weder Open/Libre-Office oder Word. Das liegt vermutlich an 
meinen frühen Erfahrungen mit Word. Also:

Latex: Früher für Diplomarbeit und alles andere Wissenschaftliche Zeug. 
Heute gerne für Briefe, Lebenslauf. Sieht einfach sehr professionell 
aus, gerade die Briefklasse aus dem KOMA-Paket macht wirklich was her. 
Ich mach das direkt aus dem 0815-Editor, meine Frau benutzt meist Kile 
zum bearbeiten.

Docbook-XML: Habe ich mal für die Firma ausprobiert. Das ist ein 
XML-Format was mit entsprechender Tools in PDF, HTML... übersetzt werden 
kann. Durch das XML ist das mit einem normalen Editor kaum zu 
bearbeiten. Sehr gut für technische Dokumentationen geeignet. (Wurde für 
diesen Zweck entwickelt) Tabellen und Bilder landen genau da wo man sie 
im Textfluss platziert was bei diesem Anwendungsbereich durchaus 
sinnvoll ist. Es gibt einige XML Editoren mit denen sich das in einer 
Art WYSISWG Modus editieren lässt. Ich hatte das damals mit 
http://sourceforge.net/projects/sernafree.mirror/ gemacht. War mir dann 
aber einfach zu kompliziert - ein Diff auf so einer XML Datei hilft 
nicht viel.

AsciiDoc: Das ist ein Markup für Textdateien. Man schreibt das Dokument 
einfach in einem normalen Texteditor und muss bestimmte 
Formatierungsregeln beachten. Z.b. Werden Überschriften z.B. mit '=' 
unterstrichen. Der Parser erkennt dann diese Formatierungen und damit 
die Dokumentenstruktur. Der Vorteil ist das mit einem normalen 
Texteditor auskommt, der Quelltext des Dokuments sehr gut lesbar bleibt 
und man diverse Ausgabeformate erstellen kann. Viele Editoren können 
dafür auch Syntax-Highlight. Asciidoc kann in diverse Formate übersetzt 
werden, bei einigen Formaten wird es zu nächst nach Docbook-XML 
gewandelt und das dann weiterverarbeitet. Man braucht daher für PDFs 
wieder den ganzen Docbook Kram. Mehr unter 
http://www.methods.co.nz/asciidoc. Dort gibt es auch einige Beispiele 
von Dokumenten die mittels AsciiDoc erstellt wurden u.a. eine 
Geräteanleitung: 
http://www.proconx.com/assets/files/products/modg100/UMMBRG300-1101.pdf 
- Das sieht doch nicht schlecht aus!

Sphinx/Restructured Text: Restructured Text ist asciidoc sehr ähnlich, 
der Parser ist jedoch komplett in Python geschrieben. Darauf basierend 
gibt es das System Sphinx, was besonders zu Dokumentation von Software 
geeignet ist, aber natürlich auch für eine Bedienungsanleitung taugt. 
Sphinx ist von der Bedienung her einfacher als Restructured Text, Da 
Makefiles oder Batchfiles für Windows automatisch mit erstellt werden 
und man die Doku in so ziemlich jedes denkbare Format schnell 
übersetzten kann. Z.b.im Industriebereich oft eingesetzt: Windows HLP 
Files auch für Geräteanleitungen. Natürlich Hilfsmittel wie Windows Help 
Compiler oder Latex vorausgesetzt. Sphinx unterstützt Formelsatz mit 
Latex-Syntax und kann durch Module erweitert werden. Z.b. wenn man 
Graphviz-Diagramme haben möchte kann man die dann direkt im Quelltext 
mit definieren. Man kann damit auch ganze Web-Seiten gestalten. Eigene 
Erweiterungen können in Python programmiert werden und somit auch eigene 
Stil - und Strukturelemente definiert werden. Es ist sogar möglich 
Ausgabetreiber - der Teil der dann das Dokument erstellt - zu 
implementieren oder vorhandene zu erweitern. Letztendlich habe ich mich 
bei Softwaredoku, einfache Webseiten usw. dann für dieses System 
entschieden. Mehr hier: http://sphinx-doc.org/index.html Man kann damit 
aber auch Bücher schreiben: http://theoretical-physics.net/

Gruß
Andreas

von Matthias L. (Gast)


Lesenswert?

>Das hört sich danach an, als wäre Dir das Vorlagensystem von OO nicht
>vertraut - dann passiert nämlich genau das Obige.

Das gilt für MS Word ebenso. Ich kann nicht verstehen, warum darauf 
immer so geschimpft wird. Wenn man das Programm (etwas) kennt, und 
(einigermassen) weiss, was man wie zutun hat, dann ist das ein ganz 
vernünftiges Programm.

Warum soll ichs mir selbst mit LaTex schwer machen? Alle meine Arbeiten 
(Diplomarbeit, Technikerarbeit, Dokus hier in der Firma, privates, etc) 
schreibe ich mit Word. Es hat noch keiner rumgejammert, wie das denn 
aussehe.

Man muss natürlich wissen, wie man zB einen Absatz erzeugt. Viele 
Leerzeichen als Einrückung ergeben Unsinn, auch wenns erstmal "gut" 
aussieht.
Oder Kapitel, Gliederungen und deren Nummerierung. Macht Word alles 
selbst und passt auch. Wenn man weiss wie das funktioniert.
Genauso ists mit Formatvorlagen. Man die selbst ändern und anpassen. 
Dann kann das das ganze Dokument betreffen. Kann gewollt sein, manchmal 
aber nicht.

Es ist wie überall: Man muss wissen, was man tut.

von Peter (Gast)


Lesenswert?

Hallo,
möglicherweise kommt die Antwort etwas spät aber ich hab mir gedacht 
falls es noch jemand durchlesen sollte so wie ich könnte es hilfreich 
sein. Durch ein paar Recherchen im Internet bin ich auf dass Programm 
OMMS gestoßen.
Die Infos die ich aus dem PDF entnehmen konnte sind echt gut und ich 
denke damit kann man ein großes Aufgabengebiet mit abdecken. Könnt euch 
ja gerne selbst durchlesen. Ich hoffe ich konnte hilfreich sein.


http://ess-doc.de/esshp/documents/pdf/OMMS_Praesentation.pdf

Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.