CMSimple_XH 1.7 Dokumentation

Ein CMSimple Support Forum für deutsch sprechende Nutzer und Entwickler
cmb
Posts: 12531
Joined: Tue Jun 21, 2011 11:04 am
Location: Mü-Sa, RLP, DE
Contact:

Re: CMSimple_XH 1.7 Dokumentation

Post by cmb » Mon Jul 03, 2017 1:53 pm

Hartmut wrote:Die beiden ersten Kapitel der CMSimple_XH 1.7 Dokumentation sind an CMSimple_XH 1.7 vollständig angepasst worden.
Super, danke! :)
Hartmut wrote:Ich würde mich über ein "gegengelesen" von Euch freuen, ob sie inhaltlich richtig und vollständigt sind und auch halbwegs verständlich geschrieben worden sind.
Folgendes ist mir aufgefallen:
  1. Im Heading von http://cmsimplexh-doku017.keil-portal.d ... zgebiet-SW wird ein Zeichen nicht richtig dargestellt, sondern nur als Rechteck.
  2. Tippfehler auf http://cmsimplexh-doku017.keil-portal.d ... ist-neu%3F: "Wenn sich sicher ist, dass diese Funktionen nicht gebraucht werden,"
  3. Tippfehler ebd.: "word separtor" sollte "word separator" sein (habe ich in der Releaseankündigung nun gefixt)
  4. Tippfehler ebd.: "Dieser verwendet" müsste "Diese verwendet" sein (ebenfalls in der Releaseankündigung behoben)
  5. Tippfehler ebd.: "umbedingt" (in der Releaseankündigung behoben)
  6. Tippfehler ebd.: "oder Anwender dies zu erlauben" → "oder Anwendern dies zu erlauben"
  7. Fehlender Link (oder Erklärung) ebd.: "Password-Hashing-Funktionen"; entweder zu http://php.net/manual/de/book.password.php verlinken, oder password_hash() und password_verify() in Klammern oder statt "Password-Hashing-Funktionen" auflisten
  8. Tippfehler ebd.: "Es sollten statt dessen XH\Pages verwendet werden." XH\Pages ist Einzahl, als "sollte". Ich bin mir aber nicht sicher, ob das wirklich als "sollte" empfohlen werden sollte. Es ist eigentlich nur eine Möglichkeit.
  9. Im Heading von http://cmsimplexh-doku017.keil-portal.d ... ssetzungen wird ebenfalls ein Zeichen nicht richtig dargestellt, vgl. (1)
  10. ebd.: "Es wird die neuste Version von Firefox, Internet Explorer, Chrome, Safari oder Opera empfohlen." Hier fehlt Edge; vielleicht sollte man auch den Internet Explorer ganz aus der Liste entfernen – letztlich ist Edge die Weiterentwicklung des IE.
  11. ebd.: "Beispielsweise könnte solch eine Erweiterung ein Plugin sein, welches nur unter PHP 5 ausgeführt werden kann." Es wird sowieso schon PHP 5.3 vorausgesetzt; hier also vielleicht PHP 5.6 statt PHP 5 angeben.
  12. http://cmsimplexh-doku017.keil-portal.d ... ereitungen: siehe (1)
  13. ebd.: Unter http://sourceforge.net/projects/cmsimplexh/ werden keine weiteren Versionen von CMSimple_XH mehr eingestellt werden. Diese alte Projektseite ist im Ruhestand, und dient lediglich der Historie.
  14. ebd.: http://www.meine-domain.de/index.php – wenn solche Beispieldomains verwendet werden, dann bitte nicht verlinken (in diesem Fall landet man derzeit bei einem Domainhändler). Oder halt eine der offiziellen Beispieldomains verwenden.
  15. ebd.: bei "Der Ordner 2lang/ist" fehlt ein Leerzeichen
  16. http://cmsimplexh-doku017.keil-portal.d ... ion-Server: siehe (1)
  17. http://cmsimplexh-doku017.keil-portal.d ... MSimple_XH: da fehlt ein Leerzeichen in der Überschrift ("Ersteinrichtungim")
  18. http://cmsimplexh-doku017.keil-portal.d ... ionsupdate: siehe (1)
  19. Tippfehler ebd.: "gihup" müsste "github" lauten
Christoph M. Becker –Plugins for CMSimple_XH, but not for CMSimple 4+

Hartmut
Posts: 507
Joined: Sat Nov 05, 2011 6:13 pm
Location: Butzbach, Deutschland
Contact:

Re: CMSimple_XH 1.7 Dokumentation

Post by Hartmut » Mon Jul 03, 2017 7:33 pm

Danke fürs gegenlesen. :-)

Deine Anmerkungen habe ich eingepflegt.
Das Sonderzeichen im Heading ist leider in recht vielen alternativen Seitentiteln (Seiten Parameter) enthalten und in den ersten drei Kapitel wurde es von mir schon entfernt.


Viele Grüße
Hartmut

Hartmut
Posts: 507
Joined: Sat Nov 05, 2011 6:13 pm
Location: Butzbach, Deutschland
Contact:

Re: CMSimple_XH 1.7 Dokumentation

Post by Hartmut » Wed Jul 12, 2017 7:35 pm

Hallo,

das dritte Kapitel der CMSimple_XH 1.7 Dokumentation (Beschreibung der Oberfläche) ist an CMSimple_XH 1.7 vollständig angepasst worden und mit dem Kapitel 4 (Beschreibung der Funktionalitäten) wurde angefangen.

Direktlink: http://cmsimplexh-doku017.keil-portal.de/

Viele Grüße
Hartmut

Hartmut
Posts: 507
Joined: Sat Nov 05, 2011 6:13 pm
Location: Butzbach, Deutschland
Contact:

Re: CMSimple_XH 1.7 Dokumentation

Post by Hartmut » Thu Jul 20, 2017 7:06 pm

Hallo,

das vierte Kapitel der CMSimple_XH 1.7 Dokumentation (Beschreibung der Funktionalitäten) ist an CMSimple_XH 1.7 vollständig angepasst worden.

Direktlink: http://cmsimplexh-doku017.keil-portal.de/

Ich würde mich wieder über ein "gegengelesen" von Euch freuen, ob sie inhaltlich richtig und vollständigt sind und auch halbwegs verständlich geschrieben worden sind.

Viele Grüße
Hartmut

Hartmut
Posts: 507
Joined: Sat Nov 05, 2011 6:13 pm
Location: Butzbach, Deutschland
Contact:

Re: CMSimple_XH 1.7 Dokumentation

Post by Hartmut » Sun Aug 06, 2017 5:46 am

Hallo,

die CMSimple_XH 1.7 Bedienungsanleitung steht jetzt vollständig in einer finalen Version Online zur Verfügung.

Sie wurde in den vergangenen 6 Wochen auf Grundlage der 1.6er Dokumentation erstellt, hat den gleichen strukturellen Aufbau und enthält hoffentlich alle relevanten Inhalte von CMSimple_XH 1.7.

Da diese Dokumentation für alle CMSimple_XH Nutzer hilfreich und für den täglichen Gebrauch gut zu gebrauchen sein soll, sind Anregungen und Änderungsvorschläge willkommen und werden gerne berücksichtig.

Für die bisher eingegangenen Hinweise, Anregungen und Unterstützung zur 1.7er Dokumentation bedanke ich mich im Besonderen bei cmb (Christoph Becker).


Viele Grüße
Hartmut

manu
Posts: 643
Joined: Wed Jun 04, 2008 12:05 pm
Location: St. Gallen - Schweiz
Contact:

Re: CMSimple_XH 1.7 Dokumentation

Post by manu » Sun Aug 06, 2017 10:30 am

Danke für Deinen tollen Einsatz, Hartmut.
Was mir aus einem anderen Zusammenhang gerade auffällt, ist, dass bei den Webserver Anforderungen der Hinweis auf die PHP Erweiterungen, die CMSimple_XH benötigt, nicht mehr aufgeführt ist. Im 1.6er Wiki wird noch auf diese hingewiesen. Vielleicht wurde dies schon an anderer Stelle diskutiert, dann ist gut.
Die mbstring Erweiterung wurde integriert, gehört aber laut PHP Doc nicht zum Standard. Obwohl diese mehrheitlich installiert ist, ist IMHO eine Erwähnung wert.
Gruss
manu

cmb
Posts: 12531
Joined: Tue Jun 21, 2011 11:04 am
Location: Mü-Sa, RLP, DE
Contact:

Re: CMSimple_XH 1.7 Dokumentation

Post by cmb » Sun Aug 06, 2017 11:00 am

manu wrote:Danke für Deinen tollen Einsatz, Hartmut.
+1
manu wrote:Die mbstring Erweiterung wurde integriert, gehört aber laut PHP Doc nicht zum Standard. Obwohl diese mehrheitlich installiert ist, ist IMHO eine Erwähnung wert.
Ich denke auch, dass die benötigten Extensions entweder konkret aufgelistet werden sollten, oder diesbezüglich allgemein auf die Systemprüfung verwiesen werden sollte. Ersteres ist vermutlich besser, da man bei Fehlen einer Extension u.U. gar nicht bis zur Systemprüfung kommt, sondern nur einen weißen Bildschirm sieht. Fehlt zum Beispiel die Session-Extension, ist nicht mal das Login möglich.

Bezüglich der "Standard"-Erweiterungen: das ist in der Praxis wenig relevant, da die Linux-Distros wohl eher ihre eigenen Standard-Pakete schnüren.
Christoph M. Becker –Plugins for CMSimple_XH, but not for CMSimple 4+

Hartmut
Posts: 507
Joined: Sat Nov 05, 2011 6:13 pm
Location: Butzbach, Deutschland
Contact:

Re: CMSimple_XH 1.7 Dokumentation

Post by Hartmut » Sun Aug 06, 2017 8:19 pm

Hallo manu und cmb,

danke für die Hinweise bzgl. der PHP Erweiterungen, die von mir in die Doku eingearbeitet worden sind. :)

Der Eintrag im Wiki und auch der Forum Beitrag mit der Utf8 Integration habe ich leider komplett übersehen. :(

Für mich als Außenstehender (nicht an der Entwicklung Beteiligter) ist es nicht einfach ist, alles Wichtige im "Hinterkopf" zu haben bzw. in den verschiedenen Quellen zu finden, zumal der Inhalt auf seine Aktualität und Relevanz zum jeweiligen Fall zu prüfen ist.
Falls es noch mehr von solchen "Spezialitäten" gibt, nehme ich sie gern in die Dokumentation mit auf, da mir eine inhaltlich vollständige und aktuelle Doku wichtig ist.

Viele Grüße

Hartmut

cmb
Posts: 12531
Joined: Tue Jun 21, 2011 11:04 am
Location: Mü-Sa, RLP, DE
Contact:

Re: CMSimple_XH 1.7 Dokumentation

Post by cmb » Sun Aug 06, 2017 9:20 pm

Hartmut wrote:danke für die Hinweise bzgl. der PHP Erweiterungen, die von mir in die Doku eingearbeitet worden sind. :)
Danke für das Einarbeiten, aber die Infos sind für CMSimple_XH 1.7 leider nicht mehr aktuell. Da wir inzwischen mindestens PHP 5.3 voraussetzen, sind pcre und date sowieso immer vorhanden (diese beiden Extensions können gar nicht mehr deaktiviert werden). xml wurde nur von Pagemanager 1 & 2 benötigt, aber Pagemanager 3 (und einige andere Stellen) benötigen statt dessen die json Extension.
Hartmut wrote:Der Eintrag im Wiki und auch der Forum Beitrag mit der Utf8 Integration habe ich leider komplett übersehen. :(
Hier noch zur Erklärung, falls es an anderer Stelle nicht erwähnt wurde: vor CMSimple_XH 1.7 wurde mbstring nicht notwendigerweise benötigt; die alternativen Implementierungen der Funktionalität waren aber umfangreich, langsam und nicht unbedingt vollständig, so dass seit XH 1.7 eben mbstring benötigt wird, und somit das Utf8 Plugin durch eine einzige kleine Datei (cmsimple/utf8.php) ersetzt werden konnte.
Hartmut wrote:Falls es noch mehr von solchen "Spezialitäten" gibt, nehme ich sie gern in die Dokumentation mit auf, da mir eine inhaltlich vollständige und aktuelle Doku wichtig ist.
Ich hoffe, dass ich im Lauf der Woche dazu komme die Doku ab Kapitel 3 gegenzulesen. Habe ich schon seit einer Weile vor, aber immer ist noch was anderes.
Christoph M. Becker –Plugins for CMSimple_XH, but not for CMSimple 4+

manu
Posts: 643
Joined: Wed Jun 04, 2008 12:05 pm
Location: St. Gallen - Schweiz
Contact:

Re: CMSimple_XH 1.7 Dokumentation

Post by manu » Mon Aug 07, 2017 1:24 pm

cmb wrote:...
Ich denke auch, dass die benötigten Extensions entweder konkret aufgelistet werden sollten, oder diesbezüglich allgemein auf die Systemprüfung verwiesen werden sollte. Ersteres ist vermutlich besser, da man bei Fehlen einer Extension u.U. gar nicht bis zur Systemprüfung kommt, sondern nur einen weißen Bildschirm sieht. Fehlt zum Beispiel die Session-Extension, ist nicht mal das Login möglich.
...
Ich finde beides sinnvoll
  1. Systemprüfung auf alle benötigten Erweiterungen
  2. daraus die Dokumentation ableiten für die Systemanforderung Webserver (benötigte Erweiterungen)

Post Reply