REDAXO Dokumentation

Die aktuelle Live-Version ist hier ersichtlich: https://redaxo.org/doku/master

Hinweise zur Mitarbeit

Wir freuen uns sehr über Mitarbeit bei der REDAXO-Dokumentation. Ihr könnt gern jederzeit komplette Kapitel übernehmen (bitte mit polarpixel, tbaddade oder skerbis absprechen) oder einfach nur Verbesserungen und Korrekturen einbringen (dann am besten als Pull request)

Bitte beachten

• Hinweise zur Formatierung und Markdown-Syntax findet Ihr in der Datei _vorlage.md
• Bitte in jedes Kapitel eine Sprunganker-Navigation integrieren (siehe _vorlage.md). Diese Sprunganker-Navigation muss direkt am Anfang hinter der ersten Überschrift kommen. Direkt danach muss die zweite Überschrift folgen.
• Wenn man sich einen Inhalt vornimmt, bitte mit Namen und Status markieren in der dokumentation.md
• Hinweis: Die Links in der Inhaltsverzeichnis-Datei dokumentation.md funktionieren nicht innerhalb von Github, da sie vorbereitet sind für den automatischen Import in die REDAXO-Website. Ihr müsst daher die gewünschte Datei selbst auswählen und öffnen.

Schreibstil

• Möglichst ohne direkte Anrede (Du / Sie) auskommen. Falls in Ausnahmefällen nicht möglich, dann "Du" verwenden statt "Sie"

Schreibweisen häufig vorkommender Begriffe

• REDAXO
• AddOn
• PlugIn

Coding-Standard

Bei den Code-Beispielen bitte bei den allgemein gültigen REDAXO-Coding-Standard beachten: http://symfony.com/doc/current/contributing/code/standards.html

Screenshots

• Breite 1600 Pixel Breite. Höhe, wie man es braucht.
• Kein Browserfenster soll zu sehen sein.
• Immer den kompletten REDAXO-Inhalt, inklusive Navigation.
• Benennung: v5.2.0-[Kennung-was-das-Bild-zeigt].png
• in den Assets-Ordner.
• Immer Standard-Theme mit aktivierten AddOns aus der Installation verwenden, damit die Navigation gleich aussieht.