diff options
| author | Thomas Willingham <founder@kakste.com> | 2013-05-14 19:14:30 +0100 |
|---|---|---|
| committer | Thomas Willingham <founder@kakste.com> | 2013-05-14 19:14:30 +0100 |
| commit | 96fa691f8a2a3df39ce92efb172ab7282afa47b1 (patch) | |
| tree | 40196ae5b8defd4f4de5ddb67d4a4fb6da234a98 | |
| parent | 32c1e34aa6cb7dee09901f92f925da83a84051d7 (diff) | |
| download | volse-hubzilla-96fa691f8a2a3df39ce92efb172ab7282afa47b1.tar.gz volse-hubzilla-96fa691f8a2a3df39ce92efb172ab7282afa47b1.tar.bz2 volse-hubzilla-96fa691f8a2a3df39ce92efb172ab7282afa47b1.zip | |
Doco
| -rw-r--r-- | doc/Account-Basics.md | 59 | ||||
| -rw-r--r-- | doc/Bugs-and-Issues.md | 31 | ||||
| -rw-r--r-- | doc/Channels.md | 27 | ||||
| -rw-r--r-- | doc/Connecting-to-Channels.md | 12 | ||||
| -rw-r--r-- | doc/Connectors.md | 67 | ||||
| -rw-r--r-- | doc/Developers.md | 11 | ||||
| -rw-r--r-- | doc/Groups-and-Privacy.md | 53 | ||||
| -rw-r--r-- | doc/Home.md | 20 | ||||
| -rw-r--r-- | doc/Install.md | 26 | ||||
| -rw-r--r-- | doc/Installing-Connectors.md | 135 | ||||
| -rw-r--r-- | doc/Making-Friends.md | 59 | ||||
| -rw-r--r-- | doc/Message-Flow.md | 54 | ||||
| -rw-r--r-- | doc/Pages.md | 36 | ||||
| -rw-r--r-- | doc/Permissions.md | 43 | ||||
| -rw-r--r-- | doc/Plugins.md | 357 | ||||
| -rw-r--r-- | doc/Profiles.md | 17 | ||||
| -rw-r--r-- | doc/Remove-Account.md | 22 | ||||
| -rw-r--r-- | doc/Settings.md | 227 | ||||
| -rw-r--r-- | doc/Tags-and-Mentions.md | 30 | ||||
| -rw-r--r-- | doc/andfinally.md | 26 | ||||
| -rw-r--r-- | doc/groupsandpages.md | 11 | ||||
| -rw-r--r-- | doc/guide.md | 13 | ||||
| -rw-r--r-- | doc/makingnewfriends.md | 11 | ||||
| -rw-r--r-- | doc/network.md | 9 | ||||
| -rw-r--r-- | doc/peopleyouknow.md | 13 |
25 files changed, 139 insertions, 1230 deletions
diff --git a/doc/Account-Basics.md b/doc/Account-Basics.md index 522b0db38..56b3eef0c 100644 --- a/doc/Account-Basics.md +++ b/doc/Account-Basics.md @@ -6,67 +6,38 @@ Account Basics **Registration** -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. +Not all Red 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. -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. +*Your Email Address* +Please provide a valid email address. Your email address is **never** published. This address will be used to (optionally) send email notifications for incoming messages or items, and used to recover lost passwords. -*OpenID* +*Password* -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. +Enter a password of your choice, and repeat it in the second box. As Red offers a decentralised identity, your account can log you in to many other websites. Because of this, you should use a strong password, even if you initially think of your account as being in the same category as forums. +*Terms Of Servive* -*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 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. - - -*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. - +Click the link to read the site's terms of service. This will open in a new tab. Once you've read them, tick the box to confirm. *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. +Once you have provided the necessary details, click the 'Register' button. An email will be sent to you providing your account login details. Some sites may require administrator approval before the registration is processed, and you will be alerted if this is the case. Please watch your email (including spam folders) for your registration approval. +*Create a Channel* -**Login Page** +Next, you will be presented with the "Add a channel" screen. Normally, your first channel will be one that represents you - so using your own name (or psuedonym) as the channel name is a good idea. The channel name should be thought of as a title, or breif description of your channel. The "choose a short nickname" box is similar to a "username" field. We will use whatever you enter here to create a channel address, which other people will use to connect to you, and you will use to log in to other sites. This looks like an email address, and takes the form nickname@siteyouregisteredat.xyz -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. +When your channel is created you will be taken straight to your settings page where you can define permissions, enable features, etc. All these things are covered in the appropriate section of the helpfiles. -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** - -After your first login, please visit the 'Settings' page from the top menu bar and change your password to something that you will remember. - - -**Retrieving Personal Data** +**See Also** -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. +* [Tips for New Members](newmember) - this link will show up on your home page for two weeks to provide some important Getting Started information. - -**See Also** +* [Permissions](help/Permissions) * [Profiles](help/Profiles) -* [Groups and Privacy](help/Groups-and-Privacy) - * [Remove Account](help/Remove-Account) +
\ No newline at end of file diff --git a/doc/Bugs-and-Issues.md b/doc/Bugs-and-Issues.md deleted file mode 100644 index 251f91e93..000000000 --- a/doc/Bugs-and-Issues.md +++ /dev/null @@ -1,31 +0,0 @@ -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, 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 <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. - -<a href="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">See this article</a> to learn more about submitting **good** bug reports. - - -**Bug Sponsorship** - -If you find a bug, and it is caused by a problem in main branch (ie, is not specific to our site), you may sponsor it. - -The bug/issue database allows you to sponsor issues. This provides an incentive for developers to work on your issue. This isn't necessary - we don't like bugs and will try to fix them. This has more importance for future development projects and feature requests. - -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 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. - -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/Channels.md b/doc/Channels.md new file mode 100644 index 000000000..b372cbbcf --- /dev/null +++ b/doc/Channels.md @@ -0,0 +1,27 @@ +**Channels** + +Channels are simply collections of content stored in one place. A channel can represent anything. It could represent you, a website, a forum, photo albums, anything. For most people, their first channel with be "Me". + +The most important features for a channel that represents "me" are: + +- Secure and private "spam free" communications + +- Identity and "single-signon" across the entire network + +- Privacy controls and permissions which extend to the entire network + +- Directory services (like a phone book) + +In short, a channel that represents yourself is "me, on the internet". + +You will be required to create your first channel as part of the sign up process. You can also create additonal channels from the "Select channel" link. + +You will be asked to provide a channel name, and a short nick name. For a channel that represents yourself, it is a good idea to use your real name here to ensure your friends can find you, and connect to your channel. The short nickname will be used to generate a "webbie". This is a bit like a username, and will look like an email address, taking the form shortnickname@domain. You should put a little thought into what you want to use here. Imagine somebody asking for your webbie and having to tell them it is "llamas-are_kewl.123". "llamasarecool" would be a much better choice. + +Once you have created your channel, you will be taken to the settings page, where you can configure your channel, and set your default permissions. + +Once you have done this, your channel is ready to use. At domain/channel/username you will find your channel "stream". This is where your recent activity will appear, in reverse chronological order. If you post in the box marked "share", the entry will appear at the top of your stream. You will also find links to all the other communication ares for this channel here. The "About" tab contains your "profile", the photos page contain photo albums, and the events page contains events share by both yourself and your contacts. + +The "Matrix" page contains all recent posts from across the matrix, again in reverse chronologial order. The exact posts that appear here depend largely on your permissions. At their most permissive, you will receive posts from complete strangers. At the other end of the scale, you may see posts from only your friends - or if you're feeling really anti-social, only your own posts. + +As mentioned at the start, many other kinds of channel are possible, however, the creation procedure is the same. The difference between channels lay in the permissions assigned. For example, a channel for sharing documents would probably want more permissive settings for "Can write to my "public" file storage" than a personal account. For more information, see the permissions section.
\ No newline at end of file diff --git a/doc/Connecting-to-Channels.md b/doc/Connecting-to-Channels.md new file mode 100644 index 000000000..df2c4c02f --- /dev/null +++ b/doc/Connecting-to-Channels.md @@ -0,0 +1,12 @@ +Connecting To Channels +============== + +Connections in Red 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? + +First, you need to find some channels to connect to. There are two primary ways of doing this. Firstly, setting the "Can send me their channel stream and posts" permission to "Anybody in this network" will bring posts from complete strangers to your matrix. This will give you a lot of public content and should hopefully help you find interesting, entertaing people, forums, and channels. + +The next thing you can do is look at the Directory. The directory is mirrored on every Red website which means searching from your own site will bring in results from the entire network. You can search by name, interest, location and keyword. This is incomplete, so we'll improve this paragraph later. + +To connect with other Red users: + +Visit their profile by clicking their photograph in the directory, matrix, or comments, and it will open their channel home page in the channel viewer. At the left hand side of the screen, you will see a link called "connect". Click it, and you're done. Depending on the settings of the channel you are connecting to, you may need to wait for them to approve your connection, but no further action is needed on your part.
\ No newline at end of file diff --git a/doc/Connectors.md b/doc/Connectors.md deleted file mode 100644 index 08b4c135e..000000000 --- a/doc/Connectors.md +++ /dev/null @@ -1,67 +0,0 @@ -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. - -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: - -* [Facebook](/settings/addon) -* [Twitter](/settings/addon) -* [StatusNet](/settings/addon) -* [Email](/settings) - -Instructions For Connecting To People On Specific Services -========================================================== - -**Friendica** - - -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** - -Add the Diaspora 'handle' to the 'Connect/Follow' text box on your [Contacts](contacts) page. - - -**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. - -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** - -Put the URL into the Connect box on your [Contacts](contacts) page. 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. - - -**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. - -**Email** - -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** - -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. - -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.) - diff --git a/doc/Developers.md b/doc/Developers.md index 17aff3869..1d9c2aaa1 100644 --- a/doc/Developers.md +++ b/doc/Developers.md @@ -1,13 +1,14 @@ -Friendica Developer Guide +Red Developer Guide +=================== -Here is how you can join us. +**Here is how you can join us.** First, get yourself a working git package on the system where you will be doing development. Create your own github account. -You may fork/clone the Friendica repository from [https://github.com/friendica/friendica.git](https://github.com/friendica/friendica.git). +You may fork/clone the Red repository from [https://github.com/friendica/red.git](https://github.com/friendica/red.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 +20,6 @@ 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 Friendica 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 Red developer to review the code. + +Further documentation can be found at the Github wiki pages at: https://github.com/friendica/red/wiki
\ No newline at end of file diff --git a/doc/Groups-and-Privacy.md b/doc/Groups-and-Privacy.md deleted file mode 100644 index 09c6a7349..000000000 --- a/doc/Groups-and-Privacy.md +++ /dev/null @@ -1,53 +0,0 @@ -Groups and Privacy -================== - -* [Home](help) - - -Groups are merely collections of friends. But Friendica uses these to unlock some very powerful features. - -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. - -You will have two boxes on this page. The top box is the roster of current group members. Below that is another box containing all of your friends who are *not* members of the group. - -If you click on a photo of a person who isn't in the group, they will be put into the group. If you click on a photo of a person who is in the group, they will be removed from it. - -Once you have created a group, you may use it in any access control list. This is the little lock icon beneath the status update box on your home page. If you click this you can select who can see and who can *not* see the post you are about to make. These can be individual people or groups. - -On your "Network" page you will find posts and conversation from everybody in your network. You may select an individual group on this page to show conversations pertaining only to members of that group. - -But wait, there's more... - -If you look carefully when visiting a group from your Network page, the lock icon under the status update box has an exclamation mark next to it. This is meant to draw attention to that lock. Click the lock. You will see that since you are only viewing a certain group of people, your status updates while on that screen default to only being seen by that same group of people. This is how you keep your future employers from seeing what you write to your drinking buddies. You can over-ride this setting, but this makes it easy to separate your conversations into different friend circles. - -These private conversations work best when your friends are Friendica members. We know who else can see the conversations - nobody, *unless* your friends cut and paste the messages and send them to others. - -This is a trust issue you need to be aware of. No software in the world can prevent your friends from leaking your confidential and trusted communications. Only a wise choice of friends. - -But it isn't as clear cut when dealing with status.net, identi.ca and other network providers. You are encouraged to be **very** cautious when other network members are in a group because it's entirely possible for your private messages to end up in a public newsfeed. If you look at the Contact Edit page for any person, we will tell you whether or not they are members of an insecure network where you should exercise caution. - -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 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 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. - - -Profiles, Privacy, and Photos -============================= - -The decentralised nature of Friendica (many websites exchanging information rather than one website which controls everything) has some implications with privacy as it relates to people on other sites. There are things you should be aware of, so you can decide best how to interact privately. - -Sharing photos privately is a problem. We can only share them __privately__ with Friendica members. In order to share with other people, we need to prove who they are. We can prove the identity of Friendica members, as we have a mechanism to do so. Your friends on other networks will be blocked from viewing these private photos because we cannot prove that they should be allowed to see them. - -Our developers are working on solutions to allow access to your friends - no matter what network they are on. However we take privacy seriously and don't behave like some networks that __pretend__ your photos are private, but make them available to others without proof of identity. - -Your profile and "wall" may also be visited by your friends from other networks, and you can block access to these by web visitors that Friendica doesn't know. Be aware that this could include some of your friends on other networks. - -This may produce undesired results when posting a long status message to (for instance) Twitter and even Facebook. When Friendica sends a post to these networks which exceeds the service length limit, we truncate it and provide a link to the original. The original is a link back to your Friendica profile. As Friendica cannot prove who they are, it may not be possible for these people to view your post in full. - -For people in this situation we would recommend providing a "Twitter-length" summary, with more detail for friends that can see the post in full. - -Blocking your profile or entire Friendica site from unknown web visitors also has serious implications for communicating with StatusNet/identi.ca members. These networks communicate with others via public protocols that are not authenticated. In order to view your posts, these networks have to access them as an "unknown web visitor". If we allowed this, it would mean anybody could in fact see your posts, and you've instructed Friendica not to allow this. So be aware that the act of blocking your profile to unknown visitors also has the effect of blocking outbound communication with public networks (such as identi.ca) and feed readers such as Google Reader.
\ No newline at end of file diff --git a/doc/Home.md b/doc/Home.md index 561362f1e..bf22bd26e 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -1,37 +1,29 @@ -Friendica Documentation and Resources -===================================== +Red Documentation and Resources +=============================== **Contents** * [Account Basics](help/Account-Basics) -* [New User Quick Start](help/guide) * [Profiles](help/Profiles) -* [Connectors](help/Connectors) -* [Making Friends](help/Making-Friends) -* [Groups and Privacy](help/Groups-and-Privacy) +* [Channels](help/Channels) +* [Connecting to Channels](help/Connecting-to-Channels) +* [Permissions](help/Permissions) * [Tags and Mentions](help/Tags-and-Mentions) -* [Pages](help/Pages) * [Remove Account](help/Remove-Account) -* [Bugs and Issues](help/Bugs-and-Issues) **Technical Documentation** * [Install](help/Install) -* [Settings](help/Settings) * [Plugins](help/Plugins) -* [Installing Connectors (Facebook/Twitter/StatusNet)](help/Installing-Connectors) -* [Message Flow](help/Message-Flow) * [Developers](help/Developers) **External Resources** * [Main Website](http://friendica.com) -* [Forums](http://groups.google.com/group/friendica) -* [Developer Forums](http://groups.google.com/group/friendica-dev) +* [Development Channel](http://zothub.com/channel/one) **About** * [Site/Version Info](siteinfo) - diff --git a/doc/Install.md b/doc/Install.md index 9455c62ba..b9a787b27 100644 --- a/doc/Install.md +++ b/doc/Install.md @@ -1,17 +1,17 @@ -Friendica Installation +Red 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. +Red should run on commodity hosting platforms - such as those used to host Wordpress blogs and Drupal websites. But be aware that Red is more than a simple web application. The kind of functionality offered by Red requires a bit more of the host system than the typical blog. Not every PHP/MySQL hosting provider will be able to support Red. 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/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. +Also if you encounter installation issues, please let us know via the Friendica forum at https://myfriendica.net/profile/friendicared. 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. 1. Requirements - Apache with mod-rewrite enabled and "Options All" so you can use a local .htaccess file - - PHP 5.2+. The later the better. You'll need 5.3 for encryption of key exchange conversations. On a Windows environment, 5.2+ might not work as the function dns_get_record() is only available with version 5.3. + - PHP 5.3 - PHP *command line* access with register_argc_argv set to true in the php.ini file - curl, gd, mysql, and openssl extensions @@ -36,11 +36,17 @@ you might have trouble getting everything to work.] - 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 - `git clone https://github.com/friendica/friendica.git mywebsite` + `git clone https://github.com/friendica/red.git mywebsite` - and then you can pick up the latest changes at any time with `git pull` + + - make sure folder *view/smarty3* exists and is writable by webserver + + `mkdir view/smarty3` + + `chown 777 view/smarty3` - For installing addons @@ -50,7 +56,7 @@ you might have trouble getting everything to work.] - Then you should clone the addon repository (separtely) - `git clone https://github.com/friendica/friendica-addons.git addon` + `git clone https://github.com/friendica/red-addons.git addon` - For keeping the addon tree updated, you should be on you addon tree and issue a git pull @@ -81,7 +87,7 @@ database was not installed correctly. You might wish to move/rename .htconfig.php to another name and empty (called 'dropping') the database tables, so that you can start fresh. -7. Set up a cron job or scheduled task to run the poller once every 5-10 +7. Set up a cron job or scheduled task to run the poller once every 15 minutes in order to perform background processing. Example: `cd /base/directory; /path/to/php include/poller.php` @@ -91,7 +97,7 @@ Change "/base/directory", and "/path/to/php" as appropriate for your situation. If you are using a Linux server, run "crontab -e" and add a line like the one shown, substituting for your unique paths and settings: -`*/10 * * * * cd /home/myname/mywebsite; /usr/bin/php include/poller.php` +`*/15 * * * * cd /home/myname/mywebsite; /usr/bin/php include/poller.php` 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 diff --git a/doc/Installing-Connectors.md b/doc/Installing-Connectors.md deleted file mode 100644 index 328e3b6c4..000000000 --- a/doc/Installing-Connectors.md +++ /dev/null @@ -1,135 +0,0 @@ -Installing Connectors (Facebook/Twitter/StatusNet) -================================================== - -* [Home](help) - - -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 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 Friendica server. - -**Site Configuration** - -Plugins must be installed by the site administrator before they can be used. This is accomplished through the site administration panel. - - -Each of the connectors also requires an "API key" from the service you wish to connect with. Some plugins allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (.htconfig.php). 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 Friendica** - -* Author: Tobias Diekershoff -* tobias.diekershoff@gmx.net - -* 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 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. - -Add this key pair to your global .htconfig.php - -``` -$a->config['twitter']['consumerkey'] = 'your consumer_key here'; -$a->config['twitter']['consumersecret'] = 'your consumer_secret here'; -``` - -After this, your user can configure their Twitter account settings -from "Settings -> Connector Settings". - -Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin - - -**StatusNet Plugin for Friendica** - -* Author: Tobias Diekershoff -* tobias.diekershoff@gmx.net - -* License:3-clause BSD license - -Configuration - -When the addon is activated the user has to aquire the following in order to connect to the StatusNet account of choice. - -* The base URL for the StatusNet API, for identi.ca this is https://identi.ca/api/ -* OAuth Consumer key & secret - -To get the OAuth Consumer key pair the user has to - -(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" on the StatusNet server. - -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 '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 Friendica server - -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 -> Connector 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). - -Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/StatusNet_Plugin - - - -**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 "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/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** be required to provide a privacy and/or terms of service URL. - -c. Set the following values in your .htconfig.php file - -``` -$a->config['facebook']['appid'] = 'xxxxxxxxxxx'; -$a->config['facebook']['appsecret'] = 'xxxxxxxxxxxxxxx'; -``` - -Replace with the settings Facebook gives you. - -d. Navigate to Set Web->Site URL & Domain -> Website Settings. Set Site URL -to yoursubdomain.yourdomain.com. Set Site Domain to your yourdomain.com. - - -On Friendica, visit the Facebook Settings section of the "Settings->Connector 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. - -You're done. To turn it off visit the Connector Settings page again and -'Remove Facebook posting'. - -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. - - - - - - - diff --git a/doc/Making-Friends.md b/doc/Making-Friends.md deleted file mode 100644 index 70b87abbc..000000000 --- a/doc/Making-Friends.md +++ /dev/null @@ -1,59 +0,0 @@ -Making Friends -============== - -* [Home](help) - -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 easiest thing to do is to join the <a href="http://kakste.com/profile/newhere">New Here</a> group. This group is especially for people new to the Friendica network. Simply connect to the group, post to the wall, and make new friends. You don't even have to like us - comment on a few of our posts, and other people will start to add you too. - -The next thing you can do is look at the Directory. The directory is split up into two parts. If you click the directory button, you will be presented with a list of all members (who chose to be listed) on your server. You'll also see a link to the Global Directory. If you click through to the global directory, you will be presented with a list of everybody who chose to be listed across all instances of Friendica. You will also see a "Show Community Forums" link, which will direct you to Groups, Forums and Fanpages. You connect to people, groups and forums in the same way, except groups and forums will automatically accept your introduction request, whereas a human will approve you manually. - -To connect with other Friendica users: - -Visit their profile. Just beneath their profile picture will be the word 'Connect' (we're assuming this is an English language profile). - -Click that. It will take you to a "Connect" form. - -This is going to ask you for your Identity Address. This is necessary so that this person's website can find yours. - -What do you put in the box? - -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.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). - -If you already know somebody's Identity Address, you can enter it in the "connect" box on your "Contacts" page. This will take you through a similar process. - - -**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 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 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 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. Friendica does not allow this by default, as it would open a gateway for spam. - -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. - -Once you have become friends, if you find the person constantly sends you spam or worthless information, you can "Ignore" them - without breaking off the friendship or even alerting them to the fact that you aren't interested in anything they are saying. In many ways they are like a "fan" - but they don't know this. They think they are a friend. - -You can also "block" a person. This completely blocks communications with that person. They may still be able to see your public posts, as can anybody in the world, but they cannot communicate with you directly. - -You can also delete a friend no matter what the friendship status - which complete removes everything relating to that person from your website. - - - - diff --git a/doc/Message-Flow.md b/doc/Message-Flow.md deleted file mode 100644 index bb1c063d3..000000000 --- a/doc/Message-Flow.md +++ /dev/null @@ -1,54 +0,0 @@ -Friendica Message Flow - -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). - - -Most message passing involves the file include/items.php, which has functions for several feed-related import/export activities. - -When a message is posted, all immediate deliveries to all networks are made using include/notifier.php, which chooses how (and to whom) to deliver the message. This file also invokes the local side of all deliveries including DFRN-notify. - -mod/dfrn_notify.php handles the remote side of DFRN-notify. - -Local feeds are generated by mod/dfrn_poll.php - which also handles the remote side of DFRN-poll protocol. - -Salmon notifications arrive via mod/salmon.php. - -Push (pubsubhubbub) feeds arrive via mod/pubsub.php - -DFRN-poll feed imports arrive via include/poller.php as a scheduled task, this implements the local side of the DFRN-poll protocol. - - - - -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 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 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 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. - -Message is delivered immediately to Mary and Jack using dfrn_notify. Public hubs are not notified. Requeueing is attempted in case of timeout. Replies follow the same flow as the public replies except that hubs are not notified and message is never made available in the public feed. The entire conversation is also made available to Mary and Jack (and nobody else) through their dfrn-poll personalised feed. - - - - - - - - - - - diff --git a/doc/Pages.md b/doc/Pages.md deleted file mode 100644 index d0e6776a4..000000000 --- a/doc/Pages.md +++ /dev/null @@ -1,36 +0,0 @@ -Pages -===== - -* [Home](help) - - -Friendica also lets you create forum and/or celebrity 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 forum 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. - -If you create a second account on a system and use the same email address or OpenID account as an existing account, you will no longer be able to use the email address (or OpenID) to login to the account. You should login using the account nickname instead. - -On the new account, visit the 'Settings' page. Towards the end of the page are "Advanced Page Settings". Typically you would use "Normal Account" for a normal personal account. This is the default selection. Group pages provide the ability for people to become friends/fans of the page without requiring approval. - -The exact setting you would use depends on how you wish to interact with people who join the page. The "Soapbox" setting let's the page owner control all communications. Everything you post will go out to the page members, but there will be no opportunity for interaction. This setting would typically be used for announcements or corporate communications. - -The most common setting is the "Community Account". This creates a group page where all members can freely interact. - -The "Automatic Friend Account" is typically used for personal profile pages where you wish to automatically approve any friendship/connection requests. - -**Managing Multiple Pages** - -We recommend that you create group pages with the same email address and password as your normal account. If you do this, you will find a new "Manage" tab on the menu bar which lets you toggle identities easily and manage your pages. You are not required to do this, but the alternative is to logout and log back into the other account to manage alternate pages - and this could get cumbersome if you manage several different pages/identities. - -You may also appoint a delegate to manage your page. Do this by visiting the [Delegation Setup Page](delegate). This will provide you with a list of contacts on this system under "Potential Delegates". Selecting one or more persons will give them access to manage your page. They will be able to edit contacts, profiles, and all content for this account/page. Please use this facility wisely. Delegated managers will not be able to alter basic account settings such as passwords or page types and/or remove the account. - - -**Posting to Community Pages** - -If you are a member of a community page/forum, you may post to the page by including an @-tag in the post mentioning the forum. For example @bicycle would send my post to all members of the group "bicycle" in addition to the normal recipients. If your post is private you must also explicitly include the group in the post permissions (to allow the forum "contact" to see the post) **and** mention it in a tag (which redistributes the post to the forum members). - -You may also post to a community page/forum by posting a "wall-to-wall" post using secure cross-site authentication. - -Comments which are relayed to community pages will be relayed back to the original post creator. Mentioning the forum/group with an @-tag in a comment does not relay the message, as distribution is controlled entirely by the original post creator.
\ No newline at end of file diff --git a/doc/Permissions.md b/doc/Permissions.md new file mode 100644 index 000000000..1afec0439 --- /dev/null +++ b/doc/Permissions.md @@ -0,0 +1,43 @@ +**Permissions** + +Permissions in the Red Matrix are more complete than you may be used to. This allows us to define more fine graded relationships than the black and white "this person is my friend, so they can do everything" or "this person is not my friend, so they can't do anything" permissions you may find elsewhere. + +**Default Permissions** + +On your settings page, you will find a list of default permissions. These permissions are automatically applied to everybody unless you specify otherwise. The scope of these permissions varies from "Only me" to "Everybody" - though some scopes may not be available for some permissions. For example, you can't allow "anybody on the internet" to send you private messages, because we'd have no way to identify the sender, or offer a return. + +The scopes of permissions are: + +- _Nobody Except Yourself_. This is self explanatory. Only you will be allowed to use this permission. +- _Only those you specifically allow_. By default, people you are not connected to, and all new contacts will have this permission denied. You will be able to make exceptions for individual channels on their contact edit screen. +- _Anybody in your address book_. Anybody you do not know will have this permission denied, but anybody you accept as a contact will have this permission approved. This is the way most legacy platforms handle permissions. +- _Anybody On This Website_. Anybody using the same website as you will have permission approved. Anybody who registered at a different site will have this permission denied. +- _Anybody in this network_. Anybody who has got zot will have this permission approved. Even complete strangers. However, anybody not logged in/authenticated will have this permission denid. +- _Anybody on the internet_. Completely public. This permission will be approved for anybody at all. + +The individual permissions are: + +- _Can view my "public" stream and posts_. This permision determines who can view your channel "stream" that is, the non-private posts that appear on the "home" tab when you're logged in. +- _Can view my "public" channel profile_. This permission determines who can view your channel's profile. This refers to the "about" tab +- _Can view my "public" photo albums_. This permission determines who can view your photo albums. Individual photographs may still be posted to a more private audience. +- _Can view my "public" address book_. This permission determines who can view your contacts. These are the connections displayed in the "View connections" section. +- _Can view my "public" file storage_. This permission determines who can view your public files. This isn't done yet, so this is placeholder text. +- _Can view my "public" pages_. This permission determines who can view your public web pages. This isn't done yet, so this is placeholder text. +- _Can send me their channel stream and posts_. This permission determines whose posts you will view. If your channel is a personal channel (ie, you as a person), you would probably want to set this to "anyone in my address book" at a minimum. A forum page would probably want to choose "nobody except myself". Setting this to "Anybody in the network" will show you posts from complete strangers, which is a good form of discovery. +- _Can post on my channel page ("wall")_. This permission determines who can write to your wall when clicking through to your channel. +- _Can comment on my posts_. This permission determines who can comment on posts you create. Normally, you would want this to match your "can view my public pages" permission +- _Can send me private mail messages_. This determines who can send you private messages (zotmail). +- _Can post photos to my photo albums_. This determines who can post photographs in your albums. This is very useful for forum-like channels where connections may not be connected to each other. +- _Can forward to all my channel contacts via post tags_. Using @- mentions will reproduce a copy of your post on the profile specified, as though you posted on the channel wall. This determines if people can post to your channel in this way. +- _Can chat with me (when available)_. This determines who can (start?) a chat with you. This isn't done yet, so is placeholder text. +- _Can write to my "public" file storage_. This determines who can upload files to your public file storage. This isn't done yet, so this is placeholder text. +- _Can edit my "public" pages_. This determines who can edit your webpages. This is useful for wikis or sites with multiple editors, but this isn't done yet, so this is placeholder text. +- _Can administer my channel resources_. This determines who can have full control of your channel. This should normally be set to "nobody except myself". + +If you have set any of these permissions to "only those I specifically allow", you may specify indivudal permissions on the contact edit screen. + +**Affinity** + +The contact edit screen offers a slider to select a degree of friendship with the contact. Think of this as a measure of how much you dislike them. 1 is for people you like, whose posts you want to see all the time. 99 is for people you can't stand, whose posts you never want to see. Once you've assigned a value here, you can use the affinity tool (assuming you have it enabled) on the network page to filter content based on this number. + +The slider has both a minimum and maximum value. Posts will only be shown from people who fall between this range.
\ No newline at end of file diff --git a/doc/Plugins.md b/doc/Plugins.md deleted file mode 100644 index df6004450..000000000 --- a/doc/Plugins.md +++ /dev/null @@ -1,357 +0,0 @@ -**Friendica Addon/Plugin development** - -Please see the sample addon 'randplace' for a working example of using some of these features. The facebook addon provides an example of integrating both "addon" and "module" functionality. Addons work by intercepting event hooks - which must be registered. Modules work by intercepting specific page requests (by URL path). - - -Plugin names cannot contain spaces or other punctuation and are used as filenames and function names. You may supply a "friendly" name within the comment block. Each addon must contain both an install and an uninstall function based on the addon/plugin name. For instance "plugin1name_install()". These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your plugin will require. The install and uninstall functions will also be called (i.e. re-installed) if the plugin changes after installation - therefore your uninstall should not destroy data and install should consider that data may already exist. Future extensions may provide for "setup" amd "remove". - -Plugins should contain a comment block with the four following parameters: - - /* - * Name: My Great Plugin - * Description: This is what my plugin does. It's really cool - * Version: 1.0 - * Author: John Q. Public <john@myfriendicasite.com> - */ - - - - -Register your plugin hooks during installation. - - register_hook($hookname, $file, $function); - -$hookname is a string and corresponds to a known Friendica hook. - -$file is a pathname relative to the top-level Friendica directory. This *should* be 'addon/plugin_name/plugin_name.php' in most cases. - -$function is a string and is the name of the function which will be executed when the hook is called. - - -Your hook callback functions will be called with at least one and possibly two arguments - - - function myhook_function(&$a, &$b) { - - - } - - -If you wish to make changes to the calling data, you must declare them as -reference variables (with '&') during function declaration. - -$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. - -$b can be called anything you like. This is information which is specific to the hook -currently being processed, and generally contains information that is being immediately -processed or acted on that you can use, display, or alter. Remember to declare it with -'&' if you wish to alter it. - -**Modules** - -Plugins/addons may also act as "modules" and intercept all page requests for a given URL path. In order for a plugin to act as a module it needs to define a function "plugin_name_module()" which takes no arguments and need not do anything. - -If this function exists, you will now receive all page requests for "http://my.web.site/plugin_name" - with any number of URL components as additional arguments. These are parsed into an array $a->argv, with a corresponding $a->argc indicating the number of URL components. So http://my.web.site/plugin/arg1/arg2 would look for a module named "plugin" and pass its module functions the $a App structure (which is available to many components). This will include: - $a->argc = 3 - $a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2'); - -Your module functions will often contain the function plugin_name_content(&$a), which defines and returns the page body content. They may also contain plugin_name_post(&$a) which is called before the _content function and typically handles the results of POST forms. You may also have plugin_name_init(&$a) which is called very early on and often does module initialisation. - - - -**Current hooks:** - -**'authenticate'** - called when a user attempts to login. - $b is an array - 'username' => the supplied username - 'password' => the supplied password - 'authenticated' => set this to non-zero to authenticate the user. - 'user_record' => successful authentication must also return a valid user record from the database - -**'logged_in'** - called after a user has successfully logged in. - $b contains the $a->user array - - -**'display_item'** - called when formatting a post for display. - $b is an array - 'item' => The item (array) details pulled from the database - 'output' => the (string) HTML representation of this item prior to adding it to the page - -**'post_local'** - called when a status post or comment is entered on the local system - $b is the item array of the information to be stored in the database - {Please note: body contents are bbcode - not HTML) - -**'post_local_end'** - called when a local status post or comment has been stored on the local system - $b is the item array of the information which has just been stored in the database - {Please note: body contents are bbcode - not HTML) - -**'post_remote'** - called when receiving a post from another source. This may also be used to post local activity or system generated messages. - $b is the item array of information to be stored in the database and the item - body is bbcode. - -**'settings_form'** - called when generating the HTML for the user Settings page - $b is the (string) HTML of the settings page before the final '</form>' tag. - -**'settings_post'** - called when the Settings pages are submitted. - $b is the $_POST array - -**'plugin_settings'** - called when generating the HTML for the addon settings page - $b is the (string) HTML of the addon settings page before the final '</form>' tag. - -**'plugin_settings_post'** - called when the Addon Settings pages are submitted. - $b is the $_POST array - -**'profile_post'** - called when posting a profile page. - $b is the $_POST array - -**'profile_edit'** - called prior to output of profile edit page - $b is array - 'profile' => profile (array) record from the database - 'entry' => the (string) HTML of the generated entry - - -**'profile_advanced'** - called when the HTML is generated for the 'Advanced profile', corresponding to the 'Profile' tab within a person's profile page. - $b is the (string) HTML representation of the generated profile - (The profile array details are in $a->profile) - -**'directory_item'** - called from the Directory page when formatting an item for display - $b is an array - 'contact' => contact (array) record for the person from the database - 'entry' => the (string) HTML of the generated entry - -**'profile_sidebar_enter'** - called prior to generating the sidebar "short" profile for a page - $b is (array) the person's profile array - -**'profile_sidebar'** - called when generating the sidebar "short" profile for a page - $b is an array - 'profile' => profile (array) record for the person from the database - 'entry' => the (string) HTML of the generated entry - -**'contact_block_end'** - called when formatting the block of contacts/friends on a profile sidebar has completed - $b is an array - 'contacts' => array of contacts - 'output' => the (string) generated HTML of the contact block - -**'bbcode'** - called during conversion of bbcode to html - $b is (string) converted text - -**'html2bbcode'** - called during conversion of html to bbcode (e.g. remote message posting) - $b is (string) converted text - -**'page_header'** - called after building the page navigation section - $b is (string) HTML of nav region - -**'personal_xrd'** - called prior to output of personal XRD file. - $b is an array - 'user' => the user record for the person - 'xml' => the complete XML to be output - -**'home_content'** - called prior to output home page content, shown to unlogged users - $b is (string) HTML of section region - -**'contact_edit'** - called when editing contact details on an individual from the Contacts page - $b is (array) - 'contact' => contact record (array) of target contact - 'output' => the (string) generated HTML of the contact edit page - -**'contact_edit_post'** - called when posting the contact edit page - $b is the $_POST array - -**'init_1'** - called just after DB has been opened and before session start - $b is not used or passed - -**'page_end'** - called after HTML content functions have completed - $b is (string) HTML of content div - -**'avatar_lookup'** - called when looking up the avatar - $b is (array) - 'size' => the size of the avatar that will be looked up - 'email' => email to look up the avatar for - 'url' => the (string) generated URL of the avatar - - -A complete list of all hook callbacks with file locations (generated 14-Feb-2012): Please see the source for details of any hooks not documented above. - - -boot.php: call_hooks('login_hook',$o); - -boot.php: call_hooks('profile_sidebar_enter', $profile); - -boot.php: call_hooks('profile_sidebar', $arr); - -boot.php: call_hooks("proc_run", $arr); - -include/contact_selectors.php: call_hooks('network_to_name', $nets); - -include/api.php: call_hooks('logged_in', $a->user); - -include/api.php: call_hooks('logged_in', $a->user); - -include/queue.php: call_hooks('queue_predeliver', $a, $r); - -include/queue.php: call_hooks('queue_deliver', $a, $params); - -include/text.php: call_hooks('contact_block_end', $arr); - -include/text.php: call_hooks('smilie', $s); - -include/text.php: call_hooks('prepare_body_init', $item); - -include/text.php: call_hooks('prepare_body', $prep_arr); - -include/text.php: call_hooks('prepare_body_final', $prep_arr); - -include/nav.php: call_hooks('page_header', $a->page['nav']); - -include/auth.php: call_hooks('authenticate', $addon_auth); - -include/bbcode.php: call_hooks('bbcode',$Text); - -include/oauth.php: call_hooks('logged_in', $a->user); - -include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr); - -include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o); - -include/acl_selectors.php: call_hooks('contact_select_options', $x); - -include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr); - -include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o); - -include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr); - -include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o); - -include/notifier.php: call_hooks('notifier_normal',$target_item); - -include/notifier.php: call_hooks('notifier_end',$target_item); - -include/items.php: call_hooks('atom_feed', $atom); - -include/items.php: call_hooks('atom_feed_end', $atom); - -include/items.php: call_hooks('atom_feed_end', $atom); - -include/items.php: call_hooks('parse_atom', $arr); - -include/items.php: call_hooks('post_remote',$arr); - -include/items.php: call_hooks('atom_author', $o); - -include/items.php: call_hooks('atom_entry', $o); - -include/bb2diaspora.php: call_hooks('bb2diaspora',$Text); - -include/cronhooks.php: call_hooks('cron', $d); - -include/security.php: call_hooks('logged_in', $a->user); - -include/html2bbcode.php: call_hooks('html2bbcode', $text); - -include/Contact.php: call_hooks('remove_user',$r[0]); - -include/Contact.php: call_hooks('contact_photo_menu', $args); - -include/conversation.php: call_hooks('conversation_start',$cb); - -include/conversation.php: call_hooks('render_location',$locate); - -include/conversation.php: call_hooks('display_item', $arr); - -include/conversation.php: call_hooks('render_location',$locate); - -include/conversation.php: call_hooks('display_item', $arr); - -include/conversation.php: call_hooks('item_photo_menu', $args); - -include/conversation.php: call_hooks('jot_tool', $jotplugins); - -include/conversation.php: call_hooks('jot_networks', $jotnets); - -include/plugin.php:if(! function_exists('call_hooks')) { - -include/plugin.php:function call_hooks($name, &$data = null) { - -index.php: call_hooks('init_1'); - -index.php:call_hooks('app_menu', $arr); - -index.php:call_hooks('page_end', $a->page['content']); - -mod/photos.php: call_hooks('photo_post_init', $_POST); - -mod/photos.php: call_hooks('photo_post_file',$ret); - -mod/photos.php: call_hooks('photo_post_end',$foo); - -mod/photos.php: call_hooks('photo_post_end',$foo); - -mod/photos.php: call_hooks('photo_post_end',$foo); - -mod/photos.php: call_hooks('photo_post_end',intval($item_id)); - -mod/photos.php: call_hooks('photo_upload_form',$ret); - -mod/friendica.php: call_hooks('about_hook', $o); - -mod/editpost.php: call_hooks('jot_tool', $jotplugins); - -mod/editpost.php: call_hooks('jot_networks', $jotnets); - -mod/parse_url.php: call_hooks('parse_link', $arr); - -mod/home.php: call_hooks('home_init',$ret); - -mod/home.php: call_hooks("home_content",$o); - -mod/contacts.php: call_hooks('contact_edit_post', $_POST); - -mod/contacts.php: call_hooks('contact_edit', $arr); - -mod/settings.php: call_hooks('plugin_settings_post', $_POST); - -mod/settings.php: call_hooks('connector_settings_post', $_POST); - -mod/settings.php: call_hooks('settings_post', $_POST); - -mod/settings.php: call_hooks('plugin_settings', $settings_addons); - -mod/settings.php: call_hooks('connector_settings', $settings_connectors); - -mod/settings.php: call_hooks('settings_form',$o); - -mod/register.php: call_hooks('register_account', $newuid); - -mod/like.php: call_hooks('post_local_end', $arr); - -mod/xrd.php: call_hooks('personal_xrd', $arr); - -mod/item.php: call_hooks('post_local_start', $_REQUEST); - -mod/item.php: call_hooks('post_local',$datarray); - -mod/item.php: call_hooks('post_local_end', $datarray); - -mod/profile.php: call_hooks('profile_advanced',$o); - -mod/profiles.php: call_hooks('profile_post', $_POST); - -mod/profiles.php: call_hooks('profile_edit', $arr); - -mod/tagger.php: call_hooks('post_local_end', $arr); - -mod/cb.php: call_hooks('cb_init'); - -mod/cb.php: call_hooks('cb_post', $_POST); - -mod/cb.php: call_hooks('cb_afterpost'); - -mod/cb.php: call_hooks('cb_content', $o); - -mod/directory.php: call_hooks('directory_item', $arr); - diff --git a/doc/Profiles.md b/doc/Profiles.md index 716db908e..249ea4f29 100644 --- a/doc/Profiles.md +++ b/doc/Profiles.md @@ -3,7 +3,7 @@ Profiles * [Home](help) -Friendica has unlimited profiles. You may use different profiles to show different "sides of yourself" to different audiences. +Red has unlimited profiles. You may use different profiles to show different "sides of yourself" to different audiences. This is different to having different _channels_. Different channels allow for completely sets of information. You may have a channel for yourself, a channel for your sports team, a channel for your website, or whatever else. A profile allows for finely graded "sides" of each channel. For example, your default public profile might say "Hello, I'm Fred, and I like laughing". You may show your close friends a profile that adds "and I also enjoy dwarf tossing". 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. @@ -17,21 +17,18 @@ 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 Friendica network can see alternate/private profiles. 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. - -Once a profile has been selected, when the person views your profile from one of the "magic profile links" on their site, they will see the private profile you have assigned. If they are not logged into their site or view your profile from elsewhere, they will see your public profile. +To assign a profile to specific persons, select the person from your "Connections" 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. -A magic profile link is indicated by a special cursor when hovering over a contact's name or photo. Currently this cursor is a hand next to a small padlock. These magic cursors indicate that by following the link, you are able to access special areas of the other person's pages which are only available to friends and may not be available to the general public. +Once a profile has been selected, when the person views your profile, they will see the private profile you have assigned. If they are not authenticated, they will see your public profile. -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. +You may also discover that (assuming you have the proper permissions) you may be able to post directly on the other person's channel (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 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. +There is a setting which allow you to publish your profile to a directory and ensure that it can be found by others. You can change this setting on the "Settings" page. If you do not wish to be visible to any of these sites, you may leave your profile unpublished. @@ -41,11 +38,11 @@ Although you may have multiple profiles, you only have one profile photo. This i **Keywords and Directory Search** -On the site Directory page, you may search for people with published profiles who are on this site. The search is typically for your nickname or part of your full name. However this search will also match against other profile fields - such as gender, location, "about", work, and education. You may also include "Keywords" in your default profile - which may be used to search for common interests with other members. You have two sets of keywords available - public and private. Private keywords are *not* visible to anybody. You could use these keywords to locate people who share membership in secret societies, or that share a love of fishing (for example) - without making this information visible on your public profile. Public keywords are used in the friend suggestion tool and although they aren't readily visible, they may be seen by viewing the HTML of your profile page. +On the site Directory page, you may search for people with published profiles. The search is typically for your nickname or part of your full name. However this search will also match against other profile fields - such as gender, location, "about", work, and education. You may also include "Keywords" in your default profile - which may be used to search for common interests with other members. You have two sets of keywords available - public and private. Private keywords are *not* visible to anybody. You could use these keywords to locate people who share membership in secret societies, or that share a love of fishing (for example) - without making this information visible on your public profile. Public keywords are used in the friend suggestion tool and although they aren't readily visible, they may be seen by viewing the HTML of your profile page. Directory searches are also able to use "boolean" logic so that you can search for "+lesbian +Florida" and find those who's sexual preference (or keywords) contain the world "lesbian" and that live in Florida. See the section on "Topical Tags" on the [Tags-and-Mentions](help/Tags-and-Mentions) page for more information on performing boolean searches. -On your Contacts page is a link to "Find People with Shared Interests" (unless your site administrator has disabled the global directory). This will combine both your public and private keywords, and find people in the global directory who have matching and/or similar keywords. (Your private keywords are not identified or stored on the global directory). The more keywords you provide, the more relevant the search results that are returned. These are sorted by relevance. You may discover that you are the first person on the list - because you are very likely the most relevant match for your keywords in the directory. +On your Contacts page is a link to "Find People with Shared Interests". This will combine both your public and private keywords, and find people who have matching and/or similar keywords. The more keywords you provide, the more relevant the search results that are returned. These are sorted by relevance. You may discover that you are the first person on the list - because you are very likely the most relevant match for your keywords in the directory.
\ No newline at end of file diff --git a/doc/Remove-Account.md b/doc/Remove-Account.md index ae5de2cb6..5759378a3 100644 --- a/doc/Remove-Account.md +++ b/doc/Remove-Account.md @@ -1,24 +1,4 @@ Remove Account ============== -* [Home](help) - -We don't like to see people leave Friendica, but if you need to remove your account, you should visit the URL - -http://sitename/removeme - -with your web browser. You will need to be logged in at the time. - -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. - -When we expire posts we send notifications out to Friendica to remove the posts. Diaspora doesn't have a bulk delete so this step is skipped on that network - and hopefully it will be obvious that deletion doesn't work on any other networks. If you manually delete a post or a range of posts we send individual delete notifications to Friendica and Diaspora for each deleted post. - -Diaspora often loses these. - -If you delete a post but somebody else has starred it, it is still removed. Your wishes take priority. - -When you remove your account we physically remove all your posts and your profile and user data, etc. immediately. - -In order to send out a bulk remove we would need to keep your account around to do this, as we would need to prove to your friends who it is that is submitting the request. We can't do this if you don't have an account. - -Your friends may still see your posts if your account is gone, but there is no public place within Friendica where they can be viewed. If you had friends on Diaspora, your public posts may stick around and be visible to others from that network. +It is presently not possible to remove an account. We'll have better doco when somebody finishes that bit.
\ No newline at end of file diff --git a/doc/Settings.md b/doc/Settings.md deleted file mode 100644 index 574ce8dcc..000000000 --- a/doc/Settings.md +++ /dev/null @@ -1,227 +0,0 @@ -Here are some of the built-in features which don't have an exposed interface or are otherwise undocumented. Configuration settings are stored in the file ".htconfig.php". Edit this file with a text editor to make the desired changes. Several system settings are already documented in that file and will not be covered here. - -**Hot Keys** - -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. - -* [F8] - Displays a language selector - - -**Birthday Notifications** - -Birthday events are published on your Home page for any friends having a birthday in the coming 6 days. In order for your birthday to be discoverable by all of your friends, you must set your birthday (at least the month and day) in your default profile. You are not required to provide the year. - -**Configuration settings** - - -**Language** - -System Setting - -Please see util/README for information on creating language translations. - -Config: -``` -$a->config['system']['language'] = 'name'; -``` - - -**System Theme** - -System Setting - -Choose a named theme to be the default system theme (which may be over-ridden by user profiles). Default theme is "default". - -Config: -``` -$a->config['system']['theme'] = 'theme-name'; -``` - - -**Verify SSL Certitificates** - -Security setting - -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: -``` -$a->config['system']['verifyssl'] = true; -``` - - -**Allowed Friend Domains** - -Corporate/Edu enhancement - -Comma separated list of domains which are allowed to establish friendships with this site. Wildcards are accepted. (Wildcard support on Windows platforms requires PHP5.3). By default, any (valid) domain may establish friendships with this site. - -Config: -``` -$a->config['system']['allowed_sites'] = "sitea.com, *siteb.com"; -``` - - -**Allowed Email Domains** - -Corporate/Edu enhancement - -Comma separated list of domains which are allowed in email addresses for registrations to this site. This can lockout those who are not part of this organisation from registering here. Wildcards are accepted. (Wildcard support on Windows platforms requires PHP5.3). By default, any (valid) email address is allowed in registrations. - -Config: -``` -$a->config['system']['allowed_email'] = "sitea.com, *siteb.com"; -``` - -**Block Public** - -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 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: -``` -$a->config['system']['block_public'] = true; -``` - - -**Force Publish** - -Corporate/Edu enhancement - -By default, each user can choose on their Settings page whether or not to have their profile published in the site directory. This setting forces all -profiles on this site to be listed in the site directory and there is no option provided to the user to change it. Default is false. - -Config: -``` -$a->config['system']['publish_all'] = true; -``` - - -**Global Directory** - -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.friendica.com/submit'; -``` - - -**Proxy Configuration Settings** - -If your site uses a proxy to connect to the internet, you may use these settings to communicate with the outside world (the outside world still needs to be able to see your website, or this will not be very useful). - -Config: -``` -$a->config['system']['proxy'] = "http://proxyserver.domain:port"; -$a->config['system']['proxyuser'] = "username:password"; -``` - - -**Network Timeout** - -How long to wait on a network communication before timing out. Value is in seconds. Default is 60 seconds. Set to 0 for unlimited (not recommended). - -Config: -``` -$a->config['system']['curl_timeout'] = 60; -``` - - -**Banner/Logo** - -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: -``` -$a->config['system']['banner'] = '<span id="logo-text">My Great Website</span>'; -``` - - -**Maximum Image Size** - -Maximum size in bytes of uploaded images. Default is 0, which means no limits. - -Config: -``` -$a->config['system']['maximagesize'] = 1000000; -``` - - -**UTF-8 Regular Expressions** - -During registrations, full names are checked using UTF-8 regular expressions. This requires PHP to have been compiled with a special setting to allow UTF-8 expressions. If you are completely unable to register accounts, set no_utf to true. Default is false (meaning UTF8 regular expressions are supported and working). - -Config: -``` -$a->config['system']['no_utf'] = true; -``` - - -**Check Full Names** - -You may find a lot of spammers trying to register on your site. During testing we discovered that since these registrations were automatic, the "Full Name" field was often set to just an account name with no space between first and last name. If you would like to support people with only one name as their full name, you may change this setting to true. Default is false. - -Config: -``` -$a->config['system']['no_regfullname'] = true; -``` - - -**OpenID** - -By default, OpenID may be used for both registration and logins. If you do not wish to make OpenID facilities available on your system (at all), set 'no_openid' to true. Default is false. - -Config: -``` -$a->config['system']['no_openid'] = true; -``` - - -**Multiple Registrations** - -The ability to create "Pages" requires a person to register more than once. Your site configuration can block registration (or require approval to register). By default logged in users can register additional accounts for use as pages. These will still require approval if REGISTER_APPROVE is selected. You may prohibit logged in users from creating additional accounts by setting 'block_extended_register' to true. Default is false. - -Config: -``` -$a->config['system']['block_extended_register'] = true; -``` - - -**Developer Settings** - -Most useful when debugging protocol exchanges and tracking down other communications issues. - -Config: - -``` -$a->config['system']['debugging'] = true; -$a->config['system']['logfile'] = 'logfile.out'; -$a->config['system']['loglevel'] = LOGGER_DEBUG; -``` -Turns on detailed debugging logs which will be stored in 'logfile.out' (which must be writeable by the webserver). LOGGER_DEBUG will show a good deal of information about system activity but will not include detailed data. You may also select LOGGER_ALL but due to the volume of information we recommend only enabling this when you are tracking down a specific problem. Other log levels are possible but are not being used at the present time. - - -**PHP error logging** - -Use the following settings to redirect PHP errors to a file. - -Config: - -``` -error_reporting(E_ERROR | E_WARNING | E_PARSE ); -ini_set('error_log','php.out'); -ini_set('log_errors','1'); -ini_set('display_errors', '0'); -``` - -This will put all PHP errors in the file php.out (which must be writeable by the webserver). Undeclared variables are occasionally referenced in the program and therefore we do not recommend using E_NOTICE or E_ALL. The vast majority of issues reported at these levels are completely harmless. Please report to the developers any errors you encounter in the logs using the recommended settings above. They generally indicate issues which need to be resolved. - -If you encounter a blank (white) page when using the application, view the PHP logs - as this almost always indicates an error has occurred. - - - diff --git a/doc/Tags-and-Mentions.md b/doc/Tags-and-Mentions.md index ce4e45f42..bcf69736f 100644 --- a/doc/Tags-and-Mentions.md +++ b/doc/Tags-and-Mentions.md @@ -1,36 +1,16 @@ Tags and Mentions ================= - -* [Home](help) - - -Like many other modern social networks, Friendica uses a special notation inside messages to indicate "tags" or contextual links to other entities. +Like many other platforms, Red uses a special notation inside messages to indicate "tags" or contextual links to other entities. **Mentions** -People are tagged by preceding their name with the @ character. - -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+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. +Channels are tagged by simply preceding their name with the @ character. 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. -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. - -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. - -Friendica makes no distinction between people and groups for the purpose of tagging. (Some other networks use !group to indicate a group.) +Red makes no distinction between different types of channel for the purpose of tagging. **Topical Tags** -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 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. - - - - +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 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.
\ No newline at end of file diff --git a/doc/andfinally.md b/doc/andfinally.md deleted file mode 100644 index c4e8cb948..000000000 --- a/doc/andfinally.md +++ /dev/null @@ -1,26 +0,0 @@ -[[!meta title="And Finally..."]] - -And that brings the Quick Start to an end. - -Here are some more things to help get you started: - -**Groups** - - -- <a href="https://kakste.com/profile/newhere">New Here</a> - a group for people new to Friendica - -- <a href="http://helpers.pyxis.uberspace.de/profile/helpers">Friendica Support</a> - problems? This is the place to ask. - -- <a href="https://kakste.com/profile/public_stream">Public Stream</a> - a place to talk about anything to anyone. - -- <a href="https://letstalk.pyxis.uberspace.de/profile/letstalk">Let's Talk</a> a group for finding people and groups who share similar interests. - -- <a href="http://newzot.hydra.uberspace.de/profile/newzot">Local Friendica</a> a page for local Friendica groups</a> - - -**Documentation** - -- <a href="help/Connectors">Connecting to more networks</a> -- <a href="help">Help Index</a> - - diff --git a/doc/groupsandpages.md b/doc/groupsandpages.md deleted file mode 100644 index 5cfbc653c..000000000 --- a/doc/groupsandpages.md +++ /dev/null @@ -1,11 +0,0 @@ -This is the global directory. If you get lost, you can <a href = "help/groupsandpages">click this link</a> to bring yourself back here. - -On this page, you'll find a collection of groups, forums and celebrity pages. Groups are not real people. Connecting to them is similar to "liking" something on Facebook, or signing up for a new forum. You don't have to feel awkward about introducing yourself to a new person, because they're not people! - -When you connect to a group, all messages to that group will start appearing in your network tab. You can comment on these posts, or post to the group yourself without ever having to add any of the groups members. This is a great way to make friends dynamically - you'll find people you like and add each other naturally instead of adding random strangers. Simply find a group you're interested in, and connect to it the same way you did with people in the last section. There are a lot of groups, and you're likely to get lost. Remember the link at the top of this page will bring you back here. - -Once you've added some groups, <a href="help/andfinally">move on to the next section</a>. - -<iframe src="http://dir.friendica.com/directory/forum" width="950" height="600"></iframe> - - diff --git a/doc/guide.md b/doc/guide.md deleted file mode 100644 index d76af92e2..000000000 --- a/doc/guide.md +++ /dev/null @@ -1,13 +0,0 @@ -First things first, let's make sure you're logged in to your account. If you're not already logged in, do so in the frame below. - -Once you've logged in (or if you are already logged in), you'll now be looking at your profile page. - -This is a bit like your Facebook wall. It's where all your status messgages are kept, and where your friends come to post on your wall. To write your status, simply click in the box that says "share". When you do this, the box will expand. You can see some formatting options at the top such as Bold, Italics and Underline, as well as ways to add links and pictures. At the bottom you'll find some more links. You can use these to upload pictures and files from your computer, share websites with a bit of preview text, or embed video and audio files from elsewhere on the web. You can also set your post location here. - -Once you've finished writing your post, click on the padlock icon to select who can see it. If you do not use the padlock icon, your post will be public. This means it will appear to anybody who views your profile, and in the community tab if your site has it enabled, as well as in the network tab of any of your contacts. - -Play around with this a bit, then when you're ready to move on, we'll take a look at the <a href="help/network">Network Tab</a> - -<iframe src="login" width="950" height="600"></iframe> - - diff --git a/doc/makingnewfriends.md b/doc/makingnewfriends.md deleted file mode 100644 index 7eff1eda1..000000000 --- a/doc/makingnewfriends.md +++ /dev/null @@ -1,11 +0,0 @@ -This is your Suggested Friends page. If you get lost, you can <a href="help/makenewfriends">click this link</a> to bring yourself back here. - -This is a bit like the Friend Suggestions page of Facebook. Everybody on this list has agreed that they may be suggested as a friend. This means they're unlikely to refuse an introduction you send, and they want to meet new people too! - -See somebody you like the look of? Click the connect button beneath their photograph. This will bring you to the introductions page. Fill in the form as instructed, and add a small note (optional). Now, wait a bit and they'll accept your request - note that these are real people, and it might take a while. Now you've added one, you're probably lost. Click the link at the top of this page to go back to the suggested friends list and add some more. - -Feel uncomfortable adding people you don't know? Don't worry - that's where <a href="help/groupsandpages">Groups and Pages</a> come in! - -<iframe src="suggest" width="950" height="600"></iframe> - - diff --git a/doc/network.md b/doc/network.md deleted file mode 100644 index afb092395..000000000 --- a/doc/network.md +++ /dev/null @@ -1,9 +0,0 @@ -This is your Network Tab. If you get lost, you can <a href="help/network">click this link</a> to bring yourself back here. - -This is a bit like the Newsfeed at Facebook or the Stream at Diaspora. It's where all the posts from your contacts, groups, and feeds will appear. If you're new, you won't see anything in this page, unless you posted your status in the last step. If you've already added a few friends, you'll be able to see their posts. Here, you can comment, like, or dislike posts, or click on somebody's name to visit their profile page where you can write on their wall. - -Now we need to fill it up, the first step, is to <a href="help/peopleyouknow"> add people you already know from Facebook</a>. - -<iframe src="network" width="950" height="600"></iframe> - - diff --git a/doc/peopleyouknow.md b/doc/peopleyouknow.md deleted file mode 100644 index ae0c9ef59..000000000 --- a/doc/peopleyouknow.md +++ /dev/null @@ -1,13 +0,0 @@ -This is your connector settings page. If you get lost, you can <a href="help/network">click this link</a> to bring yourself back here. - -This is the bit that makes Friendica unique. You can connect to <i>anybody on the internet</i> from your Friendica account using this page! The available connectors varies depending on which plugins you have installed, but for now, we'll walk you through Facebook. Note that not all servers have the Facebook connector installed. If you can't find it in the list below, don't worry, we'll look at ways of connecting to more people in the following pages. - -The biggest of all social networks is Facebook. Fortunately, this connector is really easy. Scroll down the page, and click Facebook Connector Settings. Enter your Facebook user name and password and let the application (the connector) do everything the options suggest. You can <a href="https://github.com/friendica/friendica/wiki/How-to:-Friendica%E2%80%99s-Facebook-connector" target="_blank">fine tune this</a> or experiment with the other connectors too. If you need help, you can always ask at <a href="http://helpers.pyxis.uberspace.de/profile/helpers" target="_blank">Friendica Support</a> or <a href="help/Connectors" target="_blank">see the instructions here</a>. - -When you're ready, we can move on to <a href="help/makingnewfriends">making new friends</a>. - - - -<iframe src="settings/connectors" width="950" height="600"></iframe> - - |