Wie Du die CONTENIDO-Dokumentation mitgestalten kannst

Fragen zur Installation von CONTENIDO 4.9? Probleme bei der Konfiguration? Hinweise oder Fragen zur Entwicklung des Systemes oder zur Sicherheit?
Antworten
frederic.schneider_4fb
Beiträge: 967
Registriert: Do 15. Apr 2004, 17:12
Wohnort: Eschborn-Niederhöchstadt
Kontaktdaten:

Wie Du die CONTENIDO-Dokumentation mitgestalten kannst

Beitrag von frederic.schneider_4fb » Do 17. Apr 2014, 12:21

Gestalten. Wie Du die CONTENIDO-Dokumentation mitgestalten kannst.

Voraussetzungen
Um an der CONTENIDO-Dokumentation mitzuschreiben brauchst Du grundsätzlich keine besonderen Voraussetzungen. Wichtig ist nur:
  • dass Du Dich in unserem Dokumentationssystem einmalig registrierst,
  • zur Bearbeitung der einzelnen Dokumentationsseiten einen aktuellen Internetbrowser verwendest und
  • dass Du Dir beim Verfassen der Texte etwas Zeit nimmst, denn: Qualität geht stets vor Quantität.
Registrierung
Um Seiten in der Dokumentation zu ändern ist es notwendig, dass Du Dir einen persönlichen Nutzeraccount registrierst. Dies ist völlig kostenlos und kostet Dich nur eine Minute Zeit. Hierzu rufe unsere Website unter der Internetadresse https://docs.contenido.org auf und wähle oben rechts auf der Seite den Menüpunkt „Registrieren“ aus. Alternativ kannst Du das Registrierungsformular auch direkt in dem Internetbrowser Deines Vertrauens aufrufen: https://docs.contenido.org/signup.action.

An Angaben erwartet das Formular:
  • Deinen Vor- und Nachnamen unter „Vollständiger Name“.
  • Deine gültige E-Mail-Adresse.
  • Einen im Dokumentationssystem einmaligen Benutzernamen. Es sind lediglich Kleinbuchstaben erlaubt.
  • Dein persönliches Kennwort, das Du unter „Passwort“ sowie „Passwort bestätigen“ zweimal eingeben darfst. Bitte achte darauf, ein sicheres Kennwort zu wählen, d. h. mit mind. sechs, besser acht Zeichen, und einer Mischung aus Buchstaben, Sonderzeichen und Zahlen. Aus Sicherheitsgründen empfehlen wir Dir, nicht dasselbe Kennwort zu wählen wie auf einer anderen Plattform.
Seitenbereiche
Unsere Dokumentation unterteilt sich in drei Bereiche:
  • CONTENIDO – Deutsch“: Hier findest Du die deutschsprachigen Installationshinweise, die deutsche Aktualisierungsanleitung und das deutschsprachige Redakteurs-Handbuch.
  • CONTENIDO – English“: Hier findest Du die englischsprachigen Installationshinweise, die englische Aktualisierungsanleitung und das englischsprachige Redakteurs-Handbuch.
  • Developers“: Hinweise für die Entwicklung mit CONTENIDO im Allgemeinen, aber auch spezielle Informationen für interessierte Plugin-Autoren dokumentieren wir in diesem Bereich. Die Entwicklerdokumentation ist ausnahmslos in Englisch formuliert und soll in dieser Sprache weiterentwickelt werden.
Aufbau der Bereiche
Die einzelnen Seitenbereiche haben eine vorgegebene Struktur, die sich bei den Handbüchern an der Backend-Navigation von CONTENIDO-Version 4.9 orientiert. Für jedes Backend-Element gibt es eine Erläuterung.

Formulierung der Texte
Während Du bei der Entwicklerdokumentation durchaus davon ausgehen kannst, dass der Anwender grob über die Programmierung mit PHP Bescheid weiß, solltest Du bei den Handbüchern nach dem Prinzip „Lieber etwas zu viel, als etwas zu wenig erklärt“ vorgehen. Sprich: Die Handbücher richten sich (auch) an Anwender, die bislang mit CONTENIDO noch keine Erfahrungen sammeln durften. Vermeide deshalb Fachbegriffe oder erläutere sie zumindest. Zur Auflockerung empfiehlt es sich zudem mit Screenshots aus dem Backend zu arbeiten. Wir haben, damit die Anwender ihr CONTENIDO möglichst in der Dokumentation wiederfinden, stets Screenshots mit einer Standardinstallation von CONTENIDO 4.9 mit dem Beispielmandanten erstellt.

Bearbeiten einer Seite
Du hast Dir inzwischen für unsere Dokumentation einen Nutzeraccount angelegt und bist mit ihm angemeldet. Du hast Lust, einen Beitrag für unsere Community zu leisten, um andere Nutzer von Deinem Wissen profitieren zu lassen. Wir freuen uns über Deine Unterstützung!

Für bestehende Artikel genügt es, wenn Du die Seite aufrufst und ganz oben, mittig auf den Punkt „Bearbeiten“ klickst. Es lädt eine neue Seite mit einem Editor. In diesem Editor kannst Du, wie in jedem Textverarbeitungsprogramm auch, am Text Änderungen vornehmen und einige Formatierungen durchführen, beispielsweise Wörter fett markieren oder Aufzählungszeichen einfügen, um eine Liste zu erstellen. Ebenso ist es möglich, auf interne Dokumentationsseiten genauso zu verlinken wie auf externe Websites. Der Editor hält auch die Funktion zum Einfügen von Bildern (Screenshots) vor.

Eine ausführliche (englischsprachige) Erläuterung des Editors findest Du in der offiziellen Dokumentation von Atlassian, die unser Dokumentationssystem „Confluence“ entwickelt haben. Link: https://confluence.atlassian.com/displa ... the+Editor.

Bevor Du Deine Änderungen öffentlich machst, lies bitte den Text vorher noch einmal in aller Ruhe auf mögliche Rechtschreibfehler und missverständliche/unklare Formulierungen Korrektur. Du kannst auf „Vorschau“ klicken, um Deine Änderungen im Seitenlayout zu sehen. Außerdem gib bitte im Eingabefeld „Was haben Sie geändert?“ ganz unten auf der Seite ein, was Du an dem Artikel verbessert hast. Danach klicke auf „Speichern“, um Deine Änderungen öffentlich zu stellen. Vielen Dank!
Frederic Schneider
Entwickler bei der four for business AG

Faar
Beiträge: 1328
Registriert: Sa 8. Sep 2007, 16:23
Wohnort: Brandenburg
Kontaktdaten:

Re: Wie Du die CONTENIDO-Dokumentation mitgestalten kannst

Beitrag von Faar » Do 27. Aug 2015, 11:59

Aktueller Fall bei dem ich die Doku benötige:
scanDirectory() und getFileType() sind seit 4.9.8 deprecatet.
https://docs.contenido.org/display/CONDEVE/Deprecations

Bei dem neuen cDirHandler steht manches kryptisches was eher verwirrt statt erleuchtet:
https://docs.contenido.org/display/CONDEVE/cDirHandler

1. "cDirHandler::read with parameter fileOnly true" geht laut Beschreibung nicht, weil es fileOnly nicht gibt, aber dafür ein dirOnly. Vielleicht gibt es das bereits aber in der Doku noch nicht.
2. "Returns: bool" kann irgendwie nicht sein, wenn "This method reads the content from given directory."
Es ist wahrscheinlich so, dass nur im Fehlerfall boolean übermittelt wird (false), ansonsten aber der Datei-Inhalt des angegebenen Verzeichnisses. Das sollte so dokumentiert werden wie in: http://php.net/manual/de/function.scandir.php
"Gibt bei Erfolg ein Array von Dateinamen zurück, im Fehlerfall FALSE."
3. Und was wirklich fehlt, das sind handliche Beispiele, wie in http://php.net/manual/de/function.scandir.php
Stattdessen nur "read('/var/www/test/');" und ein kleiner Satz, aber kein richtiges Beispiel wie in php.net.

Kann und darf man das als Forums-User erweitern, wenn man sich bei der Dokumentation anmeldet?
Falls ja, wäre das gut, denn meistens hat man keine Zeit, sich die Doku durchzulesen und alles nachzuarbeiten, aber wenn man dann schon mal dabei ist und einen praktischen Anwendungsfall hätte, kann man vielleicht das eine oder andere noch ergänzen.

VG,
Faar
Fliegt der Bauer übers Dach, ist der Wind weißgott nicht schwach.

frederic.schneider_4fb
Beiträge: 967
Registriert: Do 15. Apr 2004, 17:12
Wohnort: Eschborn-Niederhöchstadt
Kontaktdaten:

Re: Wie Du die CONTENIDO-Dokumentation mitgestalten kannst

Beitrag von frederic.schneider_4fb » Do 27. Aug 2015, 12:06

Lieber Faar,

alles, was sinnvoll und vor allem richtig ist, kann sehr gerne von Euch in der Dokumentation ergänzt werden. Wenn Erklärungen zu allgemein oder unvollständig sind, freue wir uns stets über jeden, der die Dokumentation in den Punkten verbessert. Also: Als drauf! ;-)
Frederic Schneider
Entwickler bei der four for business AG

Antworten