diff options
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/Pages.md | 2 | ||||
| -rwxr-xr-x | doc/Plugins.md | 40 | ||||
| -rwxr-xr-x | doc/developer | 18 |
3 files changed, 31 insertions, 29 deletions
diff --git a/doc/Pages.md b/doc/Pages.md index ff2fb9fb3..d0e6776a4 100755 --- a/doc/Pages.md +++ b/doc/Pages.md @@ -24,7 +24,7 @@ The "Automatic Friend Account" is typically used for personal profile pages wher We recommend that you create group pages with the same email address and password as your normal account. If you do this, you will find a new "Manage" tab on the menu bar which lets you toggle identities easily and manage your pages. You are not required to do this, but the alternative is to logout and log back into the other account to manage alternate pages - and this could get cumbersome if you manage several different pages/identities. -You may also appoint a delegate to manage your page. Do this by visiting the [Delegation Setup Page](/delegate). This will provide you with a list of contacts on this system under "Potential Delegates". Selecting one or more persons will give them access to manage your page. They will be able to edit contacts, profiles, and all content for this account/page. Please use this facility wisely. Delegated managers will not be able to alter basic account settings such as passwords or page types and/or remove the account. +You may also appoint a delegate to manage your page. Do this by visiting the [Delegation Setup Page](delegate). This will provide you with a list of contacts on this system under "Potential Delegates". Selecting one or more persons will give them access to manage your page. They will be able to edit contacts, profiles, and all content for this account/page. Please use this facility wisely. Delegated managers will not be able to alter basic account settings such as passwords or page types and/or remove the account. **Posting to Community Pages** diff --git a/doc/Plugins.md b/doc/Plugins.md index 70a8726c7..29dff3187 100755 --- a/doc/Plugins.md +++ b/doc/Plugins.md @@ -1,11 +1,20 @@ **Friendica Addon/Plugin development** -This is an early specification and hook details may be subject to change. - Please see the sample addon 'randplace' for a working example of using some of these features. The facebook addon provides an example of integrating both "addon" and "module" functionality. Addons work by intercepting event hooks - which must be registered. Modules work by intercepting specific page requests (by URL path). -Plugin names cannot contain spaces and are used as filenames. Each addon must contain both an install and an uninstall function based on the addon/plugin name. For instance "plugin1name_install()". These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your plugin will require. The install and uninstall functions will also be called (i.e. re-installed) if the plugin changes after installation - therefore your uninstall should not destroy data and install should consider that data may already exist. Future extensions may provide for "setup" amd "remove". +Plugin names cannot contain spaces or other punctuation and are used as filenames and function names. You may supply a "friendly" name within the comment block. Each addon must contain both an install and an uninstall function based on the addon/plugin name. For instance "plugin1name_install()". These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your plugin will require. The install and uninstall functions will also be called (i.e. re-installed) if the plugin changes after installation - therefore your uninstall should not destroy data and install should consider that data may already exist. Future extensions may provide for "setup" amd "remove". + +Plugins should contain a comment block with the four following parameters: + + /* + * Name: My Great Plugin + * Description: This is what my plugin does. It's really cool + * Version: 1.0 + * Author: John Q. Public <john@myfriendicasite.com> + */ + + Register your plugin hooks during installation. @@ -160,7 +169,8 @@ Your module functions will often contain the function plugin_name_content(&$a), $b is (string) HTML of content div -A complete list of all hook callbacks with file locations (generated 09-Nov-2011): Please see the source for details of any hooks not documented above. +A complete list of all hook callbacks with file locations (generated 14-Feb-2012): Please see the source for details of any hooks not documented above. + boot.php: call_hooks('login_hook',$o); @@ -170,7 +180,7 @@ boot.php: call_hooks('profile_sidebar', $arr); boot.php: call_hooks("proc_run", $arr); -include/contact_selectors.php: call_hooks('network_to_name', $s); +include/contact_selectors.php: call_hooks('network_to_name', $nets); include/api.php: call_hooks('logged_in', $a->user); @@ -194,8 +204,6 @@ include/nav.php: call_hooks('page_header', $a->page['nav']); include/auth.php: call_hooks('authenticate', $addon_auth); -include/auth.php: call_hooks('logged_in', $a->user); - include/bbcode.php: call_hooks('bbcode',$Text); include/oauth.php: call_hooks('logged_in', $a->user); @@ -236,19 +244,29 @@ include/bb2diaspora.php: call_hooks('bb2diaspora',$Text); include/cronhooks.php: call_hooks('cron', $d); +include/security.php: call_hooks('logged_in', $a->user); + include/html2bbcode.php: call_hooks('html2bbcode', $text); +include/Contact.php: call_hooks('remove_user',$r[0]); + include/Contact.php: call_hooks('contact_photo_menu', $args); +include/conversation.php: call_hooks('conversation_start',$cb); + +include/conversation.php: call_hooks('render_location',$locate); + include/conversation.php: call_hooks('display_item', $arr); +include/conversation.php: call_hooks('render_location',$locate); + include/conversation.php: call_hooks('display_item', $arr); include/conversation.php: call_hooks('item_photo_menu', $args); -include/conversation.php: call_hooks('jot_tool', $jotplugins); +include/conversation.php: call_hooks('jot_tool', $jotplugins); -include/conversation.php: call_hooks('jot_networks', $jotnets); +include/conversation.php: call_hooks('jot_networks', $jotnets); include/plugin.php:if(! function_exists('call_hooks')) { @@ -282,6 +300,8 @@ mod/editpost.php: call_hooks('jot_networks', $jotnets); mod/parse_url.php: call_hooks('parse_link', $arr); +mod/home.php: call_hooks('home_init',$ret); + mod/home.php: call_hooks("home_content",$o); mod/contacts.php: call_hooks('contact_edit_post', $_POST); @@ -306,7 +326,7 @@ mod/like.php: call_hooks('post_local_end', $arr); mod/xrd.php: call_hooks('personal_xrd', $arr); -mod/item.php: call_hooks('post_local_start', $_POST); +mod/item.php: call_hooks('post_local_start', $_REQUEST); mod/item.php: call_hooks('post_local',$datarray); diff --git a/doc/developer b/doc/developer deleted file mode 100755 index dd8b316ea..000000000 --- a/doc/developer +++ /dev/null @@ -1,18 +0,0 @@ -Friendica Developer Guide - -Here is how you can join us. - -First, get yourself a working git package on the system where you will be -doing development. - -Create your own github account. - -Follow the instructions provided here: [[http://help.github.com/fork-a-repo/]] -to create and use your own tracking fork on github - -Then go to your github page and create a "Pull request" when you are ready -to notify us to merge your work. - -**Important** - -Please pull in any changes from the project repository and merge them with your work **before** issuing a pull request. We reserve the right to reject any patch which results in a large number of merge conflicts. This is especially true in the case of language translations - where we may not be able to understand the subtle differences between conflicting versions.
\ No newline at end of file |