Contao NRW Day
Ergebnis 1 bis 32 von 32

Thema: Contao API & DCA Dokumentation

  1. #1
    Contao-Nutzer
    Registriert seit
    24.11.2009.
    Ort
    Fläsch
    Beiträge
    248

    Frage Contao API & DCA Dokumentation

    Was haltet Ihr davon im contaowiki eine umfassende Dokumentation von der contao core API und DCA Funktionsweise zu erstellen?

    Ich habe bei der Entwicklung schon mehrmals festgestellt, dass die Informationen auf http://www.contao.org/dca.html, für mich, nicht genug ausführlich sind. Es werden, da Aspekte vom DCA erwähnt. Allerdings gibt es keine illustrativen Codebeispiele und Funktionsbeschreibungen (Type, Parameter, ...).
    Zudem fehlt mir bis jetzt eine zentrale Dokumentation, die zeigt wie ich mit dem contao core entwickeln kann. Das Buch (contao für Entwickler) ist da ein guter Ansatz, jedoch m.E. zu wenig ausführlich, und eben nicht online Die phpDoc generierte API bringt nicht viel, da die Funktionen nicht beschrieben werden. Bei manchen Modulen ist auch in der config.php Beispiel-PHP-Code auskommentiert.

    Ich schlage deshalb vor eine zentrale und offizielle Dokumentation mit Codebeispielen des der contao core API und DCAs im contaowiki zu erstellen. Was meinst Ihr dazu?
    http://www.ideadapt.net - where ideas become code

  2. #2
    AG CMS-Garden
    Contao-Urgestein
    Avatar von lindesbs
    Registriert seit
    05.06.2009.
    Ort
    Oer-Erkenschwick
    Beiträge
    4.110
    Partner-ID
    keine
    User beschenken
    Wunschliste

    Standard

    Da kann ich nur sagen : Fang doch einfach an ;-)
    von Willi Voltz aus PR 500: Henry George sagte einmal: »Kultur ist Zusammenarbeit.«


    Contao-Hosting: begeisterter Uberspace-Nutzer

  3. #3
    Contao-Fan
    Registriert seit
    19.06.2009.
    Ort
    Greven
    Beiträge
    357

    Standard

    @lindesbs!

    Da kann ich nur sagen: Wann bist Du fertig? ;-)

    Freundliche Grüße
    Frank

  4. #4
    AG CMS-Garden
    Contao-Urgestein
    Avatar von lindesbs
    Registriert seit
    05.06.2009.
    Ort
    Oer-Erkenschwick
    Beiträge
    4.110
    Partner-ID
    keine
    User beschenken
    Wunschliste

    Standard

    @frank : ich koennte sagen, "it is done, when its done".

    Aber auch das wird fertig. UNd die Doku wird dann auch veroeffentlicht.

    24 hours are not enough
    von Willi Voltz aus PR 500: Henry George sagte einmal: »Kultur ist Zusammenarbeit.«


    Contao-Hosting: begeisterter Uberspace-Nutzer

  5. #5
    Contao-Fan
    Registriert seit
    19.06.2009.
    Ort
    Greven
    Beiträge
    357

    Standard

    @lindesbs

    Dankeschön.

    Freundliche Grüße
    Frank

  6. #6
    Contao-Nutzer
    Registriert seit
    24.11.2009.
    Ort
    Fläsch
    Beiträge
    248

    Standard

    Also ich entnehm euren Antworten, dass ihr sowas auch begrüssen würdet. Ich wollt eben nicht einfach mal anfangen irgend etwas aufzusetzen. Sinn und Zweck wäre ja später einmal die bisherige offizielle Dokumentation abzulösen. Deshalb dacht ich mir mal hier bei den Verantwortlichen nachzufragen, ob dies den überhaupt gewünscht ist? Wenn ja, bin ich gern bereit da mal einen Anfang zu machen.
    http://www.ideadapt.net - where ideas become code

  7. #7
    Contao-Fan Avatar von varix
    Registriert seit
    26.03.2010.
    Ort
    Berlin
    Beiträge
    626

    Standard

    Hallo,

    die Ideee finde ich großartig. Gerne würde ich mich dafür anbieten, allerdings bin ich selber PHP-Anfänger und gerade erst bei OOP angekommen .

    Ein Aufbau wie bei php.net wäre toll.

    Schönen Abend noch!

    varix

  8. #8
    AG Core-Entwicklung
    AG Dokumentation
    Avatar von andreas.schempp
    Registriert seit
    15.06.2009.
    Ort
    Lyss
    Beiträge
    5.444
    Partner-ID
    8667

    Standard

    Ich hatte Leo vor einigen Monaten auf das Thema angesprochen, und er hat gesagt ich könnte mich gerne darum kümmern, wenn ich Zeit dazu habe. Leider ist daraus nie etwas geworden...

    Aus meiner Sicht müssten wir erst einen Standard für die Doku finden, php.net finde ich auch sehr gut, aber ich weis nicht ob das für OOP geeignet ist.
    terminal42 gmbh
    Wir sind Contao Premium-Partner! Für Modulwünsche oder Programmierungen kannst du uns gerne kontaktieren.
    Hilfe für Isotope eCommerce kann man auch kaufen: Isotope Circle

  9. #9
    Contao-Fan Avatar von Wichteldesign
    Registriert seit
    23.06.2009.
    Ort
    Nürtingen
    Beiträge
    353

    Standard

    Aus meiner Sicht müssten wir erst einen Standard für die Doku finden, php.net finde ich auch sehr gut, aber ich weis nicht ob das für OOP geeignet ist.
    Die Aufteilung nach:

    ### Beschreibung ###

    ### Parameterliste ###

    ### Rückgabewert ###

    ### Weiters ###

    fände ich für Funktionen schon mal gut. Das sollte sich im Wiki auch gut darstellen lassen. Komplizierter wird es hier schon bei den DCA's. Jemand ne Idee? Mir fällt gerade kein gutes Beispiel ein.

    Gruß Felix
    Besten Gruß, Felix Peters
    Wichteldesign // Github // @wichteldesign // @el_wichtel

  10. #10
    Contao-Nutzer
    Registriert seit
    24.11.2009.
    Ort
    Fläsch
    Beiträge
    248

    Standard

    php.net find ich auch nicht schlecht. Vor allem ist wichtig, dass die API durch User Kommentare ergänzt werden kann.
    Mit Tools wie phpDocumentor (Beispiel output: http://manual.phpdoc.org/HTMLframesConverter/phpedit/) könnte man sicher eine gute Dokumentation erstellen. Allerdings wären da soviel ich weiss keine Benutzer Kommentare möglich. Dafür wäre das wiki schon gut. Wie es aussieht ist der phpDocumentor Output aber nicht ohne Weiteres ins Wiki integrierbar (siehe http://stackoverflow.com/questions/6...mentor-to-wiki).
    Um den DCA zu Kommentieren könnte man ein XSD definieren, und aufbauend auf dem dann die Dokumentation in XML erstellen. Mit XSLT sollte es dann möglich sein das ganze in wiki Syntax zu transformieren.

    Edit: Ein weiteres vielversprechendes Tool wäre Doxygen (Beispiel Output: http://drupal-6-doxygen.engineeredweb.com/), natürlich wieder mit verzicht auf Benutzerkommentare.
    Geändert von bubblez (16.12.2010 um 17:04 Uhr)
    http://www.ideadapt.net - where ideas become code

  11. #11
    Contao-Nutzer
    Registriert seit
    24.11.2009.
    Ort
    Fläsch
    Beiträge
    248

    Standard

    Ich bins nochmal Vielleicht wäre es auch sinnvoll zwei Dokumentationen zu erstellen...

    1. Automatisch generierte API Dokumentation (mit Doxygen?) der contao core Klassen. (Database, Module etc.). Mit kurzen Codesnippets wo sinnvoll.
    2. Wiki Dokumentation für Hook und DCA Konfiguration.


    Was meint Ihr?
    http://www.ideadapt.net - where ideas become code

  12. #12
    AG Core-Entwicklung
    AG Dokumentation
    Avatar von andreas.schempp
    Registriert seit
    15.06.2009.
    Ort
    Lyss
    Beiträge
    5.444
    Partner-ID
    8667

    Standard

    Ich hatte mir dei verfügbaren Tools eigentlich angesehen, aber leider ist keines davon wirklich genügend. Eine reine API-Doku ist auch nicht wirklich ausreichend, und wir können ja nicht von Leo verlangen dass die ganze Doku in den Core-Code kommt.
    terminal42 gmbh
    Wir sind Contao Premium-Partner! Für Modulwünsche oder Programmierungen kannst du uns gerne kontaktieren.
    Hilfe für Isotope eCommerce kann man auch kaufen: Isotope Circle

  13. #13
    AG Core-Entwicklung Avatar von Psi
    Registriert seit
    19.06.2009.
    Ort
    Mittelfranken
    Beiträge
    934
    Partner-ID
    5583
    User beschenken
    Wunschliste

    Standard

    Ich denke schon das man in sowohl in phpDoc als auch in Doxygen ein Kommentarmodul einbauen kann! Man muss sich Templates bauen die entsprechenden PHP-Code enthalten.

    Das größere Problem sehe ich hier in der Beschreibung IM Quelltext wo kein Platz für größere Beispiele etc. ist. Vllt lässt Doxygen hier Workarounds über die Doxytags zu:
    http://www.stack.nl/~dimitri/doxygen/external.html


    ## Edit
    Ein Kollege hat vor längerem ein phpDoc Template aufgebohrt um per einfachem PHP-Include Wiki-Artikel entsprechend des Namespaces in die API-Dok zu inkludieren.
    Wie ich das verstanden habe gabs im Wiki Artikel wie "Class/System", dieser wurde dann im phpDoc bei der Klasse System eingebunden. Ähnlich für Methoden "Class/System/Method".
    Geändert von Psi (17.12.2010 um 16:36 Uhr)

  14. #14
    Contao-Nutzer
    Registriert seit
    24.11.2009.
    Ort
    Fläsch
    Beiträge
    248

    Standard

    Das größere Problem sehe ich hier in der Beschreibung IM Quelltext wo kein Platz für größere Beispiele etc.
    http://www.stack.nl/~dimitri/doxygen...cturalcommands
    Die Kommentare könnten also extern angebracht werden. Allerdings fehlt dann die Dokumentation beim Source-Code. In IDEs werden dann die Code-Hints nicht mehr angezeigt... Und dem Entwickler fehlt die Dokumentation im Code, er müsste immer die externe Doku konsultieren. Auch nicht das gelbe vom Ei.

    Man könnte aber einfach die Beschreibung, Parameter, Returns etc. direkt im Source angeben, wie üblich. Und dann einen externen Link angeben zur ausführlicheren Dokumentation im Wiki. Die Templates könnte man immer noch modifizieren, um Inhalte (Code Beispiele etc.) aus dem Wiki nach zu laden.
    http://www.ideadapt.net - where ideas become code

  15. #15
    AG Core-Entwicklung
    AG Dokumentation
    Avatar von andreas.schempp
    Registriert seit
    15.06.2009.
    Ort
    Lyss
    Beiträge
    5.444
    Partner-ID
    8667

    Standard

    Eine Inline-Doku finde ich nicht praktikabel. 1: wir es schwer das mehrsprachig zu machen, 2. Sind wir dann von den Ressourcen von Leo abhängig - und der hat sicherlich schon genug zu tun.
    terminal42 gmbh
    Wir sind Contao Premium-Partner! Für Modulwünsche oder Programmierungen kannst du uns gerne kontaktieren.
    Hilfe für Isotope eCommerce kann man auch kaufen: Isotope Circle

  16. #16
    Contao-Nutzer
    Registriert seit
    24.11.2009.
    Ort
    Fläsch
    Beiträge
    248

    Frage

    Eine Inline-Doku finde ich nicht praktikabel
    Damit meinst du eine minimale Dokumentation der Methoden mit Beschreibung und Parametern wäre nicht gut? Ich vermisse genau das zur Zeit. Ich finde auch, dass das Standard sein sollte, in jedem php Modul.
    Sind wir dann von den Ressourcen von Leo abhängig
    Wieso von Leo abhängig? Kann denn nicht jeder mithelfen die Kommentare im contao core zu vervollständigen?

    Mehrsprachigkeit ist bei inline Doku ein Problem. Allerdings könnte man sich da auf Englisch einigen. Im Wiki kann die ausführliche Doku dann mehrsprachig sein.

    Wie auch immer, es muss ein System her, wie die Doku geschrieben wird. Doxygen, Wiki, XML? Eine zentrale XML hätte den Vorteil, dass es mit XSLT in verschiedene Formate transformiert werden könnte ...
    http://www.ideadapt.net - where ideas become code

  17. #17
    AG Core-Entwicklung Avatar von Psi
    Registriert seit
    19.06.2009.
    Ort
    Mittelfranken
    Beiträge
    934
    Partner-ID
    5583
    User beschenken
    Wunschliste

    Standard

    Zitat Zitat von bubblez Beitrag anzeigen
    Wie auch immer, es muss ein System her, wie die Doku geschrieben wird. Doxygen, Wiki, XML? Eine zentrale XML hätte den Vorteil, dass es mit XSLT in verschiedene Formate transformiert werden könnte ...
    Ganz meine Meinung, allerdings finde ich eine XML-Variante zu Zeitintensiv! Wer soll soll sich um Frontend und Backend für die Transformation kümmern? Ich nicht ...

    Ich halte ein Doxygen-Template was Inhalte aus dem Wiki zieht im Moment für am Zielführensten, da es mit überschaubaren Aufwand umzusetzen ist.

  18. #18
    Contao-Nutzer
    Registriert seit
    24.11.2009.
    Ort
    Fläsch
    Beiträge
    248

    Standard

    @andreas.schempp
    Abgesehen davon, dass ich immer noch nicht verstehe, warum nicht jeder die contao core files kommentieren könnte ..., find ich die Idee die Dokumentation extern zu halten auch gut. Und wie oben erwähnt einfach möglich. Das schwierige dabei wird sein, Code und Doku konsistent zu halten... Was hältst du von dieser Idee?

    Data Container Arrays und andere vordefinierte Array Strukturen von contao könnte man wie erwähnt mit XML definieren und mit XSLT dann in verschiedene Formate exportieren. Also auch in einen Wiki Dialakt wie markdown. Oder PDF oder HTML, oder Doxygen.
    Ganz meine Meinung, allerdings finde ich eine XML-Variante zu Zeitintensiv! Wer soll soll sich um Frontend und Backend für die Transformation kümmern?
    Ja da hast du recht, die Transformation müsste dann jemand regeln oder automatisiert ablaufen ... XML fänd ich eben zukunftsweisend, denn man könnte dann soweit gehen und die PHP basierten config Files durch XML Dateien ersetzen. Dank XSD würde man dann direkt im Editor unterstützt (validierung, element-vorschläge).

    Wenn wir XML weglassen und die DCA direkt im wiki Beschreiben, müsste man da einfach ein par Regeln finden, damit das dann auch einheitlich wird. Wie würden die wiki Seiten aufgebaut sein? Ganzer DCA auf einer Seite?
    http://www.ideadapt.net - where ideas become code

  19. #19
    AG Core-Entwicklung
    AG Dokumentation
    Avatar von andreas.schempp
    Registriert seit
    15.06.2009.
    Ort
    Lyss
    Beiträge
    5.444
    Partner-ID
    8667

    Standard

    Vielleicht problematisch da es noch 1/2 Jahr dauert, aber was haltet ihr von einem Workshop an der Contao Konferenz? Da könnten wir uns 2h Zeit nehmen und Erfahrungen diskutieren. Ich werde das mal im entsprechenden Thread einbringen.

    Wir müssten bei der Dokumentation auch zwischen den Klassen und dem DCA unterscheiden. Das DCA ist nicht schlecht dokumentiert, es fehlen nur einige Parameter und eher an effektiven Beispielen.
    Die Core-Bibliotheken sind dagegen praktisch gar nicht dokumentiert. Ausserdem fehlen Informationen zum Ablauf (z.B. URL act=edit triggert DC_Table::edit()), aber die sind schwer in ein Standardformat zu bringen.
    terminal42 gmbh
    Wir sind Contao Premium-Partner! Für Modulwünsche oder Programmierungen kannst du uns gerne kontaktieren.
    Hilfe für Isotope eCommerce kann man auch kaufen: Isotope Circle

  20. #20
    Contao-Fan Avatar von Wichteldesign
    Registriert seit
    23.06.2009.
    Ort
    Nürtingen
    Beiträge
    353

    Standard

    Den Workshop zum Thema finde ich eine gute Idee. Bis dahin können sicher noch einige Ideen weiter ausgebaut werden und dann auch entsprechend präsentiert werden.
    Besten Gruß, Felix Peters
    Wichteldesign // Github // @wichteldesign // @el_wichtel

  21. #21
    Contao-Nutzer
    Registriert seit
    24.11.2009.
    Ort
    Fläsch
    Beiträge
    248

    Daumen hoch

    Wir müssten bei der Dokumentation auch zwischen den Klassen und dem DCA unterscheiden. Das DCA ist nicht schlecht dokumentiert, es fehlen nur einige Parameter und eher an effektiven Beispielen.
    Unterscheidung zwischen Klassen und DCA auf jeden Fall, deshalb auch die Idee mit Doxygen und wiki/xml. Was den DCA betrifft, wäre es meiner Meinung nach eben sinnvoll die ganze Dokumentation aufzufrischen und alles an einen Ort (sinnvollerweise das wiki) zu transferieren. So könnte dann auch die generierte Doxygen Dokumentation auf Inhalte aus dem wiki verweisen.

    Workshop tönt gut Vielleicht gibt es Leute die da gute Inputs bringen könnten.
    http://www.ideadapt.net - where ideas become code

  22. #22
    Maintainer Avatar von xtra
    Registriert seit
    02.07.2009.
    Ort
    Tuebingen
    Beiträge
    1.939
    User beschenken
    Wunschliste

    Standard

    Funktionaler Mockup unter: http://code.contaowiki.org

    Fehlt noch die BBCode Auszeichnung und der Sync mit dem ER Server, aber das kommt noch.

    Login mit den "normalen" Zugangsdaten des Wikis.

    Gruss
    Chris
    Bedenke stets: Wenn Du ungenaue oder unzureichende Angaben machst, so koennte dies die Bearbeitung deiner Frage endlos verzoegern (oder sogar dazu fyhren, dass ich zu viel nachdenken muss und die Antwort vergesse!). Kein Support per PN.

  23. #23
    Contao-Fan Avatar von Wichteldesign
    Registriert seit
    23.06.2009.
    Ort
    Nürtingen
    Beiträge
    353

    Standard

    Hi,

    sei doch bitte so gut und erkläre kurz was hier jetzt alles gemacht werden muss? Ich bin mir noch nicht ganz im Klaren darüber. (Bin ich da der einzige?)

    Gruß Felix
    Besten Gruß, Felix Peters
    Wichteldesign // Github // @wichteldesign // @el_wichtel

  24. #24
    Maintainer Avatar von xtra
    Registriert seit
    02.07.2009.
    Ort
    Tuebingen
    Beiträge
    1.939
    User beschenken
    Wunschliste

    Standard

    Bislang "muss" noch nichts gemacht werden, da ich aktuell noch daran sitze, den kompletten Import fertigzustellen.

    In naher Zukunft muss man jedoch dann sich wie bei php.net hinsetzen und Beschreibungen verfassen.

    Aktuell importiere ich alle Klassen, deren Funtionen, parameter, Properties usw. und den jeweilig zugehoerigen phpdocComment (sofern vorhanden).

    Anschliessend kann man die Seiten kommentieren und als angemeldetes Mitglied auch bearbeiten/ybersetzen.

    Jedoch muss ich wie gesagt noch den import fertig stellen, bzw. dahingehend abaendern dass er nicht alles wieder bygelt, bevor ich euch darauf loslassen kann.

    Es ist bislang noch ein mockup, welchen ich gestern im IRC gezeigt habe und euch hier nun auch nicht vorenthalten wollte.

    Eine Anbindung/Vernetzung/Integration von ER und contao-forge.org ist weiterhin angedacht.

    Gruss
    Chris
    Bedenke stets: Wenn Du ungenaue oder unzureichende Angaben machst, so koennte dies die Bearbeitung deiner Frage endlos verzoegern (oder sogar dazu fyhren, dass ich zu viel nachdenken muss und die Antwort vergesse!). Kein Support per PN.

  25. #25
    AG Core-Entwicklung
    Registriert seit
    16.10.2009.
    Ort
    Bad Lausick
    Beiträge
    437

    Standard

    Ich fänd es gut, wenn man die Beschreibungen einer Klasse UND dessen Props/Methoden/Konstanten/... auf einer Seite einsehen könnte, die mit internen Links hin- und her referenziert. Javadoc macht das so und ich find das x-mal praktikabler als php.net (soll nicht heißen das php.net Mist ist).
    Das soll natürlich kein Ersatz sein, weil die Kommentare zu den einzelnen Methoden müssen ja auch irgendwo hin.
    Ihr Partner für Contao und Webentwicklung: http://www.hofff.com.

  26. #26
    Contao-Fan Avatar von Wichteldesign
    Registriert seit
    23.06.2009.
    Ort
    Nürtingen
    Beiträge
    353

    Standard

    Finde ich auf jeden Fall einen guten Ansatz. Danke Für die Erklärung
    Besten Gruß, Felix Peters
    Wichteldesign // Github // @wichteldesign // @el_wichtel

  27. #27
    Contao-Nutzer
    Registriert seit
    17.05.2011.
    Ort
    Passau
    Beiträge
    11

    Standard

    *push*

    wie ist denn eigentlich hier der aktulle stand der dinge, bzw gibt es einen aktuellen stand überhaupt?

    könnte man hier schon mit befüllen/ergänzen anfangen ?

  28. #28
    Contao-Urgestein Avatar von BugBuster
    Registriert seit
    15.06.2009.
    Ort
    Berlin
    Beiträge
    8.470
    User beschenken
    Wunschliste

    Standard

    Gesehen habe ich da schon was, kann aber nicht sagen wie weit xtra ist.
    Grüße, BugBuster
    "view source" is your guide.
    Danke an alle Amazon Wunschlisten Erfüller

  29. #29
    Contao-Nutzer
    Registriert seit
    10.09.2009.
    Beiträge
    9

    Standard

    Hallo.

    Ich differenziere jetzt mal zwischen DCA-Dokumentation und API-Dokumenation:

    DCA-Dokumenation

    Gibt es schon Ansätze für eine DCA-Dokumentation?

    Ich meine, es ist schön, wenn es eine API-Dokumentation gibt die automatisch generiert werden kann, jedoch ist das meines Erachtens mit DCA nicht möglich, da es sich nur um verschachtelte Arrays handelt, woraus sich schwierig irgend eine Dokumentation generieren lässt.

    Ich stehe derzeit auch vor dem Problem, dass ich die Dokumentation für DCA als nicht ausreichend erachte, da einige Dinge fehlen (zb Bezeichung von den 'Core-Array-Feldern') und keine Codebeispiele vorhanden sind. Klar, kann ich von vorhandenen Modulen etwas abschauen, jedoch ist das für mich keine Dokumentation, mit der ich alles im Blick habe, und wo ich sehe, welche Möglichkeiten/Einstellungen das es noch gibt.

    Die DCA-Erklärung im Entwicklerhandbuch ist eher als Übersicht zu sehen, aber für einen Entwickler sind diese Informationen einfach zu High-Level und ungenau.

    Kann man mit einer DCA-Dokumentation rechnen?


    API-Dokumentation

    Den Ansatz die Dokumentation in den Code einzubauen, halte ich für sinnvoll. Das Argument dass es hier nicht möglich ist, wegen der Mehrsprachigkeit der Dokumentation kann ich nicht gelten lassen, denn wenn der Code in Englisch geschrieben wird und die Dokumentation in Englisch ist, ist es meines Erachtens ausreichend, da ich grundlegende Englischkenntnisse bei jedem Entwickler vorraussetze.

    Ich finde, wer einen vernüftigen Code schreiben will, muss auch vernünftig dokumentieren, damit der Code für jeden verständlich ist.

    Gruß,
    mangei

  30. #30
    AG Core-Entwicklung
    AG Dokumentation
    Avatar von andreas.schempp
    Registriert seit
    15.06.2009.
    Ort
    Lyss
    Beiträge
    5.444
    Partner-ID
    8667

    Standard

    Die DCA-Dokumentation ist hier: http://www.contao.org/entwicklerhandbuch.html
    terminal42 gmbh
    Wir sind Contao Premium-Partner! Für Modulwünsche oder Programmierungen kannst du uns gerne kontaktieren.
    Hilfe für Isotope eCommerce kann man auch kaufen: Isotope Circle

  31. #31
    Contao-Nutzer
    Registriert seit
    10.09.2009.
    Beiträge
    9

    Standard

    Hallo Andreas,

    ich habe das Entwicklerhandbuch natürlich bereits studiert

    Ich finde das für einen ersten Überblick ganz gut, aber wenn ich dann genau wissen will, wie ich eine TextArea erstellen kann und welche Einstellungen das für diese möglich sind, im gegensatz zu einer Checkbox, wo es andere Einstellungen gibt, finde ich diese Dokumentation ein wenig ernüchternd.

    Wenn ich dann aber sehe, ok, es gibt Tabellenkonfigurationen und Aktionen, welche sich in globale und reguläre Aktionen aufteilen, fragt man sich natürlich: Ok, und wie schreibe/setzte ich all diese Attribute und wie sieht die Datenstruktur aus?
    Es ist mir leider nicht ersichtlich das es dort allgemeine Fields wie "config, list, global_operations, operations, etc." gibt und wie diese aufgebaut sind.

    Wenn ich die Datenstruktur im ff habe und nur nachsehen möchte, wie ein Attribut heist, ist das natürlich ausreichend, doch für Entwickler die sich nicht täglich mit dieser Materie auseinandersetzten ist das leider wenig aussagekräftig.

    Gruß,
    Manuel

  32. #32
    Contao-Fan Avatar von webster
    Registriert seit
    15.09.2010.
    Ort
    Kiel
    Beiträge
    460

    Standard

    Hallo zusammen,

    mal eine (vielleicht) doofe Frage:

    Tut sich auf api.contao.org bezüglich der Anzeige der Dateiinhalte irgendwann noch etwas? Vielleicht habe ich das auch einfach nur überlesen. Oder ist es etwa gewollt, dass ich die Dateien nicht direkt einsehen kann. Das würde schon vieles vereinfachen. Vor allem wäre es nicht so verwirrend, wenn man auf einen Link à la (line 47) klickt und nichts passiert.

    Ansonsten "Hut ab", alles schön übersichtlich und strukturiert - tausendfach besser als die erste Version!
    Was ist das? - Blaues Licht - Und was macht es? - Es leuchtet blau...

Aktive Benutzer

Aktive Benutzer

Aktive Benutzer in diesem Thema: 1 (Registrierte Benutzer: 0, Gäste: 1)

Ähnliche Themen

  1. Antworten: 0
    Letzter Beitrag: 07.12.2010, 23:33
  2. Dokumentation
    Von NoName26 im Forum graphicaltext
    Antworten: 5
    Letzter Beitrag: 19.08.2010, 12:38
  3. Update der TYPOlight-Dokumentation
    Von Seitengestalter im Forum Off Topic
    Antworten: 4
    Letzter Beitrag: 21.02.2010, 18:31
  4. Dokumentation Helpdesk?
    Von gabriel im Forum helpdesk
    Antworten: 16
    Letzter Beitrag: 15.12.2009, 21:10
  5. eigene typolight dokumentation
    Von imoyo im Forum Sonstiges zu Contao
    Antworten: 1
    Letzter Beitrag: 06.11.2009, 15:26

Berechtigungen

  • Neue Themen erstellen: Nein
  • Themen beantworten: Nein
  • Anhänge hochladen: Nein
  • Beiträge bearbeiten: Nein
  •