Difference between revisions of "Template:Edge"

From AtlasWiki
Jump to: navigation, search
(another attempt to fix the issue)
(hopefully this fixes it, seems to be the standard way to pass optional parameters safely)
Line 53: Line 53:
 
First, generate the necessary table:
 
First, generate the necessary table:
  
Notes: the hairiest thing going on here is replacing asterisks with heavy asterisks, which we do for two reasons: they're centered better (meaning we don't get the awkward look of *->*, with the stars too high), and they
+
Notes: the hardest piece of this is that the Metaclass template is very sensitive to its variables being defined; the fix used here is supplying a different named variable if the variable we're interested in is undefined; i.e. we pass our "extends" variable to "extends" if it's present, but if it's not present, we pass it to a variable "extendsNULL" instead, so that the variable "extends" is never defined.
  
--></noinclude>{{Metaclass {{#if:{{{extends|}}}| {{!}} extends = {{{extends|}}} }}
+
--></noinclude>{{Metaclass
| description = {{{description|}}} {{#if:{{{references|}}}| {{!}} references = {{{references|}}} }}
+
| extends{{#if:{{{extends|}}}||NULL}}={{{extends}}}
 +
| description = {{{description}}}
 +
| references{{#if:{{{references|}}}||NULL}}={{{references}}}
 
}}
 
}}
  

Revision as of 18:43, 24 March 2014


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 = ... | connects = 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 a table summarizing the connections:

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

In addition, the following properties will be created:

edge from [predecessor]::[successor],[multiplicity],[description of this edge]

edge to [successor]::[predecessor],[multiplicity],[description of this edge]


For the above example, the properies will be:

edge from Foo::Bar,*,Connects a Foo to a Bar or a Baz

edge to Bar::Foo,1,Connects a Foo to a Bar or a Baz

edge from Foo::Baz,*,Connects a Foo to a Bar or a Baz

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


Metaclass Edge
Description {{{description}}}
Predecessor Multiplicity Successor
Node Kind 1 ➞ ✱ Node Kind
Node Kind ✱ ➞ 1 Node Kind