From 36e4aea7ef50144d3ef496b9dba0390ec5a8929a Mon Sep 17 00:00:00 2001 From: rabuzarus <> Date: Mon, 28 Nov 2016 17:55:56 +0100 Subject: [PATCH] docs: add documentation about used protocols --- doc/Home.md | 6 +++--- doc/Protocol.md | 39 +++++++++++++++++++++++++++++++++++++++ doc/de/Home.md | 2 +- 3 files changed, 43 insertions(+), 4 deletions(-) create mode 100644 doc/Protocol.md diff --git a/doc/Home.md b/doc/Home.md index 32eb1ee999..437486e028 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -7,11 +7,11 @@ Friendica Documentation and Resources * [Account Basics](help/Account-Basics) * [New User Quick Start](help/Quick-Start-guide) * [Creating posts](help/Text_editor) - * [BBCode tag reference](help/BBCode) + * [BBCode tag reference](help/BBCode) * [Comment, sort and delete posts](help/Text_comment) * [Profiles](help/Profiles) * [Accesskey reference](help/Accesskeys) - * [Events](help/events) + * [Events](help/events) * You and other users * [Connectors](help/Connectors) * [Making Friends](help/Making-Friends) @@ -44,7 +44,7 @@ Friendica Documentation and Resources * [Plugin Development](help/Plugins) * [Theme Development](help/themes) * [Smarty 3 Templates](help/smarty3-templates) -* [Message Flow](help/Message-Flow) +* [Protocol Documentation](help/Protocol) * [Database schema documantation](help/database) * [Class Autoloading](help/autoloader) * [Code - Reference(Doxygen generated - sets cookies)](doc/html/) diff --git a/doc/Protocol.md b/doc/Protocol.md new file mode 100644 index 0000000000..92b24ed275 --- /dev/null +++ b/doc/Protocol.md @@ -0,0 +1,39 @@ +Used Protocols +=============== + +Friendicas DFRN Protocol +--- + +* [Document with the DFRN specification](spec/dfrn2.pdf) +* [Schema of the contact request process](spec/dfrn2_contact_request.png) +* [Schema of the contact request confirmation](spec/dfrn2_contact_confirmation.png) +* [Description of the message flow](help/Message-Flow) + +ActivityStreams +--- + +Friendica is using ActivityStreams in version 1.0 for its activities and object types. Additional types are using for non standard activities. + +* [Link to the specification](http://activitystrea.ms/head/activity-schema.html) +* [List of used ActivityStreams verbs and object types.](https://github.com/friendica/friendica/wiki/ActivityStreams) + +Salmon +--- + +Salmon is used as a message exchange protocol for replies and mentions. + +* [Link to the protocol summary](http://www.salmon-protocol.org/salmon-protocol-summary) + +Portable Contacts +--- + +Portable Contacts is used for friends lists. + +* [Link to the specification](https://web.archive.org/web/20160426223008/http://portablecontacts.net/draft-spec.html) (Link to archive.org) + +pubsubhubbub +--- + +pubsubhubbub is used for OStatus. + +* [Link to the specification](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html) diff --git a/doc/de/Home.md b/doc/de/Home.md index 91ec97c4cc..6023e3cdc4 100644 --- a/doc/de/Home.md +++ b/doc/de/Home.md @@ -47,7 +47,7 @@ Friendica - Dokumentation und Ressourcen * [Plugin Development](help/Plugins) * [Theme Development](help/themes) * [Smarty 3 Templates](help/smarty3-templates) -* [Nachrichtenfluss](help/Message-Flow) +* [Protokoll Dokumentation](help/Protocol) (EN) * [Datenbank-Schema](help/database) * [Code-Referenz (mit doxygen generiert - setzt Cookies)](doc/html/) * [Twitter/GNU Social API Functions](help/api) (EN)