From 13fb987b04bc5a695df433e53e6d5f966ec355c5 Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 13 Nov 2013 16:30:20 -0800 Subject: some minor documentation updates and corrections --- doc/Account-Basics.md | 12 +++++------- doc/Channels.md | 6 +++--- doc/Connecting-to-Channels.md | 18 +++++++++++++----- doc/Permissions.md | 12 +++++++----- mod/magic.php | 2 ++ 5 files changed, 30 insertions(+), 20 deletions(-) diff --git a/doc/Account-Basics.md b/doc/Account-Basics.md index 56b3eef0c..5d937cb1c 100644 --- a/doc/Account-Basics.md +++ b/doc/Account-Basics.md @@ -6,7 +6,7 @@ Account Basics **Registration** -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. +Not all Red Matrix 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. On some sites it may redirect you to another site which allow registrations. As all Red Matrix sites are linked, it does not matter where your account resides. *Your Email Address* @@ -14,26 +14,24 @@ Please provide a valid email address. Your email address is **never** published. *Password* -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. +Enter a password of your choice, and repeat it in the second box to ensure it was typed correctly. As the Red Matrix offers a decentralised identity, your account can log you in to many other websites. -*Terms Of Servive* +*Terms Of Service* 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. 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. +Once you have provided the necessary details, click the 'Register' button. 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* -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 +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 brief 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 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. **See Also** -* [Tips for New Members](newmember) - this link will show up on your home page for two weeks to provide some important Getting Started information. - * [Permissions](help/Permissions) * [Profiles](help/Profiles) diff --git a/doc/Channels.md b/doc/Channels.md index b372cbbcf..152e6aba1 100644 --- a/doc/Channels.md +++ b/doc/Channels.md @@ -16,12 +16,12 @@ 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. +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 nickname@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. +Once you have done this, your channel is ready to use. At https://yourdomain/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 areas 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 +As mentioned at the start, many other kinds of channel are possible, however, the creation procedure is the same. The difference between channels lies primarily in the permissions assigned. For example, a channel for sharing documents with colleagues at work 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 index 68de9d224..4fe2a0789 100644 --- a/doc/Connecting-to-Channels.md +++ b/doc/Connecting-to-Channels.md @@ -1,12 +1,20 @@ 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? +Connections in the Red Matrix can take on a great many different meanings. But let's keep it simple, you want to be friends with somebody like you are familiar with from social networking. 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 available 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. +The next thing you can do is look at the Directory. The directory is available on every Red Matrix 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: +To connect with other Red Matrix channels: -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 +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 usually 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. Once you've initiated the connection, you will be taken to the connection editor. This allows you to assign specific permissions for this channel. If you don't allow any permissions, communication will be very limited. There are some quick links which you can use to avoid setting individual permissions. To provide a social network environment, "Full Sharing" is recommended. You may review the settings that are applied with the quick links to ensure they are suitable for the channel you are connecting with and adjust if necessary. Then scroll to the bottom of the page and click "Submit". + +You may also connect with any channel by visiting the "Connections" page of your site or the Directory and typing their "webbie" into the "Add New Connection" field. Use this method if somebody tells you their webbie and you wish to connect with them. A webbie looks like an email address; for example "bob@example.com". The process is the same as connecting via the "Connect" button - you will then be taken to the connection editor to set permissions. + +**Premium Channels** + +Some channels are designated "Premium Channels" and **may** require some action on your part before a connection can be established. The Connect button will for these channels will take you to a page which lists in detail what terms the channel owner has set. If the terms are accepted, the connection will then proceed normally. In some cases, such as with celebrities and world-reknowned publishers, this **may** involve payment. If you do not agree to the terms, the connection will not proceed, or it may proceed but with reduced permissions allowed on your interactions with that channel. + + \ No newline at end of file diff --git a/doc/Permissions.md b/doc/Permissions.md index 155014311..25a4ac130 100644 --- a/doc/Permissions.md +++ b/doc/Permissions.md @@ -4,7 +4,7 @@ Permissions in the Red Matrix are more complete than you may be used to. This a **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. +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, therefore no way to reply to them. The scopes of permissions are: @@ -12,7 +12,7 @@ The scopes of permissions are: - _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 in this network_. Anybody in the Red Matrix will have this permission approved. Even complete strangers. However, anybody not logged in/authenticated will have this permission denied. - _Anybody on the internet_. Completely public. This permission will be approved for anybody at all. The individual permissions are: @@ -34,10 +34,12 @@ The individual permissions are: - _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. +Plugins/addons may provide special permission settings, so you may be offered additional permission settings beyond what is described here. + +If you have set any of these permissions to "only those I specifically allow", you may specify indivudal permissions on the connnection 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 connection edit screen offers a slider to select a degree of friendship with the connnection (this tool is enabled through the "Extra Features" tab of your Settings page). Think of this as a measure of how much you like or dislike them. 1 is for people you like, whose posts you want to see all the time. 99 is for people you don't care for, and whose posts you might only wish to look at occasionally. Once you've assigned a value here, you can use the affinity tool on the matrix 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. Affinity has no relation to permissions, and is only useful in conjunction with the affinity tool feature. +The slider on the matrix page has both a minimum and maximum value. Posts will only be shown from people who fall between this range. Affinity has no relation to permissions, and is only useful in conjunction with the affinity tool feature. diff --git a/mod/magic.php b/mod/magic.php index 44aa19ead..623a80751 100644 --- a/mod/magic.php +++ b/mod/magic.php @@ -6,6 +6,8 @@ function magic_init(&$a) { logger('mod_magic: invoked', LOGGER_DEBUG); + logger('mod_magic: args: ' . print_r($_REQUEST,true),LOGGER_DATA); + $addr = ((x($_REQUEST,'addr')) ? $_REQUEST['addr'] : ''); $hash = ((x($_REQUEST,'hash')) ? $_REQUEST['hash'] : ''); $dest = ((x($_REQUEST,'dest')) ? $_REQUEST['dest'] : ''); -- cgit v1.2.3