diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Account-Basics.md | 41 | ||||
| -rw-r--r-- | doc/Channels.md | 27 | ||||
| -rw-r--r-- | doc/Cloud.md | 53 | ||||
| -rw-r--r-- | doc/about.bb | 8 | ||||
| -rw-r--r-- | doc/account_basics.bb | 2 | ||||
| -rw-r--r-- | doc/accounts.bb | 2 | ||||
| -rw-r--r-- | doc/accounts_profiles_channels_basics.bb | 4 | ||||
| -rw-r--r-- | doc/addons.bb | 2 | ||||
| -rw-r--r-- | doc/addons_gnusocial.bb | 2 | ||||
| -rw-r--r-- | doc/api_functions.bb | 2 | ||||
| -rw-r--r-- | doc/api_functions.md | 138 | ||||
| -rw-r--r-- | doc/bbcode.html | 2 | ||||
| -rw-r--r-- | doc/channels.bb | 2 | ||||
| -rw-r--r-- | doc/checking_account_quota_usage.bb | 21 | ||||
| -rw-r--r-- | doc/cloud.bb | 2 |
15 files changed, 20 insertions, 288 deletions
diff --git a/doc/Account-Basics.md b/doc/Account-Basics.md deleted file mode 100644 index c4a8f3bc4..000000000 --- a/doc/Account-Basics.md +++ /dev/null @@ -1,41 +0,0 @@ -Account Basics -============== - -* [Home](help) - - -**Registration** - -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* - -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. - -*Password* - -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 Service* - -Click the link to read the site's terms of service. Once you've read them, tick the box in the register form to confirm. - -*Register* - -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 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** - -* [Permissions](help/Permissions) - -* [Profiles](help/Profiles) - -* [Remove Account](help/Remove-Account) - - diff --git a/doc/Channels.md b/doc/Channels.md deleted file mode 100644 index 152e6aba1..000000000 --- a/doc/Channels.md +++ /dev/null @@ -1,27 +0,0 @@ -**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 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 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 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/Cloud.md b/doc/Cloud.md deleted file mode 100644 index ae1e3c754..000000000 --- a/doc/Cloud.md +++ /dev/null @@ -1,53 +0,0 @@ -Personal Cloud Storage -====================== - - -The Red Matrix provides an ability to store privately and/or share arbitrary files with friends. - -You may either upload files from your computer into your storage area, or copy them directly from the operating system using the WebDAV protocol. - -On many public servers there may be limits on disk usage. - - -**File Attachments** - -The quickest and easiest way to share files is through file attachments. In the row of icons below the status post editor is a tool to upload attachments. Click the tool, select a file and submit. After the file is uploaded, you will see an attachment code placed inside the text region. Do not edit this line or it may break the ability for your friends to see the attachment. You can use the post permissions dialogue box or privacy hashtags to restrict the visibility of the file - which will be set to match the permissions of the post your are sending. - -To delete attachments or change the permissions on the stored files, visit "filestorage/$channel_nickname" replacing $channel_nickname with the nickname you provided during channel creation. - -**Web Access** - -Your files are visible on the web at the location "cloud/$channel_nickname" to anybody who is allowed to view them. If the viewer has sufficient privileges, they may also have the ability to create new files and folders/directories. - - -**WebDAV access** - -This varies by operating system. - - -*Windows* - -In Windows, open the Windows Explorer (file manager) and type "$yoursite\cloud\$channel_nickname" into the address bar. Replace $yoursite with the URL to your Red Matrix hub and $channel_nickname with the nickname for your channel. - -You will be prompted for a username and password. For the username, you may supply either your account email address (which will select the default channel), or a channel nickname for the channel you wish to authenticate as. In either case use your account password for the password field. You will then be able to copy, drag/drop, edit, delete and otherwise work with files as if they were an attached disk drive. - -*Linux KDE* - -Simply log in to your hub as normal using Konqueror. Once logged in, visit webdavs://$yoursite/cloud. No further authentication is required. - -*Linux GNOME* - -Open a File browsing window (that's Nautilus), Select File > Connect to server from the menu. Type davs://$yoursite/cloud/$channel_nickname and click Connect. You will be prompted for your username and password. For the username, you may supply either your account email address (which will select the default channel) or a channel nickname. - - -*See Also* - -- [Linux - Mounting the cloud as a file system](help/dav_davfs2) - -**Permissions** - -When using WebDAV, the file is created with your channel's default file permissions and this cannot be changed from within the operating system. It also may not be as restrictive as you would like. What we've found is that the preferred method of making files private is to first create folders or directories; then visit "filestorage/$channel_nickname"; select the directory and change the permissions. Do this before you put anything into the directory. The directory permissions take precedence so you can then put files or other folders into that container and they will be protected from unwanted viewers by the directory permissions. It is common for folks to create a "personal" or "private" folder which is restricted to themselves. You can use this as a personal cloud to store anything from anywhere on the web or any computer and it is protected from others. You might also create folders for "family" and "friends" with permission granted to appropriate collections of channels. - - - - diff --git a/doc/about.bb b/doc/about.bb index c80104e20..aa4fde54d 100644 --- a/doc/about.bb +++ b/doc/about.bb @@ -14,11 +14,11 @@ In other words, the Red Matrix can run on any computing platform that comes with Along the way, Red offers a number of unique goodies:
-[b][color= grey]Single-click user identification:[/color][/b] meaning you can access sites on the Red Matrix simply by clicking on links to remote sites. Authentication just happens automagically behind the scenes. Forget about remembering multiple user names with multiple passwords when accessing different sites online.
+[b]Single-click user identification:[/b] meaning you can access sites on the Red Matrix simply by clicking on links to remote sites. Authentication just happens automagically behind the scenes. Forget about remembering multiple user names with multiple passwords when accessing different sites online.
-[b][color= grey]Cloning:[/color][/b] of online identities. Your online presence no longer has to be tied to a single server, domain name or IP address. You can clone and import your identity (or channel as we call it) to another server (or, a hub as servers are known in the Red Matrix). Now, should your primary hub go down, no worries, your contacts, posts[i]*[/i], and messages[i]*[/i] will automagically continue to be available and accessible under your cloned channel. [i](*: only posts and messages as from the moment you cloned your channel)[/i]
+[b]Cloning:[/b] of online identities. Your online presence no longer has to be tied to a single server, domain name or IP address. You can clone and import your identity (or channel as we call it) to another server (or, a hub as servers are known in the Red Matrix). Now, should your primary hub go down, no worries, your contacts, posts[i]*[/i], and messages[i]*[/i] will automagically continue to be available and accessible under your cloned channel. [i](*: only posts and messages as from the moment you cloned your channel)[/i]
-[b][color= grey]Privacy:[/color][/b] Red identities (Zot IDs) can be deleted, backed up/downloaded, and cloned. The user is in full control of their data. Should you decide to delete all your content and erase your Zot ID, all you have to do is click on a link and it's immediately deleted from the hub. No questions, no fuss.
+[b]Privacy:[/b] Red identities (Zot IDs) can be deleted, backed up/downloaded, and cloned. The user is in full control of their data. Should you decide to delete all your content and erase your Zot ID, all you have to do is click on a link and it's immediately deleted from the hub. No questions, no fuss.
-Return to the [url=[baseurl]/help/main]Main documentation page[/url]
+Return to the [zrl=[baseurl]/help/main]Main documentation page[/zrl]
diff --git a/doc/account_basics.bb b/doc/account_basics.bb index 902ff8bd0..3c5d28fbc 100644 --- a/doc/account_basics.bb +++ b/doc/account_basics.bb @@ -30,4 +30,4 @@ See Also [zrl=[baseurl]/help/permissions]Permissions[/zrl]
[zrl=[baseurl]/help/profiles]Profiles[/zrl]
-[zrl=[baseurl]/help/remove_account]Remove Account[/zrl]
\ No newline at end of file +[zrl=[baseurl]/help/remove_account]Remove Account[/zrl]
diff --git a/doc/accounts.bb b/doc/accounts.bb index 658d8e995..bf57f1234 100644 --- a/doc/accounts.bb +++ b/doc/accounts.bb @@ -1,4 +1,4 @@ This one still needs to be written. -Return to the [url=[baseurl]/help/main]Main documentation page[/url] +Return to the [zrl=[baseurl]/help/main]Main documentation page[/zrl] diff --git a/doc/accounts_profiles_channels_basics.bb b/doc/accounts_profiles_channels_basics.bb index 69125464a..f803f25e9 100644 --- a/doc/accounts_profiles_channels_basics.bb +++ b/doc/accounts_profiles_channels_basics.bb @@ -7,7 +7,7 @@ You have [i]one[/i] account. This consists of your email account and your passwo [i]Think of your account as the way you authenticate at one Red Matrix site. It lets you do things, such as creating profiles and channels with which you can connect to other people.[/i] [b]Profile[/b] -You surely have registered with some other internet services, such as forums or online communities. For all of them you provided some information about yourself, such as date of birth, country, age and the likes. If you like you can see your profile here: [baseurl]/profile/[observer.webname] and edit it by clicking on the pencil icon next to your avatar image. +You have surely registered with some other internet services, such as forums or online communities. For all of them you provided some information about yourself, such as date of birth, country, age and the likes. If you like you can see your profile here: [baseurl]/profile/[observer.webname] and edit it by clicking on the pencil icon next to your avatar image. Unlike other services Red Matrix offers you the advantage of creating [i]many more profiles[/i]. That way you are able to distinguish between profiles targeted specially at everyone (your public profile), your work mates, your family and your partner. [i]Think of your profile as the basic information about yourself you tell other people.[/i] @@ -15,5 +15,5 @@ Unlike other services Red Matrix offers you the advantage of creating [i]many mo During the registration you created your first [i]channel[/i]. Yes, besides several profiles you are able to have several channels. This might be a bit confusing in the beginning, but let's clear things up. You already have created one channel. You can use this one for the public, to communicate with people about every day life. But perhaps you are an avid book reader and many people are bored by that. So you open a [i]second channel[/i] just for the book lovers, where you all can talk about books as much as you like. Obviously this is a new stream of posts, with a new profile (... or new profile[i]s[/i] ...) and completely different contacts. Some connections might exist in both channels, but there will be some that are exclusive to only one of both. You yourself just switch between both of them just like you would in real life switch when talking to people you meet on the street or people you meet specially to talk about books. You can even connect to yourself, or better: to your other channel. :) [i]Think of a channel as different spaces dedicated to different topics where you meet with different people.[/i] -Return to the [url=[baseurl]/help/main]Main documentation page[/url] +Return to the [zrl=[baseurl]/help/main]Main documentation page[/zrl] diff --git a/doc/addons.bb b/doc/addons.bb index 9c3a5458e..a4b76929b 100644 --- a/doc/addons.bb +++ b/doc/addons.bb @@ -1,5 +1,5 @@ * [zrl=[baseurl]/help/addons_gnusocial]Posting To Gnu Social[/zrl] -Return to the [url=[baseurl]/help/main]Main documentation page[/url] +Return to the [zrl=[baseurl]/help/main]Main documentation page[/zrl] diff --git a/doc/addons_gnusocial.bb b/doc/addons_gnusocial.bb index ca5596351..664f1df39 100644 --- a/doc/addons_gnusocial.bb +++ b/doc/addons_gnusocial.bb @@ -60,5 +60,5 @@ If you don't choose this option, you will have an option to send a post to your If all goes well, you have just cross-posted your RedMatrix post to your account on a GNUsocial instance. -Return to the [url=[baseurl]/help/main]Main documentation page[/url] +Return to the [zrl=[baseurl]/help/main]Main documentation page[/zrl] diff --git a/doc/api_functions.bb b/doc/api_functions.bb index acdf9d6a7..ade6efd42 100644 --- a/doc/api_functions.bb +++ b/doc/api_functions.bb @@ -129,5 +129,5 @@ Red proposed API extensions to the Twitter API api/albums/destroy (R),J
api/friends/permissions (R),J
-Return to the [url=[baseurl]/help/main]Main documentation page[/url]
+Return to the [zrl=[baseurl]/help/main]Main documentation page[/zrl]
diff --git a/doc/api_functions.md b/doc/api_functions.md deleted file mode 100644 index 8c63770e6..000000000 --- a/doc/api_functions.md +++ /dev/null @@ -1,138 +0,0 @@ -Red Twitter API -=============== - -The "basic" Red web API is based on the Twitter API, as this provides instant compatibility with a huge number of third-party clients and applications without requiring any code changes on their part. It is also a super-set of the StatusNet version of the Twitter API, as this also has existing wide support. - -Red has a lot more capability that isn't exposed in the Twitter interfaces or where we are forced to "dumb-down" the API functions to work with the primitive Twitter/StatusNet communications and privacy model. So we plan to extend the Twitter API in ways that will allow Red-specific clients to make full use of Red features without being crippled. - -A dedicated Red API is also being developed to work with native data structures and permissions and which do not require translating to different privacy and permission models and storage formats. This will be described in other documents. The prefix for all of the native endpoints is 'api/red'. - -Red provides multiple channels accesible via the same login account. With Red, any API function which requires authentication will accept a parameter &channel={channel_nickname} - and will select that channel and make it current before executing the API command. By default, the default channel associated with an account is selected. - -Red also provides an extended permission model. In the absence of any Red specific API calls to set permissions, they will be set to the default permissions settings which are associated with the current channel. - -Red will probably never be able to support the Twitter 'api/friendships' functions fully because Red is not a social network and has no concept of "friendships" - it only recognises permissions to do stuff (or not do stuff as the case may be). - -Legend: T= Twitter, S= StatusNet, F= Friendica, R= Red, ()=Not yet working, J= JSON only (XML formats deprecated) - - - -Twitter API compatible functions: - -* api/account/verify_credentials T,S,F,R -* api/statuses/update T,S,F,R -* api/users/show T,S,F,R -* api/statuses/home_timeline T,S,F,R -* api/statuses/friends_timeline T,S,F,R -* api/statuses/public_timeline T,S,F,R -* api/statuses/show T,S,F,R -* api/statuses/retweet T,S,F,R -* api/statuses/destroy T,S,F,(R) -* api/statuses/mentions T,S,F,(R) -* api/statuses/replies T,S,F,(R) -* api/statuses/user_timeline T,S,F,(R) -* api/favorites T,S,F,(R) -* api/account/rate_limit_status T,S,F,R -* api/help/test T,S,F,R -* api/statuses/friends T,S,F,R -* api/statuses/followers T,S,F,R -* api/friends/ids T,S,F,R -* api/followers/ids T,S,F,R -* api/direct_messages/new T,S,F,(R) -* api/direct_messages/conversation T,S,F,(R) -* api/direct_messages/all T,S,F,(R) -* api/direct_messages/sent T,S,F,(R) -* api/direct_messages T,S,F,(R) -* api/oauth/request_token T,S,F,R -* api/oauth/access_token T,S,F,R - - -Twitter API functions supported by StatusNet but not currently by Friendica or Red - -* api/favorites T,S -* api/favorites/create T,S -* api/favorites/destroy T,S -* api/statuses/retweets_of_me T,S -* api/friendships/create T,S -* api/friendships/destroy T,S -* api/friendships/exists T,S -* api/friendships/show T,S -* api/account/update_location T,S -* api/account/update_profile_background_image T,S -* api/account/update_profile_image T,S -* api/blocks/create T,S -* api/blocks/destroy T,S - -Twitter API functions not currently supported by StatusNet - -* api/statuses/retweeted_to_me T -* api/statuses/retweeted_by_me T -* api/direct_messages/destroy T -* api/account/end_session T,(R) -* api/account/update_delivery_device T -* api/notifications/follow T -* api/notifications/leave T -* api/blocks/exists T -* api/blocks/blocking T -* api/lists T - - -Statusnet compatible extensions to the Twitter API supported in both Friendica and Red - -* api/statusnet/version S,F,R -* api/statusnet/config S,F,R - -Friendica API extensions to the Twitter API supported in both Friendica and Red - -* api/statuses/mediap F,R - - -Red specific API extensions to the Twitter API not supported in Friendica - -* api/account/logout R -* api/export/basic R,J -* api/friendica/config R -* api/red/config R -* api/friendica/version R -* api/red/version R - -* api/red/channel/export/basic R,J -* api/red/channel/stream R,J (currently post only) -* api/red/albums R,J -* api/red/photos R,J (option album=xxxx) - - -Red proposed API extensions to the Twitter API - -* api/statuses/edit (R),J -* api/statuses/permissions (R),J -* api/statuses/permissions/update (R),J -* api/statuses/ids (R),J # search for existing message_id before importing a foreign post -* api/files/show (R),J -* api/files/destroy (R),J -* api/files/update (R),J -* api/files/permissions (R),J -* api/files/permissions/update (R),J -* api/pages/show (R),J -* api/pages/destroy (R),J -* api/pages/update (R),J -* api/pages/permissions (R),J -* api/pages/permissions/update (R),J -* api/events/show (R),J -* api/events/update (R),J -* api/events/permissions (R),J -* api/events/permissions/update (R),J -* api/events/destroy (R),J -* api/photos/show (R),J -* api/photos/update (R),J -* api/photos/permissions (R),J -* api/photos/permissions/update (R),J -* api/albums/destroy (R),J -* api/albums/show (R),J -* api/albums/update (R),J -* api/albums/permissions (R),J -* api/albums/permissions/update (R),J -* api/albums/destroy (R),J -* api/friends/permissions (R),J - - diff --git a/doc/bbcode.html b/doc/bbcode.html index 63e364421..97a0bbc6c 100644 --- a/doc/bbcode.html +++ b/doc/bbcode.html @@ -65,7 +65,7 @@ <li>[rpost=title]Text to post[/rpost] The observer will be returned to their home hub to enter a post with the specified title and body. Both are optional <br /> <li>[qr]text to post[/qr] - create a QR code.<br /> -<br> +<br /> Return to the <a href="/help/main">Main documentation page[/a] </div> diff --git a/doc/channels.bb b/doc/channels.bb index 780589f04..42253a664 100644 --- a/doc/channels.bb +++ b/doc/channels.bb @@ -26,5 +26,5 @@ The "Matrix" page contains all recent posts from across the matrix, ag 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.
-Return to the [url=[baseurl]/help/main]Main documentation page[/url]
+Return to the [zrl=[baseurl]/help/main]Main documentation page[/zrl]
diff --git a/doc/checking_account_quota_usage.bb b/doc/checking_account_quota_usage.bb index 00cbc98e3..51bf69b27 100644 --- a/doc/checking_account_quota_usage.bb +++ b/doc/checking_account_quota_usage.bb @@ -4,23 +4,14 @@ Your hub might implement service class limits, assigning limits to the total siz Here's how you can quickly check how much of your assigned quota you're currently using:
-[b][color= grey]Check file storage quota levels[/color][/b]
+[b]Check file storage quota levels[/b]
Visit the following URL in your browser:
-[code]
-https://{Red-domain}/filestorage/{your_username}
-[/code]
+[observer.baseurl]/filestorage/webname
-Example:
-[code]https://friendicared.net/filestorage/test2
-[/code]
-
-[b][color= grey]Check uploaded photos storage quota levels[/color][/b]
-[code]
-https://{Red-domain}photos/{your_username}/upload/
-[/code]
+[b]Check uploaded photos storage quota levels[/b]
+[observer.baseurl]/photos/webname
Example:
-[code]https://friendicared.net/photos/test2/upload/
-[/code]
+[observer.baseurl]/filestorage/webname
-Return to the [url=[baseurl]/help/main]Main documentation page[/url]
+Return to the [zrl=[baseurl]/help/main]Main documentation page[/zrl]
diff --git a/doc/cloud.bb b/doc/cloud.bb index 8690ba031..e71da78e8 100644 --- a/doc/cloud.bb +++ b/doc/cloud.bb @@ -24,4 +24,4 @@ See: [zrl=[baseurl]/help/cloud_desktop_clients]Cloud Desktop Clients[/zrl] When using WebDAV, the file is created with your channel's default file permissions and this cannot be changed from within the operating system. It also may not be as restrictive as you would like. What we've found is that the preferred method of making files private is to first create folders or directories; then visit "filestorage/{{username}}"; select the directory and change the permissions. Do this before you put anything into the directory. The directory permissions take precedence so you can then put files or other folders into that container and they will be protected from unwanted viewers by the directory permissions. It is common for folks to create a "personal" or "private" folder which is restricted to themselves. You can use this as a personal cloud to store anything from anywhere on the web or any computer and it is protected from others. You might also create folders for "family" and "friends" with permission granted to appropriate collections of channels.
-Return to the [url=[baseurl]/help/main]Main documentation page[/url]
+Return to the [zrl=[baseurl]/help/main]Main documentation page[/zrl]
|