Grundlegendes: Wie Macros entstehen

libralop — Wed, 18 Jan 2017 13:21:00 GMT

Im Zuge der Erneuerung der hier befindlichen Dokumentation soll dargestellt werden, wie die Macros im Quellcode zusammengesetzt werden:

(Fast) jeder Prototype enthält eine nach ihm benannte JavaScript-Datei (z.B. Story/Story.js)
Macros sind JavaScript-Funktionen, die auf _macro enden (z.B. abstract_macro())
Der Macroname ist der Teil vor dem _macro-Suffix (im Beispiel »abstract«)
Die Argumente für ein Macro bestehen immer aus dem (meist) param genannten Objekt; die Keys müssen allerdings aus der Funktion oder dem Macro-Aufruf erschlossen werden
Zusätzlich gibt es sog. »positional parameters«, die auf das param-Objekt folgen.

Beispiele:

// Definiert globales Macro der Form [Macro not allowed in sandbox: foo]function foo_macro(param) {res.write(param.bar); // xyz}

// Definiert Story-Macro der Form [Macro not allowed in sandbox: story.foo]Story.prototype.foo_macro = function(param, bar) {res.write(bar) // xzy};

// Definiert HopObject-Macro der Form [Macro not allowed in sandbox: this.foo]HopObject.prototype.foo_macro = function(param, arg1, whatever) {res.write(param.bar); // xyzres.write(param.baz); // 123res.write(arg1); // frummres.write(whatever); // 4711};

Globale Macros gelten überall, alle anderen immer nur für den Prototypen, für den sie definiert werden, sowie für die Prototypen, die sich davon ableiten (z.B. kennt Comment die Macros von Story, alle Prototypen kennen die von HopObject).

Es stehen immer alle Macros von Prototypen zur Verfügung, die im path vorkommen. D.h. in einem Stories-Skin gibt es auch die Site-Macros, in einem Story-Skin die von Site und Stories usw.

In einer Story selbst (also im Story-Editor) sind nur Macros erlaubt, die in Story.ALLOWED_MACROS definiert sind.

Quelle: help.antville.org

Antville Macros

Grundlegendes: Wie Macros entstehen