Changes between Version 15 and Version 16 of Development/Plugins/WebUi/Examples

Timestamp:

09/21/2008 07:51:49 AM (15 years ago)

Author:

mvoncken

Comment:

--

Development/Plugins/WebUi/Examples

@@ -52 +52 @@
 }}}
 
-=== Test the new method. ===
+=== Test the new core-plugin method. ===
 create ~/prj/deluge/plugins/df/Df/test.py ; Contents:
 {{{
@@ -62 +62 @@
 }}}
 
-=== Execute test ===
+Terminal:
 {{{
 cd ~/prj/deluge/plugins/Df/df
@@ -80 +80 @@
 === Webui plugin ===
 Edit ~/prj/deluge/plugins/Df/df/webui.py and add this above ConfigForm
+
+Note that api.render.df automatically maps to df.html , because of the call to api.render.register_template_path (see http://webpy.org/)
 {{{
 #!python
@@ -113 +115 @@
 killall deluge & deluge -u web &
 }}}
+Read the output to the console, there could be some errors there.
 
 visit http://localhost:8112/df
 
+Execute test until there are no more errors, and the page displays the desired result.
+
 === Add to top menu ===
+We added a page, but the user can't navigate to it, let's fix that :
+
 Add 2 lines for register/unregister of the menu-items.
 {{{
+#!python
     def enable(self):
         api.config_page_manager.register('plugins','df',ConfigForm)
@@ -133 +141 @@
 
 === Pretty template ===
+We're allmost ready, but the current template doesn't look right.
+
+Adding a header/footer and menu to the template:
 {{{
 $def with (df_result)
@@ -145 +156 @@
 </div>
 $:render.footer()
+
 }}}
 
@@ -150 +162 @@
  * (template_dir/path) is a convention, it will be automagic somewhere in the future.
  * all webui unregister_* methods will be renamed to deregister_*
- * basic outline of developing a webui plugin is explained, todo: add some words to make the text flow.