diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Widgets.md | 34 | ||||
| -rw-r--r-- | doc/developer/api_zot.bb | 4 | ||||
| -rw-r--r-- | doc/hooklist.bb | 7 |
3 files changed, 42 insertions, 3 deletions
diff --git a/doc/Widgets.md b/doc/Widgets.md index 4ad899a0f..7761b1833 100644 --- a/doc/Widgets.md +++ b/doc/Widgets.md @@ -129,14 +129,44 @@ Some/many of these widgets have restrictions which may restrict the type of page Creating New Widgets ==================== -If you want a widget named 'slugfish', create widget/slugfish.php containing +### Class Widgets + +To create a class-based widget named 'slugfish' create a file with the following contents: + +```` +<?php + +namespace Zotlabs\Widget; + + +class Slugfish { + + function widget($args) { + + ... widget code goes here. + ... The function returns a string which is the HTML content of the widget. + ... $args is a named array which is passed any [var] variables from the layout editor + ... For instance [widget=slugfish][var=count]3[/var][/widget] will populate $args with + ... [ 'count' => 3 ] + + } + +```` + +The resultant file may be placed in widget/Slugfish/Slugfish.php , or Zotlabs/SiteWidgets/Slugfish.php . It also may be linked from a git repository using util/add_widget_repo. + + + +Traditional function based widget: + +If you want a widget named 'slugfish', create widget/widget_slugfish.php containing <?php function widget_slugfish($args) { - .. widget code goes here + .. widget code goes here. See above information for class-based widgets for details. } diff --git a/doc/developer/api_zot.bb b/doc/developer/api_zot.bb index b2c19d7a1..ff937bfa5 100644 --- a/doc/developer/api_zot.bb +++ b/doc/developer/api_zot.bb @@ -1,5 +1,9 @@ [h3]Zot API[/h3] +Many existing social applications and tools can interface directly using the Twitter/StatusNet API, which is available using the 'twitter_api' addon. + +This document describes the native API; which allows direct programmatic access to several internal data structures and libraries extending beyond the basic social interface. + The API endpoints detailed below are relative to [code]api/z/1.0[/code], meaning that if an API is listed as [code]channel/stream[/code] the full API URL is [code][baseurl]/api/z/1.0/channel/stream[/code]. [h3]channel/export/basic[/h3] diff --git a/doc/hooklist.bb b/doc/hooklist.bb index 1192a1506..34e19660e 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -229,6 +229,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/feature_settings_post]feature_settings_post[/zrl] called from settings page when posting from 'addon/feature settings' +[zrl=[baseurl]/help/hook/file_thumbnail]file_thumbnail[/zrl] + called when generating thumbnail images for cloud page in 'view tiles' mode + [zrl=[baseurl]/help/hook/follow]follow[/zrl] called when a follow operation takes place @@ -244,7 +247,6 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/gender_selector_min]gender_selector_min[/zrl] called when creating the 'gender' drop down list (normal profile) - [zrl=[baseurl]/help/hook/generate_map]generate_map[/zrl] called to generate the HTML for displaying a map location by coordinates @@ -575,6 +577,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/tagged]tagged[/zrl] Called when a delivery is processed which results in you being tagged +[zrl=[baseurl]/help/hook/thumbnail]thumbnail[/zrl] + Called when generating thumbnails for cloud storage 'tile' view + [zrl=[baseurl]/help/hook/update_unseen]update_unseen[/zrl] Called prior to automatically marking items seen which were loaded in the browser |