Dokumentstruktur einer SelfHTML-Seite

[Eddie]

Hallo allerseits,

ich will mir endlich mein eigenes kleines Hilfesystem basteln. Natuerlich nicht auf einen Schlag, sondern, indem ich mit den wichtigsten Kapiteln anfange. Ergo habe ich aber auch nur eine grobe Vorstellung, was irgendwann mal für Elemente nötig sein könnten.

Zuerst mal will ich mir ein Grobgerüst für ein Kapitel aufbauen, das alle moeglichen Elemente enthält. Dieses Grobgerüst will ich dann als Template verwenden, wobei nur diejenigen Elemente angezeigt werden, die tatsaechlich gefragt sind.

Als Trivialbeispiel mag folgendes dienen:

{Haupt-Titel}
  {Vorwort}
  {Gliederung}

loop
{Abschnitts-Titel}
  {Inhalt
loop_end

{Weitere Informationen:}
loop
  {Link}
loop_end

{Mailadresse}

=============

Ich bin mir sicher, bei SelfHTML gibt's sowas, wo alle eben Eventualitaeten beruecksichtigt sind. Drum danke für eure Hilfe,
Eddie

[Eddie]

Hallo nochmal,

nur falls das nicht verstaendlich war: ich meinte die typischen SelfHTML-Seiten, wie z.B.
http://de.selfhtml.org/html/text/zeilenumbruch.htm

Eddie

[Christoph Schnauß]

morgens Eddie,

nur falls das nicht verstaendlich war:

Nein, das war es ganz und gar nicht.

ich meinte die typischen SelfHTML-Seiten, wie z.B. http://de.selfhtml.org/html/text/zeilenumbruch.htm

ups? Ja, was hat das hier zu suchen?

du sagtest, daß du dir ein Hilfesystem aufbauen möchtest. Das kannst du gerne tun. Aber wo soll das laufen? Auf deinem eigenen Rechner zuhause? Unter welchem Betriebssystem?
Und wen du das online realisieren möchtest: was, ums himmels willen, haben denn Zeilenumbrüche mit einem Hilfesystem zu tun?

Du läßt mehr Fragen übrig als Antworten möglich sind. Entweder verfolgst du einen absolut genialen Plan, den wegen seiner Genialität keiner verstehen und nachvollziehen kann, oder es ist absoluter Blödsinn, was du da geschreibselt hast.

Ich meine eher, daß es unüberlegter Unsinn ist, was du gerne nachfragen möchtest.

Grüße aus Berlin

Christoph S.

[Eddie]

Guten Abend Christoph,

nimm's bitte nicht persoenlich, aber wenn man mir eine Kanone in den Mund schieben und mich fragen wuerde: "Sag uns, Eddie, wer hier im Forum ist der mit der uebelsten Laune!".
Dann waere die Antwort ziemlich klar. Kommt naemlich ziemlich haeufig vor, dass du einen ziemlich unleidlichen Eindruck machst. Diesmal ist es ja noch harmlos, und ich bin der Letzte, der gleich anfaengt zu weinen, aber ich hab schon so manches Posting von dir gelesen, das kein gutes Haar mehr am Fragenden laesst. Sorry, das nervt.
Ok, soviel dazu. Meine Meinung. Muss nicht gleich die riesen Diskussion draus werden.

ich meinte die typischen SelfHTML-Seiten, wie z.B. http://de.selfhtml.org/html/text/zeilenumbruch.htm
ups? Ja, was hat das hier zu suchen?

Hä? Was wohl?
SelfHTML ist ein gigantisches Hilfesystem, oder etwa nicht? Ein monströses Tutorial, eine Anleitung, aber in erster Linie doch ein Hilfesystem. So sehe ich das jedenfalls.

du sagtest, daß du dir ein Hilfesystem aufbauen möchtest. Das kannst du gerne tun. Aber wo soll das laufen? Auf deinem eigenen Rechner zuhause? Unter welchem Betriebssystem?

Ja, du hast recht, habe ich nicht geschrieben. Also nimm das Naheliegenste, das macht man in solchen Faellen so.
Mal abgesehen davon, dass das Zielsystem bei so einer abstrakten Anforderung herzlich egal ist.

Und wen du das online realisieren möchtest: was, ums himmels willen, haben denn Zeilenumbrüche mit einem Hilfesystem zu tun?

Welche Zeilenumbrüche? Herrgott, das ist nur eine Beispielseite fuer ein Hilfekapitel. Wohl zu abstrakt...
Ich dachte, wenn ich schreibe
-----------------------------

ich meinte die typischen SelfHTML-Seiten, wie z.B. http://de.selfhtml.org/html/text/zeilenumbruch.htm

-----------------------------
wuerden die meisten Leute verstehen, dass das ein Beispiel ist, und ich einen Zusammenhang zu den "typischen SelfHTML-Seiten" herstellen will. Vielleicht ist das Adjektiv "typisch" in diesem Fall verwirrend?

Du läßt mehr Fragen übrig als Antworten möglich sind. Entweder verfolgst du einen absolut genialen Plan, den wegen seiner Genialität keiner verstehen und nachvollziehen kann, oder es ist absoluter Blödsinn, was du da geschreibselt hast.

Nein, es ist Bloedsinn. Ich werde mich jetzt in den Schlaf weinen.

Ich meine eher, daß es unüberlegter Unsinn ist, was du gerne nachfragen möchtest.

Ist ja gut, ich sag doch, dass ich schon weine. Kannst aufhoeren, zu treten.

Ist uebrigens nicht so, dass ich mir mein Original-Posting nicht nochmal durchgelesen hätte. Und ich räume durchaus ein, dass beim eiligen Überfliegen nicht gleich klar ist, worum es genau geht. Aber ich schaetze die Forumsteilnehmer als so intelligent ein, dass sie's trotzdem raffen.

Gute Nacht,
Eddie

[Stefan Muenz]

Hallo Eddie,

nimm's bitte nicht persoenlich, aber wenn man mir eine Kanone in den Mund schieben und mich fragen wuerde: "Sag uns, Eddie, wer hier im Forum ist der mit der uebelsten Laune!".

Christoph ist nicht mehr der Allerjuengste, und aelter werdende Maenner neigen dazu, zu Brummbaeren zu werden. Da ich Christoph mittlerweile persoenlich kennenlernen konnte, kann ich dir versichern, dass er ein absolut sympathischer Brummbaer ist :-)

Was deine Ausgangsfrage betrifft: es gibt zwei Seiten, die sich an Fremdautoren von SELF-Dokumenten richten, und in denen diverse Dinge ueber Aufbau, Struktur, Inhalt und Sprache von solchen Dokumenten stehen: Layoutvorgaben und Sprachvorgaben.

Wenn du was anderes als das meinst, dann solltest du noch genauer beschreiben, was du suchst.

viele Gruesse
  Stefan Muenz

[Christoph Schnauß]

uije ....

hallo Stefan,

erst diese kalte Dusche:

Christoph ist nicht mehr der Allerjuengste, und aelter werdende Maenner neigen dazu, zu Brummbaeren zu werden.

Und dann der Versuch eines Wiederaufbaus meiner soeben beschädigten Psyche mit:

Da ich Christoph mittlerweile persoenlich kennenlernen konnte, kann ich dir versichern, dass er ein absolut sympathischer Brummbaer ist :-)

Da die diesjährige Holunderernte überaus reichlich ausgefallen ist, schlage ich vor, daß du mich für zwei Tage nach München einlädst, um beim Heurigen über pädagogische Prinzipien und allerhand den SELFRaum betreffende Paralipomena zu philosophieren ;-)

Grüße aus Berlin

Christoph S.

[Christoph Schnauß]

hallo Eddie,

Kommt naemlich ziemlich haeufig vor, dass du einen ziemlich unleidlichen Eindruck machst.

Achwo. Ich bin die Liebenswürdigkeit in person.

SelfHTML ist ein gigantisches Hilfesystem, oder etwa nicht?

Nein. In Korrelation zu meiner von Stefan unten angesprochenen (Alters-)Brummigkeit bin ich gegenüber Superlativen wie "gigantisch" mehr als skeptisch. SELFHTML ist, nüchtern betrachtet, eine Dokumentation mit beachtlichem Umfang. Wie alle Dokumentationen auch, leistet SELFHTML selbstverständlich einige unschätzbare Hilfen, das steht außer Frage. Ich selber habe nahezu alles, was ich je "im Web" umgesetzt habe, an, mit, gegen, in Dankbarkeit für oder in Opposition zu SELFHTML überhaupt erst gelernt.

Ein monströses Tutorial

Du solltest dein Begriffsverständnis für "Monster" dringend revidieren, finde ich.

du sagtest, daß du dir ein Hilfesystem aufbauen möchtest. Das kannst du gerne tun. Aber wo soll das laufen? Auf deinem eigenen Rechner zuhause? Unter welchem Betriebssystem?
Ja, du hast recht, habe ich nicht geschrieben. Also nimm das Naheliegenste, das macht man in solchen Faellen so. Mal abgesehen davon, dass das Zielsystem bei so einer abstrakten Anforderung herzlich egal ist.

Nö. "Man" schaut nicht zuerst nach einer möglichen Form, sondern "man" überlegt sich zuerst, was man denn wem gerne als Hilfesystem anbieten möchte. Es ist unerläßlich, das grundlegende Thema nicht irgendwie abstrakt, sondern ganz konkret vorzuformulieren. Ich könnte beispielsweise ein Hilfesystem für meine Küche brauchen, im Gegenzug könnte ich mir überlegen, wie ich ein Hilfesystem für künftige Holunderweinhersteller zusammenstellen sollte. Die richtige Motivation dafür kriege ich nur zusammen, wenn mir das "Zielsystem" dafür alles andere als egal ist.

was, ums himmels willen, haben denn Zeilenumbrüche mit einem Hilfesystem zu tun?
Welche Zeilenumbrüche? Herrgott, das ist nur eine Beispielseite fuer ein Hilfekapitel. Wohl zu abstrakt...
Ich dachte, wenn ich schreibe

---

ich meinte die typischen SelfHTML-Seiten, wie z.B. http://de.selfhtml.org/html/text/zeilenumbruch.htm

---

wuerden die meisten Leute verstehen, dass das ein Beispiel ist, und ich einen Zusammenhang zu den "typischen SelfHTML-Seiten" herstellen will. Vielleicht ist das Adjektiv "typisch" in diesem Fall verwirrend?

Nö. Ich sollte die "typischen SelfHTML-Seiten" seit ungefähr 1998 ziemlich gut kennen. Sie zeichnen sich im wesentlichen dadurch aus, daß es zwar ein nahezu immer wiederkehrendes Layout gibt, dieses Layout aber gegenüber dem tatsächlich transportierten Inhalt zurücktritt.

Ist uebrigens nicht so, dass ich mir mein Original-Posting nicht nochmal durchgelesen hätte. Und ich räume durchaus ein, dass beim eiligen Überfliegen nicht gleich klar ist, worum es genau geht.

Siehst du, da kommen wir ja langsam an eine Stelle, an der man weiterreden könnte. Ich habe ein kleines bißchen Erfahrung, was das Zusammenstellen von Dokumentationen angeht. Auch online-Hilfen für Teilnehmer meiner Kurse habe ich schon geschrieben, und da ich die Jungs immer auch unmittelbar und direkt vor mir sitzen hatte, weiß ich natürlich, wie meine "Zielgruppen" auf solche Leseangebote reagieren können  -  allerdings nicht müssen. Immerhin kann ich ganz gut abschätzen, was man einer bekannten Zielgruppe an Hilfestellung und/oder Dokumentation anbieten kann.

Aber ich schaetze die Forumsteilnehmer als so intelligent ein, dass sie's trotzdem raffen.

Wenn du das Forum kennst, weißt du, daß es nicht nur eine "Kultur des Antwortens" gibt, sondern auch eine "Kultur der Fragestellung"  -  und die mußt du dir in den nächsten zwei Tagen noch zu eigen machen. Die Forumsteilnehmer sind in der Regel tatsächlich ziemlich intelligente und/oder irgendwie gescheite Leute. Es muß ja auch einen Grund haben, weshalb sowohl Andreas wie auch Jeena auf die Idee gekommen sind, dir mit einem vagen Hinweis auf eine DTD zu kommen  -  ich fürchte allerdings möglicherweise zu recht, daß du damit (noch) nix anfangen kannst.

Also worum geht es nun?
Du willst eine Dokumentation zu irgendeinem Thema verfassen, die du aber "Hilfesystem" nennst. Das kannst du natürlich (ich wiederhole mich) gerne machen. Aber du hast dein Thema, für das diese Hilfestellung gelten soll, (noch) nicht angegeben, es kann dir also keiner bisher ein paar unterstützende Hinweise geben, welche (thematischen) Details ins Konzept aufgenommen werden sollten. Du hast nur eine absolut abstrakte und nicht einmal schöne Struktur benannt, in der man sowohl ein Kochbuch wie auch eine Anleitung zum Aquarienbau unterbringen könnte. Für beide Themen hätte ich durchaus Details parat, die ich dir nennen könnte, gleichzeitig habe ich bei beiden Themen noch allerhand Lernbedarf. Aber was hilfts dir, wenn ich dir erkläre, mit welchen Chemikalien Silikonkleber für Aquarien hergestellt werden sollten, wenn du doch eine Dokumentation über Klavierbau zusammenstellen möchtest?

Fazit: deine Fragestellung war schlicht und einfach viel zu ungenau. Präzisiere sie. Erkläre, was du nun wirklich vor hast. Nimm dir nicht zuviel auf einmal vor. Es ist besser, mit kleinen Schritten anzufangen und sich die Option zur Erweiterung offenzuhalten, als mit einem "gigantischen" Anspruch loszumarschieren und nach wenigen Tagen schemrzhaft auf der Nase zu landen.

Grüße aus Berlin

Christoph S.

[Eddie]

Hallo Christoph,

Kommt naemlich ziemlich haeufig vor, dass du einen ziemlich unleidlichen Eindruck machst.

Achwo. Ich bin die Liebenswürdigkeit in person.

:-) Eigentlich konnte ich mir auch nichts anderes vorstellen. Drum hab ich ja auch "Eindruck" geschrieben. Aber diesen Eindruck gibt's eben manchmal, ist halt bloed im Internet, weil man die Leute dabei nicht zwinkern sieht.

Ein monströses Tutorial

Du solltest dein Begriffsverständnis für "Monster" dringend revidieren, finde ich.

Nach Wahrigs Deutschem Wörterbuch (mon'strös, mons'trös <Adj.; -er, am -esten> ungeheuerlich; missgestaltet [<lat. monstrosus „ungeheuerlich; missgestaltet; scheußlich“, urspr. „wunderbar, widernatürlich“]) sollte ich das tatsaechlich. Hast recht.

SelfHTML ist ein gigantisches Hilfesystem, oder etwa nicht?

Nein. In Korrelation zu meiner von Stefan unten angesprochenen (Alters-)Brummigkeit bin ich gegenüber Superlativen wie "gigantisch" mehr als skeptisch.

Trotz allem sagt mir Google, dass es unter de.selfhtml.org über 64.000 Einzelseiten gibt: http://www.google.de/search?hl=de&c2coff=1&q=site%3Ahttp%3A%2F%2Fde.selfhtml.org&meta=.
Wenn das nicht die Bezeichnung "gigantisch" verdient, dann weiss ich auch nicht.

du sagtest, daß du dir ein Hilfesystem aufbauen möchtest. Aber wo soll das laufen?

Im WWW, mittels PHP, um die verschiedenen Funktionen meiner Website http://www.umdiewelt.de/ zu dokumentieren. Die Texte selbst sollen in der DB lagern, einfach weil das bisher auch so ist und sich bewaehrt hat. Jeder Text jeweils in englischer und deutscher Fassung.

Nö. Ich sollte die "typischen SelfHTML-Seiten" seit ungefähr 1998 ziemlich gut kennen. Sie zeichnen sich im wesentlichen dadurch aus, daß es zwar ein nahezu immer wiederkehrendes Layout gibt, dieses Layout aber gegenüber dem tatsächlich transportierten Inhalt zurücktritt.

Und genau das will ich erreichen. Leicht zu findende und zu verstehende Informationen, ohne das der Anwender erst die Funktionsweise erlernen muss.

Ich habe ein kleines bißchen Erfahrung, was das Zusammenstellen von Dokumentationen angeht. Auch online-Hilfen für Teilnehmer meiner Kurse habe ich schon geschrieben, und da ich die Jungs immer auch unmittelbar und direkt vor mir sitzen hatte, weiß ich natürlich, wie meine "Zielgruppen" auf solche Leseangebote reagieren können  -  allerdings nicht müssen. Immerhin kann ich ganz gut abschätzen, was man einer bekannten Zielgruppe an Hilfestellung und/oder Dokumentation anbieten kann.

Ok, meine Zielgruppe sind Menschen, die zwar eine gewisse Affinitaet zum WWW haben, denen aber meistens der technische Hintergrund fehlt. Denen moechte ich Fragen beantworten koennen, und zwar
a) ohne dass sie mir jedesmal eine Mail schreiben muessen, auf die ich wiederrum ausfuehrlich antworten muss - das ist naemlich ziemlich zeitaufwendig
b) so, dass sie die Information selber finden koennen, und ich ihnen ggf. per Mail einen Link zu dieser Information schicken kann.

Es muß ja auch einen Grund haben, weshalb sowohl Andreas wie auch Jeena auf die Idee gekommen sind, dir mit einem vagen Hinweis auf eine DTD zu kommen  -  ich fürchte allerdings möglicherweise zu recht, daß du damit (noch) nix anfangen kannst.

Siehst du, und das klingt jetzt schon wieder unleidlich. Wenn du das schon fuerchtest, dann haette ein Link an dieser Stelle nicht geschadet.
Aber ich kann dich beruhigen, zu diesem Thema habe ich erst letztes Jahr ein Referat gehalten. Zugegebenermassen heisst DTD fuer mich aber automatisch XML, und XML wollte ich jetzt eigentlich nicht verwenden, weil ich die entsprechenden PHP-Bibliotheken nicht kenne und - ich geb's zu - gerade auch zu faul bin fuer sowas. Aber vielleicht sollte ich mir das nochmal ueberlegen.

Also worum geht es nun?

Um den Aufbau eines Hilfe-Systems/einer Dokumentation mittels PHP/HTML/MySQL(/XML) und unter Verwendung eingebetteter Bilder inkl. optionaler Bildunterschrift. Jeder Hilfeabschnitt muss ueber eine konkrete URL erreichbar sein, gegebenenfalls mittels Ankern.
Ich muss also in der Lage sein, entsprechende URLS per Mail zu verschicken und an beliebiger Stelle meiner Website diese Links zu setzen.
Die Dokumentation soll bei Klick auf einen Hilfelink in einem separaten Fenster ablaufen, wobei sich das Design am globalen Design von umdiewelt.de orientieren wird, allerdings etwas schlichter, z.B. so: http://www.umdiewelt.de/contact.php?m=w&s=Frage zu www.umdiewelt.de.
Themen werden z.B. die Bedienung der Seite sein (also Technisches), eine Liste häufiger Fragen ("FAQ"), aber auch Philosophischeres, z.B. zu Themen wie "Schreibstil im Internet".
Im oberen Bereich brauche ich eine "Kruemelspur", um eine baumartige Struktur zu simulieren. Anfangs, solange wenige Texte vorhanden sind, ist das aber kaum noetig.

Wenn dir dazu noch was einfaellt - seien es Kritik oder Ideen - wuerde ich mich sehr freuen, wenn du noch was schreibst. Ich hoffe, diesmal war ich etwas konkreter und leichter zu verstehen.

Eddie

[MudGuard]

Hi,

ich will mir endlich mein eigenes kleines Hilfesystem basteln. Natuerlich nicht auf einen Schlag, sondern, indem ich mit den wichtigsten Kapiteln anfange. Ergo habe ich aber auch nur eine grobe Vorstellung, was irgendwann mal für Elemente nötig sein könnten.

Ich bin mir sicher, bei SelfHTML gibt's sowas, wo alle eben Eventualitaeten beruecksichtigt sind. Drum danke für eure Hilfe,

Ich meine, mal was von einer Self-DTD gelesen zu haben - aber finde die DTD selbst nicht, nur Hinweise darauf (http://forum.de.selfhtml.org/archiv/2004/7/84623/?t=84623&m=496512#m496512)

cu,
Andreas

[Jeena Paradies]

Hallo,

Ich bin mir sicher, bei SelfHTML gibt's sowas, wo alle eben Eventualitaeten beruecksichtigt sind. Drum danke für eure Hilfe,

Also SELFHTML ist aus lauter einzelnen Dateien zusammengebaut, die von Hand verlinkt sind, so weit ich das verstanden habe. Es wird zwar an einer eigenen DTD gearbeitet, damit man (ich glaube ab Version 9) die Daten alle in Form von XML abspeichern kann und mittels eines Programms einfach verarbeiten kann, aber bisher waren es einzelne Dateien.

Es gibt auch schon fertige Systeme die dir beim erstellen von Dokumentationen (such mal nach Dokumentation help System oder so) helfen.

Grüße
Jeena Paradies

[Eddie]

Hallo allerseits,

http://aktuell.de.selfhtml.org/sonst/layoutvorgaben.htm war genau das, was ich gesucht habe.
Danke!

Eddie