Contao-Camp 2024
Ergebnis 1 bis 23 von 23

Thema: Backend kommentieren/dokumentieren

  1. #1
    Contao-Nutzer Avatar von manjarco
    Registriert seit
    16.11.2010.
    Ort
    Solingen
    Beiträge
    91

    Standard Backend kommentieren/dokumentieren

    Moin,

    mich würde mal interessieren wie ihr bestimmte Dinge im Backend dokumentiert.

    Ich stehe immer wieder vor der Herausforderung meinem Zukunfts-Selbst gerne einige Hinweise zu hinterlassen, warum ich welche Module wie eingestellt oder wofür eingesetzt habe. Für Inhaltselemente gibt es da ja do-while/contao-ce_be_remarks, für die Seitenstruktur gab es früher mal null815/contao-notes.

    Habe ich eine Erweiterung übersehen?
    Nutzt ihr eine selbst gebaute Lösung?
    Dokumentiert ihr sowas gar nicht?
    Oder in ein separates Dokument irgendwo?

  2. #2
    AG Pressearbeit
    Community-Moderator
    Buchautor 'Contao für Webdesigner'
    Avatar von planepix
    Registriert seit
    05.06.2009.
    Ort
    Stuttgart
    Beiträge
    6.464
    Partner-ID
    107
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Hallo manjarco,

    was ich - früher - mal gemacht habe:
    1. Seite Dokumentation erstellen (veröffentlicht, nicht im Menü und in der Sitemap sichtbar, noindex,nofollow
    2. Artikel erstellen und Inhaltselement Markdown nutzen (oder andere Inhaltselemente nutzen, wenn Bilder etc. dazu kommen sollen)

    Das kann man dann auch Redakteuren zur Verfügung stellen (ohne Zugriffsrechte da etwas zu ändern)
    ---------------------------------
    Beste Grüße planepix
    Contao für Webdesigner (Website), Twitter: @contaowebdesign
    weitzeldesign
    Contao-Sprechstunde
    Contao Schulungen: https://www.weitzeldesign.com/cms-co...chulungen.html
    Contao Jahrbuch: www.contao-jahrbuch.de
    Contao Agenturtag: www.contao-agenturtag.de
    Contao Stammtisch Stuttgart: www.contao-stammtisch-stuttgart.de
    Contao 4 Erfahrungen als Gitbook: https://app.gitbook.com/@planepix/s/...-mit-contao-4/
    Contao 4 & Manager Hosterhinweise: https://github.com/contao/contao-manager/wiki

    Schon wieder ein Update?
    Glücklich sind die, die den Wert erkennen – und wertschätzen.
    „Muss man machen wie beim Zahnarzt. Der bestraft einen auch mit hohen Rechnungen wenn man die Pflege vernachlässigt.”

  3. #3
    Contao-Urgestein Avatar von do_while
    Registriert seit
    15.06.2009.
    Ort
    Berlin | Deutschland
    Beiträge
    3.612
    Partner-ID
    1081
    User beschenken
    Wunschliste
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Ich installiere meinst die Erweiterung fritzmg/contao-backend-documentation. Hier kann man sich selbst oder auch für andere merkenswerte Infos reinschreiben.
    Für Kunden habe ich dort schon öfter eine Dokumentation für die Redakteure eingetragen.

  4. #4
    Contao-Fan Avatar von Fehrmann
    Registriert seit
    04.07.2009.
    Ort
    Wismar
    Beiträge
    580
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Hi,

    ich nutze omosde/contao-om-backend, das kann Markdown-Dateien aus dem Root der Installation im Backend anzeigen. Editieren mache ich aber über meinen Editor direkt und nicht im Backend.

    Viele Grüße
    Software-Entwickler Backend/Frontend

  5. #5
    Contao-Fan Avatar von Stefko
    Registriert seit
    25.10.2012.
    Ort
    Karlsruhe
    Beiträge
    771
    User beschenken
    Wunschliste

    Standard

    Moin,

    ich handhabe das exakt genauso wie @Fehrmann
    Grüße, Stefko

  6. #6
    Contao-Urgestein Avatar von do_while
    Registriert seit
    15.06.2009.
    Ort
    Berlin | Deutschland
    Beiträge
    3.612
    Partner-ID
    1081
    User beschenken
    Wunschliste
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Zitat Zitat von Fehrmann Beitrag anzeigen
    Hi,

    ich nutze omosde/contao-om-backend, das kann Markdown-Dateien aus dem Root der Installation im Backend anzeigen. Editieren mache ich aber über meinen Editor direkt und nicht im Backend.

    Viele Grüße
    Ich halte es nicht für gut, wenn die Dateien in dem Root stehen, bei contao-backend-documentation wird dazu der templates-Ordner verwendet

  7. #7
    Contao-Fan Avatar von Stefko
    Registriert seit
    25.10.2012.
    Ort
    Karlsruhe
    Beiträge
    771
    User beschenken
    Wunschliste

    Standard

    Zitat Zitat von do_while Beitrag anzeigen
    Ich halte es nicht für gut, wenn die Dateien in dem Root stehen, bei contao-backend-documentation wird dazu der templates-Ordner verwendet
    Aus Interesse gefragt, warum, bzw. was macht da für Dich den Unterschied?
    Grüße, Stefko

  8. #8
    Administrator Avatar von xchs
    Registriert seit
    19.06.2009.
    Beiträge
    14.548
    User beschenken
    Wunschliste
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Der Templates-Ordner ist nicht direkt öffentlich zugänglich, der DocumentRoot hingegen schon. In den Notizen könnten ja auch teils sensible Informationen stehen, die nur für die Backendbenutzer bestimmt sind.
    Contao Community Administrator

    [Unterstützungsmöglichkeiten]

  9. #9
    Contao-Fan Avatar von Stefko
    Registriert seit
    25.10.2012.
    Ort
    Karlsruhe
    Beiträge
    771
    User beschenken
    Wunschliste

    Standard

    Zitat Zitat von xchs Beitrag anzeigen
    Der Templates-Ordner ist nicht direkt öffentlich zugänglich, der DocumentRoot hingegen schon. In den Notizen könnten ja auch teils sensible Informationen stehen, die nur für die Backendbenutzer bestimmt sind.
    Halt stopp, ich glaube hier liegt ein Irrtum vor. Die Markdown-Files liegen im Contao-Wurzelverzeichnis, nicht im /web-Ordner und sind somit ja auch nicht von außen erreichbar.
    Grüße, Stefko

  10. #10
    Administrator Avatar von xchs
    Registriert seit
    19.06.2009.
    Beiträge
    14.548
    User beschenken
    Wunschliste
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Ah, okay.
    Contao Community Administrator

    [Unterstützungsmöglichkeiten]

  11. #11
    Contao-Urgestein Avatar von do_while
    Registriert seit
    15.06.2009.
    Ort
    Berlin | Deutschland
    Beiträge
    3.612
    Partner-ID
    1081
    User beschenken
    Wunschliste
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Ich hätte erwartet, dass sich der Contao-Manager über zusätzliche Dateien beschwert.
    Template-Verzeichnis hat den Vorteil, dass man die Datei im Contao bearbeiten kann.

  12. #12
    Contao-Fan Avatar von mdoll
    Registriert seit
    25.06.2009.
    Ort
    Wietze
    Beiträge
    334

    Standard

    Die Variante mit omosde/contao-om-backend hat den Vorteil, dass man mehr als eine Markdown Datei hinterlegen kann, die werden alle angezeigt. Dafür keine Bearbeitungsmöglichkeit im Backend.
    “Ah," said Mr Pin. "Right. I remember. You are concerned citizens." He knew about concerned citizens. Wherever they were, they all spoke the same private language, where 'traditional values' meant 'hang someone'.”
    ― Terry Pratchett, The Truth

  13. #13
    Contao-Fan Avatar von Fehrmann
    Registriert seit
    04.07.2009.
    Ort
    Wismar
    Beiträge
    580
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Hi,

    über eine Bearbeitungsfunktion ließe sich reden. Ich nehme das mal als Ticket auf.

    Edit: So ein Ticket gibt es schon. :-)

    Viele Grüße
    René
    Software-Entwickler Backend/Frontend

  14. #14
    Contao-Nutzer Avatar von manjarco
    Registriert seit
    16.11.2010.
    Ort
    Solingen
    Beiträge
    91

    Standard

    Danke schonmal für die Rückmeldungen! Werde mir contao-backend-documentation mal ansehen (hauptsächlich weil ich die anderen Funktionen von contao-om-backend momentan nicht brauche). Das eigentliche "Problem" direkt in einem Modul eine Notiz hinterlassen zu können löst das natürlich nicht, aber so ist wenigstens alles in der Installation. Und man kann ja auch nicht immer alles haben

  15. #15
    Contao-Fan Avatar von Fehrmann
    Registriert seit
    04.07.2009.
    Ort
    Wismar
    Beiträge
    580
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Hi,

    die Implementierung des neuen Features zum Editieren der Markdown-Dateien ist fertig. Viel Spaß damit.

    Viele Grüße
    René

    Hinweis: Editieren per Bleistift-Symbol (rechts oben in der Ecke bei Ansicht der Datei)
    Software-Entwickler Backend/Frontend

  16. #16
    Contao-Fan Avatar von Stefko
    Registriert seit
    25.10.2012.
    Ort
    Karlsruhe
    Beiträge
    771
    User beschenken
    Wunschliste

    Standard

    Ahoi,

    danke erstmal für die fixe Implementierung der Edit-Funktion
    Zitat Zitat von Fehrmann Beitrag anzeigen
    Hinweis: Editieren per Bleistift-Symbol (rechts oben in der Ecke bei Ansicht der Datei)
    Klicke ich auf den Bleistift, erscheint folgendes (bei zwei Installationen getestet)
    Bildschirmfoto 2019-03-17 um 11.08.58.png
    Grüße, Stefko

  17. #17
    Contao-Nutzer Avatar von harley-rider
    Registriert seit
    08.07.2013.
    Ort
    Bern, CH
    Beiträge
    220

    Standard Fehler bei Main-/Top-Navigation

    Ich habe in den letzten Tagen problemlos in ein paar CTO 4.4.lts die Erweiterung omosde/contao-om-backend mittels composer installieren können und lief OK

    Heute bei einer Installationen auf eine lokale Testumgebung kriegte ich beim Anklicken der Main- oder Top-Navigations folgenden Fehler :
    Code:
     Forbidden
    Was ist das Problem?
    Table "tl_om_backend_links_top" is not allowed in module "backend_links".
    Neu ist die Erweiterung ja mit CM installierbar, aber damit gibt es denselben Fehler.

    Hier noch der Auszug aus dem Log
    Code:
    [2019-03-17 11:16:24] request.INFO: Matched route "contao_backend". {"route":"contao_backend","route_parameters":{"_scope":"backend","_token_check":true,"_controller":"Contao\\CoreBundle\\Controller\\BackendController::mainAction","_route":"contao_backend"},"request_uri":"http://demo-oneo.roaddreams.local/contao?do=backend_links&tab=backend_links_top&table=tl_om_backend_links_top","method":"HEAD"} []
    [2019-03-17 11:16:24] security.INFO: Attempting SimplePreAuthentication. {"key":"backend","authenticator":"Contao\\CoreBundle\\Security\\ContaoAuthenticator"} []
    [2019-03-17 11:16:24] request.INFO: Matched route "contao_backend". {"route":"contao_backend","route_parameters":{"_scope":"backend","_token_check":true,"_controller":"Contao\\CoreBundle\\Controller\\BackendController::mainAction","_route":"contao_backend"},"request_uri":"http://demo-oneo.roaddreams.local/contao?do=backend_links&tab=backend_links_top&table=tl_om_backend_links_top","method":"GET"} []
    [2019-03-17 11:16:24] security.INFO: Attempting SimplePreAuthentication. {"key":"backend","authenticator":"Contao\\CoreBundle\\Security\\ContaoAuthenticator"} []
    [2019-03-17 11:16:24] app.CRITICAL: An exception occurred. {"exception":"[object] (Symfony\\Component\\HttpKernel\\Exception\\AccessDeniedHttpException(code: 0): Table \"tl_om_backend_links_top\" is not allowed in module \"backend_links\". at I:\\xampp-7-2-15-2-x64\\htdocs\\contao-4-4-lts\\rd-oneo-demo\\vendor\\contao\\core-bundle\\src\\EventListener\\ExceptionConverterListener.php:106, Contao\\CoreBundle\\Exception\\AccessDeniedException(code: 0): Table \"tl_om_backend_links_top\" is not allowed in module \"backend_links\". at I:\\xampp-7-2-15-2-x64\\htdocs\\contao-4-4-lts\\rd-oneo-demo\\vendor\\contao\\core-bundle\\src\\Resources\\contao\\classes\\Backend.php:361)"} []

  18. #18
    Contao-Fan Avatar von Fehrmann
    Registriert seit
    04.07.2009.
    Ort
    Wismar
    Beiträge
    580
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Hi,

    ich schaue mir beide Probleme an.

    Vielen Dank fürs melden.
    René
    Software-Entwickler Backend/Frontend

  19. #19
    Contao-Fan Avatar von Fehrmann
    Registriert seit
    04.07.2009.
    Ort
    Wismar
    Beiträge
    580
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Hi,

    eine neue Version ist erschienen, die beide Probleme lösen sollte.

    Viele Grüße
    René
    Software-Entwickler Backend/Frontend

  20. #20
    Contao-Nutzer Avatar von harley-rider
    Registriert seit
    08.07.2013.
    Ort
    Bern, CH
    Beiträge
    220

    Standard

    Zitat Zitat von Fehrmann Beitrag anzeigen
    eine neue Version ist erschienen, die beide Probleme lösen sollte.
    Danke René
    Mit CM aktualisiert und ich konnte wieder Toplinks erfassen.

  21. #21
    Contao-Fan Avatar von Stefko
    Registriert seit
    25.10.2012.
    Ort
    Karlsruhe
    Beiträge
    771
    User beschenken
    Wunschliste

    Standard

    `n Abend
    Zitat Zitat von Fehrmann Beitrag anzeigen
    eine neue Version ist erschienen, die beide Probleme lösen sollte.
    neeee, leider nicht. Ich bekomme nun zwar keine Aufforderung zu einer Passworteingabe, ansonsten passiert aber leider auch nichts bei Klick auf den Bleistift.
    Grüße, Stefko

  22. #22
    Contao-Fan Avatar von Fehrmann
    Registriert seit
    04.07.2009.
    Ort
    Wismar
    Beiträge
    580
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Hi Stefko,

    klappern wir doch bitte mal die üblichen Verdächtigen ab. Hilfreich wäre eventuell folgendes:

    • Cache gelöscht?
    • genaue Contao-Version?
    • Browser & Version?
    • das HTML-Markup für den Edit-Button bitte mal rauskopieren (a-Tag)
    • irgendwelche JS-Fehler in der Konsole?


    Vielleicht kommen wir damit weiter.

    Viele Grüße
    Software-Entwickler Backend/Frontend

  23. #23
    Contao-Fan Avatar von Stefko
    Registriert seit
    25.10.2012.
    Ort
    Karlsruhe
    Beiträge
    771
    User beschenken
    Wunschliste

    Standard

    Moin,
    Zitat Zitat von Fehrmann Beitrag anzeigen
    klappern wir doch bitte mal die üblichen Verdächtigen ab.
    gar nicht nötig, ich habe den "Fehler" gefunden.
    Es lag daran, dass der Dateiname mit einem Hash begann (#FooBar.md). Als ich diesen entfernte funktionierte alles wie es soll.

    Super und vielen Dank nochmal.
    Grüße, Stefko

Aktive Benutzer

Aktive Benutzer

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

Lesezeichen

Lesezeichen

Berechtigungen

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