from engine.prelude import Prelude
-# set to
+####################
+# set DEBUG to
# . False : silent
-# [ 'SliceList', 'TabbedView' ] : to debug these classes
-# True : to debug all slices
+# . [ 'SliceList', 'TabbedView' ] : to debug these classes
+# . True : to debug all plugin
DEBUG= [ 'SliceList' ]
self.name=name
self.add_to_settings ( ['title','name'] )
self.uuid=Plugin.newuuid()
+ self.classname=self._classname()
+ self.add_to_settings ( [ 'uuid', 'classname' ] )
self.visible=visible
self.hidable=hidable
self.hidden_by_default=hidden_by_default
- self.add_to_settings( ['uuid','visible','hidable','hidden_by_default'] )
+ self.add_to_settings( ['visible','hidable','hidden_by_default'] )
# we store as a dictionary the arguments passed to constructor
# e.g. SimpleList (list=[1,2,3]) => _settings = { 'list':[1,2,3] }
# our own settings are not made part of _settings but could be..
for setting_name in setting_name_s:
self._settings[setting_name]=getattr(self,setting_name)
- def classname (self):
+ def _classname (self):
try: return self.__class__.__name__
except: return 'Plugin'
def need_debug (self):
if not DEBUG: return False
if DEBUG is True: return True
- else: return self.classname() in DEBUG
+ else: return self.classname in DEBUG
# returns the html code for that plugin
# in essence, wraps the results of self.render_content ()
def render (self, request):
uuid = self.uuid
- classname = self.classname()
# initialize prelude placeholder
self._init_request (request)
# expose _settings in json format to js
settings_json = json.dumps (self._settings, separators=(',',':'))
- result = render_to_string ('plugin.html',
- {'uuid':uuid,
- 'classname':classname,
- 'visible':self.is_visible(),
- 'hidable':self.is_hidable(),
- 'hidden':self.is_hidden_by_default(),
- 'plugin_content' : plugin_content,
- 'settings_json' : settings_json,
- })
+ env= {'plugin_content' : plugin_content,
+ 'settings_json' : settings_json,
+ }
+ env.update(self._settings)
+ result = render_to_string ('plugin.html',env)
# handle requirements() if defined on this class
try:
template = self.template_file()
env=self.template_env(request)
if not isinstance (env,dict):
- raise Exception, "%s.template_env returns wrong type"%self.classname()
+ raise Exception, "%s.template_env returns wrong type"%self.classname
# expose this class's settings to the template
# xxx we might need to check that this does not overwrite env..
env.update(self._settings)
result=render_to_string (template, env)
if self.need_debug():
- print "%s.render_content: BEG --------------------"%self.classname()
+ print "%s.render_content: BEG --------------------"%self.classname
print "template=%s"%template
- print "env=%s"%env.keys()
- # print result
- print "%s.render_content: END --------------------"%self.classname()
+ print "env.keys=%s"%env.keys()
+ print "env=%s"%env
+ print result
+ print "%s.render_content: END --------------------"%self.classname
return result
#################### requirements/prelude management
def handle_requirements (self, request, d):
for (k,v) in d.iteritems():
if self.need_debug():
- print "%s: handling requirement %s"%(self.classname(),v)
+ print "%s: handling requirement %s"%(self.classname,v)
method_name='add_'+k
method=Plugin.__dict__[method_name]
method(self,request,v)
# your plugin is expected to implement either
# (*) def render_content(self, request) -> html fragment
# -- or --
- # (*) def template_file(self) -> filename
+ # (*) def template_file (self) -> filename
# relative to STATIC
# (*) def template_env (self, request) -> dict
# this is the variable->value association used to render the template
# in which case the html template will be used
# if you see this string somewhere your template_file() code is not kicking in
- def template_file (self): return "undefined_template"
- def template_env (self, request): return {}
+ def template_file (self): return "undefined_template"
+ def template_env (self, request): return {}
# # tell the framework about requirements (for the document <header>)
# # the notion of 'Media' in django provides for medium-dependant
+{#<!--begin {{ classname }}{{ name }}{{ uuid }}-->#}
{% if visible %}
-<div class='plugin-manage'>
+<div class='plugin-manage' id='{{ name }}'>
{% if hidable %}
{% if hidden %}
-<p id='show-{{ uuid }}' class='plugin-show'><a href='#'><span>» Show {{ classname }}</span></a></p>
-<p id='hide-{{ uuid }}' class='plugin-hide' style='display:none;'><a href='#'><span>« Hide {{ classname }}</span></a></p>
+<p id='show-{{ uuid }}' class='plugin-show'><a href='#'><span>» Show {{ classname }} "{{ title }}"</span></a></p>
+<p id='hide-{{ uuid }}' class='plugin-hide' style='display:none;'><a href='#'><span>« Hide {{ classname }} "{{ title }}"</span></a></p>
{% else %}
-<p id='show-{{ uuid }}' class='plugin-show' style='display:none;'><a href='#'><span>» Show {{ classname }}</span></a></p>
-<p id='hide-{{ uuid }}' class='plugin-hide'><a href='#'><span>« Hide {{ classname }}</span></a></p>
+<p id='show-{{ uuid }}' class='plugin-show' style='display:none;'><a href='#'><span>» Show {{ classname }} "{{ title }}"</span></a></p>
+<p id='hide-{{ uuid }}' class='plugin-hide'><a href='#'><span>« Hide {{ classname }} "{{ title }}"</span></a></p>
{% endif %}
{% endif %}
{% endif %}
{% if visible %}
</div>
{% endif %}
+{#<!--end {{ classname }}{{ name }}{{ uuid }}-->#}
{# Plugin initialization (if the plugin has the right structure) - from plugin.php #}
{# note: that's the spirit but using {% insert %} is not reliable enough #}
{# so for now this doesn't make it back to the browser #}
{% insert prelude_js %}
if (typeof jQuery('#{{ uuid }}').$title != 'undefined') {
- jQuery('#{{ uuid }}').$title({ {{ settings_json }} plugin_uuid: '{{ uuid }}' });
- //jQuery('#{{ uuid }}').$title('show');
+ jQuery('#plugin-{{ uuid }}').$title({ {{ settings_json }} plugin_uuid: '{{ uuid }}' });
+ //jQuery('#plugin-{{ uuid }}').$title('show');
};
{% endinsert %}