[linux-l] Warum gibt es keine einheitliche Dokumentation? (war: dwww)

[Volker Grabsch]

On Thu, Jan 04, 2007 at 06:15:21AM +1100, Peter Ross wrote:
> On Wed, 3 Jan 2007, Volker Grabsch wrote:
> 
> > Das ist ein "farbiger ASCII-Test" -> "HTML"  Konvertierer, aber kein
> > "man" -> "HTML" Konvertierer.
> 
> Exakter: eine Webseite, die Manpages aufbereitet, dass man sie mit dem 
> Webbrowser lesen kann.

Ja, aber zu jedem solchen Tool dürfte es auch ein Kommandozeilentool
geben, dass die Seiten statisch erzeugen kann, oder?

Wenn es das nicht gibt: Für kleinere Projekte wäre das ein sehr
interessantes Feature.

> Sicher kann man Dinge schicker machen - aber ist das wirklich soo wichtig?

Wenn man die Masse ansprechen will: Ja.

Und das will man. Man will, dass die Leute sich gerne Manpages ansehen.
Dass sie Manpages mit angenehm lesbarer Doku verbinden, nicht mit
merkwürdigen Texten auf der Kommandozeile in Courier-Schriftart.

Natürlich kann man versuchen, auf diese "oberflächlichen Leute" zu
verzichten. Aber genau das kann man nicht, wenn man andererseits möchte,
dass ein Werkzeug wirklich eingesetzt wird.

Anders ausgedrückt: Vielen ist nur wichtig, dass ihre Doku in HTML gut
aussieht. Gut, JavaDoc und Java an sich ist ein Thema für sich, aber
auch bei Python mit Epydoc ist dieser Trend zu sehen. Die Projekte haben
kein Interesse an Manpages, weil sie nicht portabel sind. (im Sinne von:
laufen nicht unter Windows, aber ein großer Teil der User benutzt Windows).

Hätten Manpages den Ruf, schicke HTML-Doku zu produzieren, und
darüberhinaus sogar super Druck-Versionen, dann würden IMHO viel mehr
Leute das Manpage-Format erlernen. Mit anfängerfreundlichen
Manpage-Editoren oder Manpage-Format-basierten Wikis könnte man solch
einen Trend ebenfalls unterstützen.

Und ja, es wäre ein sehr großer Gewinn, wenn ein viel größerer Anteil
der Doku im Manpage-Format vorliegen würde. Bei kleineren Handbüchern
und API-Docs geht das definitiv.

Bei Howtos angeblich nicht, wurde mir hier gesagt, auch wenn mir niemand
den Grund verraten konnte. Welches Markup fehlt? Welches Konzept ist da
inkompatibel?

> Stattdessen bekommst Du auf dieser Webseite die Manpages von etlichen OS, 
> wie Linux-Distributionen und Solaris (beides nutze ich oefter)..

Oh ja, das ist mir positiv aufgefallen und eine *sehr* schöne Sache.

Aber man sieht eben auch einen krassen Stilbruch zwischen der elegant
designten Webseite und dem Manpage-Bereich mit dieser schrottigen
HTML-Darstellung.


Ich würde sogar behaupten, es guter Teil des Erfolges der Wikipedia
gegenüber anderen Wikis darauf zurück geht, dass die erzeugten
Webseiten so schick aussehen. Das motiviert viel stärker zum Mitmachen.


Viele Grüße,

    Volker

-- 
Volker Grabsch
---<<(())>>---
Administrator
NotJustHosting GbR