mirror of https://github.com/friendica/friendica
Merge pull request #1524 from silke/documentation
More updated and reformatted documentation files
This commit is contained in:
commit
32cb1eb9f1
|
|
@ -3,71 +3,96 @@ Account Basics
|
|||
|
||||
* [Home](help)
|
||||
|
||||
Registration
|
||||
---
|
||||
|
||||
**Registration**
|
||||
Not all Friendica sites allow open registration.
|
||||
If registration is allowed, you will see a "Register" link immediately below the login prompt on the site home page.
|
||||
Following this link will take you to the site registration page.
|
||||
The strength of our network is that lots of different sites are all completely compatible with each other.
|
||||
If the site you're visting doesn't allow registration, or you think you might prefer another one, you can find a [list of public servers here](http://dir.friendica.com/siteinfo), and find one that meets your needs.
|
||||
|
||||
Not all Friendica sites allow open registration. If registration is allowed, you will see a "Register" link immediately below the login prompts on the site home page. Following this link will take you to the site registration page. The strength of our network is that lots of different sites are all completely compatible with each other. If the site you're visting doesn't allow registration, or you think you might prefer another one, you can find a <a href="http://dir.friendica.com/siteinfo">list of public servers here</a>, and find one that meets your needs.
|
||||
If you'd like to have your own server, you can do that too.
|
||||
Visit [the Friendica website](http://friendica.com/download) to download the code with setup instructions.
|
||||
It's a very simple installation process that anybody experienced in hosting websites, or with basic Linux experience can handle easily.
|
||||
|
||||
If you'd like to have your own server, you can do that too. Visit <a href="http://friendica.com/download">the Friendica website</a> to download the code with setup instructions. It's a very simple install process that anybody experienced in hosting websites, or with basic Linux experience can handle easily.
|
||||
###OpenID
|
||||
|
||||
The first field on the Registration page is for an OpenID address.
|
||||
If you do not have an OpenID address or do not wish to use OpenID, leave this field blank.
|
||||
If you have an OpenID account elsewhere and wish to use it, enter the address into this field and click 'Register'.
|
||||
Friendica will attempt to extract as much information as possible from your OpenID provider and return to this page with those items already filled in.
|
||||
|
||||
###Your Full Name
|
||||
|
||||
Please provide your full name **as you would like it to be displayed on this system**.
|
||||
Most people use their real name for this, but you're under no obligation to do so yourself.
|
||||
|
||||
###Email Address
|
||||
|
||||
Please provide a valid email address.
|
||||
Your email address is **never** published.
|
||||
We need this to send you account information and your login details.
|
||||
You may also occasionally receive notifications of incoming messages or items requiring your attention, but you have the possibility to completely disable these from your Settings page once you have logged in.
|
||||
This doesn't have to be your primary email address, but it does need to be a real email address.
|
||||
You can't get your initial password, or reset a lost password later without it.
|
||||
This is the only bit of personal information that has to be accurate.
|
||||
|
||||
###Nickname
|
||||
|
||||
A nickname is used to generate web addresses for many of your personal pages, and is also treated like an email address when establishing communications with others.
|
||||
Due to the way that the nickname is used, it has some limitations.
|
||||
It must contain only US-ASCII text characters and numbers, and must also start with a text character.
|
||||
It also must be unique on this system.
|
||||
This is used in many places to identify your account, and once set - cannot be changed.
|
||||
|
||||
|
||||
*OpenID*
|
||||
###Directory Publishing
|
||||
|
||||
The first field on the Registration page is for an OpenID address. If you do not have an OpenID address or do not wish to use OpenID, leave this field blank. If you have an OpenID account elsewhere and wish to use it, enter the address into this field and click 'Register'. Friendica will attempt to extract as much information as possible from your OpenID provider and return to this page with those items already filled in.
|
||||
The registration form also allows you to choose whether or not to list your account in the online directory.
|
||||
This is like a "phone book" and you may choose to be unlisted.
|
||||
We recommend that you select 'Yes' so that other people (friends, family, etc.) will be able to find you.
|
||||
If you choose 'No', you will essentially be invisible and have few opportunities for interaction.
|
||||
Whichever you choose, this can be changed any time from your Settings page after you login.
|
||||
|
||||
###Register
|
||||
|
||||
*Your Full Name*
|
||||
Once you have provided the necessary details, click the 'Register' button.
|
||||
An email will be sent to you providing your account login details.
|
||||
Please watch your email (including spam folders) for your registration details and initial password.
|
||||
|
||||
Please provide your full name **as you would like it to be displayed on this system**. Most people use their real name for this, but you're under no obligation to do so yourself.
|
||||
Login Page
|
||||
---
|
||||
|
||||
On the 'Login' page, please enter your login information that was provided during registration.
|
||||
You may use either your nickname or email address as a Login Name.
|
||||
|
||||
*Email Address*
|
||||
If you use your account to manage multiple '[Pages](help/Pages)' and these all have the same email address, please enter the nickname for the account you wish to manage.
|
||||
|
||||
Please provide a valid email address. Your email address is **never** published. We need this to send you account information and your login details. You may also occasionally receive notifications of incoming messages or items requiring your attention, but you have the ability to completely disable these from your Settings page once you have logged in. This doesn't have to be your primary email address, but it does need to be a real email address. You can't get your initial password, or reset a lost password later without it. This is the only bit of personal information that has to be accurate.
|
||||
*If* your account has been OpenID enabled, you may use your OpenID address as a login name and leave the password blank.
|
||||
You will be redirected to your OpenID provider to complete your authorisation.
|
||||
|
||||
Otherwise, enter your password.
|
||||
This will have been initially provided in your registration email message.
|
||||
Your password is case-sensitive, so please check your 'Caps Lock' key if you are having difficulty logging in.
|
||||
|
||||
*Nickname*
|
||||
|
||||
A nickname is used to generate web addresses for many of your personal pages, and is also treated like an email address when establishing communications with others. Due to the way that the nickname is used, it has some limitations. It must contain only US-ASCII text characters and numbers, and must also start with a text character. It also must be unique on this system. This is used in many places to identify your account, and once set - cannot be changed.
|
||||
|
||||
|
||||
*Directory Publishing*
|
||||
|
||||
The Registration form also allows you to choose whether or not to list your account in the online directory. This is like a "phone book" and you may choose to be unlisted. We recommend that you select 'Yes' so that other people (friends, family, etc.) will be able to find you. If you choose 'No', you will essentially be invisible and have few opportunities for interaction. Whichever you choose, this can be changed any time from your Settings page after you login.
|
||||
|
||||
|
||||
*Register*
|
||||
|
||||
Once you have provided the necessary details, click the 'Register' button. An email will be sent to you providing your account login details. Please watch your email (including spam folders) for your registration details and initial password.
|
||||
|
||||
|
||||
**Login Page**
|
||||
|
||||
On the 'Login' page, please enter your login information that was provided during registration. You may use either your nickname or email address as a Login Name.
|
||||
|
||||
If you use your account to manage multiple '[Pages](help/Pages)' and these all have the same email address, please enter the nickname for the account you wish to manage.
|
||||
|
||||
*If* your account has been OpenID enabled, you may use your OpenID address as a login name and leave the password blank. You will be redirected to your OpenID provider to complete your authorisation.
|
||||
|
||||
Otherwise, enter your password. This will have been initially provided in your registration email message. Your password is case-sensitive, so please check your 'Caps Lock' key if you are having difficulty logging in.
|
||||
|
||||
|
||||
**Changing Your Password**
|
||||
Changing Your Password
|
||||
---
|
||||
|
||||
After your first login, please visit the 'Settings' page from the top menu bar and change your password to something that you will remember.
|
||||
|
||||
|
||||
**Getting Started**
|
||||
Getting Started
|
||||
---
|
||||
|
||||
A ['Tips for New Members'](newmember) link will show up on your network and home pages for two weeks to provide some important Getting Started information.
|
||||
|
||||
Retrieving Personal Data
|
||||
---
|
||||
|
||||
**Retrieving Personal Data**
|
||||
You can export a copy of your personal data in XML format from the "Export personal data" link at the top of your settings page.
|
||||
|
||||
You can export a copy of your personal data in XML format from the "Export personal data" link at the top of your settings page.
|
||||
|
||||
|
||||
**See Also**
|
||||
See Also
|
||||
---
|
||||
|
||||
* [Profiles](help/Profiles)
|
||||
|
||||
|
|
|
|||
|
|
@ -3,11 +3,16 @@ Bugs and Issues
|
|||
|
||||
* [Home](help)
|
||||
|
||||
If your server has a support page, you should report any bugs/issues you encounter there first.
|
||||
Reporting to your support page before reporting to the developers makes their job easier, as they don't have to deal with bug reports that might not have anything to do with them.
|
||||
This helps us get new features faster.
|
||||
|
||||
If your server has a support page, you should report any bugs/issues you encounter there first. Reporting to your support page before reporting to the developers makes their job easier, as they don't have to deal with bug reports that might not have anything to do with them, and that helps us get new features faster.
|
||||
If you're a technical user, or your site doesn't have a support page, you'll need to use the [Bug Tracker](http://bugs.friendica.com/).
|
||||
Please perform a search to see if there's already an open bug that matches yours before submitting anything.
|
||||
|
||||
If you're a technical user, or your site doesn't have a support page, you'll need to use the <a href="http://bugs.friendica.com/">Bug Tracker</a>. Please perform a search to see if there's already an open bug that matches yours before submitting anything.
|
||||
Try to provide as much information as you can about the bug, including the **full** text of any error messages or notices, and any steps required to replicate the problem in as much detail as possible.
|
||||
It's generally better to provide too much information than not enough.
|
||||
|
||||
Try to provide as much information as you can about the bug, including the **full** text of any error messages or notices, and any steps required to replicate the problem in as much detail as possible. It's generally better to provide too much information than not enough.
|
||||
See [this article](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) to learn more about submitting **good** bug reports.
|
||||
|
||||
<a href="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">See this article</a> to learn more about submitting **good** bug reports.
|
||||
And last but not least: Better report an issue you encountered even if you don't write the perfect bug report!
|
||||
|
|
|
|||
59
doc/Chats.md
59
doc/Chats.md
|
|
@ -8,45 +8,64 @@ There are two possibilities to use a chat on your friendica site
|
|||
* IRC Chat
|
||||
* Jappix
|
||||
|
||||
##IRC-Chat Plugin
|
||||
IRC-Chat Plugin
|
||||
---
|
||||
|
||||
After activating the plugin, 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.
|
||||
After activating the plugin, 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 IR chat. Now choose a nickname and a chatroom. You can choose every name for the room, even something like #superchatwhosenameisonlyknownbyme. At last, solve the captchas and click the connect button.
|
||||
If you follow the link, you will see the login page of the IR chat.
|
||||
Now choose a nickname and a chatroom.
|
||||
You can choose every name for the room, even something like #superchatwhosenameisonlyknownbyme.
|
||||
At last, solve the captchas and click the connect button.
|
||||
|
||||
The following window shows some text while connecting. This text isn't importend for you, just wait for the next window. The first line shows your name and your current IP address. The right part of the window shows all user. The lower part of the window contains an input field.
|
||||
The following window shows some text while connecting.
|
||||
This text isn't importend for you, just wait for the next window.
|
||||
The first line shows your name and your current IP address.
|
||||
The right part of the window shows all users.
|
||||
The lower part of the window contains an input field.
|
||||
|
||||
##Jappix Mini
|
||||
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. You can find more information at http://www.jabber.org/
|
||||
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.
|
||||
You can find more information at [jabber.org](http://www.jabber.org/).
|
||||
|
||||
You can use several server to create an account:
|
||||
You can use several servers to create an account:
|
||||
|
||||
* [https://jappix.com](https://jappix.com)
|
||||
* [http://xmpp.net](http://xmpp.net)
|
||||
|
||||
**1. Basics**
|
||||
###1. Basics
|
||||
|
||||
At first you have to get the current version (via github):
|
||||
At first you have to get the current version. You can either pull it from [Github](https://github.com) like so:
|
||||
|
||||
cd /var/www/virtual/YOURSPACE/html/addon; git pull
|
||||
$> cd /var/www/virtual/YOURSPACE/html/addon; git pull
|
||||
|
||||
or as a normal download via: https://github.com/friendica/friendica-addons/blob/master/jappixmini.tgz (click at „view raw“).
|
||||
Or you can download a tar archive here: [jappixmini.tgz](https://github.com/friendica/friendica-addons/blob/master/jappixmini.tgz) (click at „view raw“).
|
||||
|
||||
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.
|
||||
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 at the admin pages. Now you can find an entry of jappix at the plugin sidebar (where you can also find twitter, statusnet and other ones). The following page shows the settings of this plugin.
|
||||
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, statusnet and others).
|
||||
The following page shows the settings of this plugin.
|
||||
|
||||
Now you can activate the BOSH proxy.
|
||||
Next, go to the setting page of your account.
|
||||
Activate the BOSH proxy.
|
||||
|
||||
**2. Settings**
|
||||
###2. Settings
|
||||
|
||||
Go to the account settings and choose the plugin page. Scroll down until you find the Jappix Mini addon settings
|
||||
Go to your user account settings next and choose the plugin page.
|
||||
Scroll down until you find the Jappix Mini addon settings.
|
||||
|
||||
At first you have to activate the addon.
|
||||
|
||||
Now add your Jabber/XMPP name, the domain/server (without "http"; just "jappix.com"). For „Jabber BOSH Host“ you could use "https://bind.jappix.com/". You can find further information in the „Configuration Help“-section below this fields.
|
||||
At last you have enter your password (there are some more optional options, you can choose). Finish these steps with "send" to save the entries. Now, you should find the chatbox at the lower right corner of your browser window.
|
||||
Now add your Jabber/XMPP name, the domain/server (without "http"; just "jappix.com").
|
||||
For „Jabber BOSH Host“ you could use "https://bind.jappix.com/".
|
||||
You can find further information in the „Configuration Help“-section below this fields.
|
||||
At last you have enter your password (there are some more optional options, you can choose).
|
||||
Finish these steps with "send" to save the entries.
|
||||
Now, you should find the chatbox at the lower right corner of your browser window.
|
||||
|
||||
If you want to add contacts manually, you can click "add contact".
|
||||
If you want to add contacts manually, you can click "add contact".
|
||||
|
|
|
|||
|
|
@ -3,7 +3,9 @@ Connectors
|
|||
|
||||
* [Home](help)
|
||||
|
||||
Connectors allow you to connect with external social networks and services. Connectors are only required for posting to existing accounts on Facebook, Twitter, and StatusNet. There is also a connector for accessing your email INBOX.
|
||||
Connectors allow you to connect with external social networks and services.
|
||||
They are only required for posting to existing accounts on Facebook, Twitter, and StatusNet.
|
||||
There is also a connector for accessing your email INBOX.
|
||||
|
||||
If the following network connectors are installed on your system, select the following links to visit the appropriate settings page and configure them for your account:
|
||||
|
||||
|
|
@ -15,53 +17,75 @@ If the following network connectors are installed on your system, select the fol
|
|||
Instructions For Connecting To People On Specific Services
|
||||
==========================================================
|
||||
|
||||
**Friendica**
|
||||
Friendica
|
||||
---
|
||||
|
||||
You can either connect to others by providing your Identity Address on the 'Connect' page of any Friendica member.
|
||||
Or you can put their Identity Address into the Connect box on your [Contacts](contacts) page.
|
||||
|
||||
|
||||
You may connect by providing your Identity Address on the 'Connect' page of any Friendica member. You may also put their Identity Address into the Connect box on your [Contacts](contacts) page.
|
||||
|
||||
|
||||
**Diaspora**
|
||||
Diaspora
|
||||
---
|
||||
|
||||
Add the Diaspora 'handle' to the 'Connect/Follow' text box on your [Contacts](contacts) page.
|
||||
|
||||
|
||||
**Identi.ca/StatusNet/GNU-Social**
|
||||
Identi.ca/StatusNet/GNU-Social
|
||||
---
|
||||
|
||||
These are described as the "federated social web" or OStatus contacts.
|
||||
|
||||
Please note that there are **no** privacy provisions on the OStatus network. Any message which is delivered to **any** OStatus member is visible to anybody in the world and will negate any privacy settings that you have in effect. These messages will also turn up in public searches.
|
||||
Please note that there are **no** privacy provisions on the OStatus network.
|
||||
Any message which is delivered to **any** OStatus member is visible to anybody in the world and will negate any privacy settings that you have in effect.
|
||||
These messages will also turn up in public searches.
|
||||
|
||||
Since OStatus communications do not use authentication, if you select the profile privacy option to hide your profile and messages from unknown viewers, OStatus members will **not** be able to receive your communications.
|
||||
|
||||
To connect with an OStatus member insert their profile URL or Identity address into the Connect box on your [Contacts](contacts) page.
|
||||
|
||||
The StatusNet connector may be used if you wish posts to appear on an OStatus site using an existing OStatus account.
|
||||
|
||||
It is not necessary to do this, as you may 'follow' OStatus members from Friendica and they may follow you (by placing their own Identity Address into your 'Connect' page).
|
||||
|
||||
**Blogger, Wordpress, RSS feeds, arbitrary web pages**
|
||||
Blogger, Wordpress, RSS feeds, arbitrary web pages
|
||||
---
|
||||
|
||||
Put the URL into the Connect box on your [Contacts](contacts) page. You will not be able to reply to these contacts.
|
||||
Put the URL into the Connect box on your [Contacts](contacts) page.
|
||||
PLease note that you will not be able to reply to these contacts.
|
||||
|
||||
This will allow you to _connect_ with millions of pages on the internet. All that we require to do this is that the page use a discoverable feed using either the RSS or Atom syndication format, and which provides an author name and a site image in a form which we can extract.
|
||||
This feed reader feature will allow you to _connect_ with millions of pages on the internet.
|
||||
All that the pages need to have is a discoverable feed using either the RSS or Atom syndication format, and which provides an author name and a site image in a form which we can extract.
|
||||
|
||||
Twitter
|
||||
---
|
||||
|
||||
**Twitter**
|
||||
To follow a Twitter member, put the URL of the Twitter member's main page into the Connect box on your [Contacts](contacts) page.
|
||||
To reply, you must have the Twitter connector installed, and reply using your own status editor.
|
||||
Begin the message with @twitterperson replacing with the Twitter username.
|
||||
|
||||
To follow a Twitter member, put the URL of the Twitter member's main page into the Connect box on your [Contacts](contacts) page. To reply, you must have the Twitter connector installed, and reply using your own status editor. Begin the message with @twitterperson replacing with the Twitter username.
|
||||
Email
|
||||
---
|
||||
|
||||
**Email**
|
||||
Configure the email connector from your [Settings](settings) page.
|
||||
Once this has been done, you may enter an email address to connect with using the Connect box on your [Contacts](contacts) page.
|
||||
They must be the sender of a message which is currently in your INBOX for the connection to succeed.
|
||||
You may include email contacts in private conversations.
|
||||
|
||||
Configure the email connector from your [Settings](settings) page. Once this has been done, you may enter an email addres to connect with using the Connect box on your [Contacts](contacts) page. They must be the sender of a message which is currently in your INBOX for the connect to succeed. You may include email contacts in private conversations.
|
||||
Facebook
|
||||
---
|
||||
|
||||
**Facebook**
|
||||
The Facebook connector is a plugin/addon which allows you to interact with friends on Facebook from within Friendica.
|
||||
If enabled, your Facebook friend list will be imported, and you will see and be able to respond to Facebook posts.
|
||||
Facebook members may also be added to private conversation groups.
|
||||
You will not be able to connect with individual Facebook accounts - but will have your entire friend list imported and updated if new friends are added.
|
||||
|
||||
The Facebook connector is a plugin/addon which allows you to interact with friends on Facebook from within Friendica. If enabled, your Facebook friend list will be imported, and you will see and be able to respond to Facebook posts. Facebook members may also be added to private conversation groups. You will not be able to connect with individual Facebook accounts - but will have your entire friend list imported and updated if new friends are added.
|
||||
Assuming the Facebook plugin/addon has been installed on your system, it can be enabled by going to your [Plugin Settings](settings/addon) page, and then selecting "Facebook Connector Settings" on that page.
|
||||
This will only appear if the Facebook plugin/addon has been installed.
|
||||
Follow the instruction to install or remove the Facebook connector.
|
||||
|
||||
Assuming the Facebook plugin/addon has been installed on your system, it can be enabled by going to your [Plugin Settings](settings/addon) page, and then select "Facebook Connector Settings" on that page. This will only appear if the Facebook plugin/addon has been installed. Follow the instruction to install or remove the Facebook connector.
|
||||
|
||||
You may also choose whether your public postings are posted to Facebook by default. You may toggle this setting at any time from the Permissions settings of the status post editor (click the lock icon). This setting has no effect on private conversations - which will always be delivered to Facebook friends who are included in the permissions.
|
||||
|
||||
(Note: At this time, Facebook contacts will not be able to view any private photos. This will be resolved in a future release. Facebook contacts may however see any public photos you have uploaded.)
|
||||
You may also choose whether your public postings are posted to Facebook by default.
|
||||
You may toggle this setting at any time from the Permissions settings of the status post editor (click the lock icon).
|
||||
This setting has no effect on private conversations - which will always be delivered to Facebook friends who are included in the permissions.
|
||||
|
||||
(Note: At this time, Facebook contacts will not be able to view any private photos.
|
||||
This will be resolved in a future release.
|
||||
Facebook contacts may however see any public photos you have uploaded.)
|
||||
|
|
|
|||
|
|
@ -3,47 +3,76 @@ Where to get started to help improve Friendica?
|
|||
|
||||
* [Home](help)
|
||||
|
||||
Do you want to help us improve Friendica? Here we have compiled some hints on how to get started and some tasks to help you choose. A project like Friendica is the sum of many different contributions. **Very different skills are required to make good software. Some of them involve coding, others do not.** We are looking for helpers in all areas, whether you write text or code, whether you spread the word to convince people or design new icons. Whether you feel like an expert or like a newbie - join us with your ideas!
|
||||
Do you want to help us improve Friendica?
|
||||
Here we have compiled some hints on how to get started and some tasks to help you choose.
|
||||
A project like Friendica is the sum of many different contributions.
|
||||
**Very different skills are required to make good software.
|
||||
Some of them involve coding, others do not.**
|
||||
We are looking for helpers in all areas, whether you write text or code, whether you spread the word to convince people or design new icons.
|
||||
Whether you feel like an expert or like a newbie - join us with your ideas!
|
||||
|
||||
**Contact us**
|
||||
Contact us
|
||||
---
|
||||
|
||||
The discussion of Friendica development takes place in the following Friendica forums:
|
||||
|
||||
* The main [forum for Friendica development](https://friendika.openmindspace.org/profile/friendicadevelopers)
|
||||
* The [forum for Friendica theme development](https://friendica.eu/profile/ftdevs)
|
||||
|
||||
**Help other users**
|
||||
Help other users
|
||||
---
|
||||
|
||||
Remember the questions you had when you first tried Friendica? A good place to start can be to help new people find their way around Friendica in the [general support forum](https://helpers.pyxis.uberspace.de/profile/helpers). Welcome them, answer their questions, point them to documentation or ping other helpers directly if you can't help but think you know who can.
|
||||
Remember the questions you had when you first tried Friendica?
|
||||
A good place to start can be to help new people find their way around Friendica in the [general support forum](https://helpers.pyxis.uberspace.de/profile/helpers).
|
||||
Welcome them, answer their questions, point them to documentation or ping other helpers directly if you can't help but think you know who can.
|
||||
|
||||
**Translations**
|
||||
Translation
|
||||
---
|
||||
|
||||
The documentation contains help on how to translate Friendica in the [at Transifex](/help/translations) where the UI is translated.
|
||||
If you don't want to translate the UI, or it is already done to your satisfaction, you might want to work on the translation of the /help files?
|
||||
|
||||
**Design**
|
||||
Design
|
||||
---
|
||||
|
||||
Are you good at designing things? If you have seen Friendica you probably have ideas to improve it, haven't you?
|
||||
Are you good at designing things?
|
||||
If you have seen Friendica you probably have ideas to improve it, haven't you?
|
||||
|
||||
* If you would like to work with us on enhancing the user interface, please join the [UX Watchdogs forum](https://fc.oscp.info/profile/ux-watchdogs)
|
||||
* Make plans for a better Friendica interface design and share them with us.
|
||||
* Tell us if you are able to realize your ideas or what kind of help you need. We can't promise we have the right skills in the group but we'll try.
|
||||
* Tell us if you are able to realize your ideas or what kind of help you need.
|
||||
We can't promise we have the right skills in the group but we'll try.
|
||||
* Choose a thing to start with, e.g. work on the icon set of your favourite theme
|
||||
|
||||
**Programming**
|
||||
Programming
|
||||
---
|
||||
|
||||
* **Issues:** Have a look at our [issue tracker](https://github.com/friendica/friendica) on gihub!
|
||||
* Try to reproduce a bug that needs more inquries and write down what you find out.
|
||||
* If a bug looks fixed, ask the bug reporters for feedback to find out if the bug can be closed.
|
||||
* Fix a bug if you can. Please make the pull request against the *develop* branch of the repository.
|
||||
###Issues
|
||||
|
||||
* **Web interface:** The thing many people want most is a better interface, preferably a responsive Friendica theme. This is a piece of work! If you want to get involved here:
|
||||
* Look at the first steps that were made (e.g. the clean theme). Ask us to find out whom to talk to about their experiences.
|
||||
* Talk to design people if you know any.
|
||||
* Let us know about your plans [in the dev forum](https://friendika.openmindspace.org/profile/friendicadevelopers) and the [theme developer forum](https://friendica.eu/profile/ftdevs). Do not worry about cross-posting.
|
||||
Have a look at our [issue tracker](https://github.com/friendica/friendica) on github!
|
||||
|
||||
* **Client software:** There are free software clients that do somehow work with Friendica but most of them need love and maintenance. Also, they were mostly made for other platforms using the StatusNet API. This means they lack:w
|
||||
the features that are really specific to Friendica. Popular clients you might want to have a look at are:
|
||||
* [Hotot (Linux)](http://hotot.org/) - abandoned
|
||||
* [Friendica for Android](https://github.com/max-weller/friendica-for-android) - abandoned
|
||||
* You can find more working client software in [Wikipedia](https://en.wikipedia.org/wiki/Friendica).
|
||||
* Try to reproduce a bug that needs more inquries and write down what you find out.
|
||||
* If a bug looks fixed, ask the bug reporters for feedback to find out if the bug can be closed.
|
||||
* Fix a bug if you can. Please make the pull request against the *develop* branch of the repository.
|
||||
|
||||
###Web interface
|
||||
|
||||
The thing many people want most is a better interface, preferably a responsive Friendica theme.
|
||||
This is a piece of work!
|
||||
If you want to get involved here:
|
||||
|
||||
* Look at the first steps that were made (e.g. the clean theme).
|
||||
Ask us to find out whom to talk to about their experiences.
|
||||
* Talk to design people if you know any.
|
||||
* Let us know about your plans [in the dev forum](https://friendika.openmindspace.org/profile/friendicadevelopers) and the [theme developer forum](https://friendica.eu/profile/ftdevs).
|
||||
Do not worry about cross-posting.
|
||||
|
||||
###Client software
|
||||
There are free software clients that do somehow work with Friendica but most of them need love and maintenance.
|
||||
Also, they were mostly made for other platforms using the StatusNet API.
|
||||
This means they lack the features that are really specific to Friendica.
|
||||
Popular clients you might want to have a look at are:
|
||||
|
||||
* [Hotot (Linux)](http://hotot.org/) - abandoned
|
||||
* [Friendica for Android](https://github.com/max-weller/friendica-for-android) - abandoned
|
||||
* You can find more working client software in [Wikipedia](https://en.wikipedia.org/wiki/Friendica).
|
||||
|
|
|
|||
123
doc/FAQ.md
123
doc/FAQ.md
|
|
@ -25,92 +25,109 @@ User
|
|||
*****
|
||||
<a name="ssl"></a>
|
||||
|
||||
**Why do I getting warnings about certificates?**
|
||||
###Why do I get warnings about SSL certificates?
|
||||
|
||||
Sometimes you get a browser warning about a missing certificate. These warnings can have three reasons:
|
||||
SSL (Secure Socket Layer) is a technology to encrypt data transfer between computers.
|
||||
Sometimes your browser warns you about a missing or invalid certificate.
|
||||
These warnings can have three reasons:
|
||||
|
||||
1. the server you are connected to doesn't have SSL;
|
||||
1. The server you are connected to doesn't offer SSL encryption.
|
||||
2. The server has a self-signed certificate (not recommended).
|
||||
3. The certificate is expired.
|
||||
|
||||
2. the server has a self-signed certificate (not recommended)
|
||||
|
||||
3. the certificate is expired.
|
||||
|
||||
*(SSL (Secure Socket Layer) is a technology to encrypt data as it passes between two computers).*
|
||||
|
||||
If you dont have a SSL cert yet, there are three ways to get one: buy one, get a free one (eg. via StartSSL) or create your own (not recommended). [You can find more information about setting up SSL and why it's a bad idea to use self-signed SSL here.](help/SSL)
|
||||
|
||||
Be aware that a browser warning about security issues is something that can make new users feel insecure about the whole friendica project.
|
||||
|
||||
Also you can have problems with the connection to diaspora because some pods require a SSL-certificated connection.
|
||||
|
||||
If you are just using friendica for a specified group of people on a single server without a connection to the rest of the friendica network, there is no need to use SSL. If you exclusively use public posts, there is also no need for it.
|
||||
|
||||
If you havn't set up a server yet, it's wise to compare the different provider and their SSL conditions. Some allow the usage of free certificates or give you the access to their certificate for free. Other ones only allow bought certificates from themselves or other providers.
|
||||
We recommend to talk to the admin(s) of the affected friendica server. (Admins, please see the respective section of the [admin manual](help/SSL).)
|
||||
|
||||
<a name="upload"></a>
|
||||
|
||||
**How can I upload images, files, links, videos and sound files to posts?**
|
||||
###How can I upload images, files, links, videos and sound files to posts?
|
||||
|
||||
You can upload images from your computer by using the [editor](help/Text_editor). An overview of all uploaded images is listed at <i>yourpage.com/photos/profilename</i>. There you could also upload images directly and choose, if your contacts shall receive a message about this upload.
|
||||
You can upload images from your computer by using the [editor](help/Text_editor).
|
||||
An overview of all uploaded images is listed at *yourpage.com/photos/profilename*.
|
||||
On that page, you can also upload images directly and choose, if your contacts shall receive a message about this upload.
|
||||
|
||||
Generally, you could attach every kind of file to a post. This is possible by using the "paper-clip"-symbol at the editor. These files will be linked to your post and can be downloaded by your contacts. But it's not possible to get a preview for these ones. Because of this, this upload method is recommended for office or zipped files.
|
||||
If you want to use Dropbox, owncloud at your own server or any other [filehoster](http://en.wikipedia.org/wiki/Comparison_of_file_hosting_services), you'll have use the "link"-button (chain-symbol).
|
||||
Generally, you could attach every kind of file to a post.
|
||||
This is possible by using the "paper-clip"-symbol in the editor.
|
||||
These files will be linked to your post and can be downloaded by your contacts.
|
||||
But it's not possible to get a preview for these ones.
|
||||
Because of this, this upload method is recommended for office or zipped files.
|
||||
If you want share content from Dropbox, Owncloud or any other [filehoster](http://en.wikipedia.org/wiki/Comparison_of_file_hosting_services), use the "link"-button (chain-symbol).
|
||||
|
||||
When you're adding URLs of other webpages with the "link"-button, Friendica tries to create a small preview. If this doesn't work, try to add the link by typing: [url=http://example.com]<i>self-chosen name</i>[/url].
|
||||
When you're adding URLs of other webpages with the "link"-button, Friendica tries to create a small preview.
|
||||
If this doesn't work, try to add the link by typing: [url=http://example.com]*self-chosen name*[/url].
|
||||
|
||||
You can also add video and audio files to posts. But instead of a direct upload you have to use one of the following methods:
|
||||
You can also add video and audio files to posts.
|
||||
But instead of a direct upload you have to use one of the following methods:
|
||||
|
||||
1. Add the video or audio link of a hoster (Youtube, Vimeo, Soundcloud and everyone else with oembed/opengraph-support). Videos will be shown with a preview image you can click on to start it. SoundCloud directly inserts a player to your post.
|
||||
|
||||
2. If you have an own server, you can upload your multimedia files via FTP and insert the URL. Your video or sound file will be shown with their own player at your post.
|
||||
2. If you have your own server, you can upload multimedia files via FTP and insert the URL.
|
||||
|
||||
Friendica is using HTML5 for embedding content. Therefore, the supported files are depending on your browser and operating system (OS). Some filetypes are WebM, MP4, MP3 and OGG. There are more examples at wikipedia ([video](http://en.wikipedia.org/wiki/HTML5_video), [audio](http://en.wikipedia.org/wiki/HTML5_audio)).
|
||||
Friendica is using HTML5 for embedding content.
|
||||
Therefore, the supported files are depending on your browser and operating system.
|
||||
Some supported filetypes are WebM, MP4, MP3 and OGG.
|
||||
See Wikipedia for more of them ([video](http://en.wikipedia.org/wiki/HTML5_video), [audio](http://en.wikipedia.org/wiki/HTML5_audio)).
|
||||
|
||||
<a name="avatars"></a>
|
||||
|
||||
**Is it possible to have different avatars per profile?**
|
||||
###Is it possible to have different avatars per profile?
|
||||
|
||||
Yes. On your Edit/Manage Profiles page, you will find a "change profile photo" link. Clicking this will take you to a page where you can upload a photograph and select which profile it will be associated with. To avoid privacy leakage, we only display the photograph associated with your default profile as the avatar in your posts.
|
||||
Yes. On your Edit/Manage Profiles page, you will find a "change profile photo" link.
|
||||
Clicking this will take you to a page where you can upload a photograph and select which profile it will be associated with.
|
||||
To avoid privacy leakage, we only display the photograph associated with your default profile as the avatar in your posts.
|
||||
|
||||
<a name="contacts"></a>
|
||||
|
||||
**What is the difference between blocked|ignored|archived|hidden contacts?**
|
||||
###What is the difference between blocked|ignored|archived|hidden contacts?
|
||||
|
||||
We prevent direct communication with blocked contacts. They are not included in delivery, and their own posts to you are not imported; however their conversations with your friends will still be visible in your stream. If you remove a contact completely, they can send you another friend request. Blocked contacts cannot do this. They cannot communicate with you directly, only through friends.
|
||||
We prevent direct communication with **blocked contacts**.
|
||||
They are not included in delivery, and their own posts to you are not imported.
|
||||
However their conversations with your friends will still be visible in your stream.
|
||||
If you remove a contact completely, they can send you another friend request.
|
||||
Blocked contacts cannot do this. They cannot communicate with you directly, only through friends.
|
||||
|
||||
Ignored contacts are included in delivery - they will receive your posts. However we do not import their posts to you. Like blocking, you will still see this person's comments to posts made by your friends.
|
||||
**Ignored contacts** are included in delivery - they will receive your posts.
|
||||
However we do not import their posts 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.]
|
||||
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 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); however unlike blocking, existing posts this person made before being archived will be visible in your stream.
|
||||
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.)
|
||||
However unlike blocking, existing posts this person made before being archived will be visible in your stream.
|
||||
|
||||
A hidden contact will not be displayed in any "friend list" (except to you). However a hidden contact will appear normally in conversations and this may expose his/her hidden status to anybody who can see the conversation.
|
||||
A **hidden contact** will not be displayed in any "friend list" (except to you).
|
||||
However a hidden contact will appear normally in conversations and this may expose his/her hidden status to anybody who can see the conversation.
|
||||
|
||||
<a name="removed"></a>
|
||||
|
||||
**What happens when an account is removed? Is it truly deleted?**
|
||||
###What happens when an account is removed? Is it truly deleted?
|
||||
|
||||
If you delete your account, we will immediately remove all your content on your server, and then issue requests to all your contacts to remove you. This will also remove you from the global directory. Doing this requires that your account and profile still be "partially" available for up to 24 hours in order to establish contact with all your friends. We can block it in several ways so that it appears empty and all profile information erased, but will then wait for 24 hours (or after all of your contacts have been notified) before we can physically remove it.
|
||||
If you delete your account, we will immediately remove all your content on **your** server.
|
||||
|
||||
Then Friendica issues requests to all your contacts to remove you.
|
||||
This will also remove you from the global directory.
|
||||
Doing this requires your account and profile still to be "partially" available for up to 24 hours in order to establish contact with all your friends.
|
||||
We can block it in several ways so that it appears empty and all profile information erased, but will then wait for 24 hours (or after all of your contacts have been notified) before we can physically remove it.
|
||||
|
||||
After that, your account is deleted.
|
||||
|
||||
<a name="hashtag"></a>
|
||||
|
||||
**Can I follow a hashtag?**
|
||||
###Can I follow a hashtag?
|
||||
|
||||
No. The act of 'following' a hashtags is an interesting technology, but presents a few issues.
|
||||
|
||||
1.) Posts which have to be copied to all sites on the network that are "listening" to that tag, which increases the storage demands to the detriment of small sites, and making the use of shared hosting practically impossible, and
|
||||
1. Posts would have to be copied to all sites on the network that are "listening" to that hashtag. This would increase the storage demands to the detriment of small sites. It would make the use of shared hosting practically impossible.
|
||||
|
||||
2.) Making spam easy (tag spam is quite a serious issue on identi.ca for instance)
|
||||
2. Making spam easy (tag spam is quite a serious issue on identi.ca for instance)
|
||||
|
||||
but mostly
|
||||
|
||||
3.) It creates a natural bias towards large sites which hold more tagged content - if your network uses tagging instead of other conversation federation mechanisms such as groups/forums.
|
||||
3. It creates a natural bias towards large sites which hold more tagged content - if your network uses tagging instead of other conversation federation mechanisms such as groups/forums.
|
||||
|
||||
Instead, we offer other mechanisms for wide-area conversations while retaining a 'level playing ground' for both large and small sites, such as forums and community pages and shared tags.
|
||||
|
||||
<a name="rss"></a>
|
||||
|
||||
**How to create a RSS feed of the stream?**
|
||||
###How to create a RSS feed of the stream?
|
||||
|
||||
If you want to share your public page via rss you can use one of the following links:
|
||||
|
||||
|
|
@ -132,9 +149,10 @@ RSS feed of the conversations at your site
|
|||
|
||||
<a name="clients"></a>
|
||||
|
||||
**Are there any clients for friendica I can use?**
|
||||
###Are there any clients for friendica I can use?
|
||||
|
||||
Friendica is using a [Twitter/StatusNet compatible API](help/api), which means you can use any Twitter/StatusNet/GNU Social client for your plattform as long as you can change the API path in its settings. Here is a list of known working clients
|
||||
Friendica is using a [Twitter/StatusNet compatible API](help/api), which means you can use any Twitter/StatusNet/GNU Social client for your plattform as long as you can change the API path in its settings.
|
||||
Here is a list of known working clients:
|
||||
|
||||
* Android
|
||||
* Friendica Client for Android
|
||||
|
|
@ -153,9 +171,11 @@ Depending on the features of the client you might encounter some glitches in usa
|
|||
|
||||
<a name="help"></a>
|
||||
|
||||
**Where I can find help?**
|
||||
###Where I can find help?
|
||||
|
||||
If you have problems with your Friendica page, you can ask the community at the [Friendica Support Group](https://helpers.pyxis.uberspace.de/profile/helpers). If you can't use your default profile you can either use a test account [test server](http://friendica.com/node/31) respectively an account at a public site [list](http://dir.friendica.com/siteinfo) or you can use the Librelist mailing list. If you want to use the mailing list, please just send a mail to friendica AT librelist DOT com.
|
||||
If you have problems with your Friendica page, you can ask the community at the [Friendica Support Group](https://helpers.pyxis.uberspace.de/profile/helpers).
|
||||
If you can't use your default profile you can either use a test account [test server](http://friendica.com/node/31) respectively an account at a public site [list](http://dir.friendica.com/siteinfo) or you can use the Librelist mailing list.
|
||||
If you want to use the mailing list, please just send a mail to friendica AT librelist DOT com.
|
||||
|
||||
If you are a theme developer, you will find help at this forum: [Friendica Theme Developers](https://friendica.eu/profile/ftdevs).
|
||||
|
||||
|
|
@ -164,15 +184,16 @@ Admin
|
|||
*****
|
||||
<a name="multiple"></a>
|
||||
|
||||
**Can I configure multiple domains with the same code instance?**
|
||||
###Can I configure multiple domains with the same code instance?
|
||||
|
||||
This function is not supported anymore starting from Friendica 3.3
|
||||
No, this function is not supported anymore starting from Friendica 3.3.
|
||||
|
||||
<a name="sources"></a>
|
||||
|
||||
**Where can I find the source code of friendica, addons and themes?**
|
||||
###Where can I find the source code of friendica, addons and themes?
|
||||
|
||||
You can find the main respository [here](https://github.com/friendica/friendica). There you will always find the current stable version of friendica.
|
||||
You can find the main respository [here](https://github.com/friendica/friendica).
|
||||
There you will always find the current stable version of friendica.
|
||||
|
||||
Addons are listed at [this page](https://github.com/friendica/friendica-addons).
|
||||
|
||||
|
|
|
|||
|
|
@ -3,26 +3,68 @@ Friendica on Github
|
|||
|
||||
* [Home](help)
|
||||
|
||||
**Here is how you can work on the code with us**
|
||||
Here is how you can work on the code with us. If you have any questions please write to the Friendica developers' forum.
|
||||
|
||||
Introduction to the workflow with our Github repository
|
||||
-------------------------------------------------------
|
||||
|
||||
1. Install git on the system you will be developing on.
|
||||
2. Create your own [github](https://github.com) account.
|
||||
3. Fork the Friendica repository from [https://github.com/friendica/friendica.git](https://github.com/friendica/friendica.git).
|
||||
4. Clone your fork from your Github account to your machine. Follow the instructions provided here: [http://help.github.com/fork-a-repo/](http://help.github.com/fork-a-repo/) to create and use your own tracking fork on github
|
||||
5. Commit your changes to your fork. Then go to your github page and create a "Pull request" to notify us to merge your work.
|
||||
4. Clone your fork from your Github account to your machine.
|
||||
Follow the instructions provided here: [http://help.github.com/fork-a-repo/](http://help.github.com/fork-a-repo/) to create and use your own tracking fork on github
|
||||
5. Commit your changes to your fork.
|
||||
Then go to your github page and create a "Pull request" to notify us to merge your work.
|
||||
|
||||
**Branches**
|
||||
Our Git Branches
|
||||
----------------
|
||||
|
||||
There are two branches in the main repo on Github:
|
||||
There are two relevant branches in the main repo on Github:
|
||||
|
||||
1. master: This branch contains stable releases only.
|
||||
2. develop: This branch contains the latest code. This is what you want to work with.
|
||||
2. develop: This branch contains the latest code.
|
||||
This is what you want to work with.
|
||||
|
||||
**Important**
|
||||
Fast-forwarding
|
||||
---------------
|
||||
|
||||
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.
|
||||
Fast forwarding is enabled by default in git.
|
||||
When you merge with fast-forwarding it does not add a new commit to mark when you've performed the merge and how.
|
||||
This means in your commit history you can't know exactly what happened in terms of merges.
|
||||
**It's best to turn off fast-forwarding.**
|
||||
This is done by running "git merge --no-ff".
|
||||
[Here](https://stackoverflow.com/questions/5519007/how-do-i-make-git-merges-default-be-no-ff-no-commit) is an explanation on how to configure git to turn off fast-forwarding by default.
|
||||
You can find some more background reading [here](http://nvie.com/posts/a-successful-git-branching-model/).
|
||||
|
||||
Also - **test your changes**. Don't assume that a simple fix won't break something else. If possible get an experienced Friendica developer to review the code.
|
||||
Release branches
|
||||
----------------
|
||||
|
||||
A release branch is created when the develop branch contains all features it should have.
|
||||
A release branch is used for a few things.
|
||||
|
||||
1. It allows last-minute bug fixing before the release goes to master branch.
|
||||
2. It allows meta-data changes (README, CHANGELOG, etc.) for version bumps and documentation changes.
|
||||
3. It makes sure the develop branch can receive new features that are **not** part of this release.
|
||||
|
||||
That last point is important because...
|
||||
**The moment a release branch is created, develop is now intended for the version after this release**.
|
||||
So please don't ever merge develop into a release!
|
||||
An example: If a release branch "release-3.4" is created, "develop" becomes either 3.5 or 4.0.
|
||||
If you were to merge develop into release-3.4 at this point, features and bug-fixes intended for 3.5 or 4.0 might leak into this release branch.
|
||||
This might introduce new bugs, too.
|
||||
Which defeats the purpose of the release branch.
|
||||
|
||||
Some important reminders
|
||||
------------------------
|
||||
|
||||
1. 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.
|
||||
|
||||
2. **Test your changes**.
|
||||
Don't assume that a simple fix won't break anything else.
|
||||
If possible get an experienced Friendica developer to review the code.
|
||||
Don't hesitate to ask us in case of doubt.
|
||||
|
||||
Check out how to work with [our Vagrant](help/Vagrant) to save a lot of setup time!
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,8 @@ Vagrant for Friendica Developers
|
|||
|
||||
* [Home](help)
|
||||
|
||||
**Getting started**
|
||||
Getting started
|
||||
---------------
|
||||
|
||||
[Vagrant](https://www.vagrantup.com/) is a virtualization solution for developers.
|
||||
No need to setup up a webserver, database etc. before actually starting.
|
||||
|
|
@ -29,7 +30,8 @@ If you want to stop vagrant after finishing your work, run the following command
|
|||
|
||||
in the development directory.
|
||||
|
||||
**Import test data**
|
||||
Import test data
|
||||
----------------
|
||||
|
||||
If you want some test data in your vagrant Friendica instance import the database dump friendica_test_data.sql like so (inside the VM):
|
||||
|
||||
|
|
|
|||
238
doc/api.md
238
doc/api.md
|
|
@ -1,11 +1,13 @@
|
|||
Implemented API calls
|
||||
===
|
||||
The friendica API aims to be compatible to the [StatusNet API](http://status.net/wiki/Twitter-compatible_API) which aims to be compatible to the [Twitter API 1.0](https://dev.twitter.com/docs/api/1).
|
||||
|
||||
Please refer to the linked documentation for further information.
|
||||
|
||||
## Implemented API calls
|
||||
General
|
||||
---
|
||||
|
||||
### General
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* cursor: Not implemented in StatusNet
|
||||
* trim_user: Not implemented in StatusNet
|
||||
* contributor_details: Not implemented in StatusNet
|
||||
|
|
@ -14,21 +16,25 @@ Please refer to the linked documentation for further information.
|
|||
* include_rts: To-Do
|
||||
* include_my_retweet: Retweets in friendica are implemented in a different way
|
||||
|
||||
#### Different behaviour
|
||||
### Different behaviour
|
||||
* screen_name: The nick name in friendica is only unique in each network but not for all networks. The users are searched in the following priority: Friendica, StatusNet/GNU Social, Diaspora, pump.io, Twitter. If no contact was found by this way, then the first contact is taken.
|
||||
* include_entities: Default is "false". If set to "true" then the plain text is formatted so that links are having descriptions.
|
||||
|
||||
#### Return values
|
||||
### Return values
|
||||
* cid: Contact id of the user (important for "contact_allow" and "contact_deny")
|
||||
* network: network of the user
|
||||
|
||||
### account/verify_credentials
|
||||
#### Parameters
|
||||
account/verify_credentials
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* skip_status: Don't show the "status" field. (Default: false)
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
### statuses/update, statuses/update_with_media
|
||||
#### Parameters
|
||||
statuses/update, statuses/update_with_media
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* title: Title of the status
|
||||
* status: Status in text format
|
||||
* htmlstatus: Status in HTML format
|
||||
|
|
@ -44,28 +50,34 @@ Please refer to the linked documentation for further information.
|
|||
* network
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* trim_user
|
||||
* place_id
|
||||
* display_coordinates
|
||||
|
||||
### users/search
|
||||
#### Parameters
|
||||
users/search
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* q: name of the user
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* page
|
||||
* count
|
||||
* include_entities
|
||||
|
||||
### users/show
|
||||
#### Parameters
|
||||
users/show
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* user_id: id of the user
|
||||
* screen_name: screen name (for technical reasons, this value is not unique!)
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
### statuses/home_timeline
|
||||
#### Parameters
|
||||
statuses/home_timeline
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
* since_id: minimal id
|
||||
|
|
@ -74,13 +86,15 @@ Please refer to the linked documentation for further information.
|
|||
* conversation_id: Shows all statuses of a given conversation.
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* include_rts
|
||||
* trim_user
|
||||
* contributor_details
|
||||
|
||||
### statuses/friends_timeline
|
||||
#### Parameters
|
||||
statuses/friends_timeline
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
* since_id: minimal id
|
||||
|
|
@ -89,13 +103,15 @@ Please refer to the linked documentation for further information.
|
|||
* conversation_id: Shows all statuses of a given conversation.
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* include_rts
|
||||
* trim_user
|
||||
* contributor_details
|
||||
|
||||
### statuses/public_timeline
|
||||
#### Parameters
|
||||
statuses/public_timeline
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
* since_id: minimal id
|
||||
|
|
@ -104,63 +120,75 @@ Please refer to the linked documentation for further information.
|
|||
* conversation_id: Shows all statuses of a given conversation.
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* trim_user
|
||||
|
||||
### statuses/show
|
||||
#### Parameters
|
||||
statuses/show
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* id: message number
|
||||
* conversation: if set to "1" show all messages of the conversation with the given id
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* include_my_retweet
|
||||
* trim_user
|
||||
|
||||
### statuses/retweet
|
||||
#### Parameters
|
||||
statuses/retweet
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* id: message number
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* trim_user
|
||||
|
||||
### statuses/destroy
|
||||
#### Parameters
|
||||
statuses/destroy
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* id: message number
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* trim_user
|
||||
|
||||
### statuses/mentions
|
||||
#### Parameters
|
||||
statuses/mentions
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
* since_id: minimal id
|
||||
* max_id: maximum id
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* include_rts
|
||||
* trim_user
|
||||
* contributor_details
|
||||
|
||||
### statuses/replies
|
||||
#### Parameters
|
||||
statuses/replies
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
* since_id: minimal id
|
||||
* max_id: maximum id
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* include_rts
|
||||
* trim_user
|
||||
* contributor_details
|
||||
|
||||
### statuses/user_timeline
|
||||
#### Parameters
|
||||
statuses/user_timeline
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* user_id: id of the user
|
||||
* screen_name: screen name (for technical reasons, this value is not unique!)
|
||||
* count: Items per page (default: 20)
|
||||
|
|
@ -171,15 +199,17 @@ Please refer to the linked documentation for further information.
|
|||
* conversation_id: Shows all statuses of a given conversation.
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* include_rts
|
||||
* trim_user
|
||||
* contributor_details
|
||||
|
||||
### conversation/show
|
||||
conversation/show
|
||||
---
|
||||
|
||||
Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.
|
||||
|
||||
#### Parameters
|
||||
### Parameters
|
||||
* id: id of the post
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
|
|
@ -187,86 +217,105 @@ Unofficial Twitter command. It shows all direct answers (excluding the original
|
|||
* max_id: maximum id
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* include_rts
|
||||
* trim_user
|
||||
* contributor_details
|
||||
|
||||
### favorites
|
||||
#### Parameters
|
||||
favorites
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
* since_id: minimal id
|
||||
* max_id: maximum id
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* user_id
|
||||
* screen_name
|
||||
|
||||
Favorites aren't displayed to other users, so "user_id" and "screen_name". So setting this value will result in an empty array.
|
||||
|
||||
### account/rate_limit_status
|
||||
account/rate_limit_status
|
||||
---
|
||||
|
||||
### help/test
|
||||
help/test
|
||||
---
|
||||
|
||||
### statuses/friends
|
||||
statuses/friends
|
||||
---
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* user_id
|
||||
* screen_name
|
||||
* cursor
|
||||
|
||||
Friendica doesn't allow showing friends of other users.
|
||||
|
||||
### statuses/followers
|
||||
statuses/followers
|
||||
---
|
||||
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* user_id
|
||||
* screen_name
|
||||
* cursor
|
||||
|
||||
Friendica doesn't allow showing followers of other users.
|
||||
|
||||
### statusnet/config
|
||||
statusnet/config
|
||||
---
|
||||
|
||||
### statusnet/version
|
||||
statusnet/version
|
||||
---
|
||||
|
||||
### friends/ids
|
||||
#### Parameters
|
||||
friends/ids
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* stringify_ids: Should the id numbers be sent as text (true) or number (false)? (default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* user_id
|
||||
* screen_name
|
||||
* cursor
|
||||
|
||||
Friendica doesn't allow showing friends of other users.
|
||||
|
||||
### followers/ids
|
||||
#### Parameters
|
||||
followers/ids
|
||||
---
|
||||
|
||||
Parameters
|
||||
---
|
||||
|
||||
* stringify_ids: Should the id numbers be sent as text (true) or number (false)? (default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* user_id
|
||||
* screen_name
|
||||
* cursor
|
||||
|
||||
Friendica doesn't allow showing followers of other users.
|
||||
|
||||
### direct_messages/new
|
||||
#### Parameters
|
||||
direct_messages/new
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* user_id: id of the user
|
||||
* screen_name: screen name (for technical reasons, this value is not unique!)
|
||||
* text: The message
|
||||
* replyto: ID of the replied direct message
|
||||
* title: Title of the direct message
|
||||
|
||||
### direct_messages/conversation
|
||||
direct_messages/conversation
|
||||
---
|
||||
|
||||
Shows all direct messages of a conversation
|
||||
#### Parameters
|
||||
### Parameters
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
* since_id: minimal id
|
||||
|
|
@ -274,16 +323,20 @@ Shows all direct messages of a conversation
|
|||
* getText: Defines the format of the status field. Can be "html" or "plain"
|
||||
* uri: URI of the conversation
|
||||
|
||||
### direct_messages/all
|
||||
#### Parameters
|
||||
direct_messages/all
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
* since_id: minimal id
|
||||
* max_id: maximum id
|
||||
* getText: Defines the format of the status field. Can be "html" or "plain"
|
||||
|
||||
### direct_messages/sent
|
||||
#### Parameters
|
||||
direct_messages/sent
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
* since_id: minimal id
|
||||
|
|
@ -291,8 +344,10 @@ Shows all direct messages of a conversation
|
|||
* getText: Defines the format of the status field. Can be "html" or "plain"
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
### direct_messages
|
||||
#### Parameters
|
||||
direct_messages
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* count: Items per page (default: 20)
|
||||
* page: page number
|
||||
* since_id: minimal id
|
||||
|
|
@ -300,26 +355,32 @@ Shows all direct messages of a conversation
|
|||
* getText: Defines the format of the status field. Can be "html" or "plain"
|
||||
* include_entities: "true" shows entities for pictures and links (Default: false)
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* skip_status
|
||||
|
||||
### oauth/request_token
|
||||
#### Parameters
|
||||
oauth/request_token
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* oauth_callback
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* x_auth_access_type
|
||||
|
||||
### oauth/access_token
|
||||
#### Parameters
|
||||
oauth/access_token
|
||||
---
|
||||
|
||||
### Parameters
|
||||
* oauth_verifier
|
||||
|
||||
#### Unsupported parameters
|
||||
### Unsupported parameters
|
||||
* x_auth_password
|
||||
* x_auth_username
|
||||
* x_auth_mode
|
||||
|
||||
## Not Implemented API calls
|
||||
Not Implemented API calls
|
||||
===
|
||||
|
||||
The following list is extracted from the [API source file](https://github.com/friendica/friendica/blob/master/include/api.php) (at the very bottom):
|
||||
* favorites/create
|
||||
* favorites/destroy
|
||||
|
|
@ -346,17 +407,24 @@ The following are things from the Twitter API also not implemented in StatusNet:
|
|||
* blocks/blocking
|
||||
* lists
|
||||
|
||||
## Usage Examples
|
||||
### BASH / cURL
|
||||
Usage Examples
|
||||
===
|
||||
|
||||
BASH / cURL
|
||||
---
|
||||
|
||||
Betamax has documentated some example API usage from a [bash script](https://en.wikipedia.org/wiki/Bash_(Unix_shell) employing [curl](https://en.wikipedia.org/wiki/CURL) (see [his posting](https://betamax65.de/display/betamax65/43539)).
|
||||
|
||||
/usr/bin/curl -u USER:PASS https://YOUR.FRIENDICA.TLD/api/statuses/update.xml -d source="some source id" -d status="the status you want to post"
|
||||
|
||||
### Python
|
||||
The [RSStoFriedika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python. The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.
|
||||
Python
|
||||
---
|
||||
|
||||
The [RSStoFriedika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python.
|
||||
The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.
|
||||
|
||||
def tweet(server, message, group_allow=None):
|
||||
url = server + '/api/statuses/update'
|
||||
urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))
|
||||
|
||||
There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.
|
||||
There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.
|
||||
|
|
|
|||
Loading…
Reference in New Issue