summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlaetzer <laetzer@users.sourceforge.net>2008-09-09 20:07:04 +0000
committerlaetzer <laetzer@users.sourceforge.net>2008-09-09 20:07:04 +0000
commitc63ad1160f40b8c44d40c13f8849297c41f058cf (patch)
tree8429c03045f210201570b973f3d227fab0f1f5f4
parentb617ea5c8dcbae4c8ca54331d053d83fe10b6b4e (diff)
downloadpigeonholes-c63ad1160f40b8c44d40c13f8849297c41f058cf.tar.gz
pigeonholes-c63ad1160f40b8c44d40c13f8849297c41f058cf.tar.bz2
pigeonholes-c63ad1160f40b8c44d40c13f8849297c41f058cf.zip
one help file for each module (that takes parameters), html code change from <table> to <dl>
-rw-r--r--modules/help_mod_category_menu.tpl1
-rw-r--r--modules/help_mod_category_suckerfish.tpl13
-rw-r--r--modules/help_mod_last_changes.tpl55
-rw-r--r--modules/help_mod_whats_related.tpl1
4 files changed, 37 insertions, 33 deletions
diff --git a/modules/help_mod_category_menu.tpl b/modules/help_mod_category_menu.tpl
new file mode 100644
index 0000000..9e6db5d
--- /dev/null
+++ b/modules/help_mod_category_menu.tpl
@@ -0,0 +1 @@
+<p>This module doesn't take any parameters.</p> \ No newline at end of file
diff --git a/modules/help_mod_category_suckerfish.tpl b/modules/help_mod_category_suckerfish.tpl
new file mode 100644
index 0000000..6440599
--- /dev/null
+++ b/modules/help_mod_category_suckerfish.tpl
@@ -0,0 +1,13 @@
+<p class="note">
+ {tr}Suckerfish category{/tr}
+ <br />
+ <span class="example">{tr}Example:{/tr} <kbd>structure_id=4</kbd></span>
+</p>
+
+<dl>
+ <dt class="param"><kbd>root_structure_id</kbd></dt>
+ <dd><em>{tr}Numeric{/tr}</em></dd>
+
+ <dt class="param"><kbd>structure_id</kbd></dt>
+ <dd><em>{tr}Numeric{/tr}</em></dd>
+</dl> \ No newline at end of file
diff --git a/modules/help_mod_last_changes.tpl b/modules/help_mod_last_changes.tpl
index 34d1d41..7611353 100644
--- a/modules/help_mod_last_changes.tpl
+++ b/modules/help_mod_last_changes.tpl
@@ -1,33 +1,22 @@
-{tr}<strong>Summary</strong>: Display the most recently changed content - limited to a given category.{/tr}<br />
-<table class="data">
- <tr>
- <th style="width:20%;">{tr}Parameter{/tr}</th>
- <th style="width:20%;">{tr}Value{/tr}</th>
- <th style="width:60%;">{tr}Description{/tr}</th>
- </tr>
- <tr class="odd">
- <td>content_type_guid</td>
- <td>bitpage<br />bituser<br />...</td>
- <td>{tr}Here you can specify what type of content you wish to show.{/tr}</td>
- </tr>
- <tr class="even">
- <td>show_date</td>
- <td>( {tr}boolean{/tr} )</td>
- <td>{tr}Specify if you want to display the date of the last modification.{/tr}</td>
- </tr>
- <tr class="odd">
- <td>hide_content_type</td>
- <td>( {tr}boolean{/tr} )</td>
- <td>{tr}Specify if you want to display the content type<br />(only applicable if you don't specify a content_type_guid).{/tr}</td>
- </tr>
- <tr class="even">
- <td>category_id</td>
- <td>( {tr}numeric{/tr} )</td>
- <td>{tr}Content ID of the pigeonhole you want to limit the listing to<br />(can be used instead of category).{/tr}</td>
- </tr>
- <tr class="odd">
- <td>category</td>
- <td>( {tr}string{/tr} )</td>
- <td>{tr}Title of a category you want to limit the listing to<br />(can be used instead of category_id).{/tr}</td>
- </tr>
-</table>
+<p class="note">
+ {tr}Display the most recently changed content &#8211; limited to a given category. <kbd>hide_content_type</kbd> is only applicable if you don't specify a <kbd>content_type_guid</kbd>. The parameters <kbd>category_id</kbd> and <kbd>category</kbd> are interchangeable.{/tr}
+ <br />
+ <span class="example">{tr}Example:{/tr} <kbd>hide_content_type=1&show_date=1&category=News</kbd></span>
+</p>
+
+<dl>
+ <dt class="param"><kbd>content_type_guid</kbd></dt>
+ <dd>{tr}bitpage, bituser, &hellip;{/tr}</dd>
+
+ <dt class="param"><kbd>show_date</kbd></dt>
+ <dd><em>{tr}Boolean{/tr}</em></dd>
+
+ <dt class="param"><kbd>hide_content_type</kbd></dt>
+ <dd><em>{tr}Boolean{/tr}</em></dd>
+
+ <dt class="param"><kbd>category_id</kbd></dt>
+ <dd><em>{tr}Numeric{/tr}</em></dd>
+
+ <dt class="param"><kbd>category</kbd></dt>
+ <dd><em>{tr}String{/tr}</em></dd>
+</dl> \ No newline at end of file
diff --git a/modules/help_mod_whats_related.tpl b/modules/help_mod_whats_related.tpl
new file mode 100644
index 0000000..9e6db5d
--- /dev/null
+++ b/modules/help_mod_whats_related.tpl
@@ -0,0 +1 @@
+<p>This module doesn't take any parameters.</p> \ No newline at end of file