diff options
Diffstat (limited to 'doc')
40 files changed, 239 insertions, 45 deletions
diff --git a/doc/accounts.bb b/doc/accounts.bb new file mode 100644 index 000000000..658d8e995 --- /dev/null +++ b/doc/accounts.bb @@ -0,0 +1,4 @@ +This one still needs to be written. + +Return to the [url=[baseurl]/help/main]Main documentation page[/url] + diff --git a/doc/accounts_profiles_channels_basics.bb b/doc/accounts_profiles_channels_basics.bb new file mode 100644 index 000000000..6ba34e771 --- /dev/null +++ b/doc/accounts_profiles_channels_basics.bb @@ -0,0 +1,19 @@ +[size=large][b]Accounts, Profiles and Channels[/b][/size] + +Once you have registered an [i]account[/i] at the matrix you have also created a [i]profile[/i] and a [i]channel[/i]. + +[b]Account[/b] +You have [i]one[/i] account. This consists of your email account and your password. With your account you access your profile and your channel. +[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.name] 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), at your work mates, your family and your partner. +[i]Think of your profile as the basic information about yourself you tell other people.[/i] + +[b]Channel[/b] +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 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] + diff --git a/doc/addons.bb b/doc/addons.bb index 4838c4a27..9c3a5458e 100644 --- a/doc/addons.bb +++ b/doc/addons.bb @@ -1,2 +1,5 @@ * [zrl=[baseurl]/help/addons_gnusocial]Posting To Gnu Social[/zrl] +Return to the [url=[baseurl]/help/main]Main documentation page[/url] + + diff --git a/doc/addons_gnusocial.bb b/doc/addons_gnusocial.bb index 4498d0b83..ca5596351 100644 --- a/doc/addons_gnusocial.bb +++ b/doc/addons_gnusocial.bb @@ -59,3 +59,6 @@ You now have several options to choose, if you desire, and those will need to be If you don't choose this option, you will have an option to send a post to your GNUsocial instance by first opening the post (by clicking in the post text area) and clicking on the lock icon next to the Share button. Select the GNUsocial icon made up of three colored dialog baloons. Close that window, then make your post. 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] + diff --git a/doc/api_functions.bb b/doc/api_functions.bb index 13460c1b9..acdf9d6a7 100644 --- a/doc/api_functions.bb +++ b/doc/api_functions.bb @@ -127,4 +127,7 @@ Red proposed API extensions to the Twitter API api/albums/permissions (R),J
api/albums/permissions/update (R),J
api/albums/destroy (R),J
- api/friends/permissions (R),J
\ No newline at end of file + api/friends/permissions (R),J
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
+
diff --git a/doc/bbcode.html b/doc/bbcode.html index 5692ec0d2..63e364421 100644 --- a/doc/bbcode.html +++ b/doc/bbcode.html @@ -65,7 +65,8 @@ <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> +Return to the <a href="/help/main">Main documentation page[/a] </div> diff --git a/doc/campaign.bb b/doc/campaign.bb index 63a072d42..f3d23baa6 100644 --- a/doc/campaign.bb +++ b/doc/campaign.bb @@ -231,4 +231,7 @@ Raising more than our initial goal of funds, will speed up our development effor [b]12. I have additional Questions[/]
-Awesome. We'd be more than happy to chat. You can find us {HERE}
\ No newline at end of file +Awesome. We'd be more than happy to chat. You can find us {HERE}
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
+
diff --git a/doc/channels.bb b/doc/channels.bb index 3be1211a6..780589f04 100644 --- a/doc/channels.bb +++ b/doc/channels.bb @@ -24,4 +24,7 @@ Once you have done this, your channel is ready to use. At [observer.url] you wil 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 +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]
+
diff --git a/doc/checking_account_quota_usage.bb b/doc/checking_account_quota_usage.bb index 198b15bfd..00cbc98e3 100644 --- a/doc/checking_account_quota_usage.bb +++ b/doc/checking_account_quota_usage.bb @@ -23,4 +23,4 @@ Example: [code]https://friendicared.net/photos/test2/upload/
[/code]
-Return to the [url=[baseurl]/help/main]Main documentation page[/url]
\ No newline at end of file +Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/cloud.bb b/doc/cloud.bb index 8997b88fe..8690ba031 100644 --- a/doc/cloud.bb +++ b/doc/cloud.bb @@ -22,4 +22,6 @@ See: [zrl=[baseurl]/help/cloud_desktop_clients]Cloud Desktop Clients[/zrl] [b]Permissions[/b]
-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.
\ No newline at end of file +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]
diff --git a/doc/comanche.bb b/doc/comanche.bb index e514d6d9e..2ab1d4337 100644 --- a/doc/comanche.bb +++ b/doc/comanche.bb @@ -179,4 +179,6 @@ The 'comment' tag is used to delimit comments. These comments will not appear on [widget]channel[/widget]
[/region]
-[/code]
\ No newline at end of file +[/code]
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/connecting_to_channels.bb b/doc/connecting_to_channels.bb index b81abc7bd..a067b6cf2 100644 --- a/doc/connecting_to_channels.bb +++ b/doc/connecting_to_channels.bb @@ -14,4 +14,6 @@ You may also connect with any channel by visiting the "Connections" pa [b]Premium Channels[/b]
-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 +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.
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/debian_install.bb b/doc/debian_install.bb index b2e74fdde..29be68f01 100644 --- a/doc/debian_install.bb +++ b/doc/debian_install.bb @@ -26,4 +26,6 @@ For intitial server setup run To install Red for domain example.com, after the initial server setup run
-[code]bash setup-debian.sh red example.com[/code]
\ No newline at end of file +[code]bash setup-debian.sh red example.com[/code]
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/dev-function-overview.md b/doc/dev-function-overview.md index 445b4823b..3cda8f7c4 100644 --- a/doc/dev-function-overview.md +++ b/doc/dev-function-overview.md @@ -48,5 +48,5 @@ Returns the translated variant of $string for the current language or $string (d Shorthand test to see if variable $var is set and is not empty. Tests vary by type. Returns false if $var or $key is not set. If variable is set, returns 1 if has 'non-zero' value, otherwise returns 0. -- e.g. x('') or x(0) returns 0; - +Return to the [url=[baseurl]/help/main]Main documentation page[/url] diff --git a/doc/developer_function_primer.bb b/doc/developer_function_primer.bb index 8a41c81f4..144664615 100644 --- a/doc/developer_function_primer.bb +++ b/doc/developer_function_primer.bb @@ -42,4 +42,6 @@ Returns the translated variant of $string for the current language or $string (d [b]x($var), $x($array,$key)[/b]
-Shorthand test to see if variable $var is set and is not empty. Tests vary by type. Returns false if $var or $key is not set. If variable is set, returns 1 if has 'non-zero' value, otherwise returns 0. -- e.g. x('') or x(0) returns 0;
\ No newline at end of file +Shorthand test to see if variable $var is set and is not empty. Tests vary by type. Returns false if $var or $key is not set. If variable is set, returns 1 if has 'non-zero' value, otherwise returns 0. -- e.g. x('') or x(0) returns 0;
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/developers.bb b/doc/developers.bb index ae3d4aa90..a29a848e0 100644 --- a/doc/developers.bb +++ b/doc/developers.bb @@ -64,4 +64,4 @@ In the interests of consistency we adopt the following code styling. We may acce [li] Generally speaking, opening braces go on the same line as the thing which opens the brace. They are the last character on the line. Closing braces are on a line by themselves. [/li]
-
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/encryption.bb b/doc/encryption.bb new file mode 100644 index 000000000..3eee7a452 --- /dev/null +++ b/doc/encryption.bb @@ -0,0 +1,16 @@ +[size=large]Builtin Automatic Encryption Plus Super-Safe Encryption[/size] + +Full disclosure: The encryption Red Matrix uses per default is not absolutely waterproof. There [i]are[/i] known procedures to circumvent it. [i]But[/i] this takes a lot of effort and needs to be done individually for each channel. And to make this clear: Other services store your messages in plaintext, therefore we regard this approach as a [i]significant[/i] improvement for your privacy. Plus you are always free to use further encryption and password protection if you so desire. + +To explain this in more detail: + +- each channel has its key pair +- every non-public post is automatically encrypted +- optional password protected super-safe encryption (needs to be enabled in settings) + +So what is the scope of security? Full disclosure: This might be great, but it is not perfect. +- every non-public post is automatically encrypted but persons who have access to the site's database and files [i]may[/i] be able to decrypt everything by usig these keys which obviously need to be stored on the server. To be clear: The encrypion keys are different for every channel and it is [i]quite an effort[/i] to do this. And again: Other services store your messages in plain text unencrypted. So this [i]is[/i] quite a significant win for your privacy. +So if you require super tight encryption enable ... and protect your posting with a password only you and the adressee(s) know. This way even people with access to the database and server ... + + +... needs to be written ... diff --git a/doc/external-resource-links.bb b/doc/external-resource-links.bb index e4173304c..787598c8a 100644 --- a/doc/external-resource-links.bb +++ b/doc/external-resource-links.bb @@ -19,3 +19,5 @@ [b]Utilities[/b]
[*][url=http://beardyunixer.com:1234/?p=debian-install-script.git;a=tree]Debian Install Script[/url]
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/extra_features.bb b/doc/extra_features.bb index 91a16d365..9d900794f 100644 --- a/doc/extra_features.bb +++ b/doc/extra_features.bb @@ -100,4 +100,6 @@ Ability to mark special posts with a star indicator [b]Tag Cloud[/b]
-Provide a personal tag cloud on your channel page
\ No newline at end of file +Provide a personal tag cloud on your channel page
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/faq_admins.bb b/doc/faq_admins.bb new file mode 100644 index 000000000..0bff9983a --- /dev/null +++ b/doc/faq_admins.bb @@ -0,0 +1,8 @@ +[size=large][b]The Red Matrix FAQ[/b][/size] + +(...) still needs to be written (...) + +[ul] +[*][b]Is there a way to change the Admin account?[/b] +Yes. (...) +[/ul] diff --git a/doc/faq_developers.bb b/doc/faq_developers.bb new file mode 100644 index 000000000..192dcb5c5 --- /dev/null +++ b/doc/faq_developers.bb @@ -0,0 +1,28 @@ +[size=large][b]Frequently Asked Questions For Developers[/b][/size] + +(...) still needs to be written (...) + +[ul] +[*][b]What does $a mean?[/b] +$a is a class defined in boot.php and passed all around Red Matrix as a global reference variable. It defines everything necessary for the Red Matrix application: Server variables, URL arguments, page structures, layouts, content, installed plugins, output device info, theme info, identity of the observer and (potential) page owner ... +We don't ever create more than one instance and always modify the elements of the single instance. The mechanics of this are somewhat tricky. If you have a function that is passed $a and needs to modify $a you need to declare it as a reference with '&' e.g. + +[code]function foo(&$a) { $a->something = 'x'; // whatever }; + +*or* access it within your function as a global variable via get_app() + +function foo() { + $a = get_app(); + $a->something = 'x'; +} + + +function foo($a) { $a->something = 'x'; }; + +will *not* change the global app state. + +function foo() { + get_app()->something = 'x'; +} +[/code] +[/ul] diff --git a/doc/faq_users.bb b/doc/faq_users.bb new file mode 100644 index 000000000..405a2e8f9 --- /dev/null +++ b/doc/faq_users.bb @@ -0,0 +1,13 @@ +[size=large][b]The Red Matrix FAQ[/b][/size] + +(...) still needs to be written (...) + +[ul] +[*][b]I am able to edit a post's text after I saved it, but is there a way to change the permissions?[/b] +Short anser: No, there isn't. This has got some resons. You are able to change permissons to your files, photos and the likes, but not to posts after you have saved them. The reason is: Once you have saved a post it is being distributed either to the public channel and from there to other Red Matrix servers or to those you intended it to go. Just like you cannot reclaim a few after you have sold them off to some people, you cannot change permissions to Red Matrix posts. We would need to track everywhere your posting goes, keep track of everyone you allowed to see it and then keep track of from whom to delete it. +If a posting is public this is even harder, as the Red Matrix is a global network and there is no way to follow a post, let alone reclaim it reliably. +Once you have sent out an email there too is no way to take it back. So think wisely and keep alert when posting. :) +[*][b]I downloaded my channel and uploaded it to another site but there is no content, no posts, no photos. What is wrong???[/b] +To be honest: Nothing. That's the way it is right now. Technically it is surely possible to take at least your own posts and maybe even files with you, but this has simply put not implemented yet. When creating this feature we thought that keeping all your contacts was more important. Once we find someone willing to implement this, it will be done. :) +[*] +[/ul] diff --git a/doc/first-post.bb b/doc/first-post.bb new file mode 100644 index 000000000..cf6ed5b49 --- /dev/null +++ b/doc/first-post.bb @@ -0,0 +1,3 @@ +[size=large]Your first posting[/size] + +... to be written ... diff --git a/doc/install.bb b/doc/install.bb index ef9ed2ca6..81fc7f844 100644 --- a/doc/install.bb +++ b/doc/install.bb @@ -100,4 +100,6 @@ one shown, substituting for your unique paths and settings: You can generally find the location of PHP by executing "which php". If you
have troubles with this section please contact your hosting provider for
-assistance. Red will not work correctly if you cannot perform this step.
\ No newline at end of file +assistance. Red will not work correctly if you cannot perform this step.
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/intro_for_developers.bb b/doc/intro_for_developers.bb index 002088be3..086d3c681 100644 --- a/doc/intro_for_developers.bb +++ b/doc/intro_for_developers.bb @@ -96,4 +96,6 @@ Oh, and don't forget to rename the _init function in /php/theme.php to be _init( At that point, if you need to add javascript or css files, add them to /js or /css, and then "register" them in _init() through head_add_js('file.js') and head_add_css('file.css').
-Now you'll probably want to alter a template. These can be found in in /view/tpl OR view//tpl. All you should have to do is copy whatever you want to tweak from the first place to your theme's own tpl directory.
\ No newline at end of file +Now you'll probably want to alter a template. These can be found in in /view/tpl OR view//tpl. All you should have to do is copy whatever you want to tweak from the first place to your theme's own tpl directory.
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/main.bb b/doc/main.bb index b9060c299..45c45139c 100644 --- a/doc/main.bb +++ b/doc/main.bb @@ -1,42 +1,52 @@ -[b]Red Matrix Documentation and Resources[/b]
+[img][baseurl]/assets/hashlogo.png[/img]
-[b]Contents[/b]
+[size=large][b]Red Matrix Documentation[/b][/size]
-[zrl=[baseurl]/help/about]What is the Red Matrix?[/zrl]
-[zrl=[baseurl]/help/features]Red Matrix Features[/zrl]
-[zrl=[baseurl]/help/what_is_zot] What is Zot?[/zrl]
+[zrl=[baseurl]/help/about][b]What is the Red Matrix?[/b][/zrl]
+Red Matrix is a decentralized communication and publishing platform that enables you to keep in control of your communication needs by automatic encryption and finely grained access control. It's you, and only you who decides who is allowed to see your stuff.
-[b]Using the Red Matrix[/b]
+[zrl=[baseurl]/help/features][b]Red Matrix Features[/b][/zrl]
+The Red Matrix is already running as a global distributed network and proves its versatility and scalability from standalone to huge sites on a daily basis.
+Think of standalone family communication platforms, distributed online communities, support forums, blogs and homepages. Or professional content providers with commercial premium channels and targeted content acces. Whatever you want, the Red Matrix is there to cater your creativity.
-[zrl=[baseurl]/help/account_basics]Account Basics[/zrl]
+[zrl=[baseurl]/help/what_is_zot][b]Got Zot? Well, you should.[/b][/zrl]
+Zot is the great new communicaton protocol invented especially for the Red Matrix. As a user you are no longer bound to a single hoster thanks to "Nomadic Identities". Migrate easily to another server and keep your contacts intact, or clone it and run the same channel on several servers. Just in case one of them might shut down, you don't lose out. Plus once you are inside the Red Matrix there is no need for you to authenticate twice, even when accessing another Red Matrix site. Zot is what sets the Red Matrix apart.
+
+[size=large][b]Getting Started[/b][/size]
+[zrl=[baseurl]/help/registration]Account Registration[/zrl]
+[zrl=[baseurl]/help/accounts_profiles_channels_basics]You at the Red Matrix: accounts, profiles and channels in short[/zrl]
[zrl=[baseurl]/help/profiles]Profiles[/zrl]
[zrl=[baseurl]/help/channels]Channels[/zrl]
-[zrl=[baseurl]/help/connecting_to_channels]Connecting to Channels[/zrl]
-[zrl=[baseurl]/help/permissions]Permissions[/zrl]
+[zrl=[baseurl]/help/first-post]Your first posting[/zrl]
+[zrl=[baseurl]/help/connecting_to_channels]Connecting To Other Channels[/zrl]
+[zrl=[baseurl]/help/permissions]Permissions And Encryption: You Are In Control[/zrl]
[zrl=[baseurl]/help/cloud]Cloud Storage[/zrl]
+[zrl=[baseurl]/help/remove_account]Remove Account[/zrl]
-[b]But Wait - There's More. MUCH More...[/b]
-
+[size=large][b]Using the Red Matrix[/b][/size]
[zrl=[baseurl]/help/tags_and_mentions]Tags and Mentions[/zrl]
[zrl=[baseurl]/help/webpages]Web Pages[/zrl]
-[zrl=[baseurl]/help/remove_account]Remove Account[/zrl]
[zrl=[baseurl]/help/bbcode]BBcode reference for posts and comments[/zrl]
[zrl=[baseurl]/help/checking_account_quota_usage]Checking Account Quota Usage[/zrl]
[zrl=[baseurl]/help/cloud_desktop_clients]Cloud Desktop Clients[/zrl]
[zrl=[baseurl]/help/AdvancedSearch]Advanced Directory Search[/zrl]
[zrl=[baseurl]/help/addons]Help With Addons[/zrl]
+[zrl=[baseurl]/help/nomadic-identity]Got Zot? Nomadic Identity, Channel Cloning And More[/zrl]
-[b]For Hub Administrators[/b]
+[size=large][b]Frequently Asked Questions For Users[/b][/size]
+[zrl=[baseurl]/help/faq_users]FAQ For Users[/zrl]
+[size=large][b]For Hub Administrators[/b][/size]
+[zrl=[baseurl]/help/install]Install[/zrl]
[zrl=[baseurl]/help/debian_install]Easy Install on Debian via script[/zrl]
[zrl=[baseurl]/help/red2pi]Installing Red on the Raspberry Pi[/zrl]
[zrl=[baseurl]/help/problems-following-an-update]Problems Following A Software Update[/zrl]
[zrl=[baseurl]/help/troubleshooting]Troubleshooting Tips[/zrl]
+[size=large][b]Frequently Asked Questions For Hub Admins[/b][/size]
+[zrl=[baseurl]/help/faq_admins]FAQ For Admins[/zrl]
-[b]Technical Documentation[/b]
-
-[zrl=[baseurl]/help/install]Install[/zrl]
+[size=large][b]Technical Documentation[/b][/size]
[zrl=[baseurl]/help/comanche]Comanche Page Descriptions[/zrl]
[zrl=[baseurl]/help/Creating-Templates]Creating Comanche Templates[/zrl]
[zrl=[baseurl]/help/Widgets]Core Widgets[/zrl]
@@ -53,13 +63,15 @@ [zrl=[baseurl]/help/to_do_code]To-Do list for Developers[/zrl]
[zrl=[baseurl]/help/git_for_non_developers]Git for Non-Developers[/zrl]
-[b]External Resources[/b]
+[size=large][b]Frequently Asked Questions For Developers[/b][/size]
+[zrl=[baseurl]/help/faq_developers]FAQ For Developers[/zrl]
+
+[size=large][b]External Resources[/b][/size]
[zrl=[baseurl]/help/external-resource-links]External Resource Links[/zrl]
[url=https://github.com/friendica/red]Main Website[/url]
[url=https://github.com/friendica/red-addons]Addon Website[/url]
[url=https://zothub.com/channel/one]Development Channel[/url]
-[b]About[/b]
-
-[zrl=[baseurl]/siteinfo] Site/Version Info[/zrl]
+[size=large][b]About This Red Matrix Site[/b][/size]
+[zrl=[baseurl]/siteinfo] [baseurl]/siteinfo[/zrl]
diff --git a/doc/nomadic-identity.bb b/doc/nomadic-identity.bb new file mode 100644 index 000000000..a062e58c8 --- /dev/null +++ b/doc/nomadic-identity.bb @@ -0,0 +1 @@ +This still needs to be written. diff --git a/doc/permissions.bb b/doc/permissions.bb index 5ca1177cf..8a071a3f5 100644 --- a/doc/permissions.bb +++ b/doc/permissions.bb @@ -106,3 +106,5 @@ If you have set any of these permissions to "only those I specifically allo 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 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.
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/plugins.bb b/doc/plugins.bb index 2440de762..099f9fdf4 100644 --- a/doc/plugins.bb +++ b/doc/plugins.bb @@ -254,4 +254,6 @@ The Red Matrix has _install and _uninstall functions but these are used differen [li] Friendica's "plugin_settings_post" hook is called "feature_settings_post"[/li]
-Changing these will often allow your plugin to function, but please double check all your permission and identity code because the concepts behind it are completely different in the Red Matrix. Many structured data names (especially DB schema columns) are also quite different.
\ No newline at end of file +Changing these will often allow your plugin to function, but please double check all your permission and identity code because the concepts behind it are completely different in the Red Matrix. Many structured data names (especially DB schema columns) are also quite different.
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/profiles.bb b/doc/profiles.bb index e45c25ccb..63b161962 100644 --- a/doc/profiles.bb +++ b/doc/profiles.bb @@ -30,4 +30,6 @@ If you do not wish to be found be people unless you give them your channel addre On the directory page, you may search for people with published profiles. Currently, only the name field and the keywords are searched. You may also include such keywords in your default profile - which may be used to search for common interests with other members. Keywords are used in the channel suggestion tool and although they aren't visible in the directory, they are shown if people visit your profile page.
-On your Connnections page and in the directory there is a link to "Suggestions" or "Channel Suggestions", respectively. This will find channels 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.
\ No newline at end of file +On your Connnections page and in the directory there is a link to "Suggestions" or "Channel Suggestions", respectively. This will find channels 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.
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/red2pi.bb b/doc/red2pi.bb index 2abba8ec5..ac6f2626a 100644 --- a/doc/red2pi.bb +++ b/doc/red2pi.bb @@ -346,4 +346,6 @@ Save and exit. [size=large]6. Running Friendica with SSL[/size]
Follow the instructions here:
-#^[url=https://github.com/friendica/friendica/wiki/Running-Friendica-with-SSL]https://github.com/friendica/friendica/wiki/Running-Friendica-with-SSL[/url]
\ No newline at end of file +#^[url=https://github.com/friendica/friendica/wiki/Running-Friendica-with-SSL]https://github.com/friendica/friendica/wiki/Running-Friendica-with-SSL[/url]
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/registration.bb b/doc/registration.bb new file mode 100644 index 000000000..1649db62e --- /dev/null +++ b/doc/registration.bb @@ -0,0 +1,34 @@ +[size=large][b]Registration[/b][/size]
+
+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.
+
+[b]Your Email Address[/b]
+
+Please provide a valid email address. Your email address is never published. This address will be used to activate your account, to (optionally) send email notifications for incoming messages or items, [/i]and to recover lost passwords[/i].
+
+[b]Password[/b]
+
+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.
+
+[b]Terms Of Service[/b]
+
+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.
+
+[b]Register[/b]
+
+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.
+
+[b]Create a Channel[/b]
+
+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
+[zrl=[baseurl]/help/accounts_profiles_channels_basics]The Basics about Identities within the Red Matrix[/zrl]
+[zrl=[baseurl]/help/accounts]Accounts[/zrl]
+[zrl=[baseurl]/help/profiles]Profiles[/zrl]
+[zrl=[baseurl]/help/permissions]Permissions[/zrl]
+[zrl=[baseurl]/help/remove_account]Remove Account[/zrl]
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/remove_account.bb b/doc/remove_account.bb index 90ef1d7df..8b17816ac 100644 --- a/doc/remove_account.bb +++ b/doc/remove_account.bb @@ -14,4 +14,6 @@ You will need to confirm your password and the channel you are currently logged This is irreversible.
-If you have identity clones on other sites this only removes the channel instance which exists on this site.
\ No newline at end of file +If you have identity clones on other sites this only removes the channel instance which exists on this site.
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/schema_development.bb b/doc/schema_development.bb index 6b2c3d315..2890d5454 100644 --- a/doc/schema_development.bb +++ b/doc/schema_development.bb @@ -71,4 +71,6 @@ theme are as follows: [li] top_photo[/li]
[li] reply_photo[/li]
[li] sloppy_photos
- Determins whether photos are "sloppy" or aligned. Set or unset (1 or '')[/li]
\ No newline at end of file + Determins whether photos are "sloppy" or aligned. Set or unset (1 or '')[/li]
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/tags_and_mentions.bb b/doc/tags_and_mentions.bb index 9d3599bd2..477fbe291 100644 --- a/doc/tags_and_mentions.bb +++ b/doc/tags_and_mentions.bb @@ -65,4 +65,6 @@ will tag Robert Johnson, but we can only match one space. If the name was "Blind @Blind_Lemon_Jefferson
[/code]
-are both equivalent.
\ No newline at end of file +are both equivalent.
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/technical_faq.bb b/doc/technical_faq.bb index 122e82ddb..91830c6ba 100644 --- a/doc/technical_faq.bb +++ b/doc/technical_faq.bb @@ -36,3 +36,5 @@ You have disabled third party cookies. 3) Rsync everything in store/ 4) Rsync everything in custom/ (this will only exist if you have custom modules) 5) Dump and restore DB. + +Return to the [url=[baseurl]/help/main]Main documentation page[/url] diff --git a/doc/to_do_code.bb b/doc/to_do_code.bb index 60c2e5716..efe79f761 100644 --- a/doc/to_do_code.bb +++ b/doc/to_do_code.bb @@ -56,4 +56,6 @@ We need much more than this, but here are areas where developers can help. Pleas [li]Put mod_admin under Comanche[/li]
-In many cases some of the work has already been started and code exists so that you needn't start from scratch. Please contact one of the developer channels like Channel One (one@zothub.com) before embarking and we can tell you what we already have and provide some insights on how we envision these features fitting together.
\ No newline at end of file +In many cases some of the work has already been started and code exists so that you needn't start from scratch. Please contact one of the developer channels like Channel One (one@zothub.com) before embarking and we can tell you what we already have and provide some insights on how we envision these features fitting together.
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/to_do_doco.bb b/doc/to_do_doco.bb index 4505de31a..d0f595b3e 100644 --- a/doc/to_do_doco.bb +++ b/doc/to_do_doco.bb @@ -18,4 +18,6 @@ Administration Guide (post-install)
- Administration Guide (pre-install)
\ No newline at end of file + Administration Guide (pre-install)
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/webpages.bb b/doc/webpages.bb index 74760c8bf..2bf7af762 100644 --- a/doc/webpages.bb +++ b/doc/webpages.bb @@ -10,4 +10,6 @@ The "page link title" box allows a user to specify the "pagelinkt Beneath the page creation box, a list of existing pages will appear with an "edit" link. Clicking this will take you to an editor, similar to that of the post editor, where you can make changes to your webpages.
-If you are the admin of a site, you can specify a channel whose webpages we will use at key points around the site. Presently, the only place this is implemented is the home page. If you specify the channel "admin" and then the channel called "admin" creates a webpage called "home", we will display it's content on your websites home page. We expect this functionality to be extended to other areas in future.
\ No newline at end of file +If you are the admin of a site, you can specify a channel whose webpages we will use at key points around the site. Presently, the only place this is implemented is the home page. If you specify the channel "admin" and then the channel called "admin" creates a webpage called "home", we will display it's content on your websites home page. We expect this functionality to be extended to other areas in future.
+
+Return to the [url=[baseurl]/help/main]Main documentation page[/url]
diff --git a/doc/zot.md b/doc/zot.md index d8b976517..f514fb3f8 100644 --- a/doc/zot.md +++ b/doc/zot.md @@ -397,4 +397,4 @@ auth_check messages MUST be encrypted with AES256CBC. This message is sent to th 'confirm' in this case is the base64url encoded RSA signature of the concatenation of 'secret' with the base64url encoded whirlpool hash of the source guid and guid_sig; signed with the source channel private key. This prevents a man-in-the-middle from inserting a rogue success packet. Upon receipt and successful verification of this packet, the destination site will redirect to the original destination URL and indicate a successful remote login. - +Return to the [url=[baseurl]/help/main]Main documentation page[/url] |