Am Handbuch mitschreiben

Das Handbuch wird auf GitHub gepflegt und wir nehmen dort sehr gerne Pull Requests entgegen. Solltest du dich damit nicht auskennen, schicke uns einfach eine E-Mail (gerne auch mit Anhängen wie Screenshots etc.) oder nutze das Feedback-Formular.

Bevor du loslegst, lese bitte noch die "Standards im Handbuch" durch.

Standards im Handbuch

Generelles

Für die Dokumentation verwenden wir die du-Form und die generelle Notation von Markdown. Die Dokumentation wird automatisch verarbeitet und auf isotopeecommerce.org dargestellt. Nebst der generellen Markdown-Notation gibt es einige zusätzliche, Isotope eCommerce spezifische Schlüsselwörter, welche in diesem Dokument ebenfalls dokumentiert sind.

Häufig verwendete Wörter

In Contao und Isotope eCommerce kommen einige Wörter sehr häufig vor. Um eine gewisse einheitliche Verwendung zu garantieren, werden diese anschliessend festgehalten:

Korrekte SchreibweiseFalsche Schreibweisen
Isotope eCommerce e-Commerce, Ecommerce, ECommerce
Frontend Front end, Front-End
Backend Back end, Back-End
du, dich, deine Du, Dich, Deine
z. B. zum Beispiel, z.B.
Gross, Strasse Groß, Straße (bitte nie ß verwenden)

Spezielle Markdown-Anweisungen

Aktuelle Version

Für die Ausgabe der aktuellen Version kannst du folgende Notation verwenden:

<docrobot_current_version>
Root der Dokumentation

Um das Referenzieren von Bildern zu vereinfachen und keine relativen Pfade verwenden zu müssen, kannst du jeweils immer vom Repository-Root ausgehen und folgende Notation verwenden:

<docrobot_root>
Sitemap der Dokumentation

Gibt eine komplette Sitemap der Dokumentation aus:

<docrobot_sitemap>
Bilder

Möchtest du ein Bild nutzen, so verwende die folgende Notation:

<docrobot_image path="~" alt="~">

Dem Pfad wird immer automatisch der Root der Dokumentation vorangestellt. Die Attribute width sowie height werden automatisch hinzugefügt.

Beispiel:

<docrobot_image path="images/isotope.png" alt="Isotope Logo">
Hinweise

Möchtest du den Leser darauf hinweisen, eine gewisse Vorsicht walten zu lassen, so kannst du folgende Notation verwenden:

<docrobot_message type="~">
  <p>Dies ist eine Warnung, sei vorsichtig!</p>
</docrobot_message>

Folgende Typen (type="~") stehen zur Verfügung:

  • warning (gelb)
  • info (blau)
  • success (grün)
"Neu in Version x.x"

Um zu dokumentieren, was in einer Version neu hinzugefügt wurde, kann folgende Notation verwendet werden:

<docrobot_new_in_version version="~">
  <p>Dieses Feature ist neu in Isotope eCommerce 2.0</p></docrobot_new_in_version>

version="~" muss dabei die Version enthalten (bspw. 2.0).

Link zu einer anderen Seite in der Dokumentation

Die config.json bestimmt den Aufbau des Handbuches und verwendet Routen. Um zu einer gewissen Route zu verlinken, kann folgende Notation verwendet werden:

Link
<docrobot_route name="~">Linkbezeichnung</docrobot_route>

name="~" muss dabei den Routen-Namen beinhalten.

Beispiel:

<docrobot_route name="products">Link</docrobot_route>
Link mit Anker
<docrobot_route name="~">Linkbezeichnung</docrobot_route>

name="~" muss dabei den Routen-Namen und path="~" den Ankerpukt beinhalten.

Beispiel:

<docrobot_route name="products" path="#anker">Link mit Anker</docrobot_route>

Feedback

Was ist die Summe aus 4 und 6?