diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Comanche.md | 8 | ||||
-rw-r--r-- | doc/Widgets.md | 73 | ||||
-rw-r--r-- | doc/comanche.bb | 8 | ||||
-rw-r--r-- | doc/main.bb | 1 |
4 files changed, 82 insertions, 8 deletions
diff --git a/doc/Comanche.md b/doc/Comanche.md index 658b31ca7..fe122db8c 100644 --- a/doc/Comanche.md +++ b/doc/Comanche.md @@ -98,9 +98,9 @@ Widgets are executable apps provided by the system which you can place on your p -Widgets and arguments are specified with the 'widget' and 'arg' tags. +Widgets and arguments are specified with the 'widget' and 'var' tags. - [widget=recent_visitors][arg=count]24[/arg][/widget] + [widget=recent_visitors][var=count]24[/var][/widget] This loads the "recent_visitors" widget and supplies it with the argument "count" set to "24". @@ -136,8 +136,8 @@ Please note that pasting this example into a layout page is not likely to do any [menu]myfavouritemenu[/menu] [widget=recent_visitors] - [arg=count]24[/arg] - [arg=names_only]1[/arg] + [var=count]24[/var] + [var=names_only]1[/var] [/widget] [widget=tagcloud][/widget] diff --git a/doc/Widgets.md b/doc/Widgets.md new file mode 100644 index 000000000..dc7093f8a --- /dev/null +++ b/doc/Widgets.md @@ -0,0 +1,73 @@ +Core Widgets +============ + +Some/many of these widgets have restrictions which may restrict the type of page where they may appear or may require login + + +* clock - displays the current time + * args: military (1 or 0) - use 24 hour time as opposed to AM/PM + * + +* profile - displays a profile sidebar on pages which load profiles (pages with nickname in the URL) + +* tagcloud - display a tagcloud of webpage items + + * args: count - number of items to return (default 24) + * + + +* collections - collection selector for the current logged in channel + + * args: mode - one of "conversation", "group", "abook" depending on module + * + + +* suggestions - friend suggestions for the current logged on channel + +* follow - presents a text box for following another channel + +* notes - private notes area for the current logged in channel if private_notes feature is enabled + +* savedsearch - network/matrix search with save - must be logged in and savedsearch feature enabled + +* filer - select filed items from network/matrix stream - must be logged in + +* archive - date range selector for network and channel pages + +* fullprofile - same as profile currently + +* categories - categories filter (channel page) + +* tagcloud_wall - tagcloud for channel page only + +* affinity - affinity slider for network page - must be logged in + +* settings_menu - sidebar menu for settings page, must be logged in + +* mailmenu - sidebar menu for private message page - must be logged in + +* design_tools - design tools menu for webpage building pages, must be logged in + +* findpeople - tools to find other channels + +* photo_albums - list photo albums of the current page owner with a selector menu + +* vcard - mini profile sidebar for the person of interest (page owner, whatever) + +* dirsafemode - directory selection tool - only on directory pages + +* dirsort - directory selection tool - only on directory pages + +* dirtags - directory tool - only on directory pages + +* menu_preview - preview a menu - only on menu edit pages + +* chatroom_list - list of chatrooms for the page owner + +* bookmarkedchats - list of bookmarked chatrooms collected on this site for the current observer + +* suggestechats - "interesting" chatrooms chosen for the current observer + +* item - displays a single webpage item by mid +1 args: mid - message_id of webpage to display + diff --git a/doc/comanche.bb b/doc/comanche.bb index 1464d809d..e79f9a4c7 100644 --- a/doc/comanche.bb +++ b/doc/comanche.bb @@ -111,9 +111,9 @@ Widgets are executable apps provided by the system which you can place on your p [/code]
-Widgets and arguments are specified with the 'widget' and 'arg' tags.
+Widgets and arguments are specified with the 'widget' and 'var' tags.
[code]
- [widget=recent_visitors][arg=count]24[/arg][/widget]
+ [widget=recent_visitors][var=count]24[/var][/widget]
[/code]
This loads the "recent_visitors" widget and supplies it with the argument "count" set to "24".
@@ -150,8 +150,8 @@ The 'comment' tag is used to delimit comments. These comments will not appear on [menu]myfavouritemenu[/menu]
[widget=recent_visitors]
- [arg=count]24[/arg]
- [arg=names_only]1[/arg]
+ [var=count]24[/var]
+ [var=names_only]1[/var]
[/widget]
[widget=tagcloud][/widget]
diff --git a/doc/main.bb b/doc/main.bb index decaa0ffc..a9ee3c5d8 100644 --- a/doc/main.bb +++ b/doc/main.bb @@ -37,6 +37,7 @@ [zrl=[baseurl]/help/install]Install[/zrl]
[zrl=[baseurl]/help/comanche]Comanche Page Descriptions[/zrl]
[zrl=[baseurl]/help/Creating-Templates]Creating Comanche Templates[/zrl]
+[zrl=[baseurl]/help/Widgets]Core Widgets[/zrl]
[zrl=[baseurl]/help/plugins]Plugins[/zrl]
[zrl=[baseurl]/help/schema_development]Schemas[/zrl]
[zrl=[baseurl]/help/developers]Developers[/zrl]
|