mirror of
https://git.friendi.ca/friendica/friendica.git
synced 2025-06-17 04:45:16 +02:00
Update docs
changelog, install and doc folder
This commit is contained in:
Adam Magness
parent
b86b04a81a
commit
20a16b0b35
21 changed files with 119 additions and 127 deletions
|
|
@ -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…
Add table
Add a link
Reference in a new issue