UserApp-Entwicklung/Tutorials/UserApp-Tutorials-Meta

Tipps und Konventionen für das Schreiben von Tutorials zu UserApps.

Erstellen des Wiki-Artikels

 Wichtig: Der Titel deines Tutorials sollte mit UserApp-Entwicklung/Tutorials/ beginnen!
 Artikel, die kein Tutorial sind, sondern lediglich etwas dokumentieren, sollten mit UserApp-Entwicklung/Doku/ beginnen.

Beispiele:

Tutorial: UserApp-Entwicklung/Tutorials/HTML-UI
Doku: UserApp-Entwicklung/Doku/AppId

Code-Beispiele einfügen

<pre>-Tag

Code ist auf dem Knuddels-Wiki am besten in einem <pre>-Tag aufgehoben.
Allerdings gibt es auch hier noch Probleme mit der Formatierung, zum Beispiel werden Whitespaces am Anfang der Zeile entfernt.

Whitespaces

Die Whitespaces am Anfang der Zeile (oder einfach alle) können durch   (geschütztes Leerzeichen) ersetzt werden, damit sie trotzdem angezeigt werden.

In Python sähe das so aus:

>>> s = """... hier der Quellcode ...
... noch mehr Quellcode ...
..."""
>>> print(s.replace(" ", "&nbsp;")

HTML-Quellcode

Bei Verwendung von XML-Tags sollte der Quellcode außerdem zuerst einmal durch dieses Tool "escaped" werden: https://mothereff.in/html-entities

Syntax-Highlighting

Das Knuddels-Wiki hat derzeit leider kein Syntax-Highlighting.

Quellcode sichern

Das Ergebnis ist durch diese Änderungen im Bearbeitungsfeld im Wiki nicht mehr gut lesbar. Um für spätere Änderungen noch die originale Version des Code-Beispiels zu erhalten, kann es in einem XML-Kommentar gesichert werden:

<!--
hier die Originalversion
-->
<pre>
hier die "escapte" Version
</pre>

Zusammenfassung

Code in einem Kommentar  sichern
Falls XML-Tags im Code vorkommen, durch dieses Tool jagen: https://mothereff.in/html-entities
alle Leerzeichen (eigentlich nur am Anfang jeder Zeile) durch   ersetzen
das Ergebnis in einem <pre></pre>-Tag einfügen

Knuddels-Wiki