Custom Instance Representation

[ryneeverett]

It would be nice if shortcodes could have a representation that indicates which instance they are.

• Add a repr option to shortcodes that takes an unformatted string. E.g.:

#!python

@shortcodes.button(repr='A person named {entity}.')

• Add a data-repr attribute to insert_shortcodes.js. The value should be the repr string after passing the instance as the "context" to str.format.
• Add a data-repr attribute to shortcodes. The problem with this is keeping the instance repr's synchronized with the shortcode parameter. In my initial idea it is hardcoded at instance definition, which I would consider unacceptable.
• Add a view to get the instance -> repr mapping. This will look a lot like render.py.
• In plugin.js's render:
  • In init callback, call a view to get instance -> repr mapping.
  • Pass instance repr into render.
  • In render, Insert repr rather than displayname if defined.