Including cards is achieved through a simple syntax, which consists of the name of the card inside double braces, with a couple of optional modifiers.
{{ cardname | key1:value; key2:value }}
The complete Nest Syntax is documented here:
{{ cardname | view }}
{{ cardname | key: value }}
{{ cardname | key1: value1 ; key2 value2 }}
{{ cardname | key1: value1 ; key2 value2 | itemkey1:itemvalue1; itemkey2:itemvalue2}}
Keys and Values
Key Values Notes view
"view" key is optional; if no key is given, value will be treated as view
title
text
replaces card name in view
show
applicable view names
e.g. title_link on any view that shows a title. use commas for multiple views
hide
applicable view names
e.g. paging on searches or menu wherever it's shown by default. use commas for multiple views
structure
any card name
overrides content and structure rule.
item
any valid view name
may be deprecated?; set via multiple-pipe syntax above Eg: size
Image cards only
type
any valid Cardtype name
may be deprecated?; set type via rules with *default setting
other
any valid CSS value
may be deprecated?; will be treated as CSS
Notes
- whitespace is optional
- inclusions can use contextual names
- see nesting and view cards for examples.
To demonstrate, here's a simple sample card:
Well, hello. I'm the content of simple sample card.
We included the card above using this syntax: {{simple sample | view:open }}. The "view:open" part means we want to see the whole card, with its green header and everything. There are many other views: closed, content, titled, link, name, change, core, etc.
The default view is "content", which means you only see the content of the card -- no header or footer. So if you don't specify a view, and just type {{simple sample}}, you'll just get the card's content:
Well, hello. I'm the content of simple sample card.
You would get the very same thing with {{simple sample | view:content}}, which is just a bit more explicit. Actually, because "view" is such a common key, you can just leave it out, like so: {{simple sample | closed}}, which gives us this:
Well, hello. I'm the content of simple sample card.
When you include Search and Pointer cards, you can also specify the view of each card in the returned list by adding another pipe. For example, {{sample user search | open | link}} will yield:
That syntax basically means "show me the search card in open view and each of its items in link view".
If you want to use double curly brackets without creating an inclusion (for example in documentation), put a backslash just before the brackets. For example, \{{nymph}} appears as:
{{nymph}}