Diese Seite ist unverschlüsselt! Um sicherzustellen, das Ihr Passwort nicht ausgelesen werden kann, sollten Sie auf die verschlüsselte Seite wechseln!

    Herzlich Willkommen, lieber Gast!
  Sie befinden sich hier:

  Forum » Allgemeines (OffTopic) » Dokumentation erstellen
Forum | Hilfe | Team | Links | Impressum | > Suche < | Mitglieder | Registrieren | Einloggen
  Quicklinks: MSDN-Online || STL || clib Reference Grundlagen || Literatur || E-Books || Zubehör || > F.A.Q. < || Downloads   

Autor Thread - Seiten: > 1 <
000
08.05.2006, 19:35 Uhr
Pler
Einer von Vielen
(Operator)


Hi.

Ich suche nach Möglichkeiten eine Dokumentation zu schreiben.
Zum einen soll damit eine API beschrieben werden, aber auch eine Dokumentation für Anwender (Oberfläche).

Docbook hört sich ja nicht schlecht an:
Da kann man am Ende ein pdf und html draus machen.
Bei HTML sehe ich nocht den Vorteil, dass man das noch aus dem Programm raus verlinken kann.
(Oder wie wird sowas sonst gemacht)

Latex scheint ja für sowas dann eher nicht so verbreitet zu sein. (Mehr nur die techn. Doku.?)

Mich würde mal interessieren was ihr da so einsetzt.

Möglichst sollte das ganze noch mit ner Oberfläche ala Kile für Latex zu bedienen sein.

Zusammenfassung:
- Welche Möglichkeiten gibt es Quellcode und Oberfläche zu dokumentieren
- Wie könnte man das ganze direkt ins Programm einbinden,
- und trotzdem noch ein extra HTML- und PDF-Buch draus machen


Ach so.. Das ganze noch unter Linux und Win

Vielen Dank
Dieser Post wurde am 08.05.2006 um 19:36 Uhr von Pler editiert.
 
Profil || Private Message || Suche Download || Zitatantwort || Editieren || Löschen || IP
001
08.05.2006, 19:54 Uhr
xXx
Devil


öhm du zu
- Wie könnte man das ganze direkt ins Programm einbinden,
- und trotzdem noch ein extra HTML- und PDF-Buch draus machen

tjo, indem du einfach einen Menüpunkt Handbuch einfügst und in dem dann das Handbuch komplett öffnest.... d.h. empfielt sich in dem fall dann aber auch das pdf dokument
 
Profil || Private Message || Suche Download || Zitatantwort || Editieren || Löschen || IP
002
08.05.2006, 20:37 Uhr
Pler
Einer von Vielen
(Operator)



Zitat von xXx:

tjo, indem du einfach einen Menüpunkt Handbuch einfügst und in dem dann das Handbuch komplett öffnest.... d.h. empfielt sich in dem fall dann aber auch das pdf dokument


Nja, an die richtige Stelle springen sollte das dann schon.
Aus dem Programm raus, könnte zum Beispiel der entsprechende Link zu dem html-Dokument aufgerufen werden.
Und zum Ausdrucken gibt's eben das pdf.
 
Profil || Private Message || Suche Download || Zitatantwort || Editieren || Löschen || IP
003
13.05.2006, 13:27 Uhr
Tron



 moin,

hast du dir schon mal doxygen angeschaut?
erzeugt die Doku sowohl als html als auch in Latex.

www.stack.nl/~dimitri/doxygen/
 
Profil || Private Message || Suche Download || Zitatantwort || Editieren || Löschen || IP
004
15.05.2006, 07:55 Uhr
Pler
Einer von Vielen
(Operator)


Danke, das hört sich ja interessant an. Hab ich noch gar nichts von gehört.

Ist aber eben nur für den Quellcode!?
Werds mir mal anschaun.
 
Profil || Private Message || Suche Download || Zitatantwort || Editieren || Löschen || IP
Seiten: > 1 <     [ Allgemeines (OffTopic) ]  


ThWBoard 2.73 FloSoft-Edition
© by Paul Baecher & Felix Gonschorek (www.thwboard.de)

Anpassungen des Forums
© by Flo-Soft (www.flo-soft.de)

Sie sind Besucher: