diff --git a/doc/Accesskeys.md b/doc/Accesskeys.md index 24b4dd4e7..3369f9afd 100644 --- a/doc/Accesskeys.md +++ b/doc/Accesskeys.md @@ -3,6 +3,8 @@ Accesskeys in Friendica * [Home](help) +For an overview of the modifier key of the different browsers we suggest this [Wikipedia](https://en.wikipedia.org/wiki/Access_key) article. + General ------- * p: profile diff --git a/doc/Bugs-and-Issues.md b/doc/Bugs-and-Issues.md index e2665be41..04ce0fd1a 100644 --- a/doc/Bugs-and-Issues.md +++ b/doc/Bugs-and-Issues.md @@ -10,6 +10,7 @@ You can also contact the [friendica support forum](https://helpers.pyxis.uberspa Bugs are rarely limited to one person, and the chances are somebody from another node has encountered the problem too, and will be able to help you. If you're a technical user, or your site doesn't have a support page, you'll need to use the [Bug Tracker](https://github.com/friendica/friendica/issues). +This is also used for issues with addons. 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. @@ -17,4 +18,4 @@ It's generally better to provide too much information than not enough. See [this article](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) to learn more about submitting **good** bug reports. The better your bug report, the more likely we are to be able to actually fix it. -And last but not least: It is better to report an issue you encountered even if you can't write the perfect bug report! \ No newline at end of file +And last but not least: It is better to report an issue you encountered even if you can't write the perfect bug report! diff --git a/doc/Github.md b/doc/Github.md index cfdb01476..d83c295fc 100644 --- a/doc/Github.md +++ b/doc/Github.md @@ -66,5 +66,8 @@ Don't assume that a simple fix won't break anything else. If possible get an experienced Friendica developer to review the code. Don't hesitate to ask us in case of doubt. +3. Check your code for typos. +There is a PHP script in the *util* directory called *typos.php* for this. + Check out how to work with [our Vagrant](help/Vagrant) to save a lot of setup time! diff --git a/doc/Groups-and-Privacy.md b/doc/Groups-and-Privacy.md index ddde9eeb2..d8d5a3d8f 100644 --- a/doc/Groups-and-Privacy.md +++ b/doc/Groups-and-Privacy.md @@ -4,66 +4,109 @@ Groups and Privacy * [Home](help) -Groups are merely collections of friends. But Friendica uses these to unlock some very powerful features. +Groups are merely collections of friends. +But Friendica uses these to unlock some very powerful features. **Setting Up Groups** -To create a group, visit your Friendica "Contacts" page and select "Create a new group". Give the group a name. +To create a group, visit your Friendica "Contacts" page and select "Create a new group". +Give the group a name. This brings you to a page where you can select the group members. -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. +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. +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. **Access Control** -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. +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. +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. +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. **Default Post Privacy** -By default, Friendica assumes that you want all of your posts to be private. Therefore, when you sign up, Friendica creates a group for you that it will automatically add all of your contacts to. All of your posts are restricted to that group by default. +By default, Friendica assumes that you want all of your posts to be private. +Therefore, when you sign up, Friendica creates a group for you that it will automatically add all of your contacts to. +All of your posts are restricted to that group by default. -Note that this behavior can be overridden by your site admin, in which case your posts will be "public" (i.e. visible to the entire Internet) by default. +Note that this behaviour can be overridden by your site admin, in which case your posts will be "public" (i.e. visible to the entire Internet) by default. -If you want your posts to be "public" by default, you can change your default post permissions on your Settings page. You also have the option there to change which groups you post to by default, or to change which group your new contacts get placed into by default. +If you want your posts to be "public" by default, you can change your default post permissions on your Settings page. +You also have the option there to change which groups you post to by default, or to change which group your new contacts get placed into by default. **Privacy Concerns To Be Aware Of** -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. +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. +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 GNU Social 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. +But it isn't as clear cut when dealing with GNU Social and other network providers. +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. -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. +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. +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, Photos, and Privacy ============================= -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. +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. **Photos** -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. +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. +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. **Profiles** -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. +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 or App.net. 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. +This may produce undesired results when posting a long status message to (for instance) Twitter. +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. +You can do so by including the BBCode tag *abstract* in your posting. -Blocking your profile or entire Friendica site from unknown web visitors also has serious implications for communicating with GNU Social 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 GNU Social) and feed readers such as Google Reader. +Blocking your profile or entire Friendica site from unknown web visitors also has serious implications for communicating with GNU Social 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 GNU Social) and feed readers such as Google Reader. diff --git a/doc/Move-Account.md b/doc/Move-Account.md index 19e6f1155..ef8509d8c 100644 --- a/doc/Move-Account.md +++ b/doc/Move-Account.md @@ -25,3 +25,5 @@ GNU Social/Diaspora contacts --- Contacts on GNU Social or Diaspora will be archived, as we can't inform them about your move. You should ask them to remove your contact from their lists and re-add you, and you should do the same with their contact. + +Support for the Diaspora account moving is scheduled for the 3.6 release of Friendica. diff --git a/doc/Plugins.md b/doc/Plugins.md index 3a25dc721..ab8c58eb8 100644 --- a/doc/Plugins.md +++ b/doc/Plugins.md @@ -36,6 +36,9 @@ 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. +Please also add a README or README.md file to the addon directory. +It will be displayed in the admin panel and should include some further information in addition to the header information. + Arguments --- Your hook callback functions will be called with at least one and possibly two arguments diff --git a/doc/Quick-Start-groupsandpages.md b/doc/Quick-Start-groupsandpages.md index 9beb2ff4c..652407d64 100644 --- a/doc/Quick-Start-groupsandpages.md +++ b/doc/Quick-Start-groupsandpages.md @@ -1,8 +1,17 @@ -This is the global directory. If you get lost, you can click this link to bring yourself back here. +This is the global directory. +If you get lost, you can click this link 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! +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. +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, move on to the next section. diff --git a/doc/Quick-Start-guide.md b/doc/Quick-Start-guide.md index 47537a3e8..5c88ffaa0 100644 --- a/doc/Quick-Start-guide.md +++ b/doc/Quick-Start-guide.md @@ -1,10 +1,20 @@ -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. +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. +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. +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 Network Tab diff --git a/doc/Quick-Start-makingnewfriends.md b/doc/Quick-Start-makingnewfriends.md index d3911266c..39edd19b4 100644 --- a/doc/Quick-Start-makingnewfriends.md +++ b/doc/Quick-Start-makingnewfriends.md @@ -1,10 +1,20 @@ -This is your Suggested Friends page. If you get lost, you can click this link to bring yourself back here. +This is your Suggested Friends page. +If you get lost, you can click this link 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! +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. +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 Groups and Pages come in! +Feel uncomfortable adding people you don't know? +Don't worry - that's where Groups and Pages come in! diff --git a/doc/Quick-Start-network.md b/doc/Quick-Start-network.md index b456135e2..e0c138d2b 100644 --- a/doc/Quick-Start-network.md +++ b/doc/Quick-Start-network.md @@ -1,6 +1,11 @@ -This is your Network Tab. If you get lost, you can click this link to bring yourself back here. +This is your Network Tab. +If you get lost, you can click this link 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. +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 make some new friends. diff --git a/doc/Remove-Account.md b/doc/Remove-Account.md index 4b4853b6b..eab4ab059 100644 --- a/doc/Remove-Account.md +++ b/doc/Remove-Account.md @@ -13,7 +13,8 @@ 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 blocked to all probing. Unlike some social networks we do **not** hold onto it for a grace period in case you change your mind. -All your content and user data, etc is instantly removed. For all intents and purposes, the account is gone in moments. +All your content and user data, etc is instantly removed. +For all intents and purposes, the account is gone in moments. We then send out an "unfriend" signal to all of your contacts. This signal deletes all content on those networks.