diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Account-Basics.md | 4 | ||||
| -rw-r--r-- | doc/Bugs-and-Issues.md | 12 | ||||
| -rw-r--r-- | doc/Connectors.md | 8 | ||||
| -rw-r--r-- | doc/Developers.md | 6 | ||||
| -rw-r--r-- | doc/Groups-and-Privacy.md | 8 | ||||
| -rw-r--r-- | doc/Home.md | 10 | ||||
| -rw-r--r-- | doc/Install.md | 12 | ||||
| -rw-r--r-- | doc/Installing-Connectors.md | 69 | ||||
| -rw-r--r-- | doc/Making-Friends.md | 16 | ||||
| -rw-r--r-- | doc/Message-Flow.md | 10 | ||||
| -rw-r--r-- | doc/Pages.md | 4 | ||||
| -rw-r--r-- | doc/Plugins.md | 10 | ||||
| -rw-r--r-- | doc/Profiles.md | 8 | ||||
| -rw-r--r-- | doc/Remove-Account.md | 6 | ||||
| -rw-r--r-- | doc/Settings.md | 10 | ||||
| -rw-r--r-- | doc/Sites-running-Friendika-you-can-join.md | 7 | ||||
| -rw-r--r-- | doc/Tags-and-Mentions.md | 21 | ||||
| -rw-r--r-- | doc/developer | 2 |
18 files changed, 96 insertions, 127 deletions
diff --git a/doc/Account-Basics.md b/doc/Account-Basics.md index 48584764a..b5e757dbc 100644 --- a/doc/Account-Basics.md +++ b/doc/Account-Basics.md @@ -6,11 +6,11 @@ Account Basics **Registration** -Not all Friendika 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. +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. *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'. Friendika 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 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* diff --git a/doc/Bugs-and-Issues.md b/doc/Bugs-and-Issues.md index ed2be00c8..c119b9968 100644 --- a/doc/Bugs-and-Issues.md +++ b/doc/Bugs-and-Issues.md @@ -4,13 +4,13 @@ Bugs and Issues * [Home](help) -Please report any bugs/issues you encounter using our bug tracker at [[http://bugs.friendika.com]] +Please report any bugs/issues you encounter using our bug tracker at [[http://bugs.friendica.com]] -Try to provide as much information as you can about the bug (including the full text of any error messages or notices), and if possible your Friendika version. +Try to provide as much information as you can about the bug (including the full text of any error messages or notices), and if possible your Friendica version. -Your Friendika version may be found in newer releases by visiting http://YOURFRIENDIKASITE/friendika +Your Friendica version may be found in newer releases by visiting http://YOURFRIENDICASITE/friendica -For older versions, view the HTML source of your profile page. The Friendika version is in the HTML header, 5-10 lines from the top of the page. +For older versions, view the HTML source of your profile page. The Friendica version is in the HTML header, 5-10 lines from the top of the page. For really old versions which don't have a version number in the HTML header - please upgrade. Your bug was probably fixed a long time ago. @@ -20,11 +20,11 @@ The bug/issue database allows you to sponsor issues. This provides an incentive Bug sponsorship works on the honour system. If you agree to pay $10 to fix a bug, when the fix has been checked in and verified you should send a paypal payment to the developer assigned to the bug. Don't ever think you can get away with not paying a developer for work performed. Some of these guys could hack into your credit card account if you make them mad. -At the present time, one has to be approved as a "developer" to be able to assign themselves to a sponsored bug. This requires the developer to have some history fixing Friendika bugs. This is for everybody's assurance that the bug fix will work well with Friendika. If you wish to become approved as a developer, work on and check in some non-sponsored issues or your own projects and we will move you up the ladder. +At the present time, one has to be approved as a "developer" to be able to assign themselves to a sponsored bug. This requires the developer to have some history fixing Friendica bugs. This is for everybody's assurance that the bug fix will work well with Friendica. If you wish to become approved as a developer, work on and check in some non-sponsored issues or your own projects and we will move you up the ladder. If you truly feel you have the solution to a sponsored bug but aren't an approved developer, you risk a sponsored developer assigning the bug to themselves before you check it in, but if they haven't done so - include a short note with your pull request. Assuming that it meets our code standards, we'll see that you get credit. If you sponsor a project at greater than a $50 level, you may be requested by the developer for payment up front before work has begun (typically half). Again this is on the honour system - and is mostly to avoid payment issues and disagreements later. You should also expect to see some progress updates or demonstrations if the work takes more than a week or two. If the work is not completed within a reasonable time (as decided by those involved), you are entitled to get your money back. -Friendika is not involved in these transactions. It is purely a personal agreement between sponsors and developers. If there are any issues, the parties will need to work it out between themselves. We're just providing some guidelines to help avoid potential problems. +Friendica is not involved in these transactions. It is purely a personal agreement between sponsors and developers. If there are any issues, the parties will need to work it out between themselves. We're just providing some guidelines to help avoid potential problems. diff --git a/doc/Connectors.md b/doc/Connectors.md index 6bbf15b2c..08b4c135e 100644 --- a/doc/Connectors.md +++ b/doc/Connectors.md @@ -15,10 +15,10 @@ If the following network connectors are installed on your system, select the fol Instructions For Connecting To People On Specific Services ========================================================== -**Friendika** +**Friendica** -You may connect by providing your Identity Address on the 'Connect' page of any Friendika member. You may also 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** @@ -38,7 +38,7 @@ To connect with an OStatus member insert their profile URL or Identity address i 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 Friendika and they may follow you (by placing their own Identity Address into your 'Connect' page). +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** @@ -57,7 +57,7 @@ Configure the email connector from your [Settings](settings) page. Once this has **Facebook** -The Facebook connector is a plugin/addon which allows you to interact with friends on Facebook from within Friendika. 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 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. diff --git a/doc/Developers.md b/doc/Developers.md index 744a76a8b..17aff3869 100644 --- a/doc/Developers.md +++ b/doc/Developers.md @@ -1,4 +1,4 @@ -Friendika Developer Guide +Friendica Developer Guide Here is how you can join us. @@ -7,7 +7,7 @@ doing development. Create your own github account. -You may fork/clone the Friendika repository from [https://github.com/friendika/Free-Friendika.git](https://github.com/friendika/Free-Friendika.git). +You may fork/clone the Friendica repository from [https://github.com/friendica/friendica.git](https://github.com/friendica/friendica.git). 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 @@ -19,4 +19,4 @@ to notify us to merge your work. 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. -Also - **test your changes**. Don't assume that a simple fix won't break something else. If possible get an experienced Friendika developer to review the code.
\ No newline at end of file +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.
\ No newline at end of file diff --git a/doc/Groups-and-Privacy.md b/doc/Groups-and-Privacy.md index 7ff76906f..61da25a21 100644 --- a/doc/Groups-and-Privacy.md +++ b/doc/Groups-and-Privacy.md @@ -4,9 +4,9 @@ Groups and Privacy * [Home](help) -Groups are merely collections of friends. But Friendika uses these to unlock some very powerful features. +Groups are merely collections of friends. But Friendica uses these to unlock some very powerful features. -To create a group, visit your Friendika "Contacts" page and select "Create a new group". Give the group a name. +To create a group, visit your Friendica "Contacts" page and select "Create a new group". Give the group a name. This brings you to a page where you can select the group members. @@ -30,7 +30,7 @@ But it isn't as clear cut when dealing with status.net, identi.ca and other netw On your "Settings" page, you may create a set of default permissions which apply to every post that you create. -Once you have created a post, you can not change the permissions assigned. Within seconds it has been delivered to lots of people - and perhaps everybody it was addressed to. If you mistakenly created a message and wish you could take it back, the best you can do is to delete it. We will send out a delete notification to everybody who received the message - and this should wipe out the message with the same speed it was initially propagated. In most cases it will be completely wiped from the Internet - in under a minute. Again, this applies to Friendika networks. Once a message spreads to other networks, it may not be removed quickly and in some cases it may not be removed at all. +Once you have created a post, you can not change the permissions assigned. Within seconds it has been delivered to lots of people - and perhaps everybody it was addressed to. If you mistakenly created a message and wish you could take it back, the best you can do is to delete it. We will send out a delete notification to everybody who received the message - and this should wipe out the message with the same speed it was initially propagated. In most cases it will be completely wiped from the Internet - in under a minute. Again, this applies to Friendica networks. Once a message spreads to other networks, it may not be removed quickly and in some cases it may not be removed at all. -In case you haven't yet figured this out, we are encouraging you to encourage your friends to use Friendika - because all these privacy features work much better within a privacy-aware network. Many of the other social networks Friendika can connect to have no privacy controls. +In case you haven't yet figured this out, we are encouraging you to encourage your friends to use Friendica - because all these privacy features work much better within a privacy-aware network. Many of the other social networks Friendica can connect to have no privacy controls. diff --git a/doc/Home.md b/doc/Home.md index f91895620..56abe8075 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -1,4 +1,4 @@ -Friendika Documentation and Resources +Friendica Documentation and Resources ===================================== @@ -26,11 +26,11 @@ Friendika Documentation and Resources **External Resources** -* [Main Website](http://friendika.com) -* [Forums](http://groups.google.com/group/friendika) -* [Developer Forums](http://groups.google.com/group/friendika-dev) +* [Main Website](http://friendica.com) +* [Forums](http://groups.google.com/group/friendica) +* [Developer Forums](http://groups.google.com/group/friendica-dev) **About** -* [Site/Version Info](friendika) +* [Site/Version Info](friendica) diff --git a/doc/Install.md b/doc/Install.md index d851624a7..9455c62ba 100644 --- a/doc/Install.md +++ b/doc/Install.md @@ -1,8 +1,8 @@ -Friendika Installation +Friendica Installation -We've tried very hard to ensure that Friendika will run on commodity hosting platforms - such as those used to host Wordpress blogs and Drupal websites. But be aware that Friendika is more than a simple web application. It is a complex communications system which more closely resembles an email server than a web server. For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down. This kind of functionality requires a bit more of the host system than the typical blog. Not every PHP/MySQL hosting provider will be able to support Friendika. Many will. But **please** review the requirements and confirm these with your hosting provider prior to installation. +We've tried very hard to ensure that Friendica will run on commodity hosting platforms - such as those used to host Wordpress blogs and Drupal websites. But be aware that Friendica is more than a simple web application. It is a complex communications system which more closely resembles an email server than a web server. For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down. This kind of functionality requires a bit more of the host system than the typical blog. Not every PHP/MySQL hosting provider will be able to support Friendica. Many will. But **please** review the requirements and confirm these with your hosting provider prior to installation. -Also if you encounter installation issues, please let us know via the forums at http://groups.google.com/group/friendika or file an issue at http://bugs.friendica.com . Please be as clear as you can about your operating environment and provide as much detail as possible about any error messages you may see, so that we can prevent it from happening in the future. Due to the large variety of operating systems and PHP platforms in existence we may have only limited ability to debug your PHP installation or acquire any missing modules - but we will do our best to solve any general code issues. +Also if you encounter installation issues, please let us know via the forums at http://groups.google.com/group/friendica or file an issue at http://bugs.friendica.com . Please be as clear as you can about your operating environment and provide as much detail as possible about any error messages you may see, so that we can prevent it from happening in the future. Due to the large variety of operating systems and PHP platforms in existence we may have only limited ability to debug your PHP installation or acquire any missing modules - but we will do our best to solve any general code issues. Before you begin: Choose a domain name or subdomain name for your server. Put some thought into this - because changing it after installation is currently not-supported. Things will break, and some of your friends may have difficulty communicating with you. We plan to address this limitation in a future release. @@ -32,7 +32,7 @@ not be as convenient to use and have not been thoroughly tested. reasonable price. If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work.] -2. Unpack the Friendika files into the root of your web server document area. +2. Unpack the Friendica files into the root of your web server document area. - If you are able to do so, we recommend using git to clone the source repository rather than to use a packaged tar or zip file. This makes the software much easier to update. The Linux command to clone the repository into a directory "mywebsite" would be @@ -95,10 +95,10 @@ one shown, substituting for your unique paths and settings: You can generally find the location of PHP by executing "which php". If you have troubles with this section please contact your hosting provider for -assistance. Friendika will not work correctly if you cannot perform this step. +assistance. Friendica will not work correctly if you cannot perform this step. Alternative: You may be able to use the 'poormancron' plugin to perform this step -if you are using a recent Friendika release. To do this, edit the file ".htconfig.php" +if you are using a recent Friendica release. To do this, edit the file ".htconfig.php" and look for a line describing your plugins. On a fresh installation, it will look like `$a->config['system']['addon'] = 'js_upload';` diff --git a/doc/Installing-Connectors.md b/doc/Installing-Connectors.md index cb56383ce..97476925e 100644 --- a/doc/Installing-Connectors.md +++ b/doc/Installing-Connectors.md @@ -4,51 +4,34 @@ Installing Connectors (Facebook/Twitter/StatusNet) * [Home](help) -Friendika uses plugins to provide connectivity to some networks, such as Facebook and Twitter. +Friendica uses plugins to provide connectivity to some networks, such as Facebook and Twitter. -There is also a plugin to post through to an existing account on a Status.Net service. You do not require this to communicate with Status.Net members from Friendika - only if you wish to post to an existing account. +There is also a plugin to post through to an existing account on a Status.Net service. You do not require this to communicate with Status.Net members from Friendica - only if you wish to post to an existing account. -All three of these plugins require an account on the target network. In addition you (or typically the server administrator) will need to obtain an API key to provide authenticated access to your Friendika server. +All three of these plugins require an account on the target network. In addition you (or typically the server administrator) will need to obtain an API key to provide authenticated access to your Friendica server. **Site Configuration** -Plugins must be installed by the site administrator before they can be used. This is accomplished through the site -configuration file ".htconfig.php". +Plugins must be installed by the site administrator before they can be used. This is accomplished through the site administration panel. -The configuration directive looks like: - -``` -$a->config['system']['addon'] = ' ... list of plugins separated by commas ... '; -``` - -Example: -To install all of the connector addons in addition to the default Javascript photo uploader this line would look like: - -``` -$a->config['system']['addon'] = 'js_upload,facebook,twitter,statusnet'; -``` - -You may also add other plugins/addons as your needs require. - -Each of the connectors also requires an "API key" from the service you wish to connect with. This is also installed in the -configuration file. The method for obtaining these keys varies greatly - but almost always requires an existing account on the target service. Once installed, these API keys can usually be shared by all site members. +Each of the connectors also requires an "API key" from the service you wish to connect with. Some plugins allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (.htconfig.php). The method for obtaining these keys varies greatly - but almost always requires an existing account on the target service. Once installed, these API keys can usually be shared by all site members. The details of configuring each service follows (much of this information comes directly from the plugin source files): -**Twitter Plugin for Friendika** +**Twitter Plugin for Friendica** * Author: Tobias Diekershoff * tobias.diekershoff@gmx.net -* License:3-clause BSD license (same as Friendika) +* License:3-clause BSD license Configuration: To use this plugin you need a OAuth Consumer key pair (key & secret) you can get it from Twitter at https://twitter.com/apps -Register your Friendika site as "Client" application with "Read & Write" access. +Register your Friendica site as "Client" application with "Read & Write" access. We do not need "Twitter as login". When you've registered the app you get the OAuth Consumer key and secret pair for your application/site. @@ -65,12 +48,12 @@ from "Settings -> Plugin Settings". Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin -**StatusNet Plugin for Friendika** +**StatusNet Plugin for Friendica** * Author: Tobias Diekershoff * tobias.diekershoff@gmx.net -* License:3-clause BSD license (same as Friendika) +* License:3-clause BSD license Configuration @@ -81,20 +64,20 @@ When the addon is activated the user has to aquire the following in order to con To get the OAuth Consumer key pair the user has to -(a) ask her Friendika admin if a pair already exists or -(b) has to register the Friendika server as a client application on the StatusNet server. +(a) ask her Friendica admin if a pair already exists or +(b) has to register the Friendica server as a client application on the StatusNet server. This can be done from the account settings under "Settings -> Connections -> Register an OAuth client application -> Register a new application". During the registration of the OAuth client remember the following: -* Application names must be unique on the StatusNet site, so we recommend a Name of 'friendika-nnnn', replace 'nnnn' with a random number or your website name. +* Application names must be unique on the StatusNet site, so we recommend a Name of 'friendica-nnnn', replace 'nnnn' with a random number or your website name. * there is no callback url * register a desktop client * with read & write access -* the Source URL should be the URL of your Friendika server +* the Source URL should be the URL of your Friendica server -After the required credentials for the application are stored in the configuration you have to actually connect your Friendika account with StatusNet. This is done from the Settings -> Plugin Settings page. Follow the Sign in with StatusNet button, allow access and then copy the security code into the box provided. Friendika will then try to acquire the final OAuth credentials from the API. +After the required credentials for the application are stored in the configuration you have to actually connect your Friendica account with StatusNet. This is done from the Settings -> Plugin Settings page. Follow the Sign in with StatusNet button, allow access and then copy the security code into the box provided. Friendica will then try to acquire the final OAuth credentials from the API. If successful the addon settings will allow you to select to post your public messages to your StatusNet account (have a look behind the little lock symbol beneath the status "editor" on your Home or Network pages). @@ -102,23 +85,20 @@ Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Stat -**Installing the Friendika/Facebook connector** +**Installing the Friendica/Facebook connector** * register an API key for your site from developer.facebook.com This requires a Facebook account, and may require additional authentication in the form of credit card or mobile phone verification. -a. We'd be very happy if you include "Friendika" in the application name -to increase name recognition. The Friendika icons are also present +a. We'd be very happy if you include "Friendica" in the application name +to increase name recognition. The Friendica icons are also present in the images directory and may be uploaded as a Facebook app icon. -Use images/friendika-16.jpg for the Icon and images/friendika-128.jpg for the Logo. +Use images/friendica-16.jpg for the Icon and images/friendica-128.jpg for the Logo. b. The url should be your site URL with a trailing slash. -You may use http://portal.friendika.com/privacy as the privacy policy -URL unless your site has different requirements, and -http://portal.friendika.com as the Terms of Service URL unless -you have different requirements. (Friendika is a software application -and does not require Terms of Service, though your installation of it might). + +You **may** be required to provide a privacy and/or terms of service URL. c. Set the following values in your .htconfig.php file @@ -133,8 +113,7 @@ d. Navigate to Set Web->Site URL & Domain -> Website Settings. Set Site URL to yoursubdomain.yourdomain.com. Set Site Domain to your yourdomain.com. -Visit the Facebook Settings section of the "Settings->Plugin Settings" page. -And click 'Install Facebook Connector'. +On Friendica, visit the Facebook Settings section of the "Settings->Plugin Settings" page. And click 'Install Facebook Connector'. This will ask you to login to Facebook and grant permission to the plugin to do its stuff. Allow it to do so. @@ -146,9 +125,7 @@ Videos and embeds will not be posted if there is no other content. Links and images will be converted to a format suitable for the Facebook API and long posts truncated - with a link to view the full post. -Facebook contacts will also not be able to view "private" photos, as they are not able to -authenticate to your site to establish identity. We will address this -in a future release. +Facebook contacts will also not be able to view "private" photos, as they are not able to authenticate to your site to establish identity. We will address this in a future release. diff --git a/doc/Making-Friends.md b/doc/Making-Friends.md index 70c7731cc..1a9c8d898 100644 --- a/doc/Making-Friends.md +++ b/doc/Making-Friends.md @@ -3,7 +3,7 @@ Making Friends * [Home](help) -Friendship in Friendika can take on a great many different meanings. But let's keep it simple, you want to be friends with somebody. How do you do it? +Friendship in Friendica can take on a great many different meanings. But let's keep it simple, you want to be friends with somebody. How do you do it? The first thing you can do is look at the Directory for somebody you would like to connect with. Visit their profile. Just beneath their profile picture will be the word 'Connect' (we're assuming this is an English language profile). @@ -13,11 +13,11 @@ This is going to ask you for your Identity Address. This is necessary so that th What do you put in the box? -If your Friendika site is called "demo.friendika.com" and your username/nickname on that site is "bob", you would put in "bob@demo.friendika.com". +If your Friendica site is called "demo.friendica.com" and your username/nickname on that site is "bob", you would put in "bob@demo.friendica.com". Notice this looks just like an email address. It was meant to be that way. It's easy for people to remember. -You *could* also put in the URL of your "home" page, such as "http://demo.friendika.com/profile/bob", but the email-style address is certainly easier. +You *could* also put in the URL of your "home" page, such as "http://demo.friendica.com/profile/bob", but the email-style address is certainly easier. When you've submitted the connection page, it will take you back to your own site where you must then login (if necessary) and verify the connection request on *your* site. Once you've done this, the two websites can communicate with each other to complete the process (after your new friend has approved the request). @@ -25,19 +25,19 @@ If you already know somebody's Identity Address, you can enter it in the "connec **Alternate Networks** -You can also use your Identity Address or other people's Identity Addresses to become friends across networks. The list of possible networks is growing all the time. If you know (for instance) "bob" on identi.ca (a Status.Net site) you could put bob@identi.ca into your Contact page and become friends across networks. (Or you can put in the URL to Bob's identi.ca page if you wish). You can also be "partial" friends with somebody on Google Buzz by putting in their gmail address. Google Buzz does not yet support all the protocols we need for direct messaging, but you should be able to follow status updates from within Friendika. You can do the same for Twitter accounts and Diaspora accounts. In fact you can "follow" most anybody or any website that produces a syndication feed (RSS/Atom,etc.). If we can find an information stream and a name to attach to the contact, we'll try to connect with them. +You can also use your Identity Address or other people's Identity Addresses to become friends across networks. The list of possible networks is growing all the time. If you know (for instance) "bob" on identi.ca (a Status.Net site) you could put bob@identi.ca into your Contact page and become friends across networks. (Or you can put in the URL to Bob's identi.ca page if you wish). You can also be "partial" friends with somebody on Google Buzz by putting in their gmail address. Google Buzz does not yet support all the protocols we need for direct messaging, but you should be able to follow status updates from within Friendica. You can do the same for Twitter accounts and Diaspora accounts. In fact you can "follow" most anybody or any website that produces a syndication feed (RSS/Atom,etc.). If we can find an information stream and a name to attach to the contact, we'll try to connect with them. -If you have supplied your mailbox connection information on your Settings page, you can enter the email address of anybody that has sent you a message recently and have their email messages show up in your social stream. You can also reply to them from within Friendika. +If you have supplied your mailbox connection information on your Settings page, you can enter the email address of anybody that has sent you a message recently and have their email messages show up in your social stream. You can also reply to them from within Friendica. -People can also become friends with you from other networks. If a friend of yours has an identi.ca account, they can become friends with you by putting your Friendika Identity Address into their identi.ca subscription dialog box. A similar mechanism is available for Diaspora members, by putting your iendtity address into their search bar. +People can also become friends with you from other networks. If a friend of yours has an identi.ca account, they can become friends with you by putting your Friendica Identity Address into their identi.ca subscription dialog box. A similar mechanism is available for Diaspora members, by putting your iendtity address into their search bar. Note: Some versions of StatusNet software may require the full URL to your profile and may not work with the identity address. When somebody requests friendship you will receive a notification. You will need to approve this before the friendship is complete. -Some networks allow people to send you messages without being friends and without your approval. Friendika does not allow this by default, as it would open a gateway for spam. +Some networks allow people to send you messages without being friends and without your approval. Friendica does not allow this by default, as it would open a gateway for spam. -When you receive a friendship notification from another Friendika member, you will have the option of allowing them as a "fan" or as a "friend". If they are a fan, they can see what you have to say, including private communications that you send to them, but not vice versa. As a friend, you can both communicate with each other. +When you receive a friendship notification from another Friendica member, you will have the option of allowing them as a "fan" or as a "friend". If they are a fan, they can see what you have to say, including private communications that you send to them, but not vice versa. As a friend, you can both communicate with each other. Diaspora uses a different terminology, and you are given the option of allowing them to "share with you", or being full friends. diff --git a/doc/Message-Flow.md b/doc/Message-Flow.md index be2045f79..bb1c063d3 100644 --- a/doc/Message-Flow.md +++ b/doc/Message-Flow.md @@ -1,6 +1,6 @@ -Friendika Message Flow +Friendica Message Flow -This page attempts to document some of the details of how messages get from one person to another in the Friendika network. There are multiple paths, using multiple protocols and message formats. +This page attempts to document some of the details of how messages get from one person to another in the Friendica network. There are multiple paths, using multiple protocols and message formats. Those attempting to understand these message flows should become familiar with (at the minimum) the DFRN protocol document (http://dfrn.org/dfrn.pdf) and the message passing elements of the OStatus stack (salmon and Pubsubhubbub). @@ -26,17 +26,17 @@ Scenario #1. Bob posts a public status message This is a public message with no conversation members so no private transport is used. There are two paths it can take - as a bbcode path to DFRN clients, and converted to HTML with the server's PuSH (pubsubhubbub) hubs notified. When a PuSH hub is operational, dfrn-poll clients prefer to receive their information through the PuSH channel. They will fall back on a daily poll in case the hub has delivery issues (this is quite common when using the default Google reference hub). If there is no specified hub or hubs, DFRN clients will poll at a configurable (per-contact) rate at up to 5-minute intervals. Feeds retrieved via dfrn-poll are bbcode and may also contain private conversations which the poller has permissions to see. -Scenario #2. Jack replies to Bob's public message. Jack is on the Friendika/DFRN network. +Scenario #2. Jack replies to Bob's public message. Jack is on the Friendica/DFRN network. Jack uses dfrn-notify to send a direct reply to Bob. Bob then creates a feed of the conversation and sends it to everybody involved in the conversation using dfrn-notify. PuSH hubs are notified that new content is available. The hub or hubs will then retrieve the latest feed and transmit it to all hub subscribers (which may be on different networks). -Scenario #3. Mary replies to Bob's public message. Mary is on the Friendika/DFRN network. +Scenario #3. Mary replies to Bob's public message. Mary is on the Friendica/DFRN network. Mary uses dfrn-notify to send a direct reply to Bob. Bob then creates a feed of the conversation and sends it to everybody involved in the conversation (excluding himself, the conversation is now sent to both Jack and Mary). Messages are sent using dfrn-notify. Push hubs are also notified that new content is available. The hub or hubs will then retrieve the latest feed and transmit it to all hub subscribers (which may be on different networks). Scenario #4. William replies to Bob's public message. William is on the OStatus network. -William uses salmon to notify Bob of the reply. Content is html embedded in salmon magic envelope. Bob then creates a feed of the conversation and sends it to all Friendika participants involved in the conversation using dfrn-notify (excluding himself, the conversation is sent to both Jack and Mary). Push hubs are notified that new content is available. The hub or hubs will then retrieve the latest feed and transmit it to all hub subscribers (which may be on different networks). +William uses salmon to notify Bob of the reply. Content is html embedded in salmon magic envelope. Bob then creates a feed of the conversation and sends it to all Friendica participants involved in the conversation using dfrn-notify (excluding himself, the conversation is sent to both Jack and Mary). Push hubs are notified that new content is available. The hub or hubs will then retrieve the latest feed and transmit it to all hub subscribers (which may be on different networks). Scenario #5. Bob posts a private message to Mary and Jack. diff --git a/doc/Pages.md b/doc/Pages.md index 6f4322b13..bce45bac8 100644 --- a/doc/Pages.md +++ b/doc/Pages.md @@ -4,9 +4,9 @@ Pages * [Home](help) -Friendika also lets you create group and/or celebrity pages. +Friendica also lets you create group and/or celebrity pages. -Every page in Friendika has a nickname and these must all be unique. This applies to all pages, whether they are normal profiles or group pages. +Every page in Friendica has a nickname and these must all be unique. This applies to all pages, whether they are normal profiles or group pages. Therefore the first thing you need to do to create a new page is to register a new account for the page. Please note that the site administrator can restrict and/or regulate the registration of new accounts. diff --git a/doc/Plugins.md b/doc/Plugins.md index 42c04cb26..090790d46 100644 --- a/doc/Plugins.md +++ b/doc/Plugins.md @@ -1,4 +1,4 @@ -**Friendika Addon/Plugin development** +**Friendica Addon/Plugin development** This is an early specification and hook details may be subject to change. @@ -16,9 +16,9 @@ Register your plugin hooks during installation. register_hook($hookname, $file, $function); -$hookname is a string and corresponds to a known Friendika hook. +$hookname is a string and corresponds to a known Friendica hook. -$file is a pathname relative to the top-level Friendika directory. This *should* be 'addon/plugin_name/plugin_name.php' in most cases. +$file is a pathname relative to the top-level Friendica directory. This *should* be 'addon/plugin_name/plugin_name.php' in most cases. $function is a string and is the name of the function which will be executed when the hook is called. @@ -35,8 +35,8 @@ Your hook callback functions will be called with at least one and possibly two a If you wish to make changes to the calling data, you must declare them as reference variables (with '&') during function declaration. -$a is the Friendika 'App' class - which contains a wealth of information -about the current state of Friendika, such as which module has been called, +$a is the Friendica 'App' class - which contains a wealth of information +about the current state of Friendica, such as which module has been called, configuration info, the page contents at the point the hook was invoked, profile and user information, etc. It is recommeded you call this '$a' to match its usage elsewhere. diff --git a/doc/Profiles.md b/doc/Profiles.md index 45db9b9ca..716db908e 100644 --- a/doc/Profiles.md +++ b/doc/Profiles.md @@ -3,7 +3,7 @@ Profiles * [Home](help) -Friendika has unlimited profiles. You may use different profiles to show different "sides of yourself" to different audiences. +Friendica has unlimited profiles. You may use different profiles to show different "sides of yourself" to different audiences. You always have a profile known as your "default" or "public" profile. This profile is always available to the general public and cannot be hidden (there may be rare exceptions on privately run or disconnected sites). You may, and probably should restrict the information you make available on your public profile. @@ -18,10 +18,10 @@ Without this basic information, you could get very lonely here. Most people (eve In addition, if you'd like to meet people that share some general interests with you, please take a moment and add some "Public Keywords" to your profile. Such as "music, linux, photography" or whatever. You can add as many keywords as you like. -Your default or public profile is also shown to contacts on other networks, since they do not have the ability to view your private profiles. Only members of the Friendika network can see alternate/private profiles. +Your default or public profile is also shown to contacts on other networks, since they do not have the ability to view your private profiles. Only members of the Friendica network can see alternate/private profiles. -To create an alternate profile, select "Profiles" from the menu of your Friendika site. You may edit an existing profile, change the profile photo, or create a new profile. You may also create a "clone" of an existing profile if you only wish to change a few items but don't wish to enter all the information again. +To create an alternate profile, select "Profiles" from the menu of your Friendica site. You may edit an existing profile, change the profile photo, or create a new profile. You may also create a "clone" of an existing profile if you only wish to change a few items but don't wish to enter all the information again. To assign a profile to specific persons, select the person from your "Contacts" page and click the pencil "Edit" icon. You will find a dropdown box listing the various profiles available. If this box is not selectable, the person is not in a supported network and cannot be assigned a specific profile. @@ -31,7 +31,7 @@ A magic profile link is indicated by a special cursor when hovering over a conta You may also discover that (assuming you have the proper permissions) you may be able to post directly on the other person's profile (often called a "wall-to-wall" post). You may also be able to comment directly on posts from while visiting the other person's profile page. -There are two settings which allow you to publish your profile to a directory and ensure that it can be found by others. You can change these through settings on the "Settings" page. One setting allows you to publish your profile in the site directory of this Friendika server. Another option (this may have been disabled by the site creator) allows you to publish your profile in the "Global Directory". This is a mega directory which contains people from many other Friendika installations world-wide. +There are two settings which allow you to publish your profile to a directory and ensure that it can be found by others. You can change these through settings on the "Settings" page. One setting allows you to publish your profile in the site directory of this Friendica server. Another option (this may have been disabled by the site creator) allows you to publish your profile in the "Global Directory". This is a mega directory which contains people from many other Friendica installations world-wide. If you do not wish to be visible to any of these sites, you may leave your profile unpublished. diff --git a/doc/Remove-Account.md b/doc/Remove-Account.md index 10c5d5cfe..f526b78a8 100644 --- a/doc/Remove-Account.md +++ b/doc/Remove-Account.md @@ -3,11 +3,11 @@ Remove Account * [Home](help) -We don't like to see people leave Friendika, but if you need to remove your account, you should visit the URL +We don't like to see people leave Friendica, but if you need to remove your account, you should visit the URL -http://friendika-site/removeme +http://friendica-site/removeme -with your web browser. You will need to be logged in at the time. (Replace "friendika-site" with the hostname of your Friendika server) +with your web browser. You will need to be logged in at the time. (Replace "friendica-site" with the hostname of your Friendica server) You will be asked for your password to confirm the request. If this matches your stored password, your account will immediately be removed. Unlike some social networks we do **not** hold onto it for a grace period in case you change your mind. Your user details, your conversations, your photos, your friends - everything; will be removed immediately and you will be logged out. diff --git a/doc/Settings.md b/doc/Settings.md index 8abb8a567..9808ecc5d 100644 --- a/doc/Settings.md +++ b/doc/Settings.md @@ -2,7 +2,7 @@ Here are some of the built-in features which don't have an exposed interface or **Hot Keys** -Friendika traps the following keyboard events: +Friendica traps the following keyboard events: * [Pause] - Pauses "Ajax" update activity. This is the process that provides updates without reloading the page. You may wish to pause it to reduce network usage and/or as a debugging aid for javascript developers. A pause indicator will appear at the lower right hand corner of the page. Hit the [pause] key once again to resume. @@ -44,7 +44,7 @@ $a->config['system']['theme'] = 'theme-name'; Security setting -By default Friendika allows SSL communication between websites that have "self-signed" SSL certificates. For the widest compatibility with browsers and other networks we do not recommend using self-signed certificates, but we will not prevent you from using them. SSL encrypts all the data transmitted between sites (and to your browser) and this allows you to have completely encrypted communications, and also protect your login session from hijacking. Self-signed certificates can be generated for free, without paying top-dollar for a website SSL certificate - however these aren't looked upon favourably in the security community because they can be subject to so-called "man-in-the-middle" attacks. If you wish, you can turn on strict certificate checking. This will mean you cannot connect (at all) to self-signed SSL sites. +By default Friendica allows SSL communication between websites that have "self-signed" SSL certificates. For the widest compatibility with browsers and other networks we do not recommend using self-signed certificates, but we will not prevent you from using them. SSL encrypts all the data transmitted between sites (and to your browser) and this allows you to have completely encrypted communications, and also protect your login session from hijacking. Self-signed certificates can be generated for free, without paying top-dollar for a website SSL certificate - however these aren't looked upon favourably in the security community because they can be subject to so-called "man-in-the-middle" attacks. If you wish, you can turn on strict certificate checking. This will mean you cannot connect (at all) to self-signed SSL sites. Config: ``` @@ -79,7 +79,7 @@ $a->config['system']['allowed_email'] = "sitea.com, *siteb.com"; Corporate/Edu enhancement -Set to true to block public access to all otherwise public personal pages on this site unless you are currently logged in. This blocks the viewing of profiles, friends, photos, the site directory and search pages to unauthorised persons. A side effect is that entries from this site will not appear in the global directory. We recommend specifically disabling that also (setting is described elsewhere on this page). Note: this is specifically for sites that desire to be "standalone" and do not wish to be connected to any other Friendika sites. Unauthorised persons will also not be able to request friendship with site members. Default is false. Available in version 2.2 or greater. +Set to true to block public access to all otherwise public personal pages on this site unless you are currently logged in. This blocks the viewing of profiles, friends, photos, the site directory and search pages to unauthorised persons. A side effect is that entries from this site will not appear in the global directory. We recommend specifically disabling that also (setting is described elsewhere on this page). Note: this is specifically for sites that desire to be "standalone" and do not wish to be connected to any other Friendica sites. Unauthorised persons will also not be able to request friendship with site members. Default is false. Available in version 2.2 or greater. Config: ``` @@ -107,7 +107,7 @@ Corporate/Edu enhancement This configures the URL to update the global directory, and is supplied in the default configuration. The undocumented part is that if this is not set, the global directory is completely unavailable to the application. This allows a private community to be completely isolated from the global mistpark network. ``` -$a->config['system']['directory_submit_url'] = 'http://dir.friendika.com/submit'; +$a->config['system']['directory_submit_url'] = 'http://dir.friendica.com/submit'; ``` @@ -134,7 +134,7 @@ $a->config['system']['curl_timeout'] = 60; **Banner/Logo** -Set the content for the site banner. Default is the Friendika logo and name. You may wish to provide HTML/CSS to style and/or position this content, as it may not be themed by default. +Set the content for the site banner. Default is the Friendica logo and name. You may wish to provide HTML/CSS to style and/or position this content, as it may not be themed by default. Config: ``` diff --git a/doc/Sites-running-Friendika-you-can-join.md b/doc/Sites-running-Friendika-you-can-join.md deleted file mode 100644 index 8127a5b9c..000000000 --- a/doc/Sites-running-Friendika-you-can-join.md +++ /dev/null @@ -1,7 +0,0 @@ -Here is a list of Friendika installations free for everybody to join: - -* [friendika.com](http://demo.friendika.com) -* [friendika.net](http://www.friendika.net) -* [aphasi.cc](https://friendika.aphasi.cc) -* [openmindspace.org](http://friendika.openmindspace.org) -* [dfrn.net](http://dfrn.net/)
\ No newline at end of file diff --git a/doc/Tags-and-Mentions.md b/doc/Tags-and-Mentions.md index 404da7465..ce4e45f42 100644 --- a/doc/Tags-and-Mentions.md +++ b/doc/Tags-and-Mentions.md @@ -5,7 +5,7 @@ Tags and Mentions * [Home](help) -Like many other modern social networks, Friendika uses a special notation inside messages to indicate "tags" or contextual links to other entities. +Like many other modern social networks, Friendica uses a special notation inside messages to indicate "tags" or contextual links to other entities. **Mentions** @@ -15,22 +15,21 @@ The following are various ways of indicating a person: * @mike - indicates a known contact in your social circle whose nickname is "mike" * @mike_macgirvin - indicates a known contact in your social circle whose full name is "Mike Macgirvin". Note that spaces cannot be used inside tags. -* @mike@macgirvin.com - indicates the Identity Address of a person on a different network, or one that is *not* in your social circle. This can only be an email-style locator, not a web URL. +* @mike+151 - this form is used by the drop-down tag completion tool. It indicates the contact whose nickname is mike and whose contact identifier number is 151. The drop-down tool may be used to resolve people with duplicate nicknames. +* @mike@macgirvin.com - indicates the Identity Address of a person on a different network, or one that is *not* in your social circle. This is called a "remote mention" and can only be an email-style locator, not a web URL. -Unless their system blocks unsolicited "mentions", the person tagged will likely receive a "Mention" post/activity or become a direct participant in the conversation in the case of public posts. Please note that Friendika often blocks incoming "mentions" from other networks and especially from people with no relationship to you. This is a spam prevention measure. +Unless their system blocks unsolicited "mentions", the person tagged will likely receive a "Mention" post/activity or become a direct participant in the conversation in the case of public posts. Please note that Friendica blocks incoming "mentions" from people with no relationship to you. This is a spam prevention measure. -Friendika makes no distinction between people and groups for the purpose of tagging. (Some other networks use !group to indicate a group.) +Remote mentions are delivered using the OStatus protocol. This protocol is used by Friendica and StatusNet and several other systems, but is not currently implemented in Diaspora. -**Topical Tags** +Friendica makes no distinction between people and groups for the purpose of tagging. (Some other networks use !group to indicate a group.) -Topical tags are indicated by preceding the tag name with the # character. This will create a link in the post to a generalised site search for the term provided. For example, #cars will provide a search link for all posts mentioning 'cars' on your site. Topical tags are generally a minimum of three characters in length. Shorter search terms are not likely to yield any search results, although this depends on the database configuration. The same rules apply as with names that spaces within tags are represented by the underscore character. It is therefore not possible to create a tag whose target contains an underscore. +**Topical Tags** -Tag searches may also use "boolean" logic. +Topical tags are indicated by preceding the tag name with the # character. This will create a link in the post to a generalised site search for the term provided. For example, #cars will provide a search link for all posts mentioning 'cars' on your site. Topical tags are generally a minimum of three characters in length. Shorter search terms are not likely to yield any search results, although this depends on the database configuration. The same rules apply as with names that spaces within tags are represented by the underscore character. It is therefore not possible to create a tag whose target contains an underscore. -* \#bike - creates a search for "bike" -* \#bike_red - creates a search for posts that contain either the word "bike" OR the word "red". -* \#+bike_+red - creates a search for posts that contain both the word "bike" AND the word "red" -* \#+bike_-blue - creates a search for posts that contain the word "bike" but do *not* contain the word "blue" +Topical tags are also not linked if they are purely numeric, e.g. #1. If you wish to use a numerica hashtag, please add some descriptive text such as #2012-elections. + diff --git a/doc/developer b/doc/developer index 1dfd0503b..dd8b316ea 100644 --- a/doc/developer +++ b/doc/developer @@ -1,4 +1,4 @@ -Friendika Developer Guide +Friendica Developer Guide Here is how you can join us. |