Werkzeuge für SuSE Dokumentation

Hallo,

weiss jemand, welche Tools bei SuSE benutzt werden, um die Handbücher und sonstige Dokumentation zu schreiben?

LaTeX? Docbook? OpenOffice? Eine Kombination aus denen?

Gruss, Carsten

Kurz und gut: Docbook.
Gruß nach Spanien,
Andreas

viva espana

Helf mir mal einer auf die sprünge.

DocBook ... könnte auch für mich interessant sein.

Laut APT installiert in der Version 4.
Finden und aufrufen geht aber nicht?

Was mache ich falsch??

Docbook sind Stylesheets für das xml-Processing mit XSLT -> grauenhafter aufwand



DocBook: The Definitive Guide

Grauenhafter Aufwand? Hmm, ja, man muss sich schon etwas einarbeiten.
Dieses Buch hilft:
ttp://www.amazon.de/exec/obidos/ASIN/3899900782/qid=1124259238/sr=8-3/ref=sr_8_xs_ap_i3_xgl/302-5252250-4134441

Vor allem kann ich empfehlen, sich diesen Artikel mal durchzulesen, um zu erfahren, was auf einen zukommt:
http://xml.oreilly.com/news/dontlearn_0701.html

Dann gibt es immer noch die Möglichkeit, in OpenOffice zu schreiben und nach DocBook zu exportieren:
http://xml.openoffice.org/xmerge/docbook/
http://de.openoffice.org/doc/sonstiges/DocBook16de.html
http://de.openoffice.org/doc/sonstiges/docbook-user-guide-de.html

Viel Spass,
Carsten

Ich bin auf docbook gekommen, weil Handbücher für KDE-Programme grundsätzlich in diesem Format erstellt werden. Es IST ein Heidenaufwand.

Der Vorteil liegt wohl darin, dass man Daten, welche in diesen XML-Dialekt erfasst sind, in die unterschiedlichsten Formate umwandeln kann (Printmedien bzw. PDF, HTML, Manpages, Info...).

taki schrieb:

Es IST ein Heidenaufwand.

Zum Vergrößern anklicken....

danke


womit schreibst Du die?

TeXpert schrieb:

womit schreibst Du die?

Zum Vergrößern anklicken....

Quanta

Ist nicht der Hit. Nix Wysiwyg, auch kein "Visual Page Layout" bei dieser DTD. Wobei ich denke, dass Quanta's Hauptproblem 45cm vor dem Bildschirm klemmt... bzw. es hängt an meinem akuten Zeitmangel mich tiefer einzuarbeiten als unbedingt nötig

Zum Austesten wird in der Konsole HTML generiert (siehe "meinproc --help" aus dem kdesdk Paket). Das nicht ganz überzeugende(*) Ergebnis kann unter http://www.andreas-silberstorff.de/ktvapp/doc/en/kalva begutachtet werden.

(*) Man beachte die kaputten Seitenfüße mit den nicht funktionierenden "last" und "next" Links.

Das Docbook selbst entspricht den Vorgaben. Nur mit dem Umwandeln komme ich nicht klar. Für meine Ansprüche und fürs Erste reicht es mir. Wird die index.docbook an die richtige Stelle installiert, macht das Hilfesystem von SuSE / KDE die Umwandlung ins passende HTML-Format automatisch und on the fly. Dann funktionieren auch die Seitenfüße.
Gruß,
Andreas

Das ist interessant und drum verschiebe ich es mal in den Officebereich. Da bleibt es der nachwelt erhalten.

taki schrieb:

TeXpert schrieb:

womit schreibst Du die?

Zum Vergrößern anklicken....

Quanta

Ist nicht der Hit. Nix Wysiwyg, auch kein "Visual Page Layout" bei dieser DTD. Wobei ich denke, dass Quanta's Hauptproblem 45cm vor dem Bildschirm klemmt... bzw. es hängt an meinem akuten Zeitmangel mich tiefer einzuarbeiten als unbedingt nötig

Zum Vergrößern anklicken....

ich mach bis jetzt immer noch einen weiten Bogen um docbook, da es sich häufig nicht lohnt, mit TeX komme ich idr aus

aber auf den ersten Blick sieht abiword als WYSIWYMG Editor nicht schlecht aus oder XEmacs mit dem psgml-Paket...

Wenn Du eine KDE-Applikation schreibst und ein Handbuch dazu reichen möchtest, hast Du keine Wahl. Da ist das Dateiformat vorgegeben. So schlimm ist es ja auch wieder nicht, xml quasi im Ascii-Editor der Wahl zu erstellen. Quanta zu nehmen ist wohl überdimensioniert. Jeder Editor mit Syntaxhighlightning für XML mit docbook DTD Unterstützung tut es auch (z.B. Kate ohne Quanta drum herum).

Ich nehme Quanta, weil ich mir die Illusion erhalten möchte, dass ich mir irgendwann doch die Zeit nehme, mich da rein zu finden und die unendlich vielen von mir noch nicht entdeckten Möglichkeiten doch noch anzueignen Ich gestehe frei und offen: Reine Verschwendungssucht...

Einer Textverarbeitung mit docbook-Export vertraue ich nicht so recht. Vielleicht sieht der Text beim Schreiben dann schöner aus als der docbook-Quellcode selber, aber die Wahrscheinlichkeit, dass es mir etwas für das KDE-Hilfesystem unzureichendes oder gar inkompatibles erzeugt ist mir zu groß.

taki schrieb:

Wenn Du eine KDE-Applikation schreibst und ein Handbuch dazu reichen möchtest, hast Du keine Wahl. Da ist das Dateiformat vorgegeben. So schlimm ist es ja auch wieder nicht, xml quasi im Ascii-Editor der Wahl zu erstellen. Quanta zu nehmen ist wohl überdimensioniert. Jeder Editor mit Syntaxhighlightning für XML mit docbook DTD Unterstützung tut es auch (z.B. Kate ohne Quanta drum herum).

Zum Vergrößern anklicken....

die emacs+psgml-Lösung soll aber das refacrtroing und die Navigation vereinfachen und zusätzlich arbeitet der mit den DTDs und kann automatisch die passenden Elemtente und Attribute vervollständigen... ich denke das wird mein Werkzeug werden

Einer Textverarbeitung mit docbook-Export vertraue ich nicht so recht. Vielleicht sieht der Text beim Schreiben dann schöner aus als der docbook-Quellcode selber, aber die Wahrscheinlichkeit, dass es mir etwas für das KDE-Hilfesystem unzureichendes oder gar inkompatibles erzeugt ist mir zu groß.

Zum Vergrößern anklicken....

also abiword arbeitet von Haus aus mit XML Dokumenten und hat AFAIR einen eigenen DocBook-XML-Exporter... insofert würde ich das nicht so pauschalisieren

TeXpert schrieb:

die emacs+psgml-Lösung soll aber das refacrtroing und die Navigation vereinfachen und zusätzlich arbeitet der mit den DTDs und kann automatisch die passenden Elemtente und Attribute vervollständigen... ich denke das wird mein Werkzeug werden

Zum Vergrößern anklicken....

Werde mir vielleicht dann doch mal den xemacs anschauen müssen (neugierig geworden). Wobei genau das Quanta auch macht. Ist wahrscheinlich reine Geschmackssache. Wenn man xemacs gewohnt ist, ist das sicher eine gute Wahl.

TeXpert schrieb:

also abiword arbeitet von Haus aus mit XML Dokumenten und hat AFAIR einen eigenen DocBook-XML-Exporter... insofert würde ich das nicht so pauschalisieren

Zum Vergrößern anklicken....

Dass XML das Standardformat ist, sagt noch nichts. Das aktuelle MS Word verwendet XML. OpenOffice Writer und KWord verwenden XML. Ersterer ein proprietäres XML, die zwei letzten bald das OASIS Dokumentenformat. Docbook ist nicht gleich XML. Und Docbook ist auch nicht immer gleich Docbook :roll: , da gibt es auch schon etliche Dialekte. Es muss vor allem zum Zielsystem passen (bei mir eben das Hilfesystem von KDE).

Aber Ausprobieren kost nix. Werde mir nach langer Abstinenz mal wieder Abi Word anschauen. XEmacs wird auch angetestet. Ich denke aber schon, dass ich bei Quanta bleiben werde - bin Gewohnheitsmensch und um ehrlich zu sein, so wichtig ist es mir nicht, womit ich das Handbuch erstelle.

Habe übrigens gerade noch etwas interessantes gefunden:

http://www.kde-files.org/content/show.php?content=26176

Und für alle, die Quanta zum Handbuchschreiben verwenden wollen und noch nicht auf KDE 3.4.2 upgegraded haben:

http://www.kde-files.org/content/show.php?content=26654

TeXpert schrieb:

also abiword arbeitet von Haus aus mit XML Dokumenten und hat AFAIR einen eigenen DocBook-XML-Exporter... insofert würde ich das nicht so pauschalisieren

Zum Vergrößern anklicken....

Dass XML das Standardformat ist, sagt noch nichts. Das aktuelle MS Word verwendet XML. OpenOffice Writer und KWord verwenden XML. Ersterer ein proprietäres XML, die zwei letzten bald das OASIS Dokumentenformat.
[/quote]

klar, aber Abiword kann zumindest in docbook-XML exportieren,

Docbook ist nicht gleich XML. Und Docbook ist auch nicht immer gleich Docbook :roll: , da gibt es auch schon etliche Dialekte. Es muss vor allem zum Zielsystem passen (bei mir eben das Hilfesystem von KDE).

Zum Vergrößern anklicken....

hier dürften die Unterschiede dann so gering sein, dass mit xslt notfalls ein Anpassen möglich ist.

Aber Ausprobieren kost nix. Werde mir nach langer Abstinenz mal wieder Abi Word anschauen. XEmacs wird auch angetestet. Ich denke aber schon, dass ich bei Quanta bleiben werde - bin Gewohnheitsmensch und um ehrlich zu sein, so wichtig ist es mir nicht, womit ich das Handbuch erstelle.

Zum Vergrößern anklicken....

*grins* da ich schon seit jeher in Emacs TeXe (und Quanta nicht mag) ist für mich der Griff zu psgml natürlich naheliegender...

ich hab mir gerade mal aus der Bibliothek XML für Print und Screen von Niedermeir mitgenommen, mal sehen was der heutige Abend bringt...