Template:Edge

From AtlasWiki
Revision as of 11:02, 24 November 2015 by Dgriffen (Talk | contribs)

Jump to: navigation, search


This template, for use on edge kind pages, takes in a short description of this edge, and a list of the kinds of connections this edge can form (the predecessor node kind, successor node kind, and multiplicities at each end), and stores that information in properties so it can be retrieved by knowing either the edge kind, the predecessor kind, or the successor kind, using a single query.

It also produces a table summarizing this information.

For example, this is the template call that would be used on a page "Edge" to indicate that "Edge" is an edge kind, that connects either a "Foo" node kind to a "Bar" node kind, or to a "Baz" node kind, with each "Bar" node being associated with exactly one "Foo" node, and each "Baz" node optionally being associated with exactly one "Foo" node:

{{Edge | extends = Another Type of Edge, Yet Another Type of Edge | description = Connects a Foo to a Bar or a Baz | references = ... | permitted = F,B,*,* | specified = Foo,Bar,1,*;Foo,Baz,0..1,* }}

As with the Metaclass template, the extends and references parameters are optional.

The visible output of this will be a metaclass table describing the edge, plus two tables summarizing the generally possible and explicitly specified connections:

Metaclass Edge
Extends Another Type of EdgeYet Another Type of Edge
Description Connects a Foo to a Bar or a Baz
References ...
Permitted Connections
Predecessor Multiplicity Successor
F ✱ ➞ ✱ B
Specified Connections
Predecessor Multiplicity Successor
Foo 1 ➞ ✱ Bar
Foo 0..1 ➞ ✱ Baz

In addition, the following properties will be created:

edge from [predecessor]::[successor]$SEP$[multiplicity]$SEP$[description of this edge]

edge to [successor]::[predecessor]$SEP$[multiplicity]$SEP$[description of this edge]

Note that $SEP$ is literal; when retrieving these properties, they can be split into the three separate values using $SEP$ as the separator argument of #explode, #arraymap, or #arraydefine.

For the above example, the properies will be:

edge from Foo::Bar$SEP$*$SEP$Connects a Foo to a Bar or a Baz

edge to Bar::Foo$SEP$1$SEP$Connects a Foo to a Bar or a Baz

edge from Foo::Baz$SEP$*$SEP$Connects a Foo to a Bar or a Baz

edge to Baz::Foo$SEP$0..1$SEP$Connects a Foo to a Bar or a Baz


Metaclass Edge
Description {{{description}}}