Update docs
changelog, install and doc folder
This commit is contained in:
Adam Magness
parent
b86b04a81a
commit
20a16b0b35
|
|
@ -299,7 +299,7 @@ Version 3.4.3 (2015-12-22)
|
|||
Contact's posts are shown in a dedicated page (annando)
|
||||
Module name is shown in page title to ease browser history navigation (issue #2079) (tobiasd)
|
||||
What's new for admins:
|
||||
Forumlist functionality moved from plugin to core (rabuzarus, annando)
|
||||
Forumlist functionality moved from addon to core (rabuzarus, annando)
|
||||
Changes on poller/workers limits management (annando)
|
||||
Diaspora and OStatus can be enabled only if requirements are satisfied (annando)
|
||||
Support for additional passwords for ejabberd (annando)
|
||||
|
|
@ -380,7 +380,7 @@ Version 3.4.2 (2015-09-29)
|
|||
Support for inline [code] tag usage (fabrixxm)
|
||||
Fix login form in aside (issue #1348) (annando)
|
||||
Show both url-style and webfinger-style identity address in profile (issue #1621) (tobiasd)
|
||||
Add button to reload all active plugins in admin plugins page to ensure new hooks are used (fabrixxm)
|
||||
Add button to reload all active addons in admin addons page to ensure new hooks are used (fabrixxm)
|
||||
Make the hardcoded path to global directory configurable (annando)
|
||||
Change default directory to dir.friendi.ca (annando)
|
||||
Improve cache system with granular expire time (annando)
|
||||
|
|
|
|||
12
INSTALL.txt
12
INSTALL.txt
|
|
@ -130,18 +130,18 @@ You should also be sure that $a->config['php_path'] is set correctly, it should
|
|||
look like (changing it to the correct PHP location)
|
||||
|
||||
$a->config['php_path'] = '/usr/local/php53/bin/php'
|
||||
|
||||
Alternative: You may be able to use the 'poormancron' plugin to perform this
|
||||
|
||||
Alternative: You may be able to use the 'poormancron' addon to perform this
|
||||
step if you are using a recent Friendica release. 'poormancron' may result in
|
||||
perfomance and memory issues and is only suitable for small sites with one or
|
||||
two users and a handful of contacts. To do this, edit the file
|
||||
".htconfig.php" and look for a line describing your plugins. On a fresh
|
||||
two users and a handful of contacts. To do this, edit the file
|
||||
".htconfig.php" and look for a line describing your addons. On a fresh
|
||||
installation, it will look like
|
||||
|
||||
$a->config['system']['addon'] = 'js_upload';
|
||||
|
||||
This indicates the "js_upload" addon module is enabled. You may add additional
|
||||
addons/plugins using this same line in the configuration file. Change it to
|
||||
This indicates the "js_upload" addon module is enabled. You may add additional
|
||||
addons/addons using this same line in the configuration file. Change it to
|
||||
read
|
||||
|
||||
$a->config['system']['addon'] = 'js_upload,poormancron';
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Our mission is to free friends, family and colleagues from data-harvesting corpo
|
|||
|
||||
Friendica connects you effortlessly to a federated communications network of several thousand servers, with more than half a million user registrations. You can directly connect to anyone on [Friendica]( https://friendi.ca), [Mastodon](https://joinmastodon.org/), [Diaspora](https://diasporafoundation.org/), [GnuSocial](https://gnu.io/social/), [Pleroma](https://pleroma.social/), or [Hubzilla](https://hubzilla.org/), regardless where each user profile is hosted.
|
||||
|
||||
With Friendica, you can also fully interact with anyone on Twitter, post on Facebook and receive any content on Tumblr, Wordpress or RSS. Friendica allows you to integrate most things on the web via a range of plugins such as ITTT, Buffer; you will be able to easily control your own data as you decide.
|
||||
With Friendica, you can also fully interact with anyone on Twitter, post on Facebook and receive any content on Tumblr, Wordpress or RSS. Friendica allows you to integrate most things on the web via a range of addons such as ITTT, Buffer; you will be able to easily control your own data as you decide.
|
||||
|
||||
Join today and [get your Friendica profile!](https://dir.friendica.social/servers 'Join Friendica today!')
|
||||
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ General
|
|||
* o: Account
|
||||
* t: Additional features
|
||||
* w: Social Networks
|
||||
* l: Plugins
|
||||
* l: Addons
|
||||
* d: Delegations
|
||||
* b: Connected apps
|
||||
* e: Export personal data
|
||||
|
|
|
|||
16
doc/Chats.md
16
doc/Chats.md
|
|
@ -8,10 +8,10 @@ There are two possibilities to use chat on your friendica site
|
|||
* IRC Chat
|
||||
* Jappix
|
||||
|
||||
IRC-Chat Plugin
|
||||
IRC-Chat Addon
|
||||
---
|
||||
|
||||
After activating the plugin, you can find the chat at [yoursite.com/irc](../irc).
|
||||
After activating the addon, you can find the chat at [yoursite.com/irc](../irc).
|
||||
Note: you can use this chat without any login at your site so that everyone could use it.
|
||||
|
||||
If you follow the link, you will see the login page of the IRC chat.
|
||||
|
|
@ -28,8 +28,8 @@ The lower part of the window contains an input field.
|
|||
Jappix Mini
|
||||
---
|
||||
|
||||
The Jappix Mini Plugin creates a chatbox for jabber- and XMPP-contacts.
|
||||
You should already have a jabber/XMPP-account before setting up the plugin.
|
||||
The Jappix Mini Addon creates a chatbox for jabber- and XMPP-contacts.
|
||||
You should already have a jabber/XMPP-account before setting up the addon.
|
||||
You can find more information at [jabber.org](http://www.jabber.org/).
|
||||
|
||||
You can use several servers to create an account:
|
||||
|
|
@ -48,15 +48,15 @@ Or you can download a tar archive here: [jappixmini.tgz](https://github.com/frie
|
|||
Just unpack the file and rename the directory to „jappixmini“.
|
||||
Next, upload this directory and the .tgz-file into your addon directory of your friendica installation.
|
||||
|
||||
Now you can activate the plugin globally on the admin pages.
|
||||
In the plugin sidebar, you will find an entry of jappix now (where you can also find twitter, GNU Social and others).
|
||||
The following page shows the settings of this plugin.
|
||||
Now you can activate the addon globally on the admin pages.
|
||||
In the addon sidebar, you will find an entry of jappix now (where you can also find twitter, GNU Social and others).
|
||||
The following page shows the settings of this addon.
|
||||
|
||||
Activate the BOSH proxy.
|
||||
|
||||
###2. Settings
|
||||
|
||||
Go to your user account settings next and choose the plugin page.
|
||||
Go to your user account settings next and choose the addon page.
|
||||
Scroll down until you find the Jappix Mini addon settings.
|
||||
|
||||
At first you have to activate the addon.
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ If you don't need to use any third-party library, then you don't need to use Com
|
|||
|
||||
#### Adding a third-party library to Friendica
|
||||
|
||||
Does your shiny new [Plugin](help/Plugins) need to rely on a third-party library not required by Friendica yet?
|
||||
Does your shiny new [Addon](help/Addons) need to rely on a third-party library not required by Friendica yet?
|
||||
First of all, this library should be available on [Packagist](https://packagist.org) so that Composer knows how to fetch it directly just by mentioning its name in `composer.json`.
|
||||
|
||||
This file is the configuration of Friendica for Composer. It lists details about the Friendica project, but also a list of required dependencies and their target version.
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ Blocked contacts cannot do this. They cannot communicate with you directly, only
|
|||
However we do not import their posts or private messages to you.
|
||||
Like blocking, you will still see this person's comments to posts made by your friends.
|
||||
|
||||
A plugin called "blockem" can be installed to collapse/hide all posts from a particular person in your stream if you desire complete blocking of an individual, including his/her conversations with your other friends.
|
||||
An addon called "blockem" can be installed to collapse/hide all posts from a particular person in your stream if you desire complete blocking of an individual, including his/her conversations with your other friends.
|
||||
|
||||
An **archived contact** means that communication is not possible and will not be attempted.
|
||||
(Perhaps the person moved to a new site and removed the old profile.)
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ Friendica Documentation and Resources
|
|||
* [Help on Vagrant](help/Vagrant)
|
||||
* [Bugs and Issues](help/Bugs-and-Issues)
|
||||
* Code structure
|
||||
* [Plugin Development](help/Plugins)
|
||||
* [Addon Development](help/Addons)
|
||||
* [Theme Development](help/themes)
|
||||
* [Smarty 3 Templates](help/smarty3-templates)
|
||||
* How To
|
||||
|
|
|
|||
|
|
@ -22,16 +22,16 @@ If you have many OStatus contacts then completing of conversations can take some
|
|||
|
||||
When using MyISAM (default) or InnoDB on MariaDB 10 this speeds up search.
|
||||
|
||||
Plugins
|
||||
Addons
|
||||
--------
|
||||
|
||||
Active the following plugins:
|
||||
Active the following addons:
|
||||
|
||||
rendertime
|
||||
|
||||
###rendertime
|
||||
|
||||
This plugin doesn't speed up your system.
|
||||
This addon doesn't speed up your system.
|
||||
It helps to analyze your bottlenecks.
|
||||
|
||||
When enabled you see some values at the bottom of every page.
|
||||
|
|
|
|||
|
|
@ -4,28 +4,28 @@ Installing Connectors (Twitter/GNU Social)
|
|||
* [Home](help)
|
||||
|
||||
|
||||
Friendica uses plugins to provide connectivity to some networks, such as Twitter or App.net.
|
||||
Friendica uses addons to provide connectivity to some networks, such as Twitter or App.net.
|
||||
|
||||
There is also a plugin to post through to an existing account on a GNU Social service.
|
||||
There is also a addon to post through to an existing account on a GNU Social service.
|
||||
You only need this to post to an already existing GNU Social account, but not to communicate with GNU Social members in general.
|
||||
|
||||
All three plugins require an account on the target network.
|
||||
All three addons require an account on the target network.
|
||||
In addition you (or typically the server administrator) will need to obtain an API key to provide authenticated access to your Friendica server.
|
||||
|
||||
Site Configuration
|
||||
---
|
||||
|
||||
Plugins must be installed by the site administrator before they can be used.
|
||||
Addons must be installed by the site administrator before they can be used.
|
||||
This is accomplished through the site administration panel.
|
||||
|
||||
Each of the connectors also requires an "API key" from the service you wish to connect with.
|
||||
Some plugins allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (.htconfig.php).
|
||||
Some addons allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (.htconfig.php).
|
||||
The ways to obtain these keys vary between the services, but they all require an existing account on the target service.
|
||||
Once installed, these API keys can usually be shared by all site members.
|
||||
|
||||
The details of configuring each service follow (much of this information comes directly from the plugin source files):
|
||||
The details of configuring each service follow (much of this information comes directly from the addon source files):
|
||||
|
||||
Twitter Plugin for Friendica
|
||||
Twitter Addon for Friendica
|
||||
---
|
||||
|
||||
* Author: Tobias Diekershoff
|
||||
|
|
@ -33,7 +33,7 @@ Twitter Plugin for Friendica
|
|||
* License: 3-clause BSD license
|
||||
|
||||
###Configuration
|
||||
To use this plugin you need a OAuth Consumer key pair (key & secret).
|
||||
To use this addon you need a OAuth Consumer key pair (key & secret).
|
||||
You can get it from [Twitter](https://twitter.com/apps).
|
||||
|
||||
Register your Friendica site as "Client" application with "Read & Write" access.
|
||||
|
|
@ -51,7 +51,7 @@ After this, your users can configure their Twitter account settings from "Settin
|
|||
Find the author's documentation here: [http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin](http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin)
|
||||
|
||||
|
||||
GNU Social Plugin for Friendica
|
||||
GNU Social Addon for Friendica
|
||||
---
|
||||
|
||||
* Author: Tobias Diekershoff
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Friendica Addon/Plugin development
|
||||
Friendica Addon development
|
||||
==============
|
||||
|
||||
* [Home](help)
|
||||
|
|
@ -7,32 +7,32 @@ Please see the sample addon 'randplace' for a working example of using some of t
|
|||
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 or other punctuation and are used as filenames and function names.
|
||||
Addon 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.
|
||||
Each addon must contain both an install and an uninstall function based on the addon/addon name.
|
||||
For instance "addon1name_install()".
|
||||
These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your addon will require.
|
||||
The install and uninstall functions will also be called (i.e. re-installed) if the addon 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:
|
||||
Addons 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.
|
||||
* Name: My Great Addon
|
||||
* Description: This is what my addon does. It's really cool.
|
||||
* Version: 1.0
|
||||
* Author: John Q. Public <john@myfriendicasite.com>
|
||||
*/
|
||||
|
||||
Register your plugin hooks during installation.
|
||||
Register your addon hooks during installation.
|
||||
|
||||
Addon::registerHook($hookname, $file, $function);
|
||||
|
||||
$hookname is a string and corresponds to a known Friendica hook.
|
||||
|
||||
$file is a pathname relative to the top-level Friendica directory.
|
||||
This *should* be 'addon/plugin_name/plugin_name.php' in most cases.
|
||||
This *should* be 'addon/addon_name/addon_name.php' in most cases.
|
||||
|
||||
$function is a string and is the name of the function which will be executed when the hook is called.
|
||||
|
||||
|
|
@ -69,39 +69,39 @@ Remember to declare it with '&' if you wish to alter it.
|
|||
Modules
|
||||
---
|
||||
|
||||
Plugins/addons may also act as "modules" and intercept all page requests for a given URL path.
|
||||
In order for a plugin to act as a module it needs to define a function "plugin_name_module()" which takes no arguments and needs not do anything.
|
||||
Addons/addons may also act as "modules" and intercept all page requests for a given URL path.
|
||||
In order for a addon to act as a module it needs to define a function "addon_name_module()" which takes no arguments and needs not do anything.
|
||||
|
||||
If this function exists, you will now receive all page requests for "http://my.web.site/plugin_name" - with any number of URL components as additional arguments.
|
||||
If this function exists, you will now receive all page requests for "http://my.web.site/addon_name" - with any number of URL components as additional arguments.
|
||||
These are parsed into an array $a->argv, with a corresponding $a->argc indicating the number of URL components.
|
||||
So http://my.web.site/plugin/arg1/arg2 would look for a module named "plugin" and pass its module functions the $a App structure (which is available to many components).
|
||||
So http://my.web.site/addon/arg1/arg2 would look for a module named "addon" and pass its module functions the $a App structure (which is available to many components).
|
||||
This will include:
|
||||
|
||||
$a->argc = 3
|
||||
$a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2');
|
||||
$a->argv = array(0 => 'addon', 1 => 'arg1', 2 => 'arg2');
|
||||
|
||||
Your module functions will often contain the function plugin_name_content(App $a), which defines and returns the page body content.
|
||||
They may also contain plugin_name_post(App $a) which is called before the _content function and typically handles the results of POST forms.
|
||||
You may also have plugin_name_init(App $a) which is called very early on and often does module initialisation.
|
||||
Your module functions will often contain the function addon_name_content(App $a), which defines and returns the page body content.
|
||||
They may also contain addon_name_post(App $a) which is called before the _content function and typically handles the results of POST forms.
|
||||
You may also have addon_name_init(App $a) which is called very early on and often does module initialisation.
|
||||
|
||||
Templates
|
||||
---
|
||||
|
||||
If your plugin needs some template, you can use the Friendica template system.
|
||||
If your addon needs some template, you can use the Friendica template system.
|
||||
Friendica uses [smarty3](http://www.smarty.net/) as a template engine.
|
||||
|
||||
Put your tpl files in the *templates/* subfolder of your plugin.
|
||||
Put your tpl files in the *templates/* subfolder of your addon.
|
||||
|
||||
In your code, like in the function plugin_name_content(), load the template file and execute it passing needed values:
|
||||
In your code, like in the function addon_name_content(), load the template file and execute it passing needed values:
|
||||
|
||||
# load template file. first argument is the template name,
|
||||
# second is the plugin path relative to friendica top folder
|
||||
$tpl = get_markup_template('mytemplate.tpl', 'addon/plugin_name/');
|
||||
# second is the addon path relative to friendica top folder
|
||||
$tpl = get_markup_template('mytemplate.tpl', 'addon/addon_name/');
|
||||
|
||||
# apply template. first argument is the loaded template,
|
||||
# second an array of 'name'=>'values' to pass to template
|
||||
$output = replace_macros($tpl,array(
|
||||
'title' => 'My beautiful plugin',
|
||||
'title' => 'My beautiful addon',
|
||||
));
|
||||
|
||||
See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
|
||||
|
|
@ -151,11 +151,11 @@ $b is an array:
|
|||
* called when the Settings pages are submitted
|
||||
* $b is the $_POST array
|
||||
|
||||
### 'plugin_settings'
|
||||
### 'addon_settings'
|
||||
* called when generating the HTML for the addon settings page
|
||||
* $b is the (string) HTML of the addon settings page before the final '</form>' tag.
|
||||
|
||||
### 'plugin_settings_post'
|
||||
### 'addon_settings_post'
|
||||
* called when the Addon Settings pages are submitted
|
||||
* $b is the $_POST array
|
||||
|
||||
|
|
@ -394,10 +394,6 @@ include/conversation.php: Addon::callHooks('jot_tool', $jotplugins);
|
|||
|
||||
include/conversation.php: Addon::callHooks('jot_networks', $jotnets);
|
||||
|
||||
include/plugin.php:if(! function_exists('call_hooks')) {
|
||||
|
||||
include/plugin.php:function Addon::callHooks($name, &$data = null) {
|
||||
|
||||
index.php: Addon::callHooks('init_1');
|
||||
|
||||
index.php:Addon::callHooks('app_menu', $arr);
|
||||
|
|
@ -434,13 +430,13 @@ mod/contacts.php: Addon::callHooks('contact_edit_post', $_POST);
|
|||
|
||||
mod/contacts.php: Addon::callHooks('contact_edit', $arr);
|
||||
|
||||
mod/settings.php: Addon::callHooks('plugin_settings_post', $_POST);
|
||||
mod/settings.php: Addon::callHooks('addon_settings_post', $_POST);
|
||||
|
||||
mod/settings.php: Addon::callHooks('connector_settings_post', $_POST);
|
||||
|
||||
mod/settings.php: Addon::callHooks('settings_post', $_POST);
|
||||
|
||||
mod/settings.php: Addon::callHooks('plugin_settings', $settings_addons);
|
||||
mod/settings.php: Addon::callHooks('addon_settings', $settings_addons);
|
||||
|
||||
mod/settings.php: Addon::callHooks('connector_settings', $settings_connectors);
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ These worker tasks are prioritised and are done accordingly.
|
|||
|
||||
Then you get an overview of the accounts on your node, which can be moderated in the "Users" section of the panel.
|
||||
As well as an overview of the currently active addons
|
||||
The list is linked, so you can have quick access to the plugin settings.
|
||||
The list is linked, so you can have quick access to the Addon settings.
|
||||
And finally you are informed about the version of Friendica you have installed.
|
||||
If you contact the devs with a bug or problem, please also mention the version of your node.
|
||||
|
||||
|
|
@ -205,7 +205,7 @@ Here the admin can also block/unblock users from accessing the node or delete th
|
|||
In the last section of the page admins can create new accounts on the node.
|
||||
The password for the new account will be send by email to the choosen email address.
|
||||
|
||||
## Plugins
|
||||
## Addons
|
||||
|
||||
This page is for selecting and configuration of extensions for Friendica which have to be placed into the `/addon` subdirectory of your Friendica installation.
|
||||
You are presented with a long list of available addons.
|
||||
|
|
@ -213,11 +213,11 @@ The name of each addon is linked to a separate page for that addon which offers
|
|||
Also shown is the version of the addon and an indicator if the addon is currently active or not.
|
||||
|
||||
When you update your node and the addons they may have to be reloaded.
|
||||
To simplify this process there is a button at the top of the page to reload all active plugins.
|
||||
To simplify this process there is a button at the top of the page to reload all active Addons.
|
||||
|
||||
## Themes
|
||||
|
||||
The Themes section of the admin panel works similar to the Plugins section but let you control the themes on your Friendica node.
|
||||
The Themes section of the admin panel works similar to the Addons section but let you control the themes on your Friendica node.
|
||||
Each theme has a dedicated subpage showing the current status, some information about the theme and a screen-shot of the Friendica interface using the theme.
|
||||
Should the theme offer special settings, admins can set a global default value here.
|
||||
|
||||
|
|
@ -266,7 +266,7 @@ To do so, they need to know the GUID of the posting.
|
|||
This can be found on the `/display` page of the posting, it is the last part of the URL displayed in the browsers navigation bar.
|
||||
You can get to the `/display` page by following the *Link to source*.
|
||||
|
||||
## Plugin Features
|
||||
## Addon Features
|
||||
|
||||
Some of the addons you can install for your Friendica node have settings which have to be set by the admin.
|
||||
All those addons will be listed in this area of the admin panels side bar with their names.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Database Tables
|
|||
|
||||
| Table | Description |
|
||||
|------------------------------------------------------|--------------------------------------------------|
|
||||
| [addon](help/database/db_addon) | registered plugins |
|
||||
| [addon](help/database/db_addon) | registered addons |
|
||||
| [attach](help/database/db_attach) | file attachments |
|
||||
| [auth_codes](help/database/db_auth_codes) | OAuth usage |
|
||||
| [cache](help/database/db_cache) | OEmbed cache |
|
||||
|
|
@ -24,7 +24,7 @@ Database Tables
|
|||
| [group](help/database/db_group) | privacy groups, group info |
|
||||
| [group_member](help/database/db_group_member) | privacy groups, member info |
|
||||
| [gserver](help/database/db_gserver) | |
|
||||
| [hook](help/database/db_hook) | plugin hook registry |
|
||||
| [hook](help/database/db_hook) | addon hook registry |
|
||||
| [intro](help/database/db_intro) | |
|
||||
| [item](help/database/db_item) | all posts |
|
||||
| [locks](help/database/db_locks) | |
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Table addon
|
|||
| Field | Description | Type | Null | Key | Default | Extra |
|
||||
| ------------- | --------------------------------------------- | ---------- | ---- | --- | ------- | --------------- |
|
||||
| id | | int(11) | NO | PRI | NULL | auto_increment |
|
||||
| name | plugin base (file)name | char(255) | NO | | | |
|
||||
| name | addon base (file)name | char(255) | NO | | | |
|
||||
| version | currently unused | char(255) | NO | | | |
|
||||
| installed | currently always 1 | tinyint(1) | NO | | 0 | |
|
||||
| hidden | currently unused | tinyint(1) | NO | | 0 | |
|
||||
|
|
@ -12,6 +12,6 @@ Table addon
|
|||
| plugin_admin | 1 = has admin config, 0 = has no admin config | tinyint(1) | NO | | 0 | |
|
||||
|
||||
Notes:
|
||||
These are addons which have been enabled by the site administrator on the admin/plugin page
|
||||
These are addons which have been enabled by the site administrator on the admin/addon page
|
||||
|
||||
Return to [database documentation](help/database)
|
||||
|
|
|
|||
|
|
@ -8,9 +8,9 @@ Du hast derzeit zwei Möglichkeiten, einen Chat auf Deiner Friendica-Seite zu be
|
|||
* IRC - Internet Relay Chat
|
||||
* Jappix
|
||||
|
||||
##IRC Plugin
|
||||
##IRC Addon
|
||||
|
||||
Sobald das Plugin aktiviert ist, kannst Du den Chat unter [deineSeite.de/irc](../irc) finden.
|
||||
Sobald das Addon aktiviert ist, kannst Du den Chat unter [deineSeite.de/irc](../irc) finden.
|
||||
Beachte aber, dass dieser Chat auch ohne Anmeldung auf Deiner Seite zugänglich ist und somit auch Fremde diesen Chat mitnutzen können.
|
||||
|
||||
Wenn Du dem Link folgst, dann kommst Du zum Anmeldefenster des IR-Chats.
|
||||
|
|
@ -29,7 +29,7 @@ Weiter Informationen zu IRC findest Du zum Beispiel auf <a href="http://wiki.ubu
|
|||
|
||||
##Jappix Mini
|
||||
|
||||
Das Jappix Mini Plugin erlaubt das Erstellen einer Chatbox für Jabber/XMPP-Kontakte.
|
||||
Das Jappix Mini Addon erlaubt das Erstellen einer Chatbox für Jabber/XMPP-Kontakte.
|
||||
Ein Jabber/XMPP Account sollte vor der Installation bereits vorhanden sein.
|
||||
Die ausführliche Anleitung dazu und eine Kontrolle, ob Du nicht sogar schon über Deinen E-Mail Anbieter einen Jabber-Account hast, findest Du unter <a href="http://einfachjabber.de" target="_blank">einfachjabber.de</a>.
|
||||
|
||||
|
|
@ -53,15 +53,15 @@ oder als normaler Download von hier: https://github.com/friendica/friendica-addo
|
|||
|
||||
Entpacke diese Datei (ggf. den entpackten Ordner in „jappixmini“ umbenennen) und lade sowohl den entpackten Ordner komplett als auch die .tgz Datei in den Addon Ordner Deiner Friendica Installation hoch.
|
||||
|
||||
Nach dem Upload gehts in den Friendica Adminbereich und dort zu den Plugins.
|
||||
Aktiviere das Jappixmini Addon und gehe anschließend über die Plugins Seitenleiste (dort wo auch die Twitter-, Impressums-, GNU Social-, usw. Einstellungen gemacht werden) zu den Jappix Grundeinstellungen.
|
||||
Nach dem Upload gehts in den Friendica Adminbereich und dort zu den Addons.
|
||||
Aktiviere das Jappixmini Addon und gehe anschließend über die Addons Seitenleiste (dort wo auch die Twitter-, Impressums-, GNU Social-, usw. Einstellungen gemacht werden) zu den Jappix Grundeinstellungen.
|
||||
|
||||
Setze hier den Haken zur Aktivierung des BOSH Proxys.
|
||||
Weiter gehts in den Einstellungen Deines Friendica Accounts.
|
||||
|
||||
2. Einstellungen
|
||||
|
||||
Gehe bitte zu den Plugin-Einstellungen in Deinen Konto-Einstellungen (Account Settings).
|
||||
Gehe bitte zu den Addon-Einstellungen in Deinen Konto-Einstellungen (Account Settings).
|
||||
Scrolle ein Stück hinunter bis zu den Jappix Mini Addon settings.
|
||||
|
||||
Aktiviere hier zuerst das Addon.
|
||||
|
|
|
|||
|
|
@ -104,7 +104,7 @@ Ignorierte Kontakte können weiterhin Beiträge und private Nachrichten von Dir
|
|||
Deren Beiträge und private Nachrichten werden allerdings nicht importiert.
|
||||
Wie bei blockierten Beiträgen siehst Du auch hier weiterhin die Kommentare dieser Person zu anderen Beiträgen Deiner Freunde.
|
||||
|
||||
[Ein Plugin namens "blockem" kann installiert werden, um alle Beiträge einer bestimmten Person in Deinem Stream zu verstecken bzw. zu verkürzen.
|
||||
[Ein Erweiterung namens "blockem" kann installiert werden, um alle Beiträge einer bestimmten Person in Deinem Stream zu verstecken bzw. zu verkürzen.
|
||||
Dabei werden auch Kommentare dieser Person in Beiträgen Deiner Freunde blockiert.]
|
||||
|
||||
Ein archivierter Kontakt bedeutet, dass Kommunikation nicht möglich ist und auch nicht versucht wird (das ist z.B. sinnvoll, wenn eine Person zu einem neuen Server gewechselt ist und das alte Profil gelöscht hat).
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ Friendica - Dokumentation und Ressourcen
|
|||
* [Installation](help/Install)
|
||||
* [Update](help/Update) (EN)
|
||||
* [Konfigurationen & Admin-Panel](help/Settings)
|
||||
* [Plugins](help/Plugins)
|
||||
* [Addons](help/Addons)
|
||||
* [Konnektoren (Connectors) installieren (Twitter/GNU Social)](help/Installing-Connectors)
|
||||
* [Installation eines ejabberd Servers (XMPP-Chat) mit synchronisierten Anmeldedaten](help/install-ejabberd) (EN)
|
||||
* [Betreibe deine Seite mit einem SSL-Zertifikat](help/SSL)
|
||||
|
|
@ -45,7 +45,7 @@ Friendica - Dokumentation und Ressourcen
|
|||
* [Help on Vagrant](help/Vagrant)
|
||||
* [How to translate Friendica](help/translations) (EN)
|
||||
* [Bugs and Issues](help/Bugs-and-Issues)
|
||||
* [Plugin Development](help/Plugins)
|
||||
* [Addon Development](help/Addons)
|
||||
* [Theme Development](help/themes)
|
||||
* [Smarty 3 Templates](help/smarty3-templates)
|
||||
* [Protokoll Dokumentation](help/Protocol) (EN)
|
||||
|
|
|
|||
|
|
@ -28,10 +28,10 @@ Der Nachteil: Du siehst nicht jede Antwort einer OStatus-Unterhaltung. Aus diese
|
|||
|
||||
Wenn du MyISAM (Standardeinstellung) oder InnoDB mit MariaDB 10 nutzt, dann beschleunigt dies die Suche.
|
||||
|
||||
Plugins
|
||||
Addons
|
||||
--------
|
||||
|
||||
Aktiviere die folgenden Plugins:
|
||||
Aktiviere die folgenden Addons:
|
||||
|
||||
rendertime
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ Aktiviere die folgenden Plugins:
|
|||
|
||||
**Beschreibung**
|
||||
|
||||
Dieses Plugin beschleunigt dein System nicht, aber es hilft dabei, die Flaschenhälse zu ermitteln.
|
||||
Dieses Addon beschleunigt dein System nicht, aber es hilft dabei, die Flaschenhälse zu ermitteln.
|
||||
|
||||
Wenn es aktiviert ist, dann siehst du Werte wie die folgenden auf jeder deiner Seiten:
|
||||
|
||||
|
|
|
|||
|
|
@ -3,29 +3,29 @@ Konnektoren installieren (Twitter/GNU Social)
|
|||
|
||||
* [Zur Startseite der Hilfe](help)
|
||||
|
||||
Friendica nutzt Plugins, um die Verbindung zu anderen Netzwerken wie Twitter oder App.net zu gewährleisten.
|
||||
Friendica nutzt Erweiterung, um die Verbindung zu anderen Netzwerken wie Twitter oder App.net zu gewährleisten.
|
||||
|
||||
Es gibt außerdem ein Plugin, um über einen bestehenden GNU Social-Account diesen Service zu nutzen.
|
||||
Du brauchst dieses Plugin aber nicht, um mit GNU Social-Mitgliedern von Friendica aus zu kommunizieren - es sei denn, du wünschst es, über einen existierenden Account einen Beitrag zu schreiben.
|
||||
Es gibt außerdem ein Erweiterung, um über einen bestehenden GNU Social-Account diesen Service zu nutzen.
|
||||
Du brauchst dieses Erweiterung aber nicht, um mit GNU Social-Mitgliedern von Friendica aus zu kommunizieren - es sei denn, du wünschst es, über einen existierenden Account einen Beitrag zu schreiben.
|
||||
|
||||
Alle drei Plugins benötigen einen Account im gewünschten Netzwerk.
|
||||
Alle drei Erweiterung benötigen einen Account im gewünschten Netzwerk.
|
||||
Zusätzlich musst du (bzw. der Administrator der Seite) einen API-Schlüssel holen, um einen authentifizierten Zugriff zu deinem Friendica-Server herstellen zu lassen.
|
||||
|
||||
|
||||
**Seitenkonfiguration**
|
||||
|
||||
Plugins müssen vom Administrator installiert werden, bevor sie genutzt werden können.
|
||||
Erweiterung müssen vom Administrator installiert werden, bevor sie genutzt werden können.
|
||||
Dieses kann über das Administrationsmenü erstellt werden.
|
||||
|
||||
Jeder der Konnektoren benötigt zudem einen API-Schlüssel vom Service, der verbunden werden soll.
|
||||
Einige Plugins erlaube es, diese Informationen auf den Administrationsseiten einzustellen, wohingegen andere eine direkte Bearbeitung der Konfigurationsdatei ".htconfig.php" erfordern.
|
||||
Einige Erweiterung erlaube es, diese Informationen auf den Administrationsseiten einzustellen, wohingegen andere eine direkte Bearbeitung der Konfigurationsdatei ".htconfig.php" erfordern.
|
||||
Der Weg, um diese Schlüssel zu erhalten, variiert stark, jedoch brauchen fast alle einen bestehenden Account im gewünschten Service.
|
||||
Einmal installiert, können diese Schlüssel von allen Seitennutzern genutzt werden.
|
||||
|
||||
Im Folgenden findest du die Einstellungen für die verschiedenen Services (viele dieser Informationen kommen direkt aus den Quelldateien der Plugins):
|
||||
Im Folgenden findest du die Einstellungen für die verschiedenen Services (viele dieser Informationen kommen direkt aus den Quelldateien der Erweiterung):
|
||||
|
||||
|
||||
**Twitter Plugin für Friendica**
|
||||
**Twitter Erweiterung für Friendica**
|
||||
|
||||
* Author: Tobias Diekershoff
|
||||
* tobias.diekershoff@gmx.net
|
||||
|
|
@ -33,7 +33,7 @@ Im Folgenden findest du die Einstellungen für die verschiedenen Services (viele
|
|||
* License:3-clause BSD license
|
||||
|
||||
Konfiguration:
|
||||
Um dieses Plugin zu nutzen, benötigst du einen OAuth Consumer-Schlüsselpaar (Schlüssel und Geheimnis), das du auf der Seite [https://twitter.com/apps](https://twitter.com/apps) erhalten kannst
|
||||
Um dieses Erweiterung zu nutzen, benötigst du einen OAuth Consumer-Schlüsselpaar (Schlüssel und Geheimnis), das du auf der Seite [https://twitter.com/apps](https://twitter.com/apps) erhalten kannst
|
||||
|
||||
Registriere deine Friendica-Seite als "Client"-Anwendung mit "Read&Write"-Zugriff. Wir benötigen "Twitter als Login" nicht. Sobald du deine Anwendung installiert hast, erhältst du das Schlüsselpaar für deine Seite.
|
||||
|
||||
|
|
@ -47,7 +47,7 @@ $a->config['twitter']['consumersecret'] = 'your consumer_secret here';
|
|||
Anschließend kann der Nutzer deiner Seite die Twitter-Einstellungen selbst eintragen: "Einstellungen -> Connector Einstellungen".
|
||||
|
||||
|
||||
**GNU Social Plugin für Friendica**
|
||||
**GNU Social Erweiterung für Friendica**
|
||||
|
||||
* Author: Tobias Diekershoff
|
||||
* tobias.diekershoff@gmx.net
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Friendica Addon/Plugin-Entwicklung
|
||||
Friendica Addon/Entwicklung
|
||||
==============
|
||||
|
||||
* [Zur Startseite der Hilfe](help)
|
||||
|
|
@ -8,30 +8,30 @@ Das Facebook-Addon bietet ein Beispiel dafür, die "addon"- und "module"-Funktio
|
|||
Addons arbeiten, indem sie Event Hooks abfangen.
|
||||
Module arbeiten, indem bestimmte Seitenanfragen (durch den URL-Pfad) abgefangen werden.
|
||||
|
||||
Plugin-Namen können keine Leerstellen oder andere Interpunktionen enthalten und werden als Datei- und Funktionsnamen genutzt.
|
||||
Addon-Namen können keine Leerstellen oder andere Interpunktionen enthalten und werden als Datei- und Funktionsnamen genutzt.
|
||||
Du kannst einen lesbaren Namen im Kommentarblock eintragen.
|
||||
Jedes Addon muss beides beinhalten - eine Installations- und eine Deinstallationsfunktion, die auf dem Addon-/Plugin-Namen basieren; z.B. "plugin1name_install()".
|
||||
Diese beiden Funktionen haben keine Argumente und sind dafür verantwortlich, Event Hooks zu registrieren und abzumelden (unregistering), die dein Plugin benötigt.
|
||||
Die Installations- und Deinstallationsfunktionfunktionen werden auch ausgeführt (z.B. neu installiert), wenn sich das Plugin nach der Installation ändert - somit sollte deine Deinstallationsfunktion keine Daten zerstört und deine Installationsfunktion sollte bestehende Daten berücksichtigen.
|
||||
Jedes Addon muss beides beinhalten - eine Installations- und eine Deinstallationsfunktion, die auf dem Addon-Namen basieren; z.B. "addon1name_install()".
|
||||
Diese beiden Funktionen haben keine Argumente und sind dafür verantwortlich, Event Hooks zu registrieren und abzumelden (unregistering), die dein Addon benötigt.
|
||||
Die Installations- und Deinstallationsfunktionfunktionen werden auch ausgeführt (z.B. neu installiert), wenn sich das Addon nach der Installation ändert - somit sollte deine Deinstallationsfunktion keine Daten zerstört und deine Installationsfunktion sollte bestehende Daten berücksichtigen.
|
||||
Zukünftige Extensions werden möglicherweise "Setup" und "Entfernen" anbieten.
|
||||
|
||||
Plugins sollten einen Kommentarblock mit den folgenden vier Parametern enthalten:
|
||||
Addons sollten einen Kommentarblock mit den folgenden vier Parametern enthalten:
|
||||
|
||||
/*
|
||||
* Name: My Great Plugin
|
||||
* Description: This is what my plugin does. It's really cool.
|
||||
* Name: My Great Addon
|
||||
* Description: This is what my addon does. It's really cool.
|
||||
* Version: 1.0
|
||||
* Author: John Q. Public <john@myfriendicasite.com>
|
||||
*/
|
||||
|
||||
Registriere deine Plugin-Hooks während der Installation.
|
||||
Registriere deine Addon-Hooks während der Installation.
|
||||
|
||||
Addon::registerHook($hookname, $file, $function);
|
||||
|
||||
$hookname ist ein String und entspricht einem bekannten Friendica-Hook.
|
||||
|
||||
$file steht für den Pfadnamen, der relativ zum Top-Level-Friendicaverzeichnis liegt.
|
||||
Das *sollte* "addon/plugin_name/plugin_name.php' sein.
|
||||
Das *sollte* "addon/addon_name/addon_name.php' sein.
|
||||
|
||||
$function ist ein String und der Name der Funktion, die ausgeführt wird, wenn der Hook aufgerufen wird.
|
||||
|
||||
|
|
@ -57,19 +57,19 @@ Achte darauf, diese mit "&" zu deklarieren, wenn du sie bearbeiten willst.
|
|||
Module
|
||||
---
|
||||
|
||||
Plugins/Addons können auch als "Module" agieren und alle Seitenanfragen für eine bestimte URL abfangen.
|
||||
Um ein Plugin als Modul zu nutzen, ist es nötig, die Funktion "plugin_name_module()" zu definieren, die keine Argumente benötigt und nichts weiter machen muss.
|
||||
Addons können auch als "Module" agieren und alle Seitenanfragen für eine bestimte URL abfangen.
|
||||
Um ein Addon als Modul zu nutzen, ist es nötig, die Funktion "addon_name_module()" zu definieren, die keine Argumente benötigt und nichts weiter machen muss.
|
||||
|
||||
Wenn diese Funktion existiert, wirst du nun alle Seitenanfragen für "http://example.com/plugin_name" erhalten - mit allen URL-Komponenten als zusätzliche Argumente.
|
||||
Wenn diese Funktion existiert, wirst du nun alle Seitenanfragen für "http://example.com/addon_name" erhalten - mit allen URL-Komponenten als zusätzliche Argumente.
|
||||
Diese werden in ein Array $a->argv geparst und stimmen mit $a->argc überein, wobei sie die Anzahl der URL-Komponenten abbilden.
|
||||
So würde http://example.com/plugin/arg1/arg2 nach einem Modul "plugin" suchen und seiner Modulfunktion die $a-App-Strukur übergeben (dies ist für viele Komponenten verfügbar). Das umfasst:
|
||||
So würde http://example.com/addon/arg1/arg2 nach einem Modul "addon" suchen und seiner Modulfunktion die $a-App-Strukur übergeben (dies ist für viele Komponenten verfügbar). Das umfasst:
|
||||
|
||||
$a->argc = 3
|
||||
$a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2');
|
||||
$a->argv = array(0 => 'addon', 1 => 'arg1', 2 => 'arg2');
|
||||
|
||||
Deine Modulfunktionen umfassen oft die Funktion plugin_name_content(App $a), welche den Seiteninhalt definiert und zurückgibt.
|
||||
Sie können auch plugin_name_post(App $a) umfassen, welches vor der content-Funktion aufgerufen wird und normalerweise die Resultate der POST-Formulare handhabt.
|
||||
Du kannst ebenso plugin_name_init(App $a) nutzen, was oft frühzeitig aufgerufen wird und das Modul initialisert.
|
||||
Deine Modulfunktionen umfassen oft die Funktion addon_name_content(App $a), welche den Seiteninhalt definiert und zurückgibt.
|
||||
Sie können auch addon_name_post(App $a) umfassen, welches vor der content-Funktion aufgerufen wird und normalerweise die Resultate der POST-Formulare handhabt.
|
||||
Du kannst ebenso addon_name_init(App $a) nutzen, was oft frühzeitig aufgerufen wird und das Modul initialisert.
|
||||
|
||||
|
||||
Derzeitige Hooks
|
||||
|
|
@ -109,10 +109,10 @@ Derzeitige Hooks
|
|||
**'settings_post'** - wird aufgerufen, wenn die Einstellungsseiten geladen werden.
|
||||
$b ist der $_POST-Array
|
||||
|
||||
**'plugin_settings'** - wird aufgerufen, wenn die HTML-Ausgabe der Addon-Einstellungsseite generiert wird.
|
||||
**'addon_settings'** - wird aufgerufen, wenn die HTML-Ausgabe der Addon-Einstellungsseite generiert wird.
|
||||
$b ist die HTML-Ausgabe (String) der Addon-Einstellungsseite vor dem finalen "</form>"-Tag.
|
||||
|
||||
**'plugin_settings_post'** - wird aufgerufen, wenn die Addon-Einstellungsseite geladen wird.
|
||||
**'addon_settings_post'** - wird aufgerufen, wenn die Addon-Einstellungsseite geladen wird.
|
||||
$b ist der $_POST-Array
|
||||
|
||||
**'profile_post'** - wird aufgerufen, wenn die Profilseite angezeigt wird.
|
||||
|
|
@ -287,10 +287,6 @@ include/conversation.php: Addon::callHooks('jot_tool', $jotplugins);
|
|||
|
||||
include/conversation.php: Addon::callHooks('jot_networks', $jotnets);
|
||||
|
||||
include/plugin.php: if(! function_exists('call_hooks')) {
|
||||
|
||||
include/plugin.php:function Addon::callHooks($name, &$data = null) {
|
||||
|
||||
index.php: Addon::callHooks('init_1');
|
||||
|
||||
index.php: Addon::callHooks('app_menu', $arr);
|
||||
|
|
@ -327,13 +323,13 @@ mod/contacts.php: Addon::callHooks('contact_edit_post', $_POST);
|
|||
|
||||
mod/contacts.php: Addon::callHooks('contact_edit', $arr);
|
||||
|
||||
mod/settings.php: Addon::callHooks('plugin_settings_post', $_POST);
|
||||
mod/settings.php: Addon::callHooks('addon_settings_post', $_POST);
|
||||
|
||||
mod/settings.php: Addon::callHooks('connector_settings_post', $_POST);
|
||||
|
||||
mod/settings.php: Addon::callHooks('settings_post', $_POST);
|
||||
|
||||
mod/settings.php: Addon::callHooks('plugin_settings', $settings_addons);
|
||||
mod/settings.php: Addon::callHooks('addon_settings', $settings_addons);
|
||||
|
||||
mod/settings.php: Addon::callHooks('connector_settings', $settings_connectors);
|
||||
|
||||
|
|
|
|||
|
|
@ -195,7 +195,7 @@ An dieser Stelle kannst du existierende Accounts vom Zugriff auf die Instanz blo
|
|||
Im letzten Bereich auf der Seite kannst du als Administrator neue Accounts anlegen.
|
||||
Das Passwort für so eingerichtete Accounts werden per E-Mail an die Nutzer geschickt.
|
||||
|
||||
## Plugins
|
||||
## Addons
|
||||
|
||||
Dieser Bereich des Admin Panels dient der Auswahl und Konfiguration der Erweiterungen von Friendica.
|
||||
Sie müssen in das `/addon` Verzeichnis kopiert werden.
|
||||
|
|
@ -203,11 +203,11 @@ Auf der Seite wird eine Liste der verfügbaren Erweiterungen angezeigt.
|
|||
Neben den Namen der Erweiterungen wird ein Indikator angezeigt, der anzeigt ob das Addon gerade aktiviert ist oder nicht.
|
||||
|
||||
Wenn du die Erweiterungen aktualisiert die du auf deiner Friendica-Instanz nutzt könnte es sein, dass sie neu geladen werden müssen, damit die Änderungen aktiviert werden.
|
||||
Um diesen Prozess zu vereinfachen gibt es am Anfang der Seite einen Button um alle aktiven Plugins neu zu laden.
|
||||
Um diesen Prozess zu vereinfachen gibt es am Anfang der Seite einen Button um alle aktiven Addons neu zu laden.
|
||||
|
||||
## Themen
|
||||
|
||||
Der Bereich zur Kontrolle der auf der Friendica-Instanz verfügbaren Themen funktioniert analog zum Plugins Bereich.
|
||||
Der Bereich zur Kontrolle der auf der Friendica-Instanz verfügbaren Themen funktioniert analog zum Addons Bereich.
|
||||
Jedes Theme hat eine extra Seite auf der der aktuelle Status, ein Bildschirmfoto des Themes, zusätzliche Informationen und eventuelle Einstellungen des Themes zu finden sind.
|
||||
Genau wie Erweiterungen können Themes in der Übersichtsliste oder der Theme-Seite aktiviert bzw. deaktiviert werden.
|
||||
Um ein Standardtheme für die Instanz zu wählen, benutze bitte die *Seiten* Bereich des Admin Panels.
|
||||
|
|
@ -256,7 +256,7 @@ Dazu muss man nur die GUID des Beitrags kennen.
|
|||
Diese kann u.a. in der Adresse der `/display`-Seite gefunden werden, wenn man dem *Link zum Originalbeitrag* folgt.
|
||||
Hier ist die GUID der letzte Teil der URL in der Adresszeile des Browsers.
|
||||
|
||||
## Plugin Features
|
||||
## Addon Features
|
||||
|
||||
Einige der Erweiterungen von Friendica benötigen global gültige Einstellungen, die der Administrator vornehmen muss.
|
||||
Diese Erweiterungen sind hier aufgelistet, damit du die Einstellungen schneller findest.
|
||||
|
|
|
|||
Loading…
Reference in a new issue