Attribute Naming Conventions

From Museon Softcode Package

The following attribute naming conventions will be used for all Museon code.

General Use Attribute

• For $ commands:
  • cmd.+command - for example +staff would be named cmd.+staff
  • cmd.+command/switch - for example +staff/all would be named cmd.+staff/all
• ufunctions:
  • fn.function
• ufunctions that set registers (and should be called with ulocal instead of u):
  • fnl.function
• functions mapped to @function:
  • gf.function
• Data attributes containing a list:
  • list.attributename
• For data attributes that configure how a system works:
  • conf.attribute
• For attributes containing commands run with @trigger:
  • trig.attribute
• Helper code used by those functions:
  • map.attribute
  • sortby.attribute
  • fil.attribute
  • fold.attribute
• Attributes containing commands called by @program:
  • prog.attribute
• Attributes containing SQL code used by sql():
  • sql.attribute
  • sql-i.attribute for inserts
  • sql-d.attribute for deletes
• Attributes explaining the use of other attributes:
  • meta.<attribute name>
  • Example 1:
    • meta.fil.isstaff - explains that fil.isstaff filters a list and only returns those in list.staff
  • Example 2:
    • meta.c.+staff/all - explains that +staff/all lists all staffers in list.staff and notes those connected and those dark/disconnected.
  • Example 3:
    • meta.list.staff - explains that list.staff contains a staff of staff as defined by the use of +staff/add and +staff/del

Skin Attribute Names

Nothing yet defined

Museon Module Attribute Names

Nothing yet defined