Die CMSimple_XH (V 1.5.x) Dokumentation ist jetzt verfügbar

[Hartmut]

Hallo,

für CMSimple_XH steht jetzt eine Onlinedokumentation zur Verfügung.
Sie ist in die Kapitel...

• • Einführung,
  • Installation,
  • Beschreibung der Oberflächen,
  • Beschreibung der Funktionen,
  • Architektur
  • Anhang (Referenzlisten zu Dienstleistern, Plugins, Templates, ....)

aufgegliedert.

Die Dokumentation richtet sich sowohl an...

• • den "Anwender", der beispielsweise die Bedeutung der einzelnen Menüfunktionen, oder eine Anleitung für Tätigkeiten im Adminbereich sucht,
  • den "Entwickler" der beispielsweise für ein neues Plugin bzw. Template CMSimple_XH interne Funktionalitäten sucht,
  • den "Installer" der beispielsweise ein ganzes CMSimple_XH oder nur ein Plugin installieren und konfigurieren will,
  • den "Designer" der beispielsweise ein Template mit vier anstelle der üblichen drei Menüebenen realisieren will.

Mit den zur Verfügung stehenden Filtern können für eine Zielgruppe (Anwender, Entwickler, Installer, Designer) nicht relevante Inhalte ausgeblendet werden.

Die Onlinedokumentation beschreibt CMSimple_XH in der Version 1.5.X und ist mit Einschränkungen auch für Version 1.6.x nutzbar. Einige beispielhafte Unterschiede sind:

• • Eine andere Verzeichnisstruktur
  • einfacheres aktivieren eines Backups
  • Die content.htm und pagedata.php wurden zur content.htm zusammen geführt
  • ....

Eine Onlinedokumentation für CMSimple_XH Version 1.6.X ist geplant und Mitautoren sind willkommen.

Link: http://www.webdesign-keil.de/cmsimplexhonlinedoku/

Meinen besonderen Dank richte ich für die fachliche Unterstützung an cmb (Christoph Becker)

Gruß Hartmut

[Ikko]

Cool! Rechtzeitig zum End of Life der V 1.5 kommt die passende Dokumentation!
http://www.cmsimple-xh.org/de/?History_ ... EOL_v1.5.x
Trotzdem ein grosses Danke für die Arbeit! Ich freue mich auf die Dokumentation für 1.6

[cmb]

Trotzdem ein grosses Danke für die Arbeit! Ich freue mich auf die Dokumentation für 1.6

Wenn Hartmut dann nicht alles alleine machen muss, verbessern sich die Chancen, dass die Doku rechtzeitig fertig ist, bevor 1.6 in Rente geht.

[snafu]

Ich lese hier immer noch regelmäßig mit ;-}

aus einer umfangreichen Doku zur 1.5 eine für die 1.6 zu machen, dürfte ein bißchen einfacher sein, als ein v1.5dok komplett neu zu klöppeln.

Was mich persönlich ein bißchen irritiert, ich habe die letzten Wochen mit steigernder Häufigkeit Anfragen zu Template Erstellung bekommen (ich verweise die dann immer hier ins Forum) und der letzte wies mich netterweise darauf hin, daß die Seite von Lars Ellmauer wohl nicht mehr ansprechbar ist.
Damit scheint mein Template Tutorial so ziemlich das Einzig halbwegs aktuelle zu sein, wenn man mal von den uralten "changing the template" Seiten im Archiv absieht.
Mein Tutorial deckt aber nicht alle Belange ab, ich benutze ja nicht alle functions call und, sollte man auch nicht übersehen, ich benutze das 1kb grid, das inzwischen auch vom netz genommen wurde (zumindest der Generator).

Ich häkel mir zwar gerade für mein WP ein neues Theme, benutze dafür aber das PocketGrid. Ich könnte zwar mein Gonzo darauf anpassen (inkl responsdingens) und das PocketGrid ist in der praktischen Anwendung noch trivialer als das 1KB ... aber unter der Haube komplizierter ... achja, und da gibts dann noch mein Zeitfenster

In die CMSimple Dokumentation gehört zwingend, habe ich schon vor Jahren gesagt, eine Tutorial zur Template Erstellung, so wie es schon auf der Site mit der Urversion von Peter Harteg war.

[Ulrich]

No offense ....
aber stolz das Erscheinen einer Dokumentation zu verkünden 12 Tage nach dem EOL für die Programmversion ist etwas sagen wir mal seltsam.

Gestern wurde die Dokumentation für Windows 95 veröffentlicht .......... oder war es 98

Liegt wohl hauptsächlich daran das ständig am aktuellen Code gearbeitet wird, kaum das ein Kapitel der aktuellen Dokumentation fertig ist, ist es schon überholt.

Ich habe 10 Jahre Tech Doc gemacht, da wurde die Dokumentation parallel zur Hardware geschrieben, und nicht hinterher.

Gut das CMSIMPLE, egal in welcher Fork oder Variante ein freies System ist; würde das CMS für Geld verkauft, gäbe es bestimmt schon Klagen wegen fehlender oder fehlerhafter Dokumentation.

Ich weiss, motzen kann jeder....... aber warum sollte ich auch nur eine Zeile Doc schreiben für etwas was morgen schon überholt ist. Sieht man sich an was hier im Forum für Patches veröffentlicht werden, und vergleicht dann die "original" *_XH version damit, dann passt weder die doc zum Programm noch das Programm zur Doc.

Meistens wird die Doc doch erst gelesen wenn etwas nicht klappt (in case of problems refer to the manual), wenn ich dann aber ein gepatchtes CMS habe und die doc sagt was anderes, ist das Geschrei gross.......und wieviele werden nun die 1.5.x doc für 1.6.x nutzen - "ist ja nur eine Versionsnummer höher, da kann nicht viel anders sein" .....

Warten wir mal ab wie viele die Dokumentation überhaupt nutzen werden............

[cmb]

Ich lese hier immer noch regelmäßig mit ;-}

Schön.

daß die Seite von Lars Ellmauer wohl nicht mehr ansprechbar ist.

Tatsächlich! http://www.larsellmauer.net/ liefert einen 500 Internal Server Error; ich vermute, dass durch ein Provider-Update die vermutlich alte CMSimple(_XH?) Version nun nicht mehr mitspielt. Anscheinend hat Lars das noch nicht mitbekommen. Ich versuche mal, ihn per E-Mail zu kontaktieren.

In die CMSimple Dokumentation gehört zwingend, habe ich schon vor Jahren gesagt, eine Tutorial zur Template Erstellung, so wie es schon auf der Site mit der Urversion von Peter Harteg war.

Ja, ein Tutorial gehört auf jeden zur Dokumentation (ob aber die Site mit der Urversion von Peter Harteg wirklich hilfreich war, wage ich zu bezweifeln) . Allerdings enthält die von Harmut vorgestellte Doku bereits einige Information zu Templates (ist natürlich ausbaufähig), und sie ist auch nicht unbedingt als Ablösung für das XH-Wiki gedacht, wo ja eine ganze Reihe von Infos zur Template-Erstellung vorhanden sind (u.a. ein Verweis auf Dein Tutorial, dessen engl. Übersetzung), und in der Developer-Doku gibt es eine aktuelle Liste der Template-Funktionen. All das müsste natürlich auch mal aufbereitet werden...

Gut das CMSIMPLE, egal in welcher Fork oder Variante ein freies System ist; würde das CMS für Geld verkauft, gäbe es bestimmt schon Klagen wegen fehlender oder fehlerhafter Dokumentation.

Na ja, letzteres wohl nicht unbedingt -- es würde halt im Zweifel weniger Käufer finden. Aber CMSimple_XH ist ein Open-Source-System, und da ist es eben (leider) nicht ungewöhnlich, dass die Dokumentation mangelhaft und verstreut ist (ist z.B. bei PHP nicht wirklich anders). Gäbe es mehr Freiwillige, die mithelfen würden, könnte sich das ändern.

Ich weiss, motzen kann jeder.......

Wer über Mängel bei einem Open-Source-System motzt, das er selbst verwendet, beschwert sich bei der Community, von der er ein Teil ist, und damit letztlich damit auch bei sich selbst.

[snafu]

Ja, ein Tutorial gehört auf jeden zur Dokumentation (ob aber die Site mit der Urversion von Peter Harteg wirklich hilfreich war, wage ich zu bezweifeln) .

Nuja, war zwar Tabellenbasierend, aber man bekam immerhin eine Idee davon, wie es funktionieren könnte

Verweis auf Dein Tutorial], dessen engl. Übersetzung),

deswegen habe ich meine cmsimpel Installation auch nicht gelöscht (frißt ja kein brot oder so), werde mir dann aber wohl irgendwann mal die Mühe machen müssen, sie versionsmäßig zu aktualisieren.

Wer über Mängel bei einem Open-Source-System motzt, das er selbst verwendet, beschwert sich bei der Community, von der er ein Teil ist, und damit letztlich damit auch bei sich selbst.

ja und? habe ich doch auch immer gerne gemacht ;-}

[cmb]

deswegen habe ich meine cmsimpel Installation auch nicht gelöscht (frißt ja kein brot oder so), werde mir dann aber wohl irgendwann mal die Mühe machen müssen, sie versionsmäßig zu aktualisieren.

Na ja, so eilig ist das nicht. An den Templates hat sich eigentlich von 1.5 zu heute nichts geändert, und ich gehe davon aus, dass das auch längerfristig so bleiben wird, damit nicht die vielen existierenden Templates plötzlich nicht mehr funktionieren. Einzig ein paar zusätzliche Möglichkeiten sind dazu gekommen (z.B. $li Parameter für toc()), aber das wird kaum jemand brauchen. Und es steht auf dem Plan für Templates den HTML5 Doctype zu empfehlen, aber das hast Du in Deinem Tutorial unter Verbesserungen ja bereits berücksichtigt.

PS: Wer lesen kann, ist klar im Vorteil. Es ging Dir natürlich um Aktualisierungen des Systems, und die verursachen leider einen gewissen Aufwand, zumal Du viele Plugins installiert hast.

[Hartmut]

Hallo,

mein persönliches Ziel die Dokumentation für CMSimple_XH 1.5.x vor dem EOL (End of Live) zu veröffentlichen hat leider nicht geklappt da meine Ressourcen endlich sind und es noch ein Leben außerhalb von CMSimple_XH gibt, aber für die 1.6-er Version bin ich optimistisch.
Das es im WWW noch viele CMSimple_XH 1.5.x Versionen im Einsatz sind, obwohl die 1.6 schon einige Zeit zur Verfügung steht, hat die derzeitige Dokumentation durchaus noch ihre Daseins Berechtigung.

Außerdem kann sie als Diskussionsgrundlage für beispielsweise zusätzliche bzw. detailliertere Inhalte dienen, die in der 1.6-er Version berücksichtigt werden können.
Sprich: "Anregungen und Mitstreiter sind willkommen".

Ihr habt durch eure Mitarbeit die Möglichkeit hier eine Dokumentation zu gestalten und zu erhalten, die für Alle (Anwender, Entwickler, Installer und Designer) hilfreich ist, ohne dabei das Wiki ersetzten zu wollen.

Mit der Idee die Dokumentation "1.5.x" als Grundlage für "1.6.x" zu verwenden, habe ich hier einige Punkte beispielhaft aufgeführt:

• • Welche Kapitel der Dokumentation 1.5.x können 1:1, bzw. mit kleinen Änderungen übernommen werden, bzw. müssen neu geschrieben werden?
  • Welche Themen fehlen vollständig bzw. sollten detaillierter sein?
  • Gibt es Themen die "überflüssig" sind bzw. etwas allgemeiner (und nicht so detailliert) benötigt werden?
  • Was kann ich (als Leser dieses Beitrages) dazu beitragen, dass diese Dokumentation meinen Erwartungen entspricht und mir auch bald zur Verfügung steht?
  • ...

Gruß Hartmut