cybertools/composer/message
helmutm 51b53f3169 allow parameters in view calls in messages; these are stored in view.options
git-svn-id: svn://svn.cy55.de/Zope3/src/cybertools/trunk@4209 fd906abe-77d9-0310-91a1-e0d9ade77398
2011-03-31 10:02:01 +00:00
..
__init__.py added new package composer.message 2007-09-10 17:31:24 +00:00
base.py Sending feedback message via rule manager OK 2007-11-11 10:58:55 +00:00
configure.zcml added new package composer.message 2007-09-10 17:31:24 +00:00
instance.py allow parameters in view calls in messages; these are stored in view.options 2011-03-31 10:02:01 +00:00
interfaces.py make message data provider configurable by subclassing MessageInstance 2009-01-13 08:12:43 +00:00
README.txt minor improvements on navigation and template layout 2007-11-20 13:43:28 +00:00
tests.py added new package composer.message 2007-09-10 17:31:24 +00:00

==================
Message Management
==================

  ($Id$)

  >>> from zope import component
  >>> from cybertools.composer.message.base import MessageManager, Message

  >>> manager = MessageManager()

  >>> messageText = '''Dear $person.firstname $person.lastname,
  ... You have been registered for the following $services.
  ... $@@list_registrations_text
  ... $footer
  ... '''

  >>> manager.addMessage('feedback_text', messageText)
  >>> manager.addMessage('footer', 'Best regards, $sender')
  >>> manager.addMessage('sender', 'Jack')
  >>> manager.addMessage('services', 'events')

Message interpolation
---------------------

  >>> from cybertools.composer.message.instance import MessageTemplate
  >>> t = MessageTemplate(messageText)
  >>> print t.safe_substitute({
  ...           'person.firstname': 'John', 'person.lastname': 'Smith',
  ...           '@@list_registrations_text': '0815: Python Introduction',
  ...           'services': 'events',
  ...           'footer': 'Regards, $sender'})
  Dear John Smith,
  You have been registered for the following events.
  0815: Python Introduction
  Regards, $sender
  <BLANKLINE>

Working with message instances
------------------------------

  >>> from cybertools.composer.message.instance import MessageInstance
  >>> mi = MessageInstance(None, manager.messages['feedback_text'], manager)
  >>> for key, value in mi.applyTemplate().items():
  ...     print key + ':', value
  url:
  text: Dear $person.firstname $person.lastname,
  You have been registered for the following events.
  $@@list_registrations_text
  Best regards, Jack
  <BLANKLINE>
  subjectLine: