Template:Catix/sandbox template tree/doc

From Project Arrhythmia Wiki
Jump to navigation Jump to search
{{treenode|data type|key name|key name alternatives}}

Puts an icon corresponding to data type (with hover text), optionally puts name of the key, and optionally provides possible alternatives for the key (hover text).

Usage examples

{{treenode|objarr}}Object Array
{{treenode|obj|events}}Object events
{{treenode|bool|option|opt, o}}Boolean ("True" or "False") option (note)
{{treenode|str|name|n}}String name (note)

Usage recommendation

This template was made for use inside treeviews (<div class="treeview"> </div>)

<div class="treeview">
* {{treenode|obj|events|e}}: event keyframes
** {{treenode|obj|pos|position, p}}: position keyframe
*** {{treenode|float|x}}
*** {{treenode|float|y}}
** {{treenode|obj|sca|scale, s}}: scale keyframe
*** {{treenode|float|x}}
*** {{treenode|float|y}}
</div>
  • Object events (note): event keyframes
    • Object pos (note): position keyframe
      • Floating Point x
      • Floating Point y
    • Object sca (note): scale keyframe
      • Floating Point x
      • Floating Point y

Data types

  • String str: string type
  • Boolean ("True" or "False") bool: boolean type
  • Integer int: integer (whole numbers) type
  • Floating Point float: floating point number type
  • Object obj: object type
  • Object Array objarr: array type, containing objects
  • String Array strarr: array type, containing strings
  • Unknown node type unknown: unknown type

Rationale

This template enables aesthetically pleasing data structure visualisations.