TagScript

Interface: TagDefinition

Defined in: packages/tagscript/src/lib/manifest.ts:12

What one tag is, in terms a person picking it from a list would recognise.

The interpreter does not read this. It exists for everything around a template rather than the render itself: an editor offering a list of tags, a check that a saved template only uses tags that exist, a generated reference.

Properties

aliasOf?

Defined in: packages/tagscript/src/lib/manifest.ts:16

The tag this one is another name for, when it is an alias.

description?

Defined in: packages/tagscript/src/lib/manifest.ts:20

What this tag does, in a sentence.

insertable?

Defined in: packages/tagscript/src/lib/manifest.ts:29

Whether an editor should offer this in a list of tags to insert.

A tag whose payload is template text the author still has to write, such as if, is better typed by hand than inserted as a finished thing.

Default Value

false

label

Defined in: packages/tagscript/src/lib/manifest.ts:33

What to show a person instead of TagDefinition.name.

name

Defined in: packages/tagscript/src/lib/manifest.ts:37

The declaration a template writes, lowercase. Matching ignores case, as willAccept does.

parameter?

Defined in: packages/tagscript/src/lib/manifest.ts:41

Whether the tag needs a parameter, and what it means.

label?

required

payload?

Defined in: packages/tagscript/src/lib/manifest.ts:45

Whether the tag needs a payload.

required