3. Referenz-Template

Einleitung

Auf dieser Seite erkläre ich dir den Aufbau des Startinhalt für eine Seite in der Referenz.

In der Referenz werden BB-Funktionen, Logic-Funktionen, AICore-Funktionen usw. gelistet. Eine Seite aus dieser Liste hat ihre eigene Syntax.

Vor dem Textkörper

Der Bereich vor dem eigentlichen Seitenkörper ist für das Design zuständig. Bitte nicht verändern.

[[table style="width: 100%; border-collapse:collapse;"]]
[[row]]
[[cell style="width: 100%; font-size: 100%; border: 1px solid grey; background-color: #a8dca8; text-align: justify; padding: 0px;"]]
[[=]]
[[[reference:bb-function|Zurück zu BB-Funktionen]]] | [[button print]] | [[button tags]]
[[/=]]

[!-- BODY --]

[[table style="width: 100%; border-collapse:collapse;"]]
[[row]]
[[cell style="width: 100%; font-size: 100%; border: 0px solid grey; background-color: #ffffff; text-align: justify; padding: 10px;"]]
[[toc]]

Der Textkörper

Innerhalb des Textkörpers brauchst du nur an der richtigen Stelle eintragen, was du mitzuteilen hast.

Parameter

In diesem Bereich beschreibst du die Parameter der Funktion.

+ Parameter
====
( _paramaer1, ...)
====

[[table style="width: 100%; border-collapse:collapse;"]]
[[row]]
[[cell style="width: 40%; font-size: 100%; border: 0px solid grey; background-color: #ffffff; text-align: left; padding: 0px;"]]

||~ Name ||~ Typ ||~ Beschreibung ||
||  ||  ||  ||

[[/cell]]
[[cell style="width: 60%; font-size: 100%; border: 0px solid grey; background-color: #ffffff; text-align: justify; padding: 0px;"]]
[[/cell]]
[[/row]]
[[/table]]

Innerhalb der doppelten | steht jeweils eine Zelle einer Tabelle.

Die mit = abgegrenzte Parameterliste wird in der Liste angezeigt.

Rückgabewerte

Innerhalb dieses Bereiches trägst du bei "Bla Bla" die Rückgabewerte ein.

+ Rückgabewerte

Bla Bla

Format der Notation:

Datentyp: Beschreibung

Beschreibung

In der Beschreibung erklärst du die Funktion dem Nutzer

+ Beschreibung
====
Kurzbeschreibung
====

====
global ✔✘
====
====
lokal ✔✘
====

An der Stelle der Kurzbeschreibung schreibst du (möglichst kurz) eine zusammenfassende Beschreibung der Funktion. Diese wird dann auch in der Liste angezeigt. Versuche sie so zu formulieren, dass sie zum nachfolgenden Text passt.

Bei global und lokal brauchst du nur den Haken stehen lassen, wenn die Funktion in der Skriptumgebung funktioniert, sonst lasse das Kreuz stehen.

Beispiel

Im Beispiel gibst du innerhalb des Code-Abschnittes dein Beispiel zu der Funktion.

+ Beispiel

Bla Bla

[[code]]
Beispiel
[[/code]]

Demo-Map

Hier kannst du, wenn du willst, eine Demomap verlinken. Nutze dazu Siedelwood als Datenbank, da der Speicher des Wikis sonst zu schnell voll wird.

+ Demo-Map

<nicht vorhanden>

Alles was unter dem Demo-Map-Abschnitt steht, braucht dich nicht zu kümmern.

Zurück zum Handbuch | Drucken | Tags
Sofern nicht anders angegeben, steht der Inhalt dieser Seite unter Lizenz Creative Commons Attribution-ShareAlike 3.0 License