Der "Source" Parameter

Heute möchte ich dir den Source-Parameter zeigen, der dir hilft, deinen Code übersichtlich zu machen. Mit ihm kannst du, wenn du Container erstellst, annotieren, was der Container eigentlich “sagen will”.

Syntax

Ich säße jetzt lieber [my_property,case=dat,det=indef,prep=in;source;in einem Porsche].

Warum brauchst du Prettification?

Wir klären das jetzt mit einem Experiment. Nimm diesen Code und geh zu deinem Büronachbarn. Frag ihn, was da tatsächlich steht. Wenn er länger als 30 Sekunden überlegen muss, hat sich dein Code über die Grenzen des intuitiven Verstehens hinaus entwickelt.

Wenn du das Training selbst schreibst, hast du zwar im Kopf, was womit gemeint ist. Dein Nebensitzer aus dem oben erwähnten Beispiel sieht nur Code.

Gerade, wenn du mit einem Team aus mehreren Entwicklern, Redakteuren, Übersetzern oder Kunden zusammen arbeitest, ist es daher wichtig, deinen ATML-Code übersichtlich zu halten. Zugänglicher Code hilft dir bei der Qualitätssicherung, Übergabe, Übersetzung und Fehlersuche ungemein.

Was bewirkt der Source-Parameter?

Der Source-Parameter funktioniert zusammen mit dem Online-Editor unter wizard.ax-semantics.com .
Wenn ein Container diesen Parameter hat, erscheint er in Textform, bis du in die Satzvariante klickst. Die Sätze im Bild haben die selben Container. Der linke hat zusätzlich Source-Parameter.
image

Wann ist der beste Zeitpunkt, um den Parameter einzubauen?

Ich empfehle gerne, den Source-Parameter als allererstes anzulegen, wenn du den Ur-Text bearbeitest.

Du bekommst wahrscheinlich so etwas von deinem Redakteur:

Ich säße jetzt lieber in einem Porsche

Setze nun Klammern, wo deine ATML3-Container erscheinen sollen:

Ich säße jetzt lieber [in einem Porsche]

Füge nun den Source-Parameter einfach vorne an:

Ich säße jetzt lieber [source:in einem Porsche]

Füge jetzt den Code ein, der den Container tatsächlich rendern soll.

Ich säße jetzt lieber [my_property,case=dat,det=indef,prep=in;source;in einem Porsche].

Pro-Tipp

Wenn du nicht weißt, wie der Container schlussendlich funktionieren soll, aber du trotzdem willst, dass er im Text erscheint, nutze ein Textobjekt.

Ich säße jetzt lieber [text=in einem Porsche;source;in einem Porsche].