diff options
Diffstat (limited to 'doc/en/member')
217 files changed, 1757 insertions, 1428 deletions
diff --git a/doc/en/member/AdvancedSearch.md b/doc/en/member/AdvancedSearch.md new file mode 100644 index 000000000..86db5bc8b --- /dev/null +++ b/doc/en/member/AdvancedSearch.md @@ -0,0 +1,50 @@ +### Advanced Directory Search + + +Advanced Directory Search is enabled in "Expert Mode" from your Settings => Additional features page. + +On the Directory page an option named "Advanced" will apear in the "Find Channels" widget (typically in the sidebar). Clicking "Advanced" will open another search box for entering advanced search requests. + +Advanced requests include + +* name=xxx +[Channel name contains xxx] + +* address=xxx +[Channel address (webbie) contains xxx] + +* locale=xxx +[Locale (typically 'city') contains xxx] + +* region=xxx +[Region (state/territory) contains xxx] + +* postcode=xxx +[Postcode or zip code contains xxx] + +* country=xxx +[Country name contains xxx] + +* gender=xxx +[Gender contains xxx] + +* marital=xxx +[Marital status contains xxx] + +* sexual=xxx +[Sexual preference contains xxx] + +* keywords=xxx +[Keywords contain xxx] + +There are many reasons why a match may not return what you're looking for, as many channels do not provide detailed information in their default (public) profile, and many of these fields allow free-text input in several languages - and this may be difficult to match precisely. For instance you may have better results finding somebody in the USA with 'country=u' (along with some odd channels from Deutschland and Bulgaria and Australia) because this could be represented in a profile as US, U.S.A, USA, United States, etc... + +Future revisions of this tool may try to smooth over some of these difficulties. + +Requests may be joined together with 'and', 'or', and 'and not'. + +Terms containing spaces must be quoted. + +Example: + name="charlie brown" and country=canada and not gender=female + diff --git a/doc/en/member/NSFW.md b/doc/en/member/NSFW.md new file mode 100644 index 000000000..df254dd6c --- /dev/null +++ b/doc/en/member/NSFW.md @@ -0,0 +1,14 @@ +## Content warning/NSFW + +Content warnings and hiding certain content is done with Hubzilla using the ‘NSFW’ app. +While with other services in the Fediverse you have to rely on the authors of posts possibly hiding ‘sensitive’ content behind a content warning (a content or trigger warning), with Hubzilla you have this functionality in your own hands as a recipient. With the NSFW app, you can create filters that ensure that posts that match the filter rules are collapsed. The content of the post is only displayed when you click on the button. + + + +Here you can enter keywords and even [regular expressions](https://en.wikipedia.org/wiki/Regular_expression) that the posting will be searched for. If one of the words or a text pattern is found, the content in the stream will be collapsed. +It is also possible to filter by language (lang=xx or lang!=xx). +If a phrase that matches one of the filters entered is found in a posting, the posting will initially be hidden from you behind a content warning. + + + + diff --git a/doc/en/member/account_settings.md b/doc/en/member/account_settings.md new file mode 100644 index 000000000..4bba247df --- /dev/null +++ b/doc/en/member/account_settings.md @@ -0,0 +1,6 @@ +#### Account settings + +You can use the account settings to change your account details. + + + diff --git a/doc/en/member/accounts_profiles_channels_basics.md b/doc/en/member/accounts_profiles_channels_basics.md new file mode 100644 index 000000000..c3252ea56 --- /dev/null +++ b/doc/en/member/accounts_profiles_channels_basics.md @@ -0,0 +1,31 @@ +## Accounts, Profiles and Channels + +Once you have registered an *account* at the grid you have also created a *profile* and a *channel*. + +**Account** + +You have *one* account. This consists of your email account and your password. With your account you access your profile and your channel. + +*Think of your account as the way you authenticate at one $Projectname site. It lets you do things, such as creating profiles and channels with which you can connect to other people.* + +**Profile** + +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/[webname] and edit it by clicking on the pencil icon next to your avatar image. + +Unlike other services hubzilla offers you the advantage of creating *many more profiles*. That way you are able to distinguish between profiles targeted specially at everyone (your public profile), your work mates, your family and your partner. + +*Think of your profile as the basic information about yourself you tell other people.* + +**Channel** + +During the registration you created your first *channel*. 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 *second channel* 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*s* ...) 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. :) + +*Think of a channel as different spaces dedicated to different topics where you meet with different people.* + + +#include doc/en/member/channels.md; +#include doc/en/member/profiles.md; +#include doc/en/member/settings.md; +#include doc/en/member/connecting_with_channels.md; diff --git a/doc/en/member/additional_features.md b/doc/en/member/additional_features.md new file mode 100644 index 000000000..90aa0fecb --- /dev/null +++ b/doc/en/member/additional_features.md @@ -0,0 +1,29 @@ +#### Additional features (hidden settings) + +The ‘Additional Features’ settings are not accessible in their entirety either via the menu or via an icon. However, all the individual feature settings can also be accessed in the respective app via the cogwheel next to the main menu (avatar picture). +These are settings for additional functions in all possible areas of Hubzilla. To access the settings, you have to append the URL of the hub `/settings/features` to the browser, e.g. `https://klacker.org/settings/features`. + + + +The default settings for all of these options are set by the hub administrator. This default setting can be overridden by the user in the ‘Additional Functions’. +For each option, the administrator also has the option of locking the default setting to prevent changes. The user can still flip the switch for the option, but the selection is not saved and the option is reset to the default setting. + + + + + + + + + + + + + + + + + + + + diff --git a/doc/en/member/addressbook.md b/doc/en/member/addressbook.md new file mode 100644 index 000000000..d939feae3 --- /dev/null +++ b/doc/en/member/addressbook.md @@ -0,0 +1,23 @@ +## Address book (CardDAV) + +Hubzilla offers you address management with the ‘CardDAV’ app. You can create as many address books as you like. + + + +The entries are stored in vCards format. + + + + + + + + + + + +The app also allows you to import address books or individual vCards from a file. + + + +Address books are generally private and cannot be shared - not even via remote authorisation. diff --git a/doc/en/member/apps.md b/doc/en/member/apps.md new file mode 100644 index 000000000..68111e864 --- /dev/null +++ b/doc/en/member/apps.md @@ -0,0 +1,58 @@ +## Apps + +A freshly installed Hubzilla instance has a number of basic functionalities. However, there are many features that are not part of the basic installation and are not immediately available for a newly created channel. + +The majority of functions are realised as ‘applications’ (or ‘apps’ for short). +You can access the apps using the ‘app menu’, which is symbolised by the ‘⋮’ button (and is located on the far right of the navigation bar on most hubs). You can also pin frequently used apps to the navigation bar so that you don't have to open the app menu every time you call them up. + +How many and which apps are available to you depends on how the administrator has configured the hub. + +### App management + +You can manage the apps for your channel using app management. You can also access this in the app menu under the lowest menu item ‘+ Apps’ + +After calling up the app management, the apps already installed are displayed. + +You can now switch between ‘Installed apps’ and ‘Available apps’ in the left-hand sidebar. + +#### Available apps + +In the available apps, you will find all the apps available on your hub. Some of them are already installed. You can use the button next to the app to install apps or update apps that are already installed. + + + +#### Installed apps + +The Installed apps tab contains all the apps that are installed for your channel. To the right of each app there are two or three buttons with icons: a star icon, a pinhead icon and, if applicable, a cogwheel icon. + + + +The star symbol is used to make the app accessible as a menu item in the app menu. + + + + + +You can pin the app in the navigation bar using the pin symbol. + + + +If there is a dialogue for app-specific settings for an app, you can access this via the button with the cogwheel symbol. + + + +#### Manage apps + +There is also a button labelled ‘Manage apps’ at the top of the installed apps tab. This button takes you to the ‘Manage apps’ page, where you can uninstall apps and also edit installed apps within certain limits. + + + +It is also possible to create your own apps there (only for advanced users!). + +#### Sorting apps in the menu + +You can easily sort the apps you have added to the app menu using drag-and-drop and specify your preferred order. + + + +#include doc/en/member/important_apps.md; diff --git a/doc/en/member/article.md b/doc/en/member/article.md new file mode 100644 index 000000000..9d40bd4db --- /dev/null +++ b/doc/en/member/article.md @@ -0,0 +1,25 @@ +## Article + +The article is a macroblogging post type at Hubzilla and is suitable for real blog posts, for example. Unlike normal posts, which are distributed throughout the entire network (including the Fediverse), articles remain on your own hub. They are only accessible to users of other instances and users who do not have an account in the Fediverse via their URL. Of course, the URL can be shared so that the article will still be known in the Fediverse and can be accessed. +You can create an article using the app (app menu ⋮) ‘Article’. When you open it, all created articles are displayed and you have the option to create a new article (‘Add article’). + + + +Creating an article is similar to creating a normal post. However, the input form has an additional field: ‘Link to page’. + +Here you can enter an easy-to-read link name. If you leave this field empty, a name will be assigned automatically (longer and more ‘cryptic’). + + + +If you have filled in the optional ‘Summary’ field, only the summary of an article will initially be displayed, just like a normal post. + + + +If you click on ‘View article’, the article itself will be displayed. + + + +The direct link to the article is composed as follows: +`URL-of-your-hub/articles/channel-name/link-to-page` + + diff --git a/doc/en/member/assets/bookmarker-save-icon.png b/doc/en/member/assets/bookmarker-save-icon.png Binary files differdeleted file mode 100644 index 6a7c10eb9..000000000 --- a/doc/en/member/assets/bookmarker-save-icon.png +++ /dev/null diff --git a/doc/en/member/assets/bookmarks-menu-dropdown.png b/doc/en/member/assets/bookmarks-menu-dropdown.png Binary files differdeleted file mode 100644 index 137ae52ad..000000000 --- a/doc/en/member/assets/bookmarks-menu-dropdown.png +++ /dev/null diff --git a/doc/en/member/assets/privacy-group-tool-public.png b/doc/en/member/assets/privacy-group-tool-public.png Binary files differdeleted file mode 100644 index 828cb6411..000000000 --- a/doc/en/member/assets/privacy-group-tool-public.png +++ /dev/null diff --git a/doc/en/member/assets/privacy-tool-3.png b/doc/en/member/assets/privacy-tool-3.png Binary files differdeleted file mode 100644 index ba896403d..000000000 --- a/doc/en/member/assets/privacy-tool-3.png +++ /dev/null diff --git a/doc/en/member/assets/qr_text_to_post.png b/doc/en/member/assets/qr_text_to_post.png Binary files differdeleted file mode 100644 index 887c85492..000000000 --- a/doc/en/member/assets/qr_text_to_post.png +++ /dev/null diff --git a/doc/en/member/assets/zat_dialog.png b/doc/en/member/assets/zat_dialog.png Binary files differdeleted file mode 100644 index 892964e95..000000000 --- a/doc/en/member/assets/zat_dialog.png +++ /dev/null diff --git a/doc/en/member/bbcode.html b/doc/en/member/bbcode.html deleted file mode 100644 index e3e079b4d..000000000 --- a/doc/en/member/bbcode.html +++ /dev/null @@ -1,337 +0,0 @@ -<style> - section { - display: inline-block; - overflow-x: scroll; - } -</style> -<h3>Text Decoration</h3> -<table class="table table-responsive table-bordered"> - <tbody> - <tr> - <th>BBcode syntax</th><th>Rendered text</th> - </tr> - <tr> - <td><code>[b]bold[/b]</code></td><td><strong>bold</strong></td> - </tr> - <tr> - <td><code>[i]italic[/i]</code></td><td><em>italic</em></td> - </tr> - <tr> - <td><code>[u]underlined[/u]</code></td><td><u>underlined</u></td> - </tr> - <tr> - <td><code>[s]strike[/s]</code></td><td><strike>strike</strike></td> - </tr> - <tr> - <td><code>[color=red]red[/color]</code></td><td><span style="color: red;">red</span></td> - </tr> - <tr> - <td><code>[hl]highlighted[/hl]</code></td><td><span style="background-color: yellow;">highlighted</span></td> - </tr> - <tr> - <td><code>[font=courier]some text[/font] </code></td><td><span style="font-family: courier;">some text</span></td> - </tr> - <tr> - <td><code>[quote]quote[/quote]</code></td><td><blockquote>quote</blockquote></td> - </tr> - <tr> - <td><code>[quote=Author]Author? Me? No, no, no...[/quote]</code></td><td><strong class="author">Author wrote:</strong><blockquote>Author? Me? No, no, no...</blockquote></td> - </tr> - <tr> - <td><code> - [size=small]small text[/size]<br> - [size=xx-large]xx-large text[/size]<br> - [size=20]20px exactly[/size]<br> - </code> - Size options include: <strong>xx-small, small, medium, large, xx-large</strong></td><td><span style="font-size: small;">small text</span><br><span style="font-size: xx-large;">xx-large text</span><br><span style="font-size: 20px;">20px exactly</span></td> - </tr> - <tr> - <td><code>Add a horizontal bar -[hr] -Like this - </code></td><td> - Add a horizontal bar<br><hr><br>Like this - </td> - </tr> - <tr> - <td><code>This is -[center]centered[/center] -text</code></td><td> - This is<br><div style="text-align:center;">centered</div><br>text - </td> - </tr> - </tbody> -</table> - -<h3>Code blocks</h3> -Code can be rendered generically in a block or inline format (depending on if there are new line characters in the text), or you can specify a supported language for enhanced syntax highlighting. Syntax highlighting requires a suitable rendering plugin such as <strong>hilite</strong>. Supported languages with the hilite plugin include <strong>php, css, mysql, sql, abap, diff, html, perl, ruby, vbscript, avrc, dtd, java, xml, cpp, python, javascript, js, json, sh </strong>. -<br><br> -If a rendering plugin is not installed or an unsupported language is specified, the output for syntax highlighted code blocks is the same as the block format code tag. -<br><br> -<table class="table table-responsive table-bordered"> - <tbody> - <tr> - <th>BBcode syntax</th><th>Output</th> - </tr> - <tr> - <td><code>[code]function bbcode() { }[/code]</code></td><td><code>function bbcode() { }</code></td> - </tr> - <tr> - <td><code>[code=php]function bbcode() {<br> - $variable = true;<br> - if( $variable ) {<br> - echo "true";<br> - }<br> -}[/code]</code></td><td><code><div class="hl-main"><ol class="hl-main"><li><span class="hl-code"> </span><span class="hl-reserved">function</span><span class="hl-code"> </span><span class="hl-identifier">bbcode</span><span class="hl-brackets">(</span><span class="hl-brackets">)</span><span class="hl-code"> </span><span class="hl-brackets">{</span><span class="hl-code"></span></li><li><span class="hl-code"> </span><span class="hl-var">$variable</span><span class="hl-code"> = </span><span class="hl-reserved">true</span><span class="hl-code">;</span></li><li><span class="hl-code"> </span><span class="hl-reserved">if</span><span class="hl-brackets">(</span><span class="hl-code"> </span><span class="hl-var">$variable</span><span class="hl-code"> </span><span class="hl-brackets">)</span><span class="hl-code"> </span><span class="hl-brackets">{</span><span class="hl-code"></span></li><li><span class="hl-code"> </span><span class="hl-reserved">echo</span><span class="hl-code"> </span><span class="hl-quotes">"</span><span class="hl-string">true</span><span class="hl-quotes">"</span><span class="hl-code">;</span></li><li><span class="hl-code"> </span><span class="hl-brackets">}</span><span class="hl-code"></span></li><li><span class="hl-code"> </span><span class="hl-brackets">}</span></li></ol></div></code></td> - </tr> - <tr> - <td><code>[nobb][nobb]This is how [i]you[/i] can -[u]show[/u] how to use -[hl]BBcode[/hl] syntax[/nobb][/nobb]</code></td><td>[nobb]This is how [i]you[/i] can [u]show[/u] how to use [hl]BBcode[/hl] syntax[/nobb]</td> - </tr> - </tbody> -</table> - -<h3>Lists</h3> -<table class="table table-responsive table-bordered"> - <tbody> - <tr> - <th>BBcode syntax</th><th>Rendered list</th> - </tr> - <tr> - <td><code>[ul]<br> -[*] First list element<br> -[*] Second list element<br> -[/ul]</code></td><td><ul class="listbullet" style="list-style-type: circle;"><li> First list element</li><li> Second list element<br></li></ul></td> - </tr> - <tr> - <td><code>[ol]<br> -[*] First list element<br> -[*] Second list element<br> -[/ol]</code></td><td><ul class="listdecimal" style="list-style-type: decimal;"><li> First list element</li><li> Second list element<br></li></ul></td> - </tr> - <tr> - <td><code>[list=A]<br> -[*] First list element<br> -[*] Second list element<br> -[/list]</code> - The list type options are <code>1, i, I, a, A</code>.</td><td><ul class="listupperalpha" style="list-style-type: upper-alpha;"><li> First list element</li><li> Second list element</li></ul></td> - </tr> - <tr> - <td><code>[dl terms="b"]<br> -[*= First element term] First element description<br> -[*= Second element term] Second element description<br> -[/dl]</code> - The <strong>terms</strong> style options can be any combination of: - <dl class="bb-dl dl-horizontal"> - <dt>b</dt><dd>bold</dd> - <dt>i</dt><dd>italic</dd> - <dt>u</dt><dd>underline</dd> - <dt>m</dt><dd>monospace</dd> - <dt>l</dt><dd>large</dd> - <dt>h</dt><dd>horizontal — like <em>this</em> defintion list</dd> - </dl> - </td><td><dl class="bb-dl dl-terms-bold"> -<dt> First element term</dt><dd> First element description<br></dd> -<dt> Second element term</dt><dd> Second element description<br></dd></dl></td> - </tr> - </tbody> -</table> - -<h3>Tables</h3> - -<table class="table table-responsive table-bordered"> - <tbody> - <tr> - <th>BBcode syntax</th><th>Rendered table</th> - </tr> - <tr> - <td><code>[table border=0]<br> -[tr]<br> -[th]Header 1[/th][th]Header 2[/th]<br> -[/tr]<br> -[tr][td]Content[/td][td]Content[/td][/tr]<br> -[tr][td]Content[/td][td]Content[/td][/tr]<br> -[/table]</code></td><td><table class="table table-responsive"><tbody><tr><th>Header 1</th><th>Header 2</th></tr> -<tr><td>Content</td><td>Content</td></tr><tr><td>Content</td><td>Content</td></tr></tbody></table></td> - </tr> - <tr> - <td><code>[table border=1]<br> -[tr]<br> -[th]Header 1[/th][th]Header 2[/th]<br> -[/tr]<br> -[tr][td]Content[/td][td]Content[/td][/tr]<br> -[tr][td]Content[/td][td]Content[/td][/tr]<br> -[/table]</code></td><td><table class="table table-responsive table-bordered"><tbody><tr><th>Header 1</th><th>Header 2</th></tr> -<tr><td>Content</td><td>Content</td></tr><tr><td>Content</td><td>Content</td></tr></tbody></table></td> - </tr> - <tr> - <td><code>[table]<br> -[tr]<br> -[th]Header 1[/th][th]Header 2[/th]<br> -[/tr]<br> -[tr][td]Content[/td][td]Content[/td][/tr]<br> -[tr][td]Content[/td][td]Content[/td][/tr]<br> -[/table]</code></td><td><table><tbody><tr><th>Header 1</th><th>Header 2</th></tr><tr><td>Content</td><td>Content</td></tr><tr><td>Content</td><td>Content</td></tr></tbody></table> -</td> - </tr> - </tbody> -</table> - -<h3>Links and Embedded Content</h3> - -<table class="table table-responsive table-bordered"> - <tbody> - <tr> - <th>BBcode syntax</th><th>Output</th> - </tr> - <tr> - <td><code>[video]video URL[/video]<br> -[audio]audio URL[/audio]</code></td><td></td> - </tr> - <tr> - <td><code>[url=https://hubzilla.org]Hubzilla[/url]</code></td><td><a href="https://hubzilla.org" target="_blank">Hubzilla</a></td> - </tr> - <tr> - <td><code>An image [img]https://example.org/image.jpg[/img] -in some text </code></td><td> - An image <img src="/images/default_profile_photos/rainbow_man/48.jpg" alt="Image/photo"> in some text - </td> - </tr> - </tbody> -</table> - - -<h3>$Projectname specific codes</h3> - -<table class="table table-responsive table-bordered"> - <tbody> - <tr> - <th>BBcode syntax</th><th>Output</th> - </tr> - <tr> - <td>Magic-auth version of [url] tag - <code>[zrl=https://hubzilla.org]Identity-aware link[/zrl]</code> - </td><td><code>https://hubzilla.org/?zid=[observer=1][observer.address][/observer][observer=0]your_channel@your.home.hub[/observer]</code></td> - </tr> - <tr> - <td>Magic-auth version of [img] tag - <code>[zmg]https://hubzilla.org/some/photo.jpg[/zmg]</code> - </td><td>Image is only viewable by those authenticated and with permission.</td> - </tr> - <tr> - <td>Observer-dependent output:<code> - [nobb][observer=1]Text to display if observer IS authenticated[/observer][/nobb] - </code></td><td></td> - </tr> - <tr> - <td> - <code> - [nobb][observer=0]Text to display if observer IS NOT authenticated[/observer][/nobb] - </code> - </td> - <td></td> - </tr> - <tr> - <td> - <code> - [nobb][observer.language=en]Text to display if observer language is English[/observer][/nobb] - </code> - </td> - <td></td> - </tr> - <tr> - <td> - <code> - [nobb][observer.language!=de]Text to display if observer language is not German[/observer][/nobb] - </code> - </td> - <td></td> - </tr> - <tr> - <td> - <code> - [nobb][observer.url][/nobb] - </code> - </td> - <td>channel URL of observer</td> - </tr> - <tr> - <td> - <code> - [nobb][observer.baseurl][/nobb] - </code> - </td> - <td>website of observer</td> - </tr> - <tr> - <td> - <code> - [nobb][observer.name][/nobb] - </code> - </td> - <td>name of observer</td> - </tr> - <tr> - <td> - <code> - [nobb][observer.webname][/nobb] - </code> - </td> - <td>short name in the url of the observer</td> - </tr> - <tr> - <td> - <code> - [nobb][observer.address][/nobb] - </code> - </td> - <td>address (ZOT-id) of observer</td> - </tr> - <tr> - <td> - <code> - [nobb][observer.photo][/nobb] - </code> - </td> - <td>profile photo of observer</td> - </tr> - <tr> - <td><code>What is a spoiler?<br> - [spoiler]Text you want to hide.[/spoiler]</code></td><td> - What is a spoiler? <div onclick="openClose('opendiv-1131603764'); return false;" class="fakelink">Click to open/close</div><blockquote id="opendiv-1131603764" style="display: none;">Text you want to hide.</blockquote> - </td> - </tr> - <tr> - <td><code>[toc data-toc='div.page-body' data-toc-headings='h1,h2']</code><br> -Create a table of content in a webpage or wiki page. Please refer to the <a href="http://ndabas.github.io/toc/" target="_blank">original jQuery toc</a> to get more explanations. - <ul> - <li>Optional param: 'data-toc'. If omitted the default is 'body'</li> - <li>Optional param: 'data-toc-headings'. If omitted the default is 'h1,h2,h3'</li> - </ul></td><td></td> - </tr> - <tr> - <td><code>[nobb][rpost=title]Text to post[/rpost][/nobb]</code><br> -The observer will be returned to their home hub to enter a post with the specified title and body. Both are optional</td><td><a href="[baseurl]/rpost?f=&title=title&body=Text+to+post" target="_blank">[baseurl]/rpost?f=&title=title&body=Text+to+post</a></td> - </tr> - <tr> - <td>This requires the <a href="https://framagit.org/hubzilla/addons/tree/master/qrator"><strong>qrator</strong></a> plugin.<br><code>[qr]text to post[/qr]</code></td><td><img src="/doc/member/assets/qr_text_to_post.png"></td> - </tr> - <tr> - <td>This requires a suitable map plugin such as <strong><a href="https://framagit.org/hubzilla/addons/tree/master/openstreetmap">openstreetmap</a></strong>. - <code>[map]</code></td><td>Generate an inline map using the current browser coordinates of the poster, if browser location is enabled</td> - </tr> - <tr> - <td>This requires a suitable map plugin such as <strong><a href="https://framagit.org/hubzilla/addons/tree/master/openstreetmap">openstreetmap</a></strong>. - <code>[map=latitude,longitude]</code></td><td>Generate a map using global coordinates.</td></tr> - <tr> - <td>This requires a suitable map plugin such as <strong><a href="https://framagit.org/hubzilla/addons/tree/master/openstreetmap">openstreetmap</a></strong>. - <code>[map]Place Name[/map]</code></td><td> -Generate a map for a given named location. The first matching location is returned. For instance "Sydney" will usually return Sydney, Australia and not Sydney, Nova Scotia, Canada unless the more precise location is specified. It is highly recommended to use the post preview utility to ensure you have the correct location before submitting the post. -</td> - </tr> - <tr> - <td><code>[&copy;]</code></td><td> © </td> - </tr> - </tbody> -</table> diff --git a/doc/en/member/bbcode.md b/doc/en/member/bbcode.md new file mode 100644 index 000000000..b3855b11c --- /dev/null +++ b/doc/en/member/bbcode.md @@ -0,0 +1,81 @@ +### bbCode + +##### Text Decoration + +| BBcode syntax | Rendered text | +| ------------------------------------------------------------ | --------------------------------- | +| `[b]bold[/b]` | **bold** | +| `[i]italic[/i]` | *italic* | +| `[u]underlined[/u]` | underlined | +| `[s]strike[/s]` | ~~strike~~ | +| `[color=red]red[/color]` |  | +| `[hl]highlighted[/hl]` |  | +| `[font=courier]some text[/font] ` |  | +| `[quote]quote[/quote]` |  | +| `[quote=Author]Author? Me? No, no, no...[/quote]` |  | +| ` [size=small]small text[/size]`<br />`[size=xx-large]xx-large text[/size]`<br />` [size=20]20px exactly[/size] `<br />Size options include: **xx-small, small, medium, large, xx-large** |  | +| `Add a horizontal bar [hr] Like this ` |  | +| `This is [center]centered[/center] text` |  | + +##### Code blocks + +Code can be rendered generically in a block or inline format (depending on if there are new line characters in the text), or you can specify a supported language for enhanced syntax highlighting. Syntax highlighting requires a suitable rendering plugin such as **hilite**. Supported languages with the hilite plugin include **php, css, mysql, sql, abap, diff, html, perl, ruby, vbscript, avrc, dtd, java, xml, cpp, python, javascript, js, json, sh** . + + If a rendering plugin is not installed or an unsupported language is specified, the output for syntax highlighted code blocks is the same as the block format code tag. + +| BBcode syntax | Output | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| `[code]function bbcode() { }[/code]` | `function bbcode() { }` | +| `[code=php]function bbcode() { $variable = true; if( $variable ) { echo "true"; } }[/code]` |  | +| `[nobb][nobb]This is how [i]you[/i] can [u]show[/u] how to use [hl]BBcode[/hl] syntax[/nobb][/nobb]` | This is how [i]you[/i] can [u]show[/u] how to use [hl]BBcode[/hl] syntax | + +##### Lists + +| BBcode syntax | Rendered list | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| `[ul] [*] First list element [*] Second list element [/ul]` | - First list element<br />- Second list element | +| `[ol] [*] First list element [*] Second list element [/ol]` | 1. First list element<br />2. Second list element | +| `[list=A] [*] First list element [*] Second list element [/list]` The list type options are `1, i, I, a, A`. | A. First list element<br />B. Second list element | +| `[dl terms="b"] [*= First element term] First element description [*= Second element term] Second element description [/dl]` The **terms** style options can be any combination of: bbold iitalic uunderline mmonospace llarge hhorizontal — like *this* defintion list | First element term<br />First element description <br />Second element term<br />Second element description | + +##### Tables + +| BBcode syntax | Rendered table | +| ------------------------------------------------------------ | --------------------------- | +| `[table border=0] [tr] [th]Header 1[/th][th]Header 2[/th] [/tr] [tr][td]Content[/td][td]Content[/td][/tr] [tr][td]Content[/td][td]Content[/td][/tr] [/table]` |  | +| `[table border=1] [tr] [th]Header 1[/th][th]Header 2[/th] [/tr] [tr][td]Content[/td][td]Content[/td][/tr] [tr][td]Content[/td][td]Content[/td][/tr] [/table]` |  | +| `[table] [tr] [th]Header 1[/th][th]Header 2[/th] [/tr] [tr][td]Content[/td][td]Content[/td][/tr] [tr][td]Content[/td][td]Content[/td][/tr] [/table]` |  | + +##### Links and Embedded Content + +| BBcode syntax | Output | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| `[video]video URL[/video] [audio]audio URL[/audio]` | VIDEO<br />AUDIO | +| `[video='URL_TO_POSTER']video_link[/video]` | <img src="./pic/video_poster.png" alt="image" style="zoom:100%;" /> | +| `[url=https://hubzilla.org]Hubzilla[/url]` | [Hubzilla](https://hubzilla.org) | +| `An image [img]https://example.org/image.jpg[/img] in some text ` | <img src="./pic/image.png" alt="image" style="zoom:80%;" /> | + +##### Hubzilla spezific codes + +| BBcode syntax | Output | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| Magic-auth version of [url] tag `[zrl=https://hubzilla.org]Identity-aware link[/zrl]` |  | +| Magic-auth version of [img] tag `[zmg]https://hubzilla.org/some/photo.jpg[/zmg]` | Image is only viewable by those authenticated and with permission. | +| Observer-dependent output:`[observer=1]Text to display if observer IS authenticated[/observer]` | | +| ` [observer=0]Text to display if observer IS NOT authenticated[/observer]` | | +| `[observer.language=en]Text to display if observer language is English[/observer]` | | +| `[observer.language!=de]Text to display if observer language is not German[/observer]` | | +| `[observer.url]` | channel URL of observer | +| `[observer.baseurl]` | website of observer | +| `[observer.name]` | name of observer | +| ` [observer.webname]` | short name in the url of the observer | +| `[observer.address]` | address (Nomad/Zot-id) of observer | +| `[observer.photo]` | profile photo of observer | +| `What is a spoiler? [spoiler]Text you want to hide.[/spoiler]` | What is a spoiler? Click to open/close | +| `[toc data-toc='div.page-body' data-toc-headings='h1,h2']` Create a table of content in a webpage or wiki page. Please refer to the [original jQuery toc](http://ndabas.github.io/toc/) to get more explanations. Optional param: 'data-toc'. If omitted the default is 'body' Optional param: 'data-toc-headings'. If omitted the default is 'h1,h2,h3' | | +| `[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 | [[baseurl\]/rpost?f=&title=title&body=Text+to+post](file:///home/daniel/Fediverse/orig doc/member/[baseurl]/rpost?f=&title=title&body=Text+to+post) | +| This requires the [**qrator**](https://framagit.org/hubzilla/addons/tree/master/qrator) plugin. `[qr]text to post[/qr]` |  | +| This requires a suitable map plugin such as **[openstreetmap](https://framagit.org/hubzilla/addons/tree/master/openstreetmap)**. `[map]` | Generate an inline map using the current browser coordinates of the poster, if browser location is enabled | +| This requires a suitable map plugin such as **[openstreetmap](https://framagit.org/hubzilla/addons/tree/master/openstreetmap)**. `[map=latitude,longitude]` | Generate a map using global coordinates. | +| This requires a suitable map plugin such as **[openstreetmap](https://framagit.org/hubzilla/addons/tree/master/openstreetmap)**. `[map]Place Name[/map]` | Generate a map for a given named location. The first matching location is returned. For instance "Sydney" will usually return Sydney, Australia and not Sydney, Nova Scotia, Canada unless the more precise location is specified. It is highly recommended to use the post preview utility to ensure you have the correct location before submitting the post. | +| `[©]` | © | diff --git a/doc/en/member/blocking_channels.md b/doc/en/member/blocking_channels.md new file mode 100644 index 000000000..d2ccee7d7 --- /dev/null +++ b/doc/en/member/blocking_channels.md @@ -0,0 +1,19 @@ +## Blocking/ignoring/archiving/hiding channels + +Channels in your address book can have the status ‘ *blocked*’, ‘ *ignored’,*‘ *archived’* or ‘ *hidden’*. There is a filter on your connection page that displays the channels with these statuses. + + + +You can change the status of a channel on the pages for editing connections. + +The meaning: + +**Blocked:** The channel cannot read your items, regardless of permissions, and it cannot write to your channel. + +**Ignored**: The channel can read your items if it is authorised to do so, but it cannot write to your channel. + +**Hidden:** The channel is not displayed in the connection list of your profile. No one can see that you are connected to it. Note: It is still visible to your other connections, for example in replies to posts. + +**Archived:** If a channel cannot be reached for 30 days, it is automatically marked as archived. This means that all data is retained, but the channel is no longer queried for new information and is removed from the auto-complete. If you find out later that the channel is online again, you can remove it manually from the archive. + +#include doc/en/member/superblock.md; diff --git a/doc/en/member/bookmarks.md b/doc/en/member/bookmarks.md new file mode 100644 index 000000000..60582ec5d --- /dev/null +++ b/doc/en/member/bookmarks.md @@ -0,0 +1,27 @@ +[##](##) Bookmarks + +Bookmarks specify a link that can be saved in your bookmarks folder. They use the character string `#^` followed by the link. These are often generated automatically. If the administrator of the Hub has installed the ‘bookmarker’ add-on, this sequence is converted into a bookmark symbol when the post or comment is viewed online. + + + + + +If you click on the icon, the bookmark is saved. If the bookmark add-in is not installed, the post drop-down menu contains a link to save the bookmark or bookmarks. + +To use bookmarks, you must install the ‘Bookmarks’ app. + +The app will then list all the bookmarks you have set. + +To add a bookmark independently of a link in the stream or a post, you can call up the page `<URL_your_hub>`/rbmark, which provides you with a mask for manually entering a bookmark. + + + +You can also create a [bookmarklet](https://en.wikipedia.org/wiki/Bookmarklet) and place it in the bookmark bar of your web browser, for example: + +```javascript +javascript:javascript:(function(){var%20url=location.href;var%20title=document.title||url;window.open('[observer.baseurl]/rbmark?&url='+encodeURIComponent(url)+'&title='+encodeURIComponent(title)+'&source=bookmarklet','_blank','menubar=no,height=390,width=600,toolbar=no,scrollbars=no,status=no,dialog=1');})(); +``` + +<u>Important:</u> Replace the expression `[observer.baseurl]` with the URL of your hub, e.g. if you have your channel on Klackerhub, you simply have to enter `https://klacker.org` for `[observer.baseurl]`. + +Now you can add any website you visit to your channel's bookmarks by clicking on the bookmarklet. diff --git a/doc/en/member/calendar.md b/doc/en/member/calendar.md new file mode 100644 index 000000000..648dc9f83 --- /dev/null +++ b/doc/en/member/calendar.md @@ -0,0 +1,22 @@ +## Calendar + +The ‘Calendar’ app can be used to manage appointments. +After opening the app, a calendar overview (one month) is displayed. + + + +Clicking on a day allows you to create an event. In the input mask (shortened view, can be expanded by clicking on ‘more’ ) you can now enter the essential contents. + + + + + +You may also define detailed [permissions](permissions_content.md) for these entries, so that you can record private appointments and public/shared appointments in one and the same calendar. + + + +### CalDAV access with Android + +You can synchronise your Android calendar with your hub. +Use the ‘URL’ and ‘Username’ to log in. The base URL is `<your-hub-URL>/cdav`, and the username is your channel name (without the leading ‘@’ and without the hub address ‘`@<your-hub>`’). +To share your calendar, visit `<your-hub-URL>/cdav/calendar`. diff --git a/doc/en/member/channel_locations.md b/doc/en/member/channel_locations.md new file mode 100644 index 000000000..5e17b38ca --- /dev/null +++ b/doc/en/member/channel_locations.md @@ -0,0 +1,6 @@ +#### Manage Channel locations + +If the current channel has clones on other hubs, the menu will show an additional entry, ‘Manage Channel locations’. This allows you to specify the hub on which the main channel (primary channel) is located (this also determines the part of the handle after the ‘@’). +You can also delete clones from here. However, for channels on third-party servers, it is recommended that you delete the channel on the actual hub. Deleting from the clone management should only be used if the clone's hub no longer exists. + + diff --git a/doc/en/member/channel_roles.md b/doc/en/member/channel_roles.md new file mode 100644 index 000000000..85852e8a0 --- /dev/null +++ b/doc/en/member/channel_roles.md @@ -0,0 +1,41 @@ +### Channel roles + +When you create a new channel, you will be asked to select an permission role depending on how you want to use this channel. The most popular permission roles are the social network roles. You have many more choices comparable to Facebook groups and pages, collaborative spaces, news feeds and more. These roles automatically configure various system variables, from the permissions granted to friends to the default privacy and visibility settings. Advanced configurations are available to customise each of these parameters to your needs, but our experience has been that most users prefer to set it and forget it. Below are some of the different roles that are currently available and how they affect your privacy and interaction options. + +**There are four channel roles:** + +- Public +- Personal +- Community Forum +- Customised + +#### Public + +The channel is a very permissive social network profile that is compatible with other federated social networks. Privacy is a lower priority than ease of access and connection with others. Anyone on the network can comment on your public posts and send you private messages. By default, posts and published articles are public, but you can override and restrict this when you create the article. You are listed in the directory. Your online presence and connections are visible to others. This mode can increase your susceptibility to unsolicited messages and spam. The ‘classic’ social media account. + +#### Personal + +By default, posts and published items are public, but you can override and restrict this when creating the item. You are listed in the directory. Your online presence and connections are visible to others. Only your direct connections can comment on your public posts and send you private messages. + +#### Community Forum + +The channel is a typical forum. By default, posts and published articles are public. Members can post articles via !mention or wall-to-wall. The posting of photos and other published articles is blocked. The channel is visible in the directory. Members are added automatically. + +In order to be able to view media as a forum user, some of which may have restricted authorisations, it is necessary to activate the option ‘Enable OCAP access’ in your own user channel under Settings → Privacy settings (`<hub>/settings/privacy`). + +#### Custom + +This is the most precise setting for channel rights. All rights can be set in fine granularity. Caution: If you select the wrong settings here, you can render your channel unusable. Fortunately, the rights can also be changed again so that such malfunctions can be rectified. It makes sense to consider the effects of each individual permission for yourself as the channel owner, but also for other users. + +**The following settings are possible for each control point:** + +- Only me +- Only those you explicitly authorise +- Accepted connections +- Any connections +- Everyone on this website +- All Hubzilla members +- Anyone authenticated +- Anyone on the Internet + +To edit the **custom role**, select ‘Privacy settings’ in the settings. At the bottom right you will find the button ‘Custom channel role configuration’. If you click on it, a warning dialogue will appear, drawing your attention to the risks of incorrect configuration. If you confirm that you want to edit the rights, the settings dialogue for the user-defined role rights opens. diff --git a/doc/en/member/channel_settings.md b/doc/en/member/channel_settings.md new file mode 100644 index 000000000..e0f07d42f --- /dev/null +++ b/doc/en/member/channel_settings.md @@ -0,0 +1,15 @@ +#### Channel settings + +If you access the settings via the menu item, the channel settings are displayed by default. The basic settings are used to set the properties and functions of the currently selected (used) channel. In addition to the channel role, you can also define the standard for automatically created directories in the cloud (these are generated, for example, when you upload an image as an attachment in a post). + +It is also possible to delete the channel (red ‘Delete channel’ button). + +<u>Important note:</u> It is not possible to create a new channel on this hub under the name of the deleted channel (not even by cloning). This is to protect against ‘identity misuse’. If you still want to reinstall a channel with this name for important reasons, you can contact the admin of the hub, explain the reasons (so that they can be sure that you have a legitimate interest) and ask them to remove the block. Only he can do this with a few simple steps in the database. + +You can also set the expiry period for imported content from other channels and control this import using two filters. + + + +The notification settings allow you to specify exactly whether you want to be notified of certain events and actions. And whether you also want the notification to be sent by email. + + diff --git a/doc/en/member/channels.md b/doc/en/member/channels.md new file mode 100644 index 000000000..e1b123ee4 --- /dev/null +++ b/doc/en/member/channels.md @@ -0,0 +1,15 @@ +### Channels + +Channels are simply collections of content that are stored in one place. A channel can stand for anything. It can represent you, a website, a forum, photo albums, anything. For most people, their first channel is ‘Me’. +The most important functions for a channel that represents ‘me’ are: + +- Secure and private ‘spam-free’ communication +- Identity and ‘single sign-on’ across the entire network +- Privacy controls and authorisations that extend to the entire network +- Directory services (like a phone book) + +In short, a channel that represents you is ‘me on the Internet’. +With one account at a hub, several different channels can be created and used, each with its own individual configuration. + +#include doc/en/member/create_channels.md; +#include doc/en/member/channel_roles.md; diff --git a/doc/en/member/chat_rooms.md b/doc/en/member/chat_rooms.md new file mode 100644 index 000000000..6134bfb39 --- /dev/null +++ b/doc/en/member/chat_rooms.md @@ -0,0 +1,13 @@ +## Chat Rooms + +The ‘Chat Rooms’ app allows you to set up chat rooms for instant messaging within a hub and to chat with other channels within the hub. + +If you access the app from the app menu, your own chat rooms will be displayed. +To create a new chat room, click on the ‘Add Room’ button. + + + +Here you have to give the chat a name and you can choose how many minutes the chat content will expire after. It is also possible to use the [privacy tool](permissions_content.md) (🔒) to determine who is authorised to see and use the chat room. +The URL to the chat room is displayed in the browser and is also available via the link to the chat room in the left sidebar. Now you can share the URL with another user in your hub and start a chat with them. + + diff --git a/doc/en/member/clone.md b/doc/en/member/clone.md new file mode 100644 index 000000000..27acbfee7 --- /dev/null +++ b/doc/en/member/clone.md @@ -0,0 +1,47 @@ +## Clone + +Hubzilla channels have a so-called ‘nomadic identity’. This is a speciality of the Nomad protocol, on which Hubzilla is based and with which Hubzilla hubs communicate with each other. + +The nomadic identity makes it possible to create clones of your own channel, which greatly increases your resistance to censorship and outages. + +If you have cloned your channel, it is no problem if your ‘home hub’ fails or does not work correctly. You can seamlessly continue to participate in the Fediverse with a channel clone located on another hub. +All channel clones are automatically synchronised in the background. + +To create a clone of your channel, you need an account on another Hubzilla hub. +There are now several ways to create a clone of your channel on this other hub. + +You can use the ‘Channel Export’ app to export the channel on your ‘home hub’. + + + +By clicking on the ‘Export channel’ button, you can export your identity and your social graph to a file that you can download. +Since files, websites, wikis, calendars and chat rooms are always restricted to your own hub (i.e. the respective server), you can also use the ‘Channel export’ app to download archives of this data locally. +Now log in to the new hub and either select the ‘Channels’ menu item in the main menu (your profile picture; top left) and then the ‘+ Create new’ button on the channel selection page that appears, or go directly to the channel creation page at `<URL-of-your-hub>/new_channel`. + + + +On this page, however, you do not enter any information for creating a new channel, but instead select the link ‘import an existing channel from another server’ at the bottom of the dialogue. + + + +The dialogue for importing the channel now opens. + + + +Click on the ‘File to upload: Browse...’ button to open a file dialogue where you can select the previously saved channel file. + +As an alternative to this method, you can also clone your channel directly from the source, i.e. the originating hub. To do this, you must enter the handle of the channel to be cloned, the e-mail address for logging in to the source hub, and the corresponding password in the channel import dialogue. In addition, you can use a switch to select whether files and objects from the source hub should also be imported (provided that your new hub allows this and the storage limit is sufficient). + +In the dialogue, you can also specify whether the new hub should be your ‘primary hub’. This means that the new channel (the one you are now creating) will be your primary channel. This affects the handle of your channel, which will now end with the URL of the new hub. + +As a rule, unless you want to move completely to a different hub, you leave the switch at ‘No’ and the primary hub remains the one it currently is (the handle remains unchanged). + +If you would like a different channel name (short name), you can enter it in an additional input field. If you leave the field empty, the channel short name remains unchanged. + +*Note: If the channel short name is already in use on the new hub (or has been blocked because an identical channel already existed there but was deleted), the system will automatically modify the short name.* + +Finally, click on ‘Submit’ and do NOT leave the page until the import is complete. Depending on the size of the source channel, this may take some time. + +You can manage your clones at any time via Settings → Manage clone addresses. You can define which is the ‘primary hub’ and you can delete clones, although it is recommended that you delete cloned channels directly on the respective hub. + + diff --git a/doc/en/member/cloud_storage.md b/doc/en/member/cloud_storage.md new file mode 100644 index 000000000..8b9ce0046 --- /dev/null +++ b/doc/en/member/cloud_storage.md @@ -0,0 +1,8 @@ +### Cloud storage + +Your files are visible to everyone who is allowed to view them on the internet at `<URL-of-your-hub>/cloud/<your-channel-name>`. If the viewer has sufficient rights, they can also create new files and folders/directories. This option should only be used for smaller files and photos (up to a few megabytes), as it uses the internal memory. Please use WebDAV to upload larger files (videos, music, etc.). These files can still be accessed via the web access. + +With WebDAV, you can copy files directly into or out of your computer's operating system, with your cloud files appearing like a virtual drive. This should be used to upload large files such as video and audio files. +The URL for the cloud directory is `<URL-of-your-hub>/dav/`. + +If, depending on the DAV file system integration (depending on the operating system used and possibly the application), a username is required, this is the channel short name (i.e. without the leading ‘@’ and without the following ‘@hub address’). A possibly required password corresponds to your login password. diff --git a/doc/en/member/comanche.md b/doc/en/member/comanche.md new file mode 100644 index 000000000..57aa19902 --- /dev/null +++ b/doc/en/member/comanche.md @@ -0,0 +1,255 @@ +## Comanche page description language + +Comanche is a BBCode-like markup language that can be used to create elaborate and complex web pages by assembling them from a series of components, some of which are pre-built and others that can be defined on the fly. Comanche uses a page description language to create these pages. +Comanche primarily selects which content should appear in the various areas of the page. The various areas have names, and these names may change depending on the layout template selected. + +### Page templates + +There are currently five layout templates, unless your website offers additional layouts. + +**Standard template** + +The default template defines a ‘nav’ area at the top, ‘aside’ as a sidebar with a fixed width, ‘content’ for the main content area and ‘footer’ for a page footer. + +**Full template** + +The full template corresponds to the default template except that there is no ‘aside’ area. + +**Choklet** + +The Choklet template offers a range of fluid layout styles that can be set to taste: + +- (default flavour) - a two-column layout similar to the default template, but more flexible +- bannertwo - a two-column layout with a banner area, compatible with the default template on small displays +- three - three-column layout (adds a ‘right_aside’ area to the standard template) +- edgestwo - two-column layout with fixed margins +- edgesthree - three-column layout with fixed margins +- full - three-column layout with fixed margins and the addition of a ‘header’ area below the navigation bar + +**Redable** + +A template for reading longer texts in full screen mode (i.e. without a navigation bar). Three columns: aside, content and right_aside. +For maximum readability, it is advisable to use only the middle content column. + +**Zen** + +Gives you the freedom to do everything yourself. Just a blank page with a content area. +To select a layout template, use the ‘template’ tag. + +``` +[template]full[/template] +``` + +To select the template ‘choklet’ with the flavour ‘three’: + +``` +[template=three]choklet[/template] +``` + +The default template is used if no other template is specified. The template can use arbitrary names for the content regions. You will use ‘region’ tags to decide what content should be placed in which regions. +Three ‘macros’ have been defined for your use. + +``` +$htmlhead - replaced with the site head content. +$nav - replaced with the site navigation bar content. +$content - replaced with the main page content. +``` + +By default, `$nav` is inserted into the ‘nav’ page area and `$content` into the ‘content’ area. You only need to use these macros if you want to change the order of the elements or move them to other areas. +To select a theme for your page, use the ‘theme’ tag. + +``` +[theme]suckerberg[/theme] +``` + +This selects the theme ‘suckerberg’. By default, the theme preferred by your channel is used. + +``` +[theme=passion]suckerberg[/theme] +``` + +This selects the theme named ‘suckerberg’ and chooses the ‘passion’ scheme (theme variant). Alternatively, it is also possible to use compressed theme notation. + +``` +[theme]suckerberg:passion[/theme] +``` + +The compressed notation is not part of Comanche itself, but it is recognised by the Hubzilla platform as a theme specifier. + +**Navbar** + +``` +[navbar]tucson[/navbar] +``` + +Use the ‘tucson’ template for the navigation bar and CSS rules. By default, the ‘default’ template is used for the navigation bar. + +**Regions** + +Each region has a name, as mentioned above. You specify the region you are interested in with a ‘region’ tag containing the name. Any content you want to place in that region should be placed between the opening region tag and the closing tag. + +``` +[region=htmlhead]....content goes here....[/region] +[region=aside]....content goes here....[/region] +[region=nav]....content goes here....[/region] +[region=content]....content goes here....[/region] +``` + +**CSS and Javascript** + +We have the option of including Javascript and CSS libraries in the htmlhead section. Currently we use jquery (js), bootstrap (css/js) and foundation (css/js). +This overwrites the htmlhead of the selected theme. + +``` +[region=htmlhead] + [css]bootstrap[/css] + [js]jquery[/js] + [js]bootstrap[/js] +[/region] +``` + +**Menus and blocks** + +The website creation tools allow you to create menus and blocks in addition to page content. These provide a set of existing content that can be placed in the areas and order you specify. Each of these elements has a name that you set when you create the menu or block. + +``` +[menu]mymenu[/menu] +``` + +This places the menu ‘mymenu’ at this point on the page, which must be within an area. + +``` +[menu=horizontal]mymenu[/menu] +``` + +This places the menu named ‘mymenu’ at this point on the page, which must be within an area. It also assigns the class ‘horizontal’ to the menu. The class ‘horizontal’ is defined in the redbasic theme. It may or may not be available in other themes. + +``` +[menu][var=wrap]none[/var]mymenu[/menu] +``` + +The `[var=wrap]none[/var]` variable in a block removes the enclosing div element from the menu. + +``` +[block]contributors[/block] +``` + +This places a block named ‘contributors’ in this region. + +``` +[block=someclass]contributors[/block] +``` + +This places a block named ‘contributors’ in this region. In addition, the class ‘someclass’ is applied to the block. This replaces the default block classes ‘bblock widget’. + +``` +[block][var=wrap]none[/var]contributors[/block] +``` + +The variable `[var=wrap]none[/var]` in a block removes the enclosing div element from the block. + +**Widgets** + +Widgets are executable applications provided by the system that you can place on your page. Some widgets require arguments that you can use to customise the widget to your purpose. System widgets are listed here. Widgets can also be created by plugins, themes or your website administrator to provide additional functions. +Widgets and arguments are specified with the tags ‘widget’ and ‘var’. + +``` +[widget=recent_visitors][var=count]24[/var][/widget] +``` + +This loads the ‘recent_visitors’ widget and sets the ‘count’ argument to ‘24’. + +**Comments** + +The ‘comment’ tag is used to delimit comments. These comments are not displayed on the rendered page. + +``` +[comment]This is a comment[/comment] +``` + +**Conditional execution** + +You can use an ‘if’ construct to make decisions. These are currently based on the system configuration variable or the current observer. + +``` +[if $config.system.foo] + ... the configuration variable system.foo evaluates to ‘true’. +[else] + ... the configuration variable system.foo evaluates to ‘false’. +[/if] + +[if $observer] + ... this content will only be show to authenticated viewers +[/if] +``` + +The ‘else’ clause is optional. +In addition to the Boolean evaluation, several tests are supported. + +``` +[if $config.system.foo == bar] + ... the configuration variable system.foo is equal to the string ‘bar’ +[/if] +[if $config.system.foo != bar] + ... the configuration variable system.foo is not equal to the string ‘bar’ +[/if] +[if $config.system.foo {} bar ]... + the configuration variable system.foo is a simple array containing a value ‘bar’ +[/if] +[if $config.system.foo {*} bar]... + the configuration variable system.foo is a simple array containing a key named ‘bar’ +[/if] +``` + +**Complex example** + +``` +[comment]use an existing page template which provides a banner region plus 3 columns beneath it[/comment] + +[template]3-column-with-header[/template] + +[comment]Use the "darknight" theme[/comment] + +[theme]darkknight[/theme] + +[comment]Use the existing site navigation menu[/comment] + +[region=nav]$nav[/region] + +[region=side] + + [comment]Use my chosen menu and a couple of widgets[/comment] + + [menu]myfavouritemenu[/menu] + + [widget=recent_visitors] + [var=count]24[/var] + [var=names_only]1[/var] + [/widget] + + [widget=tagcloud][/widget] + [block]donate[/block] + +[/region] + + + +[region=middle] + + [comment]Show the normal page content[/comment] + + $content + +[/region] + + + +[region=right] + + [comment]Show my condensed channel "wall" feed and allow interaction if the observer is allowed to interact[/comment] + + [widget]channel[/widget] + +[/region] +``` + diff --git a/doc/en/member/commenting.md b/doc/en/member/commenting.md new file mode 100644 index 000000000..f41ad37e7 --- /dev/null +++ b/doc/en/member/commenting.md @@ -0,0 +1,8 @@ +### Commenting + +If you want to comment on a post, i.e. reply to it, click in the field at the bottom of the post (‘Comment’). This opens the comment editor, which is similar to the post editor. However, there are no fields for a title, a summary or categories. Below the input field for the content of the comment there are again buttons for certain formatting (not all that are available in the post editor, because not everything is possible in a comment) and on the right again a button for a preview, as well as a ‘Submit’ button to publish the comment. + + + +You can also mark up the text in the comment content field with Markdown, bbCode and HTML. +As there is no field for a summary, it is not possible to use this for a content warning regarding the comment. However, this can be achieved using bbCode by inserting the content warning in `[summary][/summary]`. This initially hides all of the following content, which can then be displayed by clicking on it. diff --git a/doc/en/member/connecting_with_channels.md b/doc/en/member/connecting_with_channels.md new file mode 100644 index 000000000..323a2af88 --- /dev/null +++ b/doc/en/member/connecting_with_channels.md @@ -0,0 +1,31 @@ +### Connecting with channels + +Connections in Hubzilla can have many different meanings. A connection is more precisely defined as a set of permissions that you have granted to another person. In traditional social networks, all connections are given the same permissions or at most two levels (friends and ‘followers’). In Hubzilla, a separate set of permissions can be set/customised depending on the situation and the relationship you have with the other channel. You can allow someone to see your posts, but not your photos. You can also deny them permission to comment on your posts or send private messages to you. But let's make it simple: you want to be friends with someone you know from social networks. How do you do that? + +You can view the directory. The directory is available on all Hubzilla sites, so if you search from your own site, you'll get results from across the network. You can search by name, interest, location and keyword. +If you already know someone's ‘handle’, you can contact them directly. A handle looks just like an email address (e.g. `bob@example.com)` but refers to a person in the open social network. In order to establish a connection, a compatible network protocol must be used. By default, this software supports the Nomad protocol, but other protocols can be provided via plugins/add-ons. For more information on connecting to channels on other networks, see below. + +#### How to connect to other Hubzilla channels: + +Visit the desired channel's profile by clicking on their photo in the directory, stream or comments and it will open their channel homepage in the channel viewer. On the left side of the screen you will normally see a link labelled ‘Connect’. Click on it and you're done. Depending on the settings of the channel you want to connect to, you may have to wait for the channel to approve your connection, but no further action is required on your part. Once you have initiated the connection, you will be redirected to the connection editor. Here you can assign specific authorisations for this channel if you want to make changes. + +You can also create a connection to any channel by going to the ‘Connections’ page of your website or directory and entering the ‘Handle’ in the ‘Add new connection’ field. Use this method if someone tells you their handle and you want to connect to them. The process is the same as when connecting via the ‘Connect’ button - you will then be redirected to the connection editor to set the authorisations. + +#### This is how you establish a connection to channels in other networks: + +The process for connecting to ‘channels’ on other networks (such as GNU Social, Mastodon, Misskey, Pleroma and Diaspora) is similar - enter their ‘handle’ in the ‘+Add’ field on the ‘Connections’ page. However, before you do this, please visit the App Management in the app menu and make sure that the appropriate protocol (Diaspora, GNU-Social/OStatus or ActivityPub) is deployed in your hub and ***enabled*** **for your channel**. These networks/protocols do not support account migration and location independence. So if you change location or clone your channel elsewhere, communication with these connections may fail. For this reason, these protocols are not enabled by default, but only with your consent. Enabling these protocols is an important decision between communicating with friends on these networks and account resilience in case your server goes down. + +Some communication networks offer more than one protocol. For example, you can connect to someone who uses both the ‘ostatus’ and ‘activitypub’ protocols for communication. In general, the ‘activitypub’ protocol provides a better experience than the ‘ostatus’ protocol, but Hubzilla often chooses the first protocol it detects, and that may not be what you want. You can connect to someone using a specific protocol by putting the protocol name in square brackets before their ‘handle’. For example + +`[activitypub]https://foo.bar/foobar` + +`[ostatus]foobar@foo.bar` + +`[diaspora]foobar@foo.bar[zot]foobar@foo.bar` + +`[feed]https://foo.bar/foobar` + +#### How to connect to RSS feeds: + +Your hub administrator can allow you to connect to RSS feeds. The procedure for connecting to an RSS feed is the same, except that you enter (or paste) the URL of the feed into the ‘Add new connection’ field. The options may be restricted by your hub administrator because connections to feeds can sometimes cause high system loads. + diff --git a/doc/en/member/connection_editor.md b/doc/en/member/connection_editor.md new file mode 100644 index 000000000..8a8fdde23 --- /dev/null +++ b/doc/en/member/connection_editor.md @@ -0,0 +1,31 @@ +### Connection editor + +If you click on the ‘Edit’ button for a contact in the ‘Connections’ app, the connection editor opens. +You can use the editor to assign a specific contact role to a contact. If required, you can use the ‘Contact Roles’ button to display the existing roles and also create new roles. Another button (Compare authorisations) allows you to compare the assigned authorisations with those of the standard authorisation role. + + + +You can use the ‘Privacy groups’ tab to assign a contact to one or more privacy groups. + + + +You can use the ‘Profiles’ tab to specify which of your profiles (if you have created several) is displayed to the contact. + + + +With the content filters, you can filter out posts from a contact with certain content or use filters to specify that only posts with defined content end up in the stream. + + + +You can use the contact tools to + +- block the contact, +- ignore, +- archive, +- hide + +or + +- delete. + + diff --git a/doc/en/member/connections.md b/doc/en/member/connections.md new file mode 100644 index 000000000..5176836ff --- /dev/null +++ b/doc/en/member/connections.md @@ -0,0 +1,23 @@ +## Connections + +You can use the ‘Connections’ app to display all your connections. + + + +In the overview, for each connection + +- the channel name +- the date of the connection +- the channel address (handle) +- the network of the contact (ActivityPub, Zot (Nomad), RSS, Diaspora...) + - you can use a filter next to it to display the channel's recent activities in the stream +- the profile picture +- and a coloured dot (traffic light colours) indicates the rights granted by the contact (if you rest the mouse pointer over the coloured dot, the rights granted are displayed) + +can be seen. + +A label is also displayed which shows the type of connection or warns that (in the case of clones) there is no connection at this location. +There is an ‘Edit’ button on the right of each contact entry, with which you can edit the connection using the connection editor. + +#include doc/en/member/connection_editor.md; +#include doc/en/member/diaspora_compat.md; diff --git a/doc/en/member/conversation_features.md b/doc/en/member/conversation_features.md new file mode 100644 index 000000000..991d4e60e --- /dev/null +++ b/doc/en/member/conversation_features.md @@ -0,0 +1,8 @@ +### Conversation features + +You can use this dialogue to define certain conversation features for a post: + +- Allow emoji reactions +- Allow dislikes +- Allow local marking (asterisks) +- Allow replies to comments diff --git a/doc/en/member/create_channels.md b/doc/en/member/create_channels.md new file mode 100644 index 000000000..7792b75a7 --- /dev/null +++ b/doc/en/member/create_channels.md @@ -0,0 +1,9 @@ +#### Create channels + +Once you have created your account, you will be presented with the ‘Add Channel’ screen. Normally, your first channel will be one that represents you - so it's a good idea to use your own name (or a pseudonym) as your channel name. The channel name should be considered the title or short description of your channel. The ‘Choose a short nickname’ field is similar to a ‘Username’. With what you enter here, you create a channel address (also known as a ‘handle’ in Fediverse) that other people can use to connect to you and that you can use to log in to other websites. This address looks like an email address and has the form `<nickname>@<your_hub>.` + +**Note**: ***In other Fediverse services, the handle is preceded by an ‘@’.*** ***With Hubzilla, this character must be omitted if you want to connect to another user or search for a handle, as an example.*** + +You can create additional channels via the ‘Channel manager’ link. + +As soon as you have done this, your channel is ready for use. Under `<your_hub>/channel/<nickname>` you will find your channel ‘Stream’. Your most recent activities are displayed here in reverse chronological order. diff --git a/doc/en/member/delete.md b/doc/en/member/delete.md new file mode 100644 index 000000000..1da26a5e2 --- /dev/null +++ b/doc/en/member/delete.md @@ -0,0 +1,3 @@ +### Delete + +This function can be used to delete posts from the stream. A normal user does not have this option in the global stream. Only an administrator can remove posts from this stream. diff --git a/doc/en/member/delete_account.md b/doc/en/member/delete_account.md new file mode 100644 index 000000000..eaaebe661 --- /dev/null +++ b/doc/en/member/delete_account.md @@ -0,0 +1,7 @@ +## Deleting your account + +If you wish to delete your account, i.e. all access to the hub, use the settings in the main menu (top left; profile picture): Settings → Account settings. + +At the top of the page, you will see a button labelled ‘Remove account’. Click on it and your account (account) will be deleted, including all content, after you enter your account password (for security purposes). + + diff --git a/doc/en/member/deleting_channel.md b/doc/en/member/deleting_channel.md new file mode 100644 index 000000000..fa8bb0892 --- /dev/null +++ b/doc/en/member/deleting_channel.md @@ -0,0 +1,9 @@ +## Deleting a channel + +If you want to delete your channel, use the settings in the main menu (top left; profile picture): Settings → Channel settings. +At the top of the page, you will see a button labelled ‘Remove channel’. Click on it and your channel, including all content, will be deleted after you enter your account password (for security purposes). + + + +***Note:*** It is no longer possible to create a new channel with the same name on this hub. This is because the channel nickname is locked in the database to prevent impersonation. However, if you need to restore the old channel (by cloning) on the hub, please ask the administrator to delete the locked nickname from the Hubzilla database. + diff --git a/doc/en/member/diaspora_compat.md b/doc/en/member/diaspora_compat.md new file mode 100644 index 000000000..ec8398d70 --- /dev/null +++ b/doc/en/member/diaspora_compat.md @@ -0,0 +1,37 @@ +### Diaspora Compatibility + +The Diaspora Protocol addon allows a site to communicate using the Diaspora protocol, which allows communications and connections to be made with Diaspora members (and also Friendica members, since that network also provides the Diaspora Protocol). + +This addon is available in the 'basic' and 'standard' server configurations. It is not available with and the plugin is disabled completely when you are using the 'pro' server configuration. The reason for this is that the Diaspora protocol is not very sophisticated and many $projectname features do not work well with it. + +Members will have to be aware of limitations of the protocol or limit their own activities to those which are compatible with Diaspora. The 'pro' server configuration is free from these limitations and you may use all of the project features and abilities without regard for how they translate to other networks. Many features are unique to Hubzilla and are supported by the Nomad protocol, which is our native communications language between servers/hubs. + +If you are using a configuration which allows direct Diaspora communications you should be aware of the limitations presented here. + +- Private mail retraction (unsend) is not possible for Diaspora connections. +- Private posts and their associated comments are sent in plaintext email notifications in Diaspora and Friendica. This is a major privacy issue and affects any private communications you have where *any* member of the conversation is on another network. Be aware of it. +- Access control only works on posts and comments. Diaspora members will get permission denied trying to access any other access controlled hubzilla objects such as files, photos, webpages, chatrooms, etc. In the case of private photos that are linked to posts, they will see a "prohibited sign" instead of the photo. Diaspora has no concept of private media and provides an illusion of photo privacy by using obscured URLs rather than protecting the photo from snooping by unauthorised viewers. + +There is no workaround except to make your media resources public (to everybody on the internet). + +- Edited posts will not be delivered. Diaspora members will see the original post/comment without edits. There is no mechanism in the protocol to update an existing post. We cannot delete it and submit another invisibly because the message-id will change and we need to keep the same message-id on our own network. The only workaround is to delete the post/comment and do it over. (If this is a post, this will delete any existing likes/comments). We may eventually provide a way to delete the out of date copy only from Diaspora and keep it intact on networks that can handle edits. +- Nomadic identity ($projectname 'standard' only) will not work with Diaspora. We may eventually provide an **option** which will allow you to "start sharing" from all of your clones when you make the first connection. The Diaspora person does not have to accept this, but it will allow your communications to continue if they accept this connection. Without this option, if you go to another server from where you made the connection originally or you make the connection before creating the clone, you will need to connect with them again from the new location. +- Post expiration is not supported on Diaspora. We may provide you an option to not send expiring posts to that network. In the future this may be provided with a remote delete request. +- End-to-end encryption is not supported. We will translate these posts into a lock icon, which can never be unlocked from the Diaspora side. +- Message verification will eventually be supported. +- Multiple profiles are not supported. Diaspora members can only see your default profile. +- Birthday events will not appear in Diaspora. Other events will be translated and sent as a post, but all times will either be in the origination channel's timezone or in GMT. We do not know the recipient's timezone because Diaspora doesn't have this concept. +- We currently allow tags to be hijacked by default. An option is provided to allow you to prevent the other end of the network from hijacking your tags and point them at its own resources. +- Community tags will not work. We will send a tagging activity as a comment. It won't do anything. +- Privacy tags (@!somebody) will not be available to Diaspora members. These tags may have to be stripped or obscured to prevent them from being hijacked - which could result in privacy issues. +- Plus-tagged hubzilla forums should work from Diaspora. +- You cannot use Diaspora channels as channel sources. +- Dislikes of posts will be converted to comments and you will have the option to send these as comments or not send them to Diaspora (which does not provide dislike). Currently they are not sent. +- We will do the same for both likes and dislikes of ***comments***. They can either be sent as comments or you will have the ability to prevent them from being transmitted to Diaspora. Currently they are not sent. +- Emojis are currently untranslated. +- "observer tags" will be converted to empty text. +- Embedded apps will be translated into links. +- Embedded page design elements (work in progress) will be either stripped or converted to an error message. +- Diaspora members will not appear in the directory. +- There are differences in oembed compatibility between the networks. Some embedded resources will turn into a link on one side or the other. + diff --git a/doc/en/member/direct_messages.md b/doc/en/member/direct_messages.md new file mode 100644 index 000000000..233d7864b --- /dev/null +++ b/doc/en/member/direct_messages.md @@ -0,0 +1,9 @@ +## Direct messages + +Direct messages are messages that are addressed to one or more individual connections. They are accessible via the network stream. A filter for direct messages has been added to the stream filter widget for quick access. + +If you want to send a direct message to one (or more) other users (direct messages can only be read by the recipients and the sender), you write a normal post and address it exclusively to the recipient(s) using a special mention. This is done with the private mention (privacy tag). A privacy tag is a name that is preceded by the two characters `@!` and which, in addition to marking these channels, also changes the data protection authorisations of the post so that only these are taken into account. + +You do not need to use a privacy tag to reply to a DN ‘privately’, i.e. as a DN. You simply reply directly to the incoming DN, which distributes the reply to all original recipients. + +As an alternative to the privacy tag, you can also select channels or privacy groups from the [privacy tool](permissions_content.md) (🔒). This is the more complicated way, but it also works. However, the use of a privacy tag overwrites any selection made in the privacy tool. So if you write a post that is to be sent as a direct message, you can omit the privacy tag and instead click on the padlock symbol next to the ‘Share’ button to access the authorisation settings. diff --git a/doc/en/member/directory.md b/doc/en/member/directory.md new file mode 100644 index 000000000..8871e6c3f --- /dev/null +++ b/doc/en/member/directory.md @@ -0,0 +1,15 @@ +## The Directory + +Hubzilla offers a channel directory via the app (in the app menu ⋮). The Hubzilla Grid channels are listed in the directory. + + + +The directory options in the left sidebar can be used to filter the scope of the directory. For example, you can restrict the listing to channels from your own hub. + +There is also a keyword cloud in the left sidebar, which you can use to find channels with corresponding interests/focal points. + +There is also a search field in the left sidebar to find channels by name / name components or interests (keywords). + +You can then connect directly to a channel found by clicking on the corresponding button. + +#include doc/en/member/AdvancedSearch.md; diff --git a/doc/en/member/display_settings.md b/doc/en/member/display_settings.md new file mode 100644 index 000000000..a500a7864 --- /dev/null +++ b/doc/en/member/display_settings.md @@ -0,0 +1,18 @@ +#### Display settings + +The display settings can be used to customise the design of the channel. In addition, you can determine which content is displayed, within certain limits. +In the design settings, you can select from the installed themes and set your design scheme for the topic. + + + +With the custom design settings, it is possible to adjust the colour scheme to your own preferences and to define corner rounding, standard sizes and standard dimensions for avatars. The default settings are initially displayed in simplified form, and only allow you to set the dark mode, choose a narrow navigation bar, set the width of the content area and adjust the font size. + + + +If you set the ‘Show advanced settings’ switch to ‘Yes’ and submit the selection, the advanced settings will be displayed, where you can set colours, avatar dimensions and background images. + + + +The content settings allow you to select various parameters (e.g. the time until the view is updated) and to switch off the display of the ‘links for new members’ that are displayed when new channels are created. + + diff --git a/doc/en/member/encryption.md b/doc/en/member/encryption.md new file mode 100644 index 000000000..68ef7532d --- /dev/null +++ b/doc/en/member/encryption.md @@ -0,0 +1,18 @@ +## Builtin Automatic Encryption + +Full disclosure: The encryption hubzilla uses per default is not absolutely waterproof. There *are* known procedures to circumvent it. *But* 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 *significant* 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 protect content via crypto-javascript browser-to-browser encryption (needs to be enabled in settings) Full disclosure: A rogue hub admin could injects malicious javascript-code (e.g. keylogging-abilities) into the code. Encrypt our stuff out of band with GPG, become a hub administrator yourself or use other means of communication if this worries you. + +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 *may* be able to decrypt everything by using 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 *quite an effort* to do this. And again: Other services store your messages in plain text unencrypted. So this *is* quite a significant win for your privacy. + +We believe that the NSA-level dragnet plaintext extracting mass surveillance is probably not possible due to the design of the Nomad protocol. Dedicated attacks including hacking into one hub to obtain the server logs and database only partly reveal what is going on between people communication between different hubs. We believe that this makes it much more expensive for state-level attackers to access your content in hubzilla. + + +We gladly accept help improving the security of the system and auditing it as well. diff --git a/doc/en/member/files.md b/doc/en/member/files.md new file mode 100644 index 000000000..642884fd0 --- /dev/null +++ b/doc/en/member/files.md @@ -0,0 +1,28 @@ +## Files + +Hubzilla provides cloud functionality. This means that you have a directory for each channel in which you can create further subdirectories and store files. You can define precise access rights for each directory, and even for each individual file. These can range from visibility for the general public, to visibility for members of certain groups, to individual approval for individual members of your own connections. It is even possible to share files with people who do not have a Hubzilla identity. This is done using guest access tokens. + +Creating and deleting directories and creating and deleting files is really easy. +You can access your cloud storage via the ‘app menu’ (⋮) → Files. You can also upload images via the files section, which is also possible via the ‘Photos’ section. + +The files can be displayed in a list view + + + +or in a tile view + + + +You can create new directories/folders with the ‘Create’ button. When creating a folder, you can also immediately define the [permissions for](permissions_content.md) the new folder (🔓). + +With the ‘+ Add files’ button, you can upload files to your cloud. Here, too, you can set the access permissions directly. + +To set or change access rights (permissions) for directories or files at a later time, click on the context menu (︙) of the file or directory. You can also perform various file operations here. + + + +If you attach a file using the ‘📎’ button when creating a post or comment, this file will be stored in a new directory (sample: `year-month`) in the cloud, if one is created. + +#include doc/en/member/photos.md; +#include doc/en/member/gallery.md; +#include doc/en/member/cloud_storage.md; diff --git a/doc/en/member/follow_conversation.md b/doc/en/member/follow_conversation.md new file mode 100644 index 000000000..55edff774 --- /dev/null +++ b/doc/en/member/follow_conversation.md @@ -0,0 +1,3 @@ +### Follow / unfollow conversation + +With Follow conversation / Unfollow conversation you can switch whether you want to follow a thread, i.e. whether you want to receive notifications about comments/replies, likes, dislikes, emoji reactions or that the post has been shared or re-shared. diff --git a/doc/en/member/gallery.md b/doc/en/member/gallery.md new file mode 100644 index 000000000..11cd31c7d --- /dev/null +++ b/doc/en/member/gallery.md @@ -0,0 +1,6 @@ +### Gallery + +The ‘Gallery’ app is a simple photo gallery that displays all your images from the cloud storage. +The displayed images are scaled appropriately, which can lead to a slightly blurred display for smaller images. It is more practical to use the ‘[Photos](fotos.md)’ app. + + diff --git a/doc/en/member/guest_access.md b/doc/en/member/guest_access.md new file mode 100644 index 000000000..0efce5ab5 --- /dev/null +++ b/doc/en/member/guest_access.md @@ -0,0 +1,15 @@ +## Guest access + +If you would like to share private content (i.e. content that is not accessible to the public) with people who do not have a Hubzilla account, you have the option of realising this using guest access. + +With guest access, you create a (possibly temporary) access that enables the user who logs in with this data to access your publicly accessible content, but also non-public content that you specifically release for guest access. + +If you call up the ‘Guest access’ app, a web form is displayed with which you can set up such guest access. You enter a login name of your choice. Hubzilla has already automatically generated a password for the guest access. You can now give these two pieces of information to the person you want to give access to content. + +In the ‘Expires’ field, you can also enter an expiry date after which the guest access will be automatically deleted. If you leave this field empty, the guest access will be created without a time limit. It will then never expire automatically and may have to be deleted manually. + +You can also define a [contact role](/help/member/permissions_contact_roles.md) for the guest access. + +All guest accounts are listed in the left-hand sidebar. If you select a guest account there, you can edit or delete it again (even before the deadline expires). + +As soon as a guest account has been created, it also appears in the ‘[Authorisation settings](/help/member/permissions_content.md)’ (privacy tool) under ‘User-defined selection’. You can use this to explicitly authorise individual private content for the guest account (but of course also for other contacts) so that the guest can access the content. diff --git a/doc/en/member/important_apps.md b/doc/en/member/important_apps.md new file mode 100644 index 000000000..63214f2e7 --- /dev/null +++ b/doc/en/member/important_apps.md @@ -0,0 +1,16 @@ +### Important apps + +If you want to use your channel mainly for social networking, there are some apps that are not installed or activated by default, some of which are essential. + +To participate in the entire Fediverse, you need to install the ‘**ActivityPub Protocol**’ app. + +To make it easier to find worthwhile contacts and find out what is happening in the Fediverse, you can install and use the ‘**[Public stream](/help/en/member/public_stream.md)**’ app. + +The ‘[**NSFW**](inhaltswarnung_NSFW.md)’ app, with which you can create and use your own content warning filters, is also useful and recommended. + +You should also install the ‘[**Superblock**](superblock.md)’ app, which allows you to completely block certain users. +The ‘[**Privacy Groups**](privacy_gruppen.md)’ app is also important. This makes it possible to create contact groups and filter them, as well as to communicate with the contacts in the groups. + +---- + +**<u>Please note:</u>** The ‘Public stream’ app is only available for installation if the hub administrator has activated this stream. diff --git a/doc/en/member/insert_images.md b/doc/en/member/insert_images.md new file mode 100644 index 000000000..d8be83428 --- /dev/null +++ b/doc/en/member/insert_images.md @@ -0,0 +1,50 @@ +### Insert images + +There are various ways to insert images into posts and comments. + +##### In the post editor + +There are two buttons in the post editor that allow you to insert images: ‘Embed image’ and ‘Attach/upload file’. + +With ‘Embed image’, you can insert an image that already exists in the cloud into the post. The image must therefore either be available or you can upload it for precisely this purpose, e.g. using the ‘Files’ app. + + + +If you select this button, an overview of the available image files opens and you only have to select and click on the appropriate image. Please note: After selecting the image to be inserted, the selection window must be closed again. It does not close automatically after inserting an image so that you have the option of inserting several images in one go. + +Once selected, the image, scaled to its original size, is inserted as a clickable link to the source file using the bbCode tags `[zrl][zmg][/zmg][/zrl]` at the end of the previous post (not at the current text cursor position). + + + +With ‘Attach/upload file’ an image can be uploaded directly from your own device and embedded at the end of the post. + + + +A file selection dialogue opens where you can select and upload the image on your own device. It is uploaded to an automatically created subdirectory in the cloud and inserted at the end of the previous post using the bbCode tags `[zrl][zmg][/zmg][/zrl]`. + +<u>Please note:</u> With this method, the image is not scaled to its original size but displayed as a smaller preview image if there is no continuous text. As a result, you may see a chequered background around the image. + + + +##### In the comment editor + +The comment editor only offers the option of uploading and embedding an image. The button for inserting an existing image does not exist there. + + + +If you still want to insert an existing image, you must do this manually using the tags `[img][/img]` or `[img=URL][/img]`. To do this, you need to know the URL of the image. In this way, you can also insert images from external sources on the web. + +If you use `[img=WIDTHxHEIGHT][/img]`, you can scale the image. + +##### Alt text + +If you want an alternative text (alt text) to be displayed when the image cannot be displayed or - as a pop-up - when you move the mouse pointer over the image, you can place it between the two tags `[img=URL]ALT_TEXT[/img]`. If you have embedded the image in a post using the first method (‘Embed image’), you have to do it yourself. You have to replace the scaling that was inserted in the opening zmg tag with the URL of the image and replace the automatically inserted image URL between the opening and closing zmg tag with the alt text. + +Example: + +The image was embedded and the code +`[zrl=https://klacker.org/photos/tutorial01/image/cd747cd9-3f05-42cd-94cc-91c7368c5a18][zmg=520x520]https://klacker.org/photo/cd747cd9-3f05-42cd-94cc-91c7368c5a18-2.png[/zmg][/zrl]` +was created automatically, then it must be changed to insert the alt text ‘Hubzilla icon on red background’, for example: +`[zrl=https://klacker.org/photos/tutorial01/image/cd747cd9-3f05-42cd-94cc-91c7368c5a18][zmg=https://klacker.org/photo/cd747cd9-3f05-42cd-94cc-91c7368c5a18-2.png520x520]Hubzilla icon on red background[/zmg][/zrl]` + + diff --git a/doc/en/member/interact.md b/doc/en/member/interact.md new file mode 100644 index 000000000..9dec01a2e --- /dev/null +++ b/doc/en/member/interact.md @@ -0,0 +1,24 @@ +## Interact with posts + +You can interact with posts that you see in the stream. This is one of the purposes of social networks. You can comment on such a post, but there are also other ways of interacting. +The buttons for this can be found at the bottom right of the post. + + + +You can ‘like’ 🖒 or ‘dislike’ a post 🖓 or you can react to a post with an emoji: + + + +Further functions can be found in the ⚙ menu. + + + +#include doc/en/member/repeat.md; +#include doc/en/member/share.md; +#include doc/en/member/link_to_source.md; +#include doc/en/member/save_to_folder.md; +#include doc/en/member/toggle_star_status.md; +#include doc/en/member/show_source_code.md; +#include doc/en/member/follow_conversation.md; +#include doc/en/member/delete.md; +#include doc/en/member/conversation_features.md; diff --git a/doc/en/member/link_to_source.md b/doc/en/member/link_to_source.md new file mode 100644 index 000000000..fdb7faf29 --- /dev/null +++ b/doc/en/member/link_to_source.md @@ -0,0 +1,3 @@ +### Link to source + +Link to source’ takes you to the actual source of a post. You end up at the original post on the instance of the post creator. diff --git a/doc/en/member/member_faq.bb b/doc/en/member/member_faq.bb deleted file mode 100644 index 9533cb557..000000000 --- a/doc/en/member/member_faq.bb +++ /dev/null @@ -1,10 +0,0 @@ -[h3]$Projectname FAQ[/h3] -[h4]I am able to edit a post's text after I saved it, but is there a way to change the permissions?[/h4] -Short anser: No, there isn't. There are reasons. You are able to change permissons to your files, photos and the likes, but not to posts after you have saved them. The main reason is: Once you have saved a post it is being distributed either to the public channel and from there to other $Projectname servers or to those you intended it to go. Just like you cannot reclaim something you gave to another person, you cannot change permissions to $Projectname 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 $Projectname is a global network and there is no way to follow a post, let alone reclaim it reliably. Other networks that may receive your post have no reliable way to delete or reclaim the post. -[h4]I downloaded my channel and imported it (cloned my identity) to another site but there is no content, no posts, no photos. What is wrong???[/h4] -Posts and photos/files are provided separately from the channel basic information. This is due to memory limitations dealing with years of conversations and photo archives. Posts and conversations can be synced separately from the basic channel information. Photos and file archives can be transferred using a plugin tool such as 'redfiles', which is currently listed as "experimental". When creating this feature we thought that keeping all your contacts was the most important task. Your friends have already seen your old content. Posts/conversations were next in priority and these may now be synced. Files and photos are the last bit to get completely working. Once we find someone willing to finish implementing this, it will be done. :) -[h4]I can't see private resources[/h4] -You have probably disabled third party cookies. You need to enable them for remote authentication to work. -[h4]There are a lot of foreign language posts. Let's auto-translate them.[/h4] -There are also a lot of [b]private[/b] foreign language posts and auto-translation services would require us to transmit these private messages to the translation service; and we don't know what they will do with them on their servers. Actually we do know thanks to Edward Snowden. Our best bet is a project called [b][i]Apertium[/i][/b] which is an open source translator we can install locally. It is currently missing German translations - which are the most requested translation in the matrix. Once again, this will be implemented when we find somebody who really wants to make it happen. diff --git a/doc/en/member/member_guide.bb b/doc/en/member/member_guide.bb deleted file mode 100644 index e3d62a4b5..000000000 --- a/doc/en/member/member_guide.bb +++ /dev/null @@ -1,1081 +0,0 @@ -[h3]Overview[/h3] - -While many features and capabilities of $Projectname are familiar to people who have used social networking sites and blogging software, there are also quite a few new concepts and features that most people have not encountered before. Some of the new ideas are related to the decentralized nature of the grid; others are associated with the advanced permissions system that is necessary to protect your data privacy. The purpose of this guide is to help you understand how to create, configure, and use your nomadic identity. - -[h3]Registration[/h3] - -Not all $Projectname 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 $Projectname 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 $Projectname 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 [zrl=[baseurl]/help/TermsOfService]Terms of Service[/zrl]. 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. - - - -[h3]Channels[/h3] - -[h4]What are channels?[/h4] - -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: -[ul] -[*]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) -[/ul] -In short, a channel that represents yourself is "me, on the internet". - - - -[h3]Channel Permission Roles[/h3] - -When you create a new channel, you will be asked to select a permission role based on how you envision using this channel. The most popular permission roles are the Social Networking roles. You have many other choices, providing options which are analagous to Facebook Groups and Pages, collaborative spaces, newsfeeds, and more. These roles automatically configure several different system variables ranging from what permissions are granted to friends, to your default privacy settings and visibility choices. Advanced configurations are available to let you adjust each of these parameters to your needs, but we've found that most people prefer to "set it and forget it". Thew following describes some of the different roles which are currently available and how they impact your privacy and ability to interact. - -[h4]Social[/h4] - -[b]Federation[/b] - -The channel is a very permissive social networking profile which is compatible with other federated social networks. The permission policies are similar to Twitter and mostly compatible with Diaspora and Mastodon. Privacy is a lower priority than ease of access and connecting with others. Anybody in the network can comment on your public posts and send you private mail. By default posts and published items are public, but you can over-ride this when creating the item and restrict it. You are listed in the directory. Your online presence and connections are visible to others. This mode [i]may[/i] increase your exposure to undesired communications and spam. This role is not generally recommended [i]unless[/i] you need to interact regularly with members of other networks. - -[b]Mostly Public[/b] - -The channel is a typical social networking profile. By default posts and published items are public, but you can over-ride this when creating the item and restrict it. You are listed in the directory. Your online presence and connections are visible to others. Only your immediate connections can comment on your public posts and send you private mail. The permission policies are similar to Facebook. - - -[b]Restricted[/b] - -By default all posts and published items are sent to your 'Friends' privacy group and not made public. New friends are added to this privacy group. You can over-ride this and create a public post or published item if you desire. You are listed in the directory. Your online presence (for chat) and your connections (friends) are visible to your profile viewers. - -[b]Private[/b] - -By default all posts and published items are sent to your 'Friends' privacy group. New friends are added to this privacy group. You can over-ride this and create a public post or public item if you desire. You are NOT listed in the directory. Only your connections can see your other connections. Your online presence is hidden. - - -[h4]Forum[/h4] - -[b]Mostly Public[/b] - -The channel is a typical forum. By default posts and published items are public. Members may post by !mention or wall-to-wall post. Posting photos and other published items is blocked. The channel is visible in the directory. Members are added automatically. - - -[b]Restricted[/b] - -By default all posts and published items are sent to the channel's 'Friends' privacy group. New friends are added to this privacy group. Members may post by !mention or wall-to-wall post, but posts and replies may also be seen by other receipients of the top-level post who are not members. The channel is visible in the directory. Members must be manually added by the forum owner. - -[b]Private[/b] - -By default all posts and published items are sent to your 'Friends' privacy group. New friends are added to this privacy group. The owner can over-ride this and create a public post or public item if desired. Members cannot. You are NOT listed in the directory. Only your connections can see your other connections. Your online presence is hidden. Members must be manually added by the forum owner. Posting by !mention is disabled. Posts can only be made via wall-to-wall posts, and sent to members of the 'Friends' privacy group. They are not publicly visible. - - -[h4]Feed[/h4] - - -[b]Public[/b] - -Similiar to Social - Mostly Public, but tailored for RSS feed sources. Items may be freely republished and sourced. Online presence is meaningless, therefore hidden. New connections are automatically approved. - - -[b]Restricted[/b] - -Not listed in directory. Online presence is meaningless, therefore hidden. Feed is published only to members of the 'Friends' privacy group. New connections are automatically added to this privacy group. Members must be manually approved by the channel owner. - - -[h4]Special[/h4] - -[b]Celebrity/Soapbox[/b] - -Listed in directory. Communications are by default public. Online presence is hidden. No commenting or feedback of any form is allowed, though connections have the ability to "like" your profile. - - -[b]Group Repository[/b] - -A public forum which allows members to post files/photos/webpages. - - -[h4]Custom/Expert Mode[/h4] - -Set all the privacy and permissions manually to suit your specific needs. - - -[h3]Creating channels[/h3] - - -After creating your account, 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 - -See Also -[zrl=[baseurl]/help/accounts_profiles_channels_basics]The Basics about Identities within $Projectname[/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] - - -You can create additonal channels from the "Channel Manager" link. - -Once you have done this, your channel is ready to use. At [observer=1][observer.url][/observer][observer=0][baseurl]/channel/username[/observer] 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 "hamburger" menu in most themes will provide you with navigation to other system components and apps. The Photos page contain photo albums, and the Events page contains events share by both yourself and your contacts. - -[b]Profiles[/b] - -$Projectname has unlimited profiles. You may use different profiles to show different "sides of yourself" to different audiences. This is different to having different channels. Different channels allow for completely different sets of information. You may have a channel for yourself, a channel for your sports team, a channel for your website, or whatever else. A profile allows for finely graded "sides" of each channel. For example, your default public profile might say "Hello, I'm Fred, and I like laughing". You may show your close friends a profile that adds "and I also enjoy dwarf tossing". - -You always have a profile known as your "default" or "public" profile. This profile is always available to the general public and cannot be hidden (there may be rare exceptions on privately run or disconnected sites). You may, and probably should restrict the information you make available on your public profile. - -That said, if you want other friends to be able to find you, it helps to have the following information in your public profile... - -[ul][*]Your real name or at least a nickname everybody knows -[*]A photo of you -[*]Your location on the planet, at least to a country level.[/ul] - -In addition, if you'd like to meet people that share some general interests with you, please take a moment and add some "Keywords" to your profile. Such as "music, linux, photography" or whatever. You can add as many keywords as you like. - -To create an alternate profile, first go to [zrl=[baseurl]/settings/features]Settings > Additional Features[/zrl] and enable "Multiple Profiles" there, otherwise you won't have the ability to use more than just your default profile. - -Then select "Edit Profiles" from the menu of your $Projectname site. You may edit an existing profile, change the profile photo, add things to a profile or create a new profile. You may also create a "clone" of an existing profile if you only wish to change a few items but don't wish to enter all the information again. To do that, click on the profile you want to clone and choose "Clone this profile" there. - -In the list of your profiles, you can also choose the contacts who can see a specific profile. Just click on "Edit visibility" next to the profile in question (only available for the profiles that are not your default profile) and then click on specific connections to add them to or remove them from the group of people who can see this profile. - -Once a profile has been selected, when the person views your profile, they will see the private profile you have assigned. If they are not authenticated, they will see your public profile. - -There is a setting which allows you to publish your profile to a directory and ensure that it can be found by others. You can change this setting on the "Settings" page. - -If you do not wish to be found be people unless you give them your channel address, you may leave your profile unpublished. - -[b]Keywords and Directory Search[/b] - -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. - -See Also - -[zrl=[baseurl]/help/AdvancedSearch]Advanced Searching[/zrl] - - -[h4]The grid, permissions and delegation[/h4] - -The "Grid" page contains all recent posts from across $Projectname network, 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 [zrl=[baseurl]/help/roles]permissions section[/zrl]. - -You can also delegate control of your channels' posts and connections, but not its configurations, to another channel. That is done by editing a connection and assigning it the permission to administer your channel's resources. - -[h3]Connecting To Channels[/h3] - -Connections in $Projectname can take on a great many different meanings. A connection is more accurately defined as a set of permissions that you have granted to somebody else. In traditional social network applications, all connections are granted the same permissions; or at most there two levels (friends and 'followers'). In $Projectname, a range of separate permissions may be set/adjusted depending on the siutation and relationship you have with the other channel. You can allow somebody to view your posts but not your photos. You can also deny them permission to comment on your posts or send private mail to you. 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 $Projectname 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. - -If you already know somebody's 'webbie' you can connect with them directly. A webbie looks just like an email address (for instance bob@example.com) but refers to somebody in the open social web. In order to connect they must be using a compatible network protocol. By default, this software supports the 'zot' protocol, however additional protocols may be provided through plugins/addons. See below for more information on connecting to channels on other networks. - -To connect with other $Projectname 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 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 wish to make any changes. - -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. The process is the same as connecting via the "Connect" button - you will then be taken to the connection editor to set permissions. - -To connect with channels on other networks: - -The process for connecting to channels on other networks (such as GNU-Social, Mastodon, and Diaspora) is similar - type their "webbie" into the "Add New Connections" box on the "Connections" page. Before you do this however, please visit your Settings page (Feature/Addon Settings) and ensure that the relevant protocol (Diaspora, GNU-Social/OStatus, or ActivityPub) is provided on your hub and [b][i]activated[/i] for your channel[/b]. These networks/protocols do not support account migration and location independence so if you move location or clone your channel elsewhere, communications with these connections may fail. For this reason these protocols are not activated by default, but only through your consent. Activating these protocols involves an important decision between communicating with friends on these networks or providing fail-safe account resilience if your server fails. - -Some communications offer more than one protocol. If you wish to connect with somebody on Mastodon (for instance) they can use either the 'ostatus' or the 'activitypub' protocol for communication. Generally the 'activitypub' protocol will provide a better experience than 'ostatus', but $Projectname will often choose the first protocol it discovers and this may not be the one you want. You may connect with somebody over a specific protocol by prepending the protocol name in square brackets to their "webbie". For example - -[code] -[activitypub]https://foo.bar/foobar -[ostatus]foobar@foo.bar -[diaspora]foobar@foo.bar -[zot]foobar@foo.bar -[feed]https://foo.bar/foobar -[/code] - - -To connect with RSS feeds: - -Your hub admin may allow connecting to RSS feeds. The process for connecting to an RSS feed is the same, exept type (or paste) the URL of the feed into the "Add New Connection" box. Feeds are only processed once or twice per day and your hub admin may impose limits on how many feeds you may add. - -[h4]Block/Ignore/Archive/Hide channels [/h4] - -Channels in your address book can have statuses such as [i]blocked[/i], [i]ignored[/i], [i]archived[/i] and [i]hidden[/i]. From your connections page you can see tabs that display the channels with those statuses. From your edit connection pages you can change the statuses of a channel. - -Here's their meaning: - -[b]Blocked:[/b] the channel can't read your items regardless of permissions, nor can it write to your channel. - -[b]Ignored:[/b] the channel can read your items if it has permission, but can't write to your channel. - -[b]Hidden:[/b] the channel does not show up in your profile's connections list, noone can see you're connected, but beware they may still show up to your other connections, for example in post replies. - -[b]Archived:[/b] if a channel can't be reached for 30 days, it is automatically marked as archived. This keeps all the data but stops polling the channel for new information and removes it from autocomplete. If later you learn the channel has come back online, you may manually unarchive it. - -[h4]Premium Channels[/h4] - -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. - -[h3]Permissions[/h3] -Permissions in $Projectname are more complete than you may be used to. This allows us to define more fine graded relationships than the black and white "this person is my friend, so they can do everything" or "this person is not my friend, so they can't do anything" permissions you may find elsewhere. - -[h4]Permission Roles[/h4] - -When you create a channel we allow you to select different 'roles' for that channel. These create an entire family of permissions and privacy settings that are appropriate for that role. Typical roles are "Social - mostly public", "Social - mostly private", "Forum - public" and many others. These bring a level of simplicity to managing permissions. Just choose a role and appropriate permissions are automatically applied. You can also choose 'Custom/Expert mode' and change any individual permission setting in any way you desire. - - -[h4]Default Permission Limits[/h4] - -There are a large number of individual permissions. These control everything from the ability to view your stream to the ability to chat with you. Every permission has a limit. The scope of these permissions varies from "Only me" to "Everybody on the internet" - though some scopes may not be available for some permissions. The limit applies to any published thing you create which has no privacy or access control. For example if you publish a photo and didn't select a specific audience with permission to view it, we apply the limit. These limits apply to everything within that permission rule, so you cannot apply a limit to one photo. The limit applies to all your photos. If all your photos are visible to everybody on the internet and you reduce the limit only to friends, [b]all[/b] of your photos will now be visible only to friends. - -[h4]Access Control[/h4] - -Access Control is the preferred method of managing privacy in [i]most[/i] cases, rather than using permission limits. This creates lists of either connections or privacy groups (or both) and uses the access list to decide if a permission is allowed. An access list is attached to everything you publish. Unlike permission limits, if you change the access control list on a single photo, it doesn't affect any of your other photos. You can use privacy groups and a "default access control list" to create and automate the management of access control lists to provide any level of privacy you desire on anything you publish. - -We highly recommend that you use the "typical social network" settings when you create your first channel, as it allows others to communicate with you and help you out if you have difficulty. You will find that these settings allow you as much privacy as you desire - when you desire it; but also allow you to communicate in public if you choose to. You are free to use much more private settings once you have learned your way around. - - -[dl terms="l"] -[*= The scopes of permissions are:] -[dl terms="i"] - [*= Nobody Except Yourself ] This is self explanatory. Only you will be allowed access. - - [*= 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 Hub ] Anybody with a channel on the same hub/website as you will have permission approved. Anybody who is registered at a different hub will have this permission denied. - - [*= Anybody in this network ] Anybody in $Projectname will have this permission approved. Even complete strangers. However, anybody not logged in/authenticated will have this permission denied. - - [*= Anybody authenticated ] This is similar to "anybody in this network" except that it can include anybody who can authenticate by any means - and therefore [i]may[/i] include visitors from other networks. - - [*=Guest Access Token] This allows you to share a file, folder, photo, album, or channel with a specific person or group of people. They don't need to be $Projectname members. You can set an expiration for the Access Token. - - [*= Anybody on the internet ] Completely public. This permission will be approved for anybody at all. -[/dl] -[*= The individual permissions are:] -[dl terms="i"] - [*= Can view my "public" stream and posts. ] This permision determines who can view your channel "stream" that is, the non-private posts that appear on the "home" tab when you're logged in. - - [*= Can view my "public" channel profile. ] This permission determines who can view your channel's profile. This refers to the "about" tab - - [*= Can view my "public" photo albums. ] This permission determines who can view your photo albums. Individual photographs may still be posted to a more private audience. - - [*= Can view my "public" address book. ] This permission determines who can view your contacts. These are the connections displayed in the "View connections" section. - - [*= Can view my "public" file storage. ] This permission determines who can view your public files stored in your cloud. - - [*= Can view my "public" pages. ] This permission determines who can view your public web pages. - - [*= Can send me their channel stream and posts. ] This permission determines whose posts you will view. If your channel is a personal channel (ie, you as a person), you would probably want to set this to "anyone in my address book" at a minimum. A personal notes channel would probably want to choose "nobody except myself". Setting this to "Anybody in the network" will show you posts from complete strangers, which is a good form of discovery. - - [*= Can post on my channel page ("wall"). ] This permission determines who can write to your wall when clicking through to your channel. - - [*= Can comment on my posts. ] This permission determines who can comment on posts you create. Normally, you would want this to match your "can view my public stream and posts" permission - - [*= Can send me private mail messages. ] This determines who can send you private messages (zotmail). - - [*= Can post photos to my photo albums. ] This determines who can post photographs in your albums. This is very useful for forum-like channels where connections may not be connected to each other. - - [*= Can forward to all my channel contacts via post tags. ] Using @- mentions will reproduce a copy of your post on the profile specified, as though you posted on the channel wall. This determines if people can post to your channel in this way. - - [*= Can chat with me (when available). ] This determines who can join the public chat rooms created by your channel. - - [*= Can write to my "public" file storage. ] This determines who can upload files to your public file storage, or 'cloud'. - - [*= Can edit my "public" pages. ] This determines who can edit your webpages. This is useful for wikis or sites with multiple editors. - - [*= Can administer my channel resources. ] This determines who can have full control of your channel. This should normally be set to "nobody except myself". -[/dl][/dl] -[i]Note:[/i] -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 individual permissions on the connnection edit screen. - -[h4]Affinity[/h4] - -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. - -[h3]Guest Access Tokens[/h3] -Guest access tokens (sometimes called "Zot access tokens") allow you to share a file, folder, photo, album, or channel with a specific person or group of people who are not $Projectname members. These tokens allow you to share individual items by sending a link that includes the token in the URL; alternatively, people can actually [i]log in[/i] using the token credentials, after which they can seamlessly view whatever content has been shared with that token. - -To create and manage guest tokens, open the [zrl=[baseurl]/settings/tokens/]Guest Access Tokens[/zrl] settings page. A random token is generate with each page load, allowing you to create one by inputting an associated login name and optionally specifying an expiration date. Existing tokens are listed below the dialog and can be edited by selecting them or deleted by pressing the trash icon. - -Additional permissions may be granted to the guest token by expanding the [b]Individual Permissions[/b] options and selecting privacy settings such as [b]Can view my channel stream and posts[/b] or [b]Can chat with me[/b]. - -[url=[baseurl]/help/feature/access_tokens]More details can be found here...[/url] - -[img][baseurl]/doc/member/assets/zat_dialog.png[/img] - - -[h3]Markup Languages[/h3] -$Projectname supports several markup languages for advanced formatting of content. The default markup language is a [url=[baseurl]/help/member/bbcode]custom variant of BBcode[/url], tailored for use in $Projectname. [url=[baseurl]/help/member/bbcode]BBcode[/url] is supported for posts, wiki pages, and web page elements. Wiki pages and webpage elements may also be written using standard Markdown. -[table border=0] -[tr][th]Content Type[/th][th]Supported Markup[/th][/tr] -[tr][td]Post[/td][td][url=[baseurl]/help/member/bbcode]BBcode[/url][/td][/tr] -[tr][td]Wiki[/td][td][url=[baseurl]/help/member/bbcode]BBcode[/url], Markdown[/td][/tr] -[tr][td]Webpage element[/td][td][url=[baseurl]/help/member/bbcode]BBcode[/url], Markdown, HTML[/td][/tr] -[/table] - -[h3]Tags And Mentions[/h3] - -[h4]Mentions[/h4] -You can mention a channel by simply preceding their name with the [code]@[/code] character, like this: - -[code] -@Jack -[/code] - -If the channel mentioned is in the list of recipients for the post or comment, they will receive a notification, bringing it to their attention. If they're [i]not[/i] among the recipients, the tag will simply work as a link to their profile. - -When you begin to mention somebody, it will create an auto-complete box to select from [u]your immediate connections[/u](?). Select one as appropriate. - - -[h4]Private Mentions[/h4] -If you wish to restrict a post to a single—or only a few—channels you can do this by selecting channels or privacy groups from the privacy tool. - -[img=[baseurl]/help/en/member/assets/privacy-tool-3.png]Two views of the permissions dialogue. To the left: Selecing a single privacy group or forum as recipients for the post. To the right: Using the 'Custom selection' view to gain fine grained control over the recipients.[/img] - -You can also just tag a channel with a [i]privacy tag[/i]. - -A privacy tag is a channel name preceded by the two characters [code]@![/code]. This will also change the privacy permissions of the post to only include the tagged channel. You can use more than one privacy tag, for instance [code]@!bob and @!linda[/code] will send the post only to Bob and Linda. This mechanism over-rides the privacy selector. - -[h4]Mentioning forums[/h4] - -Forums may be mentioned in the same way. [code]@!dogs[/code] will post to the dogs forum privately. The forum will redeliver the post to all the forum members, but your own followers will not see the post unless they are also members of the dogs forum. - -[size=small][b]Note:[/b] In previous releases you could mention a forum by prefixing the forum name with the characters [code]!![/code]. This is no longer supported. The correct way to send to a forum is by using the [code]@![/code] tag.[/size] - -[h4]Mentioning privacy groups[/h4] - -You may also tag privacy groups which are "public". - -When you create or edit a privacy group, there is a checkbox to allow the group members to be seen by others. If this box is checked for a group and you tag (for instance) [code]@!Friends[/code] - the post will be restricted to the Friends group. Check that the group is public before doing this - as there is no way to take back a post except to delete it. The group name will appear in the post and will alert members of that group that they are members of it. - -Set the privacy group visible to others to make it public: -[img=[baseurl]/help/en/member/assets/privacy-group-tool-public.png]The privacy group tool with 'Members are visible to other channels' set to 'yes'.[/img] - -To add or edit privacy groups, you need to have the [url=[baseurl]/group]Privacy Groups app[/url] installed. - -[h4]Mentions and Comments[/h4] -The above mechanisms only apply to "top-level" posts you create. Mentioning a channel with any of the above mechanisms has no effect in comments, except that the mentioned channel may receive a notification if they were already included as a recipient in the conversation. - -[h4]Topical Tags (also known as Hashtags)[/h4] -Topical tags are indicated by preceding the tag name with the [code]#[/code] character. This will create a link in the post to a generalised site search for the term provided. For example, #[zrl=[baseurl]/search?tag=cars]cars[/zrl] will provide a search link for all posts tagged with '[code]#cars[/code]' on your site. Topical tags are generally a minimum of three characters in length. Shorter search terms are not likely to yield any search results, although this depends on the database configuration. - -Topical tags are also not normally linked if they are purely numeric, e.g. [code]#1[/code]. If you wish to use a numeric hashtag, please add some descriptive text such as [code]#2012-elections[/code] or enclose the entire tag in double quotes (for example [code]#"2012"[/code]). Doubles quotes are also required if the tag contains spaces ([code]#"My Tag"[/code]) and may be required if the tag contains punctuation characters ([code]#"EndsWithPeriod."[/code] or [code]#"Exciting!!!"[/code]). - -[h4]Bookmarks[/h4] -Bookmarks indicate a link which can be saved to your bookmark folder. They use the sequence [code]#^[/code] followed by the link. Often these are generated automatically. - -[img=[baseurl]/help/en/member/assets/bookmarker-save-icon.png]Saving a bookmark by clicking the bookmark icon when the 'bookmarker' addon is enabled.[/img] - -If the site administrator has enabled the [url=[baseurl]/admin/addons/bookmarker]bookmarker[/url] addon for the site, this sequence will be converted to a bookmark icon when viewing the post or comment online. Clicking the icon will save the bookmark. - -Otherwise if the [url=[baseurl]/bookmarks]Bookmarks app[/url] is installed for the channel, the post dropdown menu contains a link for saving the bookmark or bookmarks. - -[img=[baseurl]/help/en/member/assets/bookmarks-menu-dropdown.png]A post with a bookmark, showing the dropdown menu.[/img] - -[h4]Manual Mentions[/h4] -Where possible please use the auto-complete window to select tag and mention recipients, because it will generate a coded tag which uniquely identifies one channel. Names are sometimes ambiguous. However, you can "manually" tag a channel by matching the channel name or address. - -[code] -@billy -[/code] - -will tag a connection whose name or network address is 'billy' (exact match). If you have two connections with a name or network address of billy, for instance [code]billy@server1.hubzilla.org[/code] and [code]billy@server2.hubzilla2.org[/code], you will need to supply the complete address or the results will be ambiguous and the wrong person may be tagged. - -[code] -@"Robert Johnson" -[/code] - -will tag Robert Johnson. The double quotes are required if the tagged name contains space characters. - - -[h3]Web Pages[/h3] - -$Projectname allows members and allowed connections to create static webpages. To activate this feature, enable the [b]Web Pages[/b] feature in your [b][url=[baseurl]/settings/features/]Additional Features[/url][/b] section. - -Once enabled, a new tab will appear on your channel page labeled "Webpages". Clicking this link will take you to the webpage editor. Pages will be accessible at [b][baseurl]/page/[observer=1][observer.webname][/observer][observer=0]channelname[/observer]/pagelinktitle[/b] - -The "page link title" box allows you to specify the "pagelinktitle" of this URL. If no page link title is set, we will set one for you automatically, using the message ID of the item. - -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. - -[h4]Using Blocks[/h4] - -Blocks can be parts of webpages. The basic HTML of a block looks like this -[code] - <div> - Block Content - </div> - -[/code] - -If a block has text/html content type it can also contain menu elements. Sample content of -[code] - <p>HTML block content</p> - [menu]menuname[/menu] - -[/code] -will produce HTML like this -[code] - <div> - <p>HTML block content</p> - <div> - <ul> - <li><a href="#">Link 1</a></li> - <li><a href="#">Link 2</a></li> - <li><a href="#">Link 3</a></li> - </ul> - </div> - </div> - -[/code] - -Via the $content macro a block can also contain the actual webpage content. For this create a block with only -[code] - $content - -[/code]as content. - -To make a block appear in the webpage it must be defined in the page layout inside a region. -[code] - [region=aside] - [block]blockname[/block] - [/region] - -[/code] - -The block appearance can be manipulated in the page layout. - -Custom classes can be assigned -[code] - [region=aside] - [block=myclass]blockname[/block] - [/region] - -[/code] -will produce this HTML -[code] - <div class="myclass"> - Block Content - </div> - -[/code] - -Via the wrap variable a block can be stripped off its wrapping <div></div> tag -[code] - [region=aside] - [block][var=wrap]none[/var]blockname[/block] - [/region] - -[/code] -will produce this HTML -[code] - Block Content -[/code] - -[h4]Webpage element import tool[/h4] - -There are two methods of importing webpage elements: uploading a zip file or referencing a local cloud files folder. Both methods require that the webpage elements are specified using a specific folder structure. The import tool makes it possible to import all the elements necessary to construct an entire website or set of websites. The goal is to accommodate external development of webpages as well as tools to simplify and automate deployment on a hub. - -[h5] Folder structure [/h5] -Element definitions must be stored in the repo root under folders called -[code] - /pages/ - /blocks/ - /layouts/ -[/code] - -Each element of these types must be defined in an individual subfolder using two files: one JSON-formatted file for the metadata and one plain text file for the element content. - -[h5] Page elements [/h5] -Page element metadata is specified in a JSON-formatted file called [code]page.json[/code] with the following properties: -[list] -[*] title -[*] pagelink -[*] mimetype -[*] layout -[*] contentfile -[/list] -[b]Example[/b] - -Files: -[code] - /pages/my-page/page.json - /pages/my-page/my-page.bbcode -[/code] -Content of [code]page.json[/code]: -[code] - { - "title": "My Page", - "pagelink": "mypage", - "mimetype": "text/bbcode", - "layout": "my-layout", - "contentfile": "my-page.bbcode" - } -[/code] -[h5] Layout elements [/h5] - -Layout element metadata is specified in a JSON-formatted file called [code]layout.json[/code] with the following properties: -[list] -[*] name -[*] description -[*] contentfile -[/list] -[b]Example[/b] - -Files: -[code] - /layouts/my-layout/layout.json - /layouts/my-layout/my-layout.bbcode -[/code] -Content of [code]layout.json[/code]: -[code] - { - "name": "my-layout", - "description": "Layout for my project page", - "contentfile": "my-layout.bbcode" - } -[/code] - -[h5] Block elements [/h5] - -Block element metadata is specified in a JSON-formatted file called [code]block.json[/code] with the following properties: -[list] -[*] name -[*] title -[*] mimetype -[*] contentfile -[/list] -[b]Example[/b] - -Files: -[code] - /blocks/my-block/block.json - /blocks/my-block/my-block.html -[/code] -Content of [code]block.json[/code]: - -[code] - { - "name": "my-block", - "title": "", - "mimetype": "text/html", - "contentfile": "my-block.html" - } -[/code] - -[h3]Comanche Page Description Language[/h3] - -Comanche is a markup language similar to [url=[baseurl]/help/member/bbcode]BBcode[/url] with which to create elaborate and complex web pages by assembling them from a series of components - some of which are pre-built and others which can be defined on the fly. Comanche uses a Page Decription Language to create these pages. - -Comanche primarily chooses what content will appear in various regions of the page. The various regions have names and these names can change depending on what layout template you choose. - -[h4]Page Templates[/h4] -Currently there are five layout templates, unless your site provides additional layouts. - -[dl terms="b"] -[*= default] -The default template defines a "nav" region across the top, "aside" as a fixed width sidebar, -"content" for the main content region, and "footer" for a page footer. - -[*= full] -The full template defines the same as the default template with the exception that there is no "aside" region. - -[*= choklet] -The choklet template provides a number of fluid layout styles which can be specified by flavour: -[list] -[*] (default flavour) - a two column layout similar to the "default" template, but more fluid -[*] bannertwo - a two column layout with a banner region, compatible with the "default" template on small displays -[*] three - three column layout (adds a "right_aside" region to the default template) -[*] edgestwo - two column layout with fixed side margins -[*] edgesthree - three column layout with fixed side margins -[*] full - three column layout with fixed side margins and adds a "header" region beneath the navigation bar -[/list] - -[*= redable] -A template for reading longer texts full screen (so without navigation bar). Three columns: aside, content and right_aside. -For maximum readability it is advised to only use the middle content column. - -[*= zen] -Gives you the freedom to do everything yourself. Just a blank page with a content region. -[/dl] - -To choose a layout template, use the 'template' tag. - -[code] - [template]full[/template] - -[/code] - -To choose the "choklet" template with the "three" flavour: - -[code] - [template=three]choklet[/template] - -[/code] - -The default template will be used if no other template is specified. The template can use any names it desires for content regions. You will be using 'region' tags to decide what content to place in the respective regions. - -Three "macros" have been defined for your use. -[code] - $htmlhead - replaced with the site head content. - $nav - replaced with the site navigation bar content. - $content - replaced with the main page content. - -[/code] - -By default, $nav is placed in the "nav" page region and $content is placed in the "content" region. You only need to use these macros if you wish to re-arrange where these items appear, either to change the order or to move them to other regions. - - -To select a theme for your page, use the 'theme' tag. -[code] - [theme]suckerberg[/theme] - -[/code] -This will select the theme named "suckerberg". By default your channel's preferred theme will be used. - -[code] - [theme=passion]suckerberg[/theme] - -[/code] -This will select the theme named "suckerberg" and select the "passion" schema (theme variant). Alternatively it may be possible to use a condensed theme notation for this. - -[code] - [theme]suckerberg:passion[/theme] - -[/code] - -The condensed notation isn't part of Comanche itself but is recognised by $Projectname platform as a theme specifier. - -[h4]Navbar[/h4] - -[code] - [navbar]tucson[/navbar] -[/code] - -Use the 'tucson' navbar template and CSS rules. By default the 'default' navbar template will be used. - - -[h4]Regions[/h4] -Each region has a name, as noted above. You will specify the region of interest using a 'region' tag, which includes the name. Any content you wish placed in this region should be placed between the opening region tag and the closing tag. - -[code] - [region=htmlhead]....content goes here....[/region] - [region=aside]....content goes here....[/region] - [region=nav]....content goes here....[/region] - [region=content]....content goes here....[/region] - -[/code] - -[h4]CSS and Javascript[/h4] -We have the possibility to include javascript and css libraries in the htmlhead region. At present we make use of jquery (js), bootstrap (css/js) and foundation (css/js). -This will overwrite the selected themes htmlhead. - -[code] - [region=htmlhead] - [css]bootstrap[/css] - [js]jquery[/js] - [js]bootstrap[/js] - [/region] - -[/code] - -[h4]Menus and Blocks[/h4] -Your webpage creation tools allow you to create menus and blocks, in addition to page content. These provide a chunk of existing content to be placed in whatever regions and whatever order you specify. Each of these has a name which you define when the menu or block is created. - -[code] - [menu]mymenu[/menu] - -[/code] -This places the menu called "mymenu" at this location on the page, which must be inside a region. - -[code] - [menu=horizontal]mymenu[/menu] - -[/code] -This places the menu called "mymenu" at this location on the page, which must be inside a region. Additionally it applies the "horizontal" class to the menu. "horizontal" is defined in the redbasic theme. It may or may not be available in other themes. - -[code] - [menu][var=wrap]none[/var]mymenu[/menu] - -[/code] -The variable [var=wrap]none[/var] in a block removes the wrapping div element from the menu. - -[code] - [block]contributors[/block] -[/code] -This places a block named "contributors" in this region. - -[code] - [block=someclass]contributors[/block] - -[/code] -This places a block named "contributors" in this region. Additionally it applies the "someclass" class to the block. This replaces the default block classes "bblock widget". - -[code] - [block][var=wrap]none[/var]contributors[/block] - -[/code] -The variable [var=wrap]none[/var] in a block removes the wrapping div element from the block. - -[h4]Widgets[/h4] -Widgets are executable apps provided by the system which you can place on your page. Some widgets take arguments which allows you to tailor the widget to your purpose. System widgets are listed [url=help/Widgets]here[/url]. Widgets can also ve created by plugins, themes, or your site administrator to provide additional functionality. - - -Widgets and arguments are specified with the 'widget' and 'var' tags. -[code] - [widget=recent_visitors][var=count]24[/var][/widget] - -[/code] - -This loads the "recent_visitors" widget and supplies it with the argument "count" set to "24". - -[h4]Comments[/h4] -The 'comment' tag is used to delimit comments. These comments will not appear on the rendered page. - -[code] - [comment]This is a comment[/comment] - -[/code] - -[h4]Conditional Execution[/h4] -You can use an 'if' construct to make decisions. These are currently based on system configuration variable or the current observer. - -[code] - [if $config.system.foo] - ... the configuration variable system.foo evaluates to 'true'. - [else] - ... the configuration variable system.foo evaluates to 'false'. - [/if] - - [if $observer] - ... this content will only be show to authenticated viewers - [/if] - -[/code] - - The 'else' clause is optional. - - Several tests are supported besides boolean evaluation. - -[code] - [if $config.system.foo == bar] - ... the configuration variable system.foo is equal to the string 'bar' - [/if] - [if $config.system.foo != bar] - ... the configuration variable system.foo is not equal to the string 'bar' - [/if] - [if $config.system.foo {} bar ] - ... the configuration variable system.foo is a simple array containing a value 'bar' - [/if] - [if $config.system.foo {*} bar] - ... the configuration variable system.foo is a simple array containing a key named 'bar' - [/if] -[/code] - -[h4]Complex Example[/h4] -[code] - [comment]use an existing page template which provides a banner region plus 3 columns beneath it[/comment] - - [template]3-column-with-header[/template] - - [comment]Use the "darknight" theme[/comment] - - [theme]darkknight[/theme] - - [comment]Use the existing site navigation menu[/comment] - - [region=nav]$nav[/region] - - [region=side] - - [comment]Use my chosen menu and a couple of widgets[/comment] - - [menu]myfavouritemenu[/menu] - - [widget=recent_visitors] - [var=count]24[/var] - [var=names_only]1[/var] - [/widget] - - [widget=tagcloud][/widget] - [block]donate[/block] - - [/region] - - - - [region=middle] - - [comment]Show the normal page content[/comment] - - $content - - [/region] - - - - [region=right] - - [comment]Show my condensed channel "wall" feed and allow interaction if the observer is allowed to interact[/comment] - - [widget]channel[/widget] - - [/region] - -[/code] - - -[h3]Personal Cloud Storage[/h3] - -$Projectname 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. - -[h4]File Attachments[/h4] - -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 [observer=1][baseurl]/cloud/[observer.webname][/observer][observer=0][baseurl]/cloud/username replacing username with the nickname you provided during channel creation[/observer]. - -[h4]Web Access[/h4] - -Your files are visible on the web at the location [observer=1][baseurl]/cloud/[observer.webname][/observer][observer=0][baseurl]/cloud/username[/observer] 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. This should only be used for smaller files and photos (up to a few megabytes) as it uses internal memory. For larger files (videos, music, etc.), please upload using WebDAV. These files may still be retrieved via web access. - -[h4]WebDAV access[/h4] - -WebDAV provides a way to copy files directly to or from your computer's operating system, where your cloud files appear as a virtual disk drive. This should be used to upload large files such as video and audio; as it is not limited to available memory. See [zrl=help/member/member_guide#Cloud_Desktop_Clients]Cloud Desktop Clients[/zrl] below. - -[h4]CalDAV and CardDAV access on Android[/h4] - -You can sync you calendar and contacts on Android with your Hub. - -The following steps where tested for [url=https://f-droid.org/en/packages/at.bitfire.davdroid/]DAVdroid[/url] -[list] -[*] install DAVdroid -[*] add account -[*] use "URL" and "user name" to login -[list] -[*] base url is [baseurl]/cdav -[*] user name is [observer=1][observer.webname][/observer][observer=0]username[/observer] -[/list] -[/list] - -To share your calendar visit [observer.baseurl]/cdav/calendar - - -[h4]Permissions[/h4] - -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 [observer=1][baseurl]/cloud/[observer.webname][/observer][observer=0][baseurl]/cloud/username[/observer] 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 privacy groups. - -[h3]Cloud Desktop Clients[/h3] - - -[h4]Cloud Desktop Clients - Windows[/h4] - -WebDAV using Windows 7 graphical user interface wizard: -1. Left-click the Start-button to open the start menu. -2. Right-click the My computer icon to access its menu. -3. Left-click Map network drive... to open the connection dialog wizard. -4. Type '[baseurl]/dav/nickname' in the textbox (replace nickname with your channel nickname) and click the Complete button. -5. Type your $Projectname channel nickname. IMPORTANT - NO at-sign or domain name. -6. Type your $Projectname password - -[h4]Cloud Desktop Clients - Linux[/h4] - -[h5]Mount as a filesystem[/h5] - -[b]Mounting As A Filesystem[/b] - -To install your cloud directory as a filesystem, you first need davfs2 installed. 99% of the time, this will be included in your distributions repositories. In Debian - -[code]apt-get install davfs2[/code] - -If you want to let normal users mount the filesystem - -[code] dpkg-reconfigure davfs2[/code] - -and select "yes" at the prompt. - -Now you need to add any user you want to be able to mount dav to the davfs2 group - -[code]usermod -aG davfs2 <DesktopUser>[/code] - -[b]Note:[/b] on some systems the user group may be different, i.e. - "network" -on Arch Linux. If in doubt, check the davfs documentation for your -particular OS. - -Edit /etc/fstab - -[code]nano /etc/fstab[/code] - - to include your cloud directory by adding - -[code] -[baseurl]/dav/ /mount/point davfs user,noauto,uid=<DesktopUser>,file_mode=600,dir_mode=700 0 1 -[/code] - -Where [baseurl] is the URL of your hub, /mount/point is the location you want to mount the cloud, and <DesktopUser> is the user you log in to one your computer. Note that if you are mounting as a normal user (not root) the mount point must be in your home directory. - -For example, if I wanted to mount my cloud to a directory called 'cloud' in my home directory, and my username was bob, my fstab would be - -[code][baseurl]/dav/ /home/bob/cloud davfs user,noauto,uid=bob,file_mode=600,dir_mode=700 0 1[/code] - -Now, create the mount point. - -[code]mkdir /home/bob/cloud[/code] - -and also create a directory file to store your credentials - -[code]mkdir /home/bob/.davfs2[/code] - -Create a file called 'secrets' - -[code]nano /home/bob/.davfs2/secrets[/code] - -and add your cloud login credentials - -[code] -[baseurl]/dav <username> <password> -[/code] - -Where <username> and <password> are the username and password [i]for your hub[/i]. - -Don't let this file be writeable by anyone who doesn't need it with - -[code]chmod 600 /home/bob/.davfs2/secrets[/code] - -Finally, mount the drive. - -[code]mount [baseurl]/dav[/code] - -You can now find your cloud at /home/bob/cloud and use it as though it were part of your local filesystem - even if the applications you are using have no dav support themselves. - -[b]Troubleshooting[/b] - -With some webservers and certain configurations, you may find davfs2 creating files with 0 bytes file size where other clients work just fine. This is generally caused by cache and locks. If you are affected by this issue, you need to edit your davfs2 configuration. - -[code]nano /etc/davfs2/davfs2.conf[/code] - -Your distribution will provide a sample configuration, and this file should already exist, however, most of it will be commented out with a # at the beginning of the line. - -First step is to remove locks. - -Edit the use_locks line so it reads [code]use_locks 0[/code]. - -Unmount your file system, remount your file system, and try copying over a file from the command line. Note you should copy a new file, and not overwrite an old one for this test. Leave it a minute or two then do [code]ls -l -h[/code] and check the file size of your new file is still greater than 0 bytes. If it is, stop there, and do nothing else. - -If that still doesn't work, disable the cache. Note that this has a performance impact so should only be done if disabling locks didn't solve your problem. Edit the cache_size and set it to [code]cache_size 0[/code] and also set file_refresh to [code]file_refresh 0[/code]. Unmount your filesystem, remount your file system, and test it again. - -If it [i]still[/i] doesn't work, there is one more thing you can try. (This one is caused by a bug in older versions of dav2fs itself, so updating to a new version may also help). Enable weak etag dropping by setting [code]drop_weak_etags 1[/code]. Unmount and remount your filesystem to apply the changes. - - -[h5]Dolphin[/h5] -Visit webdavs://example.com/dav where "example.com" is the URL of your hub. - -When prompted for a username and password, enter your channel name (the first part of your webbie - no @ or domain name) and password for your normal account. - -Note, if you are already logged in to the web interface via Konqueror, you will not be prompted for further authentication. - -[h5]Konqueror[/h5] - -Simply visit webdavs://example.com/dav after logging in to your hub, where "example.com" is the URL of your hub. - -No further authentication is required if you are logged in to your hub in the normal manner. - -Additionally, if one has authenticated at a different hub during their normal browser session, your identity will be passed to the cloud for these hubs too - meaning you can access any private files on any server, as long as you have permissions to see them, as long as you have visited that site earlier in your session. - -This functionality is normally restricted to the web interface, and is not available to any desktop software other than KDE. - -[h5]Nautilus[/h5] - -1. Open a File browsing window (that's Nautilus) -2. Select File > Connect to server from the menu -3. Type davs://<domain_name>/dav/<your_channelname> and click Connect -4. You will be prompted for your channel name (same as above) and password -5. Your personal DAV directory will be shown in the window - -[h5]Nemo[/h5] - -For (file browser) Nemo 1.8.2 under Linux Mint 15, Cinnamon 1.8.8. Nemo ist the standard file browser there. - -1st way -type "davs://<domain_name>/dav/<your_channelname>" in the address bar. - -2nd way -Menu > file > connect to server -Fill the dialog -- Server: hubzilla_domain_name -- Type: Secure WebDAV (https) -- Folder: /dav -- Username: yourchannelname -- Password: yourpassword - -Once open you can set a bookmark. - -[h5]Server Notes[/h5] - -Note: There have been reported issues with clients that use "chunked transfer encoding", which includes Apple iOS services, and also the "AnyClient" and "CyberDuck" tools. These work fine for downloads, but uploads often end up with files of zero size. This is caused by an incorrect implemention of chunked encoding in some current FCGI (fast-cgi) implementations. Apache running with PHP as a module does not have these issues, but when running under FCGI you may need to use alternative clients or use the web uploader. At the time of this writing the issue has been open and no updates provided for at least a year. If you encounter zero size files with other clients, please check the client notes; as there are occasional configuration issues which can also produce these symptoms. - -[h3]Saved Searches[/h3] - -In order to quickly find information, the 'saved search' widget may be used. This widget may be presented as a sidebar tool on your network page and possibly from your channel page. It is differentiated from the 'navigation bar' search tool in that it does not search the entire site, but only the subset of information available to your channel. - -Additionally the search terms you provide may activate a one-time search or be saved in a list for re-use. Saving the search item also invokes the search in addition to adding it to the saved list (which is displayed below the search text entry box). Any item in the list may be discarded if it is no longer needed. - -The saved search widget will provide autocompletion of channels (the results are prefixed with '@'), and hashtags (prefixed with '#'). You do not need to enter these tags; although entering the desired tag will reduce the autocomplete results to only hold the relevant information. The behaviour maps as follows: - -[list] -[*]@name - search your network stream for posts or comments written by 'name'. This will also change the post editor permissions to include only 'name'; as if this was a privacy group. -[*]#hashtag - search you network stream for posts containing #hashtag. -[*]text - search your network stream for posts containing 'text'. -[/list] - - -[h3]Remove Channel or Account[/h3] - -[h4]Remove Channel[/h4] - -Select the 'Remove Channel' link on your channel settings page or visit the URL: - - [baseurl]/removeme - -You will need to confirm your password and the channel you are currently logged into will be removed. - -[hl][i][b]This is irreversible.[/b][/i][/hl] - -If you have identity clones on other hubs this only removes by default the channel instance which exists on this hub. - -[h4]Remove Account[/h4] - -Select 'Remove Account' from your account settings page or visit the URL: - - [baseurl]/removeaccount - -You will need to confirm your password and the account you are currently logged into will be removed. - -[hl][i][b]This is irreversible.[/b][/i][/hl] - -All your channels will be deleted. If you have identity clones on other hubs this only removes by default the channels instances which exists on this hub. - diff --git a/doc/en/member/mentions.md b/doc/en/member/mentions.md new file mode 100644 index 000000000..ac668c46d --- /dev/null +++ b/doc/en/member/mentions.md @@ -0,0 +1,8 @@ +## Mentions + +Channels (users) are labelled by simply prefixing their name (handle) with the @ sign. `@Jack` +When you mention someone, an autocomplete field is created from which you can select your immediate connections. Select accordingly. + +If the contact is authorised to receive your posting, they will receive a tag notification. + +If the addressee is not in your contact list, you must write out the handle after the ‘@’ sign. If the recipient also authorises mentions of third parties, they will also be notified of the mention. diff --git a/doc/en/member/overview.md b/doc/en/member/overview.md new file mode 100644 index 000000000..cba453093 --- /dev/null +++ b/doc/en/member/overview.md @@ -0,0 +1,3 @@ +## Overview + +While many of Hubzilla's features and capabilities will be familiar to those who have used social networking sites and blogging software before, there are also some new concepts and features that most people have not yet encountered. Some of the new ideas are related to the decentralised nature of the grid, others to the advanced permission system needed to protect your data. This guide will help you understand how to create, configure and use your nomadic identity. diff --git a/doc/en/member/permissions.md b/doc/en/member/permissions.md new file mode 100644 index 000000000..f5704e5f1 --- /dev/null +++ b/doc/en/member/permissions.md @@ -0,0 +1,7 @@ +## Permissions + +Permissions are a core element of Hubzilla. They allow very fine-grained options for making content accessible, hiding it or restricting its use. They are also used to make direct messages possible by using authorisations to determine who can see the post (direct messages are nothing else) and who cannot. + +#include doc/en/member/permissions_content.md; +#include doc/en/member/permissions_channel_roles.md; +#include doc/en/member/permissions_contact_roles.md; diff --git a/doc/en/member/permissions_channel_roles.md b/doc/en/member/permissions_channel_roles.md new file mode 100644 index 000000000..b968f6ab5 --- /dev/null +++ b/doc/en/member/permissions_channel_roles.md @@ -0,0 +1,45 @@ +### Permissions - User-defined channel roles + +[Channel roles](channel_roles.md) define which rights are granted when interacting with a channel. They can be accessed under ‘Settings’ → ‘Channel settings’. + +The role for a channel can be defined here. Channel roles also have an influence on contact roles because individual rights that are specified and inherited from the channel roles overwrite your own settings there. +To truly customise the role permissions of your channel, you must select ‘User-defined’ as the channel role. + +The other roles (‘Public’, ‘Personal’, ‘Community Forum’) are predefined authorisation roles (see: [Channel roles](channel_roles.md)). + +With the customised channel roles, you can define who can perform the following interactions and how: + +- Can see my channel stream and my posts +- Can send me the posts from their channel +- Can see my default profile +- Can see my connections +- Can see my file and image folders +- Can upload/modify my file and image folders +- Can see the web pages of my channel +- Can see my wiki pages +- Can create/edit web pages in my channel +- Can edit my wiki pages +- Can publish posts on my channel page (‘wall’) +- Can send me direct messages +- Can like/dislike profiles and profile stuff +- Can chat with me +- Can quote/mirror my public posts in other channels +- Can administer my channel + +The following authorisations are then available for these interactions: + +- Only me +- Only those you explicitly allow +- Accepted connections +- Any connections +- Everyone on this website +- All Hubzilla members +- Anyone authenticated +- Anyone on the Internet + +To edit the **custom role**, select ‘Privacy settings’ in the settings. At the bottom right you will find the button ‘Custom channel role configuration’. If you click on it, a warning dialogue appears, which draws your attention to the risks of incorrect configuration. If you confirm that you want to edit the rights, the settings dialogue for the user-defined role rights opens. + +---- + +**Important note:** +The user-defined roles should be set with caution and harbour the risk that the channel will no longer behave as desired with certain configurations. diff --git a/doc/en/member/permissions_contact_roles.md b/doc/en/member/permissions_contact_roles.md new file mode 100644 index 000000000..b340930a1 --- /dev/null +++ b/doc/en/member/permissions_contact_roles.md @@ -0,0 +1,17 @@ +### Permissions - Contact roles + +Contact roles are used to create roles (i.e. a collection of rights and options) for contacts. These roles can then be assigned to a contact or all contacts in a privacy group (not the group itself). This restricts or extends the possibilities of contacts. + +The ‘Contact roles’ app can be used to create roles that correspond to the [channel roles](permissions_channel_roles.md). This permission role can then be assigned to individual contacts or all contacts in a privacy group in the contact editor or privacy group editor. + +After creation, each channel automatically has the ‘Standard’ contact role (‘System role - not editable’). New contacts are automatically assigned this contact role (unless you create your own contact role, change this default setting and assign the new, customised role to new contacts in future). The default contact role includes authorisations based on the selected channel role. In addition to the rights granted by the channel role, some other rights are granted so that the channel behaves as you would expect based on the channel role (e.g. ‘Public’ is most similar to a ‘normal’ social network channel). + + + +Note: Some of the rights of a channel role (whether standard or self-created) are inherited from the channel role. These rights cannot be revoked in the contact role. The contact role is a whitelist in which only additional rights can be granted. + +You can assign a contact role to a contact in the [connection editor](connection_editor.md). This dialogue also appears when you add a new contact. By default, the contact role for which the ‘Automatically assign this role to new contacts’ switch has been activated is selected here. + + + +For channels without self-defined contact roles, this is always ‘Standard’. There is also a ‘Contact Roles’ button in the connection editor which takes you to the contact role editor if you want to create a new contact role for the contact. diff --git a/doc/en/member/permissions_content.md b/doc/en/member/permissions_content.md new file mode 100644 index 000000000..83d51922c --- /dev/null +++ b/doc/en/member/permissions_content.md @@ -0,0 +1,32 @@ +### Permissions for content + +If you share content on Hubzilla, i.e. publish posts, upload images or texts, enter appointments in the calendar, you can define exactly who has access to this content. +You can access the permission settings for content via a button ("Privacy Tool") with a padlock symbol 🔒or 🔓. + +For sharing posts:  + +For creating folders/directories in the cloud storage:  + +For uploading files:  + +For sharing dates/events:  + +There are also corresponding permission setting options for websites, wiki pages and various other content. + +If you click on the icon, the permissions dialogue opens, which you can use to set the permissions for other users (this is usually about the visibility of content). + + + +You have the choice between + +- **Public** - As the name suggests, the content is visible to everyone on the Internet. So even for users who do not use a Fediverse service. +- **Only me** - Here, only the user who created the content can see it. They ‘share’ it with themselves. +- **Privacy groups** - The content is visible to all users who are in one of your privacy groups. +- **Customised selection** - Here you can specify exactly who can see the content. It is also possible to combine privacy groups and individual contacts by selecting ‘Allow’ or ‘Deny’ for the respective entry. + + + +---- + +**Important note:** +Once permissions for postings have been set, they can no longer be changed! A posting is immediately distributed to an indeterminable number of other servers, so that permissions cannot be subsequently granted or withdrawn, whereas permissions for other content such as files, images, etc. can be subsequently edited because this content is only stored on your own instance (hub) and only the reference to the content is passed on when it is shared. diff --git a/doc/en/member/photos.md b/doc/en/member/photos.md new file mode 100644 index 000000000..5a25fa9c3 --- /dev/null +++ b/doc/en/member/photos.md @@ -0,0 +1,17 @@ +### Photos + +The Photos app is a special management/viewing tool for images uploaded to your own cloud. It displays thumbnails instead of tiles or file names, which makes it easier to find specific images. + + + +Clicking on the image will take you to the image view. There are two control icons here to switch to the next or previous photo. + + + +There is also a ‘Photo tools’ button that allows you to set the image as a profile picture or banner and to edit the image using a menu. + + + +Clicking on the image again will open a full-size view. + + diff --git a/doc/en/member/pic/apps01.png b/doc/en/member/pic/apps01.png Binary files differnew file mode 100644 index 000000000..5330c148c --- /dev/null +++ b/doc/en/member/pic/apps01.png diff --git a/doc/en/member/pic/apps02.png b/doc/en/member/pic/apps02.png Binary files differnew file mode 100644 index 000000000..ef003e66d --- /dev/null +++ b/doc/en/member/pic/apps02.png diff --git a/doc/en/member/pic/apps03.png b/doc/en/member/pic/apps03.png Binary files differnew file mode 100644 index 000000000..65495c445 --- /dev/null +++ b/doc/en/member/pic/apps03.png diff --git a/doc/en/member/pic/apps04.png b/doc/en/member/pic/apps04.png Binary files differnew file mode 100644 index 000000000..4c219fb6c --- /dev/null +++ b/doc/en/member/pic/apps04.png diff --git a/doc/en/member/pic/apps05.png b/doc/en/member/pic/apps05.png Binary files differnew file mode 100644 index 000000000..9fee0ed74 --- /dev/null +++ b/doc/en/member/pic/apps05.png diff --git a/doc/en/member/pic/apps06.png b/doc/en/member/pic/apps06.png Binary files differnew file mode 100644 index 000000000..566b0a0d6 --- /dev/null +++ b/doc/en/member/pic/apps06.png diff --git a/doc/en/member/pic/apps07.png b/doc/en/member/pic/apps07.png Binary files differnew file mode 100644 index 000000000..eb9f9029a --- /dev/null +++ b/doc/en/member/pic/apps07.png diff --git a/doc/en/member/pic/apps08.png b/doc/en/member/pic/apps08.png Binary files differnew file mode 100644 index 000000000..6f787d357 --- /dev/null +++ b/doc/en/member/pic/apps08.png diff --git a/doc/en/member/pic/article01.png b/doc/en/member/pic/article01.png Binary files differnew file mode 100644 index 000000000..50788249f --- /dev/null +++ b/doc/en/member/pic/article01.png diff --git a/doc/en/member/pic/article02.png b/doc/en/member/pic/article02.png Binary files differnew file mode 100644 index 000000000..0f5c5f504 --- /dev/null +++ b/doc/en/member/pic/article02.png diff --git a/doc/en/member/pic/article03.png b/doc/en/member/pic/article03.png Binary files differnew file mode 100644 index 000000000..3c9c8330c --- /dev/null +++ b/doc/en/member/pic/article03.png diff --git a/doc/en/member/pic/article04.png b/doc/en/member/pic/article04.png Binary files differnew file mode 100644 index 000000000..afb88b9c7 --- /dev/null +++ b/doc/en/member/pic/article04.png diff --git a/doc/en/member/pic/article05.png b/doc/en/member/pic/article05.png Binary files differnew file mode 100644 index 000000000..e54844b49 --- /dev/null +++ b/doc/en/member/pic/article05.png diff --git a/doc/en/member/pic/author.png b/doc/en/member/pic/author.png Binary files differnew file mode 100644 index 000000000..75ec9e636 --- /dev/null +++ b/doc/en/member/pic/author.png diff --git a/doc/en/member/pic/block-etc01.png b/doc/en/member/pic/block-etc01.png Binary files differnew file mode 100644 index 000000000..b04d34203 --- /dev/null +++ b/doc/en/member/pic/block-etc01.png diff --git a/doc/en/member/pic/bookm01.png b/doc/en/member/pic/bookm01.png Binary files differnew file mode 100644 index 000000000..97cdcab11 --- /dev/null +++ b/doc/en/member/pic/bookm01.png diff --git a/doc/en/member/pic/bookm02.png b/doc/en/member/pic/bookm02.png Binary files differnew file mode 100644 index 000000000..b57aa435e --- /dev/null +++ b/doc/en/member/pic/bookm02.png diff --git a/doc/en/member/pic/bookm03.png b/doc/en/member/pic/bookm03.png Binary files differnew file mode 100644 index 000000000..54ada0db9 --- /dev/null +++ b/doc/en/member/pic/bookm03.png diff --git a/doc/en/member/pic/cal01.png b/doc/en/member/pic/cal01.png Binary files differnew file mode 100644 index 000000000..16bbce37b --- /dev/null +++ b/doc/en/member/pic/cal01.png diff --git a/doc/en/member/pic/cal02.png b/doc/en/member/pic/cal02.png Binary files differnew file mode 100644 index 000000000..217468d57 --- /dev/null +++ b/doc/en/member/pic/cal02.png diff --git a/doc/en/member/pic/cal03.png b/doc/en/member/pic/cal03.png Binary files differnew file mode 100644 index 000000000..a64a10a1f --- /dev/null +++ b/doc/en/member/pic/cal03.png diff --git a/doc/en/member/pic/cal04.png b/doc/en/member/pic/cal04.png Binary files differnew file mode 100644 index 000000000..8dca0419c --- /dev/null +++ b/doc/en/member/pic/cal04.png diff --git a/doc/en/member/pic/cal05.png b/doc/en/member/pic/cal05.png Binary files differnew file mode 100644 index 000000000..b13d30f86 --- /dev/null +++ b/doc/en/member/pic/cal05.png diff --git a/doc/en/member/pic/carddav01.png b/doc/en/member/pic/carddav01.png Binary files differnew file mode 100644 index 000000000..10b02c040 --- /dev/null +++ b/doc/en/member/pic/carddav01.png diff --git a/doc/en/member/pic/carddav02.png b/doc/en/member/pic/carddav02.png Binary files differnew file mode 100644 index 000000000..eea60f355 --- /dev/null +++ b/doc/en/member/pic/carddav02.png diff --git a/doc/en/member/pic/carddav03.png b/doc/en/member/pic/carddav03.png Binary files differnew file mode 100644 index 000000000..c711bf5a5 --- /dev/null +++ b/doc/en/member/pic/carddav03.png diff --git a/doc/en/member/pic/carddav04.png b/doc/en/member/pic/carddav04.png Binary files differnew file mode 100644 index 000000000..56c70c93b --- /dev/null +++ b/doc/en/member/pic/carddav04.png diff --git a/doc/en/member/pic/carddav05.png b/doc/en/member/pic/carddav05.png Binary files differnew file mode 100644 index 000000000..59aa8cfa6 --- /dev/null +++ b/doc/en/member/pic/carddav05.png diff --git a/doc/en/member/pic/carddav06.png b/doc/en/member/pic/carddav06.png Binary files differnew file mode 100644 index 000000000..d38ddd34e --- /dev/null +++ b/doc/en/member/pic/carddav06.png diff --git a/doc/en/member/pic/carddav07.png b/doc/en/member/pic/carddav07.png Binary files differnew file mode 100644 index 000000000..9869dcb95 --- /dev/null +++ b/doc/en/member/pic/carddav07.png diff --git a/doc/en/member/pic/center.png b/doc/en/member/pic/center.png Binary files differnew file mode 100644 index 000000000..c3ce7b125 --- /dev/null +++ b/doc/en/member/pic/center.png diff --git a/doc/en/member/pic/chat01.png b/doc/en/member/pic/chat01.png Binary files differnew file mode 100644 index 000000000..93bc9a77a --- /dev/null +++ b/doc/en/member/pic/chat01.png diff --git a/doc/en/member/pic/chat02.png b/doc/en/member/pic/chat02.png Binary files differnew file mode 100644 index 000000000..0d699f2e8 --- /dev/null +++ b/doc/en/member/pic/chat02.png diff --git a/doc/en/member/pic/clone01.png b/doc/en/member/pic/clone01.png Binary files differnew file mode 100644 index 000000000..b58ae4948 --- /dev/null +++ b/doc/en/member/pic/clone01.png diff --git a/doc/en/member/pic/clone02.png b/doc/en/member/pic/clone02.png Binary files differnew file mode 100644 index 000000000..fb4d69541 --- /dev/null +++ b/doc/en/member/pic/clone02.png diff --git a/doc/en/member/pic/clone03.png b/doc/en/member/pic/clone03.png Binary files differnew file mode 100644 index 000000000..2e97842de --- /dev/null +++ b/doc/en/member/pic/clone03.png diff --git a/doc/en/member/pic/clone04.png b/doc/en/member/pic/clone04.png Binary files differnew file mode 100644 index 000000000..16b2d5298 --- /dev/null +++ b/doc/en/member/pic/clone04.png diff --git a/doc/en/member/pic/clone05.png b/doc/en/member/pic/clone05.png Binary files differnew file mode 100644 index 000000000..5ac750c8b --- /dev/null +++ b/doc/en/member/pic/clone05.png diff --git a/doc/en/member/pic/code.png b/doc/en/member/pic/code.png Binary files differnew file mode 100644 index 000000000..2bed8e01a --- /dev/null +++ b/doc/en/member/pic/code.png diff --git a/doc/en/member/pic/comment01.png b/doc/en/member/pic/comment01.png Binary files differnew file mode 100644 index 000000000..c84079ba4 --- /dev/null +++ b/doc/en/member/pic/comment01.png diff --git a/doc/en/member/pic/conn01.png b/doc/en/member/pic/conn01.png Binary files differnew file mode 100644 index 000000000..142b048b3 --- /dev/null +++ b/doc/en/member/pic/conn01.png diff --git a/doc/en/member/pic/conn02.png b/doc/en/member/pic/conn02.png Binary files differnew file mode 100644 index 000000000..06cfc042c --- /dev/null +++ b/doc/en/member/pic/conn02.png diff --git a/doc/en/member/pic/conn03.png b/doc/en/member/pic/conn03.png Binary files differnew file mode 100644 index 000000000..72fb98e6f --- /dev/null +++ b/doc/en/member/pic/conn03.png diff --git a/doc/en/member/pic/conn04.png b/doc/en/member/pic/conn04.png Binary files differnew file mode 100644 index 000000000..e2d88c251 --- /dev/null +++ b/doc/en/member/pic/conn04.png diff --git a/doc/en/member/pic/conn05.png b/doc/en/member/pic/conn05.png Binary files differnew file mode 100644 index 000000000..87fa312be --- /dev/null +++ b/doc/en/member/pic/conn05.png diff --git a/doc/en/member/pic/conn06.png b/doc/en/member/pic/conn06.png Binary files differnew file mode 100644 index 000000000..085d85480 --- /dev/null +++ b/doc/en/member/pic/conn06.png diff --git a/doc/en/member/pic/croles1.png b/doc/en/member/pic/croles1.png Binary files differnew file mode 100644 index 000000000..a70a2376b --- /dev/null +++ b/doc/en/member/pic/croles1.png diff --git a/doc/en/member/pic/croles2.png b/doc/en/member/pic/croles2.png Binary files differnew file mode 100644 index 000000000..2c3451501 --- /dev/null +++ b/doc/en/member/pic/croles2.png diff --git a/doc/en/member/pic/delacc01.png b/doc/en/member/pic/delacc01.png Binary files differnew file mode 100644 index 000000000..83a4c5fae --- /dev/null +++ b/doc/en/member/pic/delacc01.png diff --git a/doc/en/member/pic/delchan01.png b/doc/en/member/pic/delchan01.png Binary files differnew file mode 100644 index 000000000..e86103194 --- /dev/null +++ b/doc/en/member/pic/delchan01.png diff --git a/doc/en/member/pic/directory.png b/doc/en/member/pic/directory.png Binary files differnew file mode 100644 index 000000000..4bbc8447a --- /dev/null +++ b/doc/en/member/pic/directory.png diff --git a/doc/en/member/pic/files01.png b/doc/en/member/pic/files01.png Binary files differnew file mode 100644 index 000000000..cc6998ae4 --- /dev/null +++ b/doc/en/member/pic/files01.png diff --git a/doc/en/member/pic/files02.png b/doc/en/member/pic/files02.png Binary files differnew file mode 100644 index 000000000..7fc9d76b7 --- /dev/null +++ b/doc/en/member/pic/files02.png diff --git a/doc/en/member/pic/files03.png b/doc/en/member/pic/files03.png Binary files differnew file mode 100644 index 000000000..4e57ae850 --- /dev/null +++ b/doc/en/member/pic/files03.png diff --git a/doc/en/member/pic/font.png b/doc/en/member/pic/font.png Binary files differnew file mode 100644 index 000000000..598448ce7 --- /dev/null +++ b/doc/en/member/pic/font.png diff --git a/doc/en/member/pic/gal01.png b/doc/en/member/pic/gal01.png Binary files differnew file mode 100644 index 000000000..b3b1cec56 --- /dev/null +++ b/doc/en/member/pic/gal01.png diff --git a/doc/en/member/pic/hbar.png b/doc/en/member/pic/hbar.png Binary files differnew file mode 100644 index 000000000..10594f231 --- /dev/null +++ b/doc/en/member/pic/hbar.png diff --git a/doc/en/member/pic/highlited.png b/doc/en/member/pic/highlited.png Binary files differnew file mode 100644 index 000000000..4dc0224f1 --- /dev/null +++ b/doc/en/member/pic/highlited.png diff --git a/doc/en/member/pic/image.png b/doc/en/member/pic/image.png Binary files differnew file mode 100644 index 000000000..ecb300cd2 --- /dev/null +++ b/doc/en/member/pic/image.png diff --git a/doc/en/member/pic/interact01.png b/doc/en/member/pic/interact01.png Binary files differnew file mode 100644 index 000000000..e73f0a789 --- /dev/null +++ b/doc/en/member/pic/interact01.png diff --git a/doc/en/member/pic/interact02.png b/doc/en/member/pic/interact02.png Binary files differnew file mode 100644 index 000000000..81b2c84d5 --- /dev/null +++ b/doc/en/member/pic/interact02.png diff --git a/doc/en/member/pic/interact03.png b/doc/en/member/pic/interact03.png Binary files differnew file mode 100644 index 000000000..5b3985f2d --- /dev/null +++ b/doc/en/member/pic/interact03.png diff --git a/doc/en/member/pic/mauth.png b/doc/en/member/pic/mauth.png Binary files differnew file mode 100644 index 000000000..5e624124b --- /dev/null +++ b/doc/en/member/pic/mauth.png diff --git a/doc/en/member/pic/nsfw01.png b/doc/en/member/pic/nsfw01.png Binary files differnew file mode 100644 index 000000000..4a4eec074 --- /dev/null +++ b/doc/en/member/pic/nsfw01.png diff --git a/doc/en/member/pic/nsfw02.png b/doc/en/member/pic/nsfw02.png Binary files differnew file mode 100644 index 000000000..4d344fcd7 --- /dev/null +++ b/doc/en/member/pic/nsfw02.png diff --git a/doc/en/member/pic/nsfw03.png b/doc/en/member/pic/nsfw03.png Binary files differnew file mode 100644 index 000000000..5bc63d258 --- /dev/null +++ b/doc/en/member/pic/nsfw03.png diff --git a/doc/en/member/pic/perm01.png b/doc/en/member/pic/perm01.png Binary files differnew file mode 100644 index 000000000..178990892 --- /dev/null +++ b/doc/en/member/pic/perm01.png diff --git a/doc/en/member/pic/perm02.png b/doc/en/member/pic/perm02.png Binary files differnew file mode 100644 index 000000000..ced652bb9 --- /dev/null +++ b/doc/en/member/pic/perm02.png diff --git a/doc/en/member/pic/perm03.png b/doc/en/member/pic/perm03.png Binary files differnew file mode 100644 index 000000000..d7cb84dcc --- /dev/null +++ b/doc/en/member/pic/perm03.png diff --git a/doc/en/member/pic/perm04.png b/doc/en/member/pic/perm04.png Binary files differnew file mode 100644 index 000000000..ad9575630 --- /dev/null +++ b/doc/en/member/pic/perm04.png diff --git a/doc/en/member/pic/perm05.png b/doc/en/member/pic/perm05.png Binary files differnew file mode 100644 index 000000000..6f923df62 --- /dev/null +++ b/doc/en/member/pic/perm05.png diff --git a/doc/en/member/pic/perm06.png b/doc/en/member/pic/perm06.png Binary files differnew file mode 100644 index 000000000..7ba94f2a0 --- /dev/null +++ b/doc/en/member/pic/perm06.png diff --git a/doc/en/member/pic/pgroups01.png b/doc/en/member/pic/pgroups01.png Binary files differnew file mode 100644 index 000000000..642082311 --- /dev/null +++ b/doc/en/member/pic/pgroups01.png diff --git a/doc/en/member/pic/pgroups02.png b/doc/en/member/pic/pgroups02.png Binary files differnew file mode 100644 index 000000000..a144ca0ad --- /dev/null +++ b/doc/en/member/pic/pgroups02.png diff --git a/doc/en/member/pic/pgroups03.png b/doc/en/member/pic/pgroups03.png Binary files differnew file mode 100644 index 000000000..a6096d836 --- /dev/null +++ b/doc/en/member/pic/pgroups03.png diff --git a/doc/en/member/pic/pgroups04.png b/doc/en/member/pic/pgroups04.png Binary files differnew file mode 100644 index 000000000..a2a992dbc --- /dev/null +++ b/doc/en/member/pic/pgroups04.png diff --git a/doc/en/member/pic/photos01.png b/doc/en/member/pic/photos01.png Binary files differnew file mode 100644 index 000000000..a1cfd009f --- /dev/null +++ b/doc/en/member/pic/photos01.png diff --git a/doc/en/member/pic/photos02.png b/doc/en/member/pic/photos02.png Binary files differnew file mode 100644 index 000000000..3d82c5660 --- /dev/null +++ b/doc/en/member/pic/photos02.png diff --git a/doc/en/member/pic/photos03.png b/doc/en/member/pic/photos03.png Binary files differnew file mode 100644 index 000000000..b5abc89a5 --- /dev/null +++ b/doc/en/member/pic/photos03.png diff --git a/doc/en/member/pic/photos04.png b/doc/en/member/pic/photos04.png Binary files differnew file mode 100644 index 000000000..509c77260 --- /dev/null +++ b/doc/en/member/pic/photos04.png diff --git a/doc/en/member/pic/picture01.png b/doc/en/member/pic/picture01.png Binary files differnew file mode 100644 index 000000000..7389e778d --- /dev/null +++ b/doc/en/member/pic/picture01.png diff --git a/doc/en/member/pic/picture02.png b/doc/en/member/pic/picture02.png Binary files differnew file mode 100644 index 000000000..0b0f89ca0 --- /dev/null +++ b/doc/en/member/pic/picture02.png diff --git a/doc/en/member/pic/picture03.png b/doc/en/member/pic/picture03.png Binary files differnew file mode 100644 index 000000000..6efbfb4fb --- /dev/null +++ b/doc/en/member/pic/picture03.png diff --git a/doc/en/member/pic/picture04.png b/doc/en/member/pic/picture04.png Binary files differnew file mode 100644 index 000000000..a837b69bf --- /dev/null +++ b/doc/en/member/pic/picture04.png diff --git a/doc/en/member/pic/picture05.png b/doc/en/member/pic/picture05.png Binary files differnew file mode 100644 index 000000000..f180d8686 --- /dev/null +++ b/doc/en/member/pic/picture05.png diff --git a/doc/en/member/pic/picture06.png b/doc/en/member/pic/picture06.png Binary files differnew file mode 100644 index 000000000..d9bff1e54 --- /dev/null +++ b/doc/en/member/pic/picture06.png diff --git a/doc/en/member/pic/posting01.png b/doc/en/member/pic/posting01.png Binary files differnew file mode 100644 index 000000000..735bb0644 --- /dev/null +++ b/doc/en/member/pic/posting01.png diff --git a/doc/en/member/pic/qrcode.png b/doc/en/member/pic/qrcode.png Binary files differnew file mode 100644 index 000000000..0db383feb --- /dev/null +++ b/doc/en/member/pic/qrcode.png diff --git a/doc/en/member/pic/quote.png b/doc/en/member/pic/quote.png Binary files differnew file mode 100644 index 000000000..cef0df619 --- /dev/null +++ b/doc/en/member/pic/quote.png diff --git a/doc/en/member/pic/red.png b/doc/en/member/pic/red.png Binary files differnew file mode 100644 index 000000000..227f8ccda --- /dev/null +++ b/doc/en/member/pic/red.png diff --git a/doc/en/member/pic/savefolder01.png b/doc/en/member/pic/savefolder01.png Binary files differnew file mode 100644 index 000000000..dd95987ea --- /dev/null +++ b/doc/en/member/pic/savefolder01.png diff --git a/doc/en/member/pic/savefolder02.png b/doc/en/member/pic/savefolder02.png Binary files differnew file mode 100644 index 000000000..d775ddae6 --- /dev/null +++ b/doc/en/member/pic/savefolder02.png diff --git a/doc/en/member/pic/savefolder03.png b/doc/en/member/pic/savefolder03.png Binary files differnew file mode 100644 index 000000000..896ec24b2 --- /dev/null +++ b/doc/en/member/pic/savefolder03.png diff --git a/doc/en/member/pic/savefolder04.png b/doc/en/member/pic/savefolder04.png Binary files differnew file mode 100644 index 000000000..7f21ed49c --- /dev/null +++ b/doc/en/member/pic/savefolder04.png diff --git a/doc/en/member/pic/search01.png b/doc/en/member/pic/search01.png Binary files differnew file mode 100644 index 000000000..75cc8bce6 --- /dev/null +++ b/doc/en/member/pic/search01.png diff --git a/doc/en/member/pic/search02.png b/doc/en/member/pic/search02.png Binary files differnew file mode 100644 index 000000000..feaec66ad --- /dev/null +++ b/doc/en/member/pic/search02.png diff --git a/doc/en/member/pic/search03.png b/doc/en/member/pic/search03.png Binary files differnew file mode 100644 index 000000000..b68d81fa7 --- /dev/null +++ b/doc/en/member/pic/search03.png diff --git a/doc/en/member/pic/settings01.png b/doc/en/member/pic/settings01.png Binary files differnew file mode 100644 index 000000000..7d54b766f --- /dev/null +++ b/doc/en/member/pic/settings01.png diff --git a/doc/en/member/pic/settings02.png b/doc/en/member/pic/settings02.png Binary files differnew file mode 100644 index 000000000..dfd5d3df5 --- /dev/null +++ b/doc/en/member/pic/settings02.png diff --git a/doc/en/member/pic/settings03.png b/doc/en/member/pic/settings03.png Binary files differnew file mode 100644 index 000000000..a331b9306 --- /dev/null +++ b/doc/en/member/pic/settings03.png diff --git a/doc/en/member/pic/settings04.png b/doc/en/member/pic/settings04.png Binary files differnew file mode 100644 index 000000000..4a18df7f6 --- /dev/null +++ b/doc/en/member/pic/settings04.png diff --git a/doc/en/member/pic/settings05.png b/doc/en/member/pic/settings05.png Binary files differnew file mode 100644 index 000000000..beff5d823 --- /dev/null +++ b/doc/en/member/pic/settings05.png diff --git a/doc/en/member/pic/settings06.png b/doc/en/member/pic/settings06.png Binary files differnew file mode 100644 index 000000000..c66c4182e --- /dev/null +++ b/doc/en/member/pic/settings06.png diff --git a/doc/en/member/pic/settings07.png b/doc/en/member/pic/settings07.png Binary files differnew file mode 100644 index 000000000..39c294ebe --- /dev/null +++ b/doc/en/member/pic/settings07.png diff --git a/doc/en/member/pic/settings08.png b/doc/en/member/pic/settings08.png Binary files differnew file mode 100644 index 000000000..0dab2d1f2 --- /dev/null +++ b/doc/en/member/pic/settings08.png diff --git a/doc/en/member/pic/settings09.png b/doc/en/member/pic/settings09.png Binary files differnew file mode 100644 index 000000000..964a2e0c0 --- /dev/null +++ b/doc/en/member/pic/settings09.png diff --git a/doc/en/member/pic/settings10.png b/doc/en/member/pic/settings10.png Binary files differnew file mode 100644 index 000000000..939c43db8 --- /dev/null +++ b/doc/en/member/pic/settings10.png diff --git a/doc/en/member/pic/settings11.png b/doc/en/member/pic/settings11.png Binary files differnew file mode 100644 index 000000000..7a2c4d5ae --- /dev/null +++ b/doc/en/member/pic/settings11.png diff --git a/doc/en/member/pic/settings12.png b/doc/en/member/pic/settings12.png Binary files differnew file mode 100644 index 000000000..6429464f4 --- /dev/null +++ b/doc/en/member/pic/settings12.png diff --git a/doc/en/member/pic/settings13.png b/doc/en/member/pic/settings13.png Binary files differnew file mode 100644 index 000000000..22a36dbd5 --- /dev/null +++ b/doc/en/member/pic/settings13.png diff --git a/doc/en/member/pic/settings14.png b/doc/en/member/pic/settings14.png Binary files differnew file mode 100644 index 000000000..bd8d0d074 --- /dev/null +++ b/doc/en/member/pic/settings14.png diff --git a/doc/en/member/pic/settings15.png b/doc/en/member/pic/settings15.png Binary files differnew file mode 100644 index 000000000..7e5378dac --- /dev/null +++ b/doc/en/member/pic/settings15.png diff --git a/doc/en/member/pic/settings16.png b/doc/en/member/pic/settings16.png Binary files differnew file mode 100644 index 000000000..1a7c29809 --- /dev/null +++ b/doc/en/member/pic/settings16.png diff --git a/doc/en/member/pic/settings17.png b/doc/en/member/pic/settings17.png Binary files differnew file mode 100644 index 000000000..a8e690d0f --- /dev/null +++ b/doc/en/member/pic/settings17.png diff --git a/doc/en/member/pic/settings18.png b/doc/en/member/pic/settings18.png Binary files differnew file mode 100644 index 000000000..88f05e28a --- /dev/null +++ b/doc/en/member/pic/settings18.png diff --git a/doc/en/member/pic/settings19.png b/doc/en/member/pic/settings19.png Binary files differnew file mode 100644 index 000000000..d376d42e1 --- /dev/null +++ b/doc/en/member/pic/settings19.png diff --git a/doc/en/member/pic/settings20.png b/doc/en/member/pic/settings20.png Binary files differnew file mode 100644 index 000000000..2925de06c --- /dev/null +++ b/doc/en/member/pic/settings20.png diff --git a/doc/en/member/pic/settings21.png b/doc/en/member/pic/settings21.png Binary files differnew file mode 100644 index 000000000..74b589177 --- /dev/null +++ b/doc/en/member/pic/settings21.png diff --git a/doc/en/member/pic/settings22.png b/doc/en/member/pic/settings22.png Binary files differnew file mode 100644 index 000000000..d18762634 --- /dev/null +++ b/doc/en/member/pic/settings22.png diff --git a/doc/en/member/pic/settings23.png b/doc/en/member/pic/settings23.png Binary files differnew file mode 100644 index 000000000..b10adab2b --- /dev/null +++ b/doc/en/member/pic/settings23.png diff --git a/doc/en/member/pic/settings24.png b/doc/en/member/pic/settings24.png Binary files differnew file mode 100644 index 000000000..e55a08a96 --- /dev/null +++ b/doc/en/member/pic/settings24.png diff --git a/doc/en/member/pic/size.png b/doc/en/member/pic/size.png Binary files differnew file mode 100644 index 000000000..f87ab74cf --- /dev/null +++ b/doc/en/member/pic/size.png diff --git a/doc/en/member/pic/source.png b/doc/en/member/pic/source.png Binary files differnew file mode 100644 index 000000000..bb1db07a1 --- /dev/null +++ b/doc/en/member/pic/source.png diff --git a/doc/en/member/pic/star.png b/doc/en/member/pic/star.png Binary files differnew file mode 100644 index 000000000..ed6206c1f --- /dev/null +++ b/doc/en/member/pic/star.png diff --git a/doc/en/member/pic/table1.png b/doc/en/member/pic/table1.png Binary files differnew file mode 100644 index 000000000..99a4fb9a0 --- /dev/null +++ b/doc/en/member/pic/table1.png diff --git a/doc/en/member/pic/table2.png b/doc/en/member/pic/table2.png Binary files differnew file mode 100644 index 000000000..ed241a6d6 --- /dev/null +++ b/doc/en/member/pic/table2.png diff --git a/doc/en/member/pic/table3.png b/doc/en/member/pic/table3.png Binary files differnew file mode 100644 index 000000000..9b7acceb3 --- /dev/null +++ b/doc/en/member/pic/table3.png diff --git a/doc/en/member/pic/video_poster.png b/doc/en/member/pic/video_poster.png Binary files differnew file mode 100644 index 000000000..48b27fb91 --- /dev/null +++ b/doc/en/member/pic/video_poster.png diff --git a/doc/en/member/pic/websites01.png b/doc/en/member/pic/websites01.png Binary files differnew file mode 100644 index 000000000..f2eb31c29 --- /dev/null +++ b/doc/en/member/pic/websites01.png diff --git a/doc/en/member/pic/websites02.png b/doc/en/member/pic/websites02.png Binary files differnew file mode 100644 index 000000000..0e22c2232 --- /dev/null +++ b/doc/en/member/pic/websites02.png diff --git a/doc/en/member/pic/websites03.png b/doc/en/member/pic/websites03.png Binary files differnew file mode 100644 index 000000000..e061a2fcf --- /dev/null +++ b/doc/en/member/pic/websites03.png diff --git a/doc/en/member/pic/websites04.png b/doc/en/member/pic/websites04.png Binary files differnew file mode 100644 index 000000000..5d28d9291 --- /dev/null +++ b/doc/en/member/pic/websites04.png diff --git a/doc/en/member/pic/websites05.png b/doc/en/member/pic/websites05.png Binary files differnew file mode 100644 index 000000000..c9efe1471 --- /dev/null +++ b/doc/en/member/pic/websites05.png diff --git a/doc/en/member/pic/websites06.png b/doc/en/member/pic/websites06.png Binary files differnew file mode 100644 index 000000000..d9da6f79a --- /dev/null +++ b/doc/en/member/pic/websites06.png diff --git a/doc/en/member/pic/wiki01.png b/doc/en/member/pic/wiki01.png Binary files differnew file mode 100644 index 000000000..3fc603669 --- /dev/null +++ b/doc/en/member/pic/wiki01.png diff --git a/doc/en/member/pic/wiki02.png b/doc/en/member/pic/wiki02.png Binary files differnew file mode 100644 index 000000000..9921e2c5c --- /dev/null +++ b/doc/en/member/pic/wiki02.png diff --git a/doc/en/member/pic/wiki03.png b/doc/en/member/pic/wiki03.png Binary files differnew file mode 100644 index 000000000..ab7126ab8 --- /dev/null +++ b/doc/en/member/pic/wiki03.png diff --git a/doc/en/member/pic/wiki04.png b/doc/en/member/pic/wiki04.png Binary files differnew file mode 100644 index 000000000..9ac2a29ff --- /dev/null +++ b/doc/en/member/pic/wiki04.png diff --git a/doc/en/member/posting.md b/doc/en/member/posting.md new file mode 100644 index 000000000..3a10cde91 --- /dev/null +++ b/doc/en/member/posting.md @@ -0,0 +1,16 @@ +## Posting + +If you would like to write and share a post (publish, although the circle of recipients or those who can see the post may be restricted), you can usually do this via the ‘Share’ field located above the stream. Click on this field to open the post editor. + +At the top is the field for the post title (optional), below this is the field for the summary (also optional), if the administrator of your hub allows this function. The summary can also be used for the purpose of a content warning. Below the field for the summary is a field for categories (if activated by the admin). +Below this is the text field in which you can create the post content. Depending on the Hub settings, you can use plain text, Markdown, bbCode or HTML for formatting the text. + +At the bottom of the post editor there are some buttons for easier formatting of the content and for inserting elements and using additional functions: bold, italic, underline, quote, code, attach/upload file, insert link, insert image (an image that already exists under Files), insert location, set expiry date for the post, set publication date, encrypt text, vote (poll) on/off, deactivate comments. To the right of this is another block with buttons. Here you can display a preview of the post, specify whether the post should be published on other networks, make the authorisation settings (who can see the post) and finally publish it using the ‘Share’ button. + + + +You can also access the post editor by selecting the corresponding menu item in the app menu (top right ⋮) or the corresponding icon in the navigation bar (if you have pinned the ‘Write post’ app). + +#include doc/en/member/commenting.md; +#include doc/en/member/insert_images.md; +#include doc/en/member/bbcode.md; diff --git a/doc/en/member/privacy_groups.md b/doc/en/member/privacy_groups.md new file mode 100644 index 000000000..3b44d0a19 --- /dev/null +++ b/doc/en/member/privacy_groups.md @@ -0,0 +1,24 @@ +## Privacy Groups + +The ‘Privacy Groups’ app allows you to create groups to which you can assign contacts. On the one hand, they serve to filter the stream (so you can only display posts from users who are in a privacy group) and, on the other hand, they allow you to grant certain groups rights to content with regard to [permissions](permissions_contact_roles.md). + +The first function is easy to understand. If you have contacts (a contact can be in several groups) in a group and you select a specific group in the left sidebar in the stream view, only posts from contacts in that group will be displayed. This function thus acts as a stream filter. + +The second function is also easy to grasp, but rather unusual for many Fediverse users, since it only exists in this form in Hubzilla and related services (Streams, Friendica etc.). As the name ‘Privacy Groups’ suggests, this is also about restricted communication. If you select a group as the authorisation when composing a post, the post is only distributed to the contacts contained in that group and only they can see it. It is also not possible for the recipients (group members) to share such a post publicly. This allows for closed group communication. + +When you open the app, existing groups are displayed in the left sidebar and the input form for creating a new group is displayed in the main view. + + + +If you select one of the groups in the sidebar, you can edit it. + + + + + +Membership for contacts can also be set here. Clicking on an entry toggles the membership between ‘Not in group’ and ‘Group membership’. This way, you can remove members from a group or add users as group members. +Adding a contact to a group can also be done in the ‘Connections’ app using the contacts tool: + + + +To add a new group, click on the ‘+ Add new group’ entry in the sidebar. diff --git a/doc/en/member/privacy_settings.md b/doc/en/member/privacy_settings.md new file mode 100644 index 000000000..ea03cc73a --- /dev/null +++ b/doc/en/member/privacy_settings.md @@ -0,0 +1,5 @@ +#### Privacy settings + +In the privacy settings, you can determine whether your posts may be indexed by search engines, whether you accept contact requests automatically (without manual approval), whether all messages in which you are mentioned are automatically accepted, whether comments from users who are not among your contacts are submitted for moderation (approved/rejected) or deleted, and whether you allow OCAP access. + + diff --git a/doc/en/member/profiles.md b/doc/en/member/profiles.md new file mode 100644 index 000000000..8f31061b4 --- /dev/null +++ b/doc/en/member/profiles.md @@ -0,0 +1,21 @@ +### Profiles + +Hubzilla has unlimited profiles. You can use different profiles to show different ‘sides of yourself’ to different target groups. This is not the same as having different channels. Different channels allow for completely different information. You can have a channel for yourself, a channel for your sports team, a channel for your website or something else. A profile allows for fine-grained ‘’sides‘’ of each channel. Different profiles could be compared to different business cards of a person. Depending on the purpose, different information is given on each business card. For example, your standard public profile could read: ‘Hi, I'm Fred and I like to laugh’. You can show your close friends a profile that says ‘and I also like to throw dwarfs’. + +You always have a profile that is referred to as your ‘standard’ or ‘public’ profile. This profile is always accessible to the general public and cannot be hidden (there may be rare exceptions on privately run or unaffiliated sites). You can and should limit the information you make available in your public profile. +If you want your friends to be able to find you, it is helpful if you include the following information in your public profile... + +- Your real name or at least a nickname that everyone knows +- A photo of you +- Your location on earth, at least at country level. + +If you also want to meet people who share general interests with you, please take a moment to add some ‘keywords’ to your profile. For example, ‘music, linux, photography’ or something similar. You can add as many keywords as you like. + +Select ‘Edit profiles’ from the menu on your Hubzilla site. You can edit an existing profile, change the profile photo, add things to a profile or create a new profile. You can also create a ‘clone’ of an existing profile if you only want to change a few things but don't want to re-enter all the information. To do this, click on the profile you want to clone and select ‘Clone this profile’. + +In the list of your profiles, you can also select the contacts who can see a particular profile. Simply click on ‘Edit visibility’ next to the profile in question (only available for profiles that are not your default profile) and then click on specific connections to add them to or remove them from the group of people who can see this profile. + +Once a profile has been selected, the person viewing your profile will see the private profile you have assigned. If the person is not authenticated, they will see your public profile. +There is a setting that allows you to publish your profile in a directory and ensure that it can be found by others. You can change this setting on the ‘Settings’ page. + +If you do not want others to find you without telling them your channel address, you can leave your profile unpublished. diff --git a/doc/en/member/protection_of_privacy.md b/doc/en/member/protection_of_privacy.md new file mode 100644 index 000000000..be4eee9e0 --- /dev/null +++ b/doc/en/member/protection_of_privacy.md @@ -0,0 +1,65 @@ +## Tips for protecting your privacy + +If you attach great importance to your privacy and still want to participate in Fediverse, you need to think carefully about what you want to reveal about yourself before and during the creation of a personal channel. This is the case with every Fediverse service. With Hubzilla, however, there is another important aspect. You not only have to ask yourself the question ‘What?’, but also ‘To whom?’ and ‘Which?’. + +With Hubzilla, you not only determine what you disclose about yourself, but also who you allow to see the information and content. And who you allow to interact with what. + +The advantage is that you are not dependent on a ‘rule set’, but can define different rules for different applications and different contacts. + +A typical use case would be that you want to participate in Fediverse in the normal way that you are familiar with from other social networks. + +When creating a channel, you must make the first relevant decision: **the channel role**. + +Here you can choose between ‘Public’, ‘Personal’, ‘Community Forum’ and ‘ Customised’. + +Apart from the ‘Community Forum’, which is intended for other applications, you have the choice between three roles. + +1. With the ‘Public’ role, you allow others to + 1. see your channel stream (i.e. the posts that you share publicly) and your posts in general, + 2. see your standard profile, + 3. see your connections, + 4. see your file and image folders, + 5. see the web pages of your channel, + 6. see the wiki pages of your channel, + 7. comment on, like or dislike your posts, + 8. send you direct messages, + 9. like or dislike your profiles and profile content and + 10. chat with you. + +These role-based rules reflect the ‘normal’ use of a social network quite well. + +1. The ‘Personal’ role is similar and only denies some of the permissions of the ‘Public’ role. It allows others to + 1. see your channel stream (i.e. the posts that you share publicly) and your posts in general, + 2. see your default profile, + 3. ./. + 4. see your file and image folders, + 5. see the web pages of your channel, + 6. see the wiki pages of your channel, + 7. ./. + 8. ./. + 9. ./. + 10. ./. + +Interaction by other users is restricted with this profile, as they are not allowed to comment on, like or dislike your posts (the latter also not in relation to your profile/profile content). They are also not allowed to send you direct messages or chat with you. + +The ‘User-defined’ role allows you to define all authorisations individually. Caution is advised here, as inappropriate rules can make a channel halfway ‘unusable’. + +For the intended use as a ‘typical social network account’, we recommend selecting the ‘Public’ or ‘Personal’ role. + +If you would rather opt for the ‘Personal’ role, but would still like to allow further interaction with certain users (friends, family, colleagues, etc.), you do not have to use the ‘Public’ role. + +Hubzilla works with whitelists (permission lists) for authorisations. The channel role therefore defines the basic authorisations. You cannot subsequently revoke these (apart from defining access rights in the specific individual case of a content) using other mechanisms. + +However, you can add various authorisations to the whitelist using different **contact roles**. For example, you could create a ‘Family’ contact role in which - in addition to the authorisations granted by the ‘Personal’ role - further authorisations (e.g. commenting, linking, disliking and sending direct messages) are granted. If you now assign this contact role to your contacts that you define as ‘Family’ in this example, your family members - unlike everyone else - can write comments, give you a thumbs up or thumbs down and communicate with you non-publicly (direct message). + +You can create as many contact roles as you like for different purposes and contacts and grant additional authorisations in addition to those of the channel role. But(!): You cannot revoke any authorisation from the channel role there. + +It is therefore advisable not to be too generous with the channel role and to select it accordingly, depending on the purpose of the channel. By selecting ‘User-defined’, for example, you could define an even more restrictive channel role than ‘Personal’ and then define further authorisations for certain users with the contact roles (only recommended if you are really familiar with the authorisation system). + +Another aspect of privacy is the **profile** information. For ‘typical’ use as a social network account, some information should be disclosed in the profile. Otherwise, other users will not have the idea of connecting with you. Or they want to connect with another user, but the other user refuses because they have no information about you (unless they know you and your channel name). So some information should go in there. + +As much as necessary, as little as possible. + +You should fill your standard profile, which every channel has, with information according to exactly this principle. + +However, Hubzilla allows you to create multiple profiles. In such profiles, you can then enter further information that may be of interest for certain connections. You then have the option of releasing such special profiles for certain connections. The information is therefore not visible and public to everyone, but is only available to the selected users. diff --git a/doc/en/member/public_stream.md b/doc/en/member/public_stream.md new file mode 100644 index 000000000..4fa015917 --- /dev/null +++ b/doc/en/member/public_stream.md @@ -0,0 +1,12 @@ +### Public Stream + +If the administrator of a hub has activated the public stream, you as a user can install and activate the ‘Public stream’ app. + +While all posts and activities from yourself and all your connections appear in the ‘normal’ stream, the public stream is more comprehensive. + +There are two options: + +1. If the administrator has restricted the public stream to their own hub, all public posts and activities from the streams of all users who have an account on this hub will appear there. +2. If the administrator has not restricted the public stream to their own hub, all public posts from all channels of their own hub, public content that arrives at their own hub (e.g. comments on posts by hub users that originate from other instances) and randomly collected content from channels that are known to their own hub (i.e. all contacts from all channels on their own hub) will be displayed. + +The public stream is not unmoderated. The administrator of a hub has the option of deleting posts from the public stream (‘Admin delete’). These posts are then actually deleted from the public stream of their own hub. They also do not appear in the public stream view of other channels of the hub. diff --git a/doc/en/member/registration.md b/doc/en/member/registration.md new file mode 100644 index 000000000..879d89246 --- /dev/null +++ b/doc/en/member/registration.md @@ -0,0 +1,19 @@ +## Login / Registration + +Not all Hubzilla sites allow open registration. If registration is allowed, you will see a ‘Register’ link right next to the login prompt on the site's homepage. Following this link will take you to the site's registration page. On some sites, you may be redirected to another site that lists hubs where registration is allowed. Since all Hubzilla sites are connected, it does not matter where your account is located. + +**Your e-mail address** + +Please enter a valid e-mail address. Your email address will never be published. This address will be used to activate your account, to send (optional) email notifications for incoming messages or articles *and to recover lost passwords*. + +**Password** + +Enter a password of your choice and repeat it in the second field to ensure that it has been entered correctly. As Hubzilla offers a decentralised identity, you can use your account to log in to many other websites. + +**Terms of Use** + +Click on the link to read the website's terms of use. Once you have read them, confirm them by ticking the box in the registration form. + +**Log in** + +Once you have entered the required information, click on the ‘Register’ button. Some websites may require administrator approval before registration can be processed, in which case you will be notified. Please check your email (including your spam folder) for approval of your registration. diff --git a/doc/en/member/repeat.md b/doc/en/member/repeat.md new file mode 100644 index 000000000..d4a92f0a4 --- /dev/null +++ b/doc/en/member/repeat.md @@ -0,0 +1,5 @@ +### Repeat + +By repeating posts, the post is distributed to your own connections. Comments end up in the original post (in contrast to [shared posts](/help/en/usermanual/share)). + +This behaviour corresponds to ‘boosting’, as we know it from Mastodon or other Fediverse services, for example. diff --git a/doc/en/member/save_to_folder.md b/doc/en/member/save_to_folder.md new file mode 100644 index 000000000..088a6c539 --- /dev/null +++ b/doc/en/member/save_to_folder.md @@ -0,0 +1,22 @@ +### Save to folder + +If you want to remember postings for later, you can do this by [marking them](./toggle_star_status.md) (star). However, if you have a large number of postings marked in this way, it can easily become confusing. +It is more practical to save such posts in different ‘folders’. These are categorised markings. +If you select ‘Save in folder’, a dialogue window opens to select the folder. + + + +You can enter a folder name in the text field. If folders already exist, a double click in the text field will display a selection list of the existing folders so that you can select one of them. + + + +If you have placed a post in a folder, you can recognise this by the folder symbol (including folder name) at the bottom left of the post. + + + +This icon can also be used to remove a post from a folder by clicking on the ‘X’ in the icon. + + + +In the stream view, you will find the entry ‘Saved folders’ in the left sidebar. If you click on it, all existing folders are displayed. If you now select a folder, all the posts that you have saved in this folder will be displayed in (reverse) chronological order in the stream. +This feature is comparable to the ‘clips’ (= categorised bookmarks) as known from Misskey and the Forkeys. diff --git a/doc/en/member/search.md b/doc/en/member/search.md new file mode 100644 index 000000000..6ab59a0fc --- /dev/null +++ b/doc/en/member/search.md @@ -0,0 +1,14 @@ +## Search + +To quickly find information, you can use the search function. +To do so, click on the icon in the navigation bar. + + + + + +This searches the entire hub. You can search for hashtags, handles and text. + +In the channel view, there is also a search field in the left sidebar. It only searches the stream of your own channel. Searches that have been performed in this widget can also be saved by clicking on the floppy disc symbol next to the search field. The saved search is then displayed in a list of search terms below the search field and can be repeated at any time with a single click. + + diff --git a/doc/en/member/settings.md b/doc/en/member/settings.md new file mode 100644 index 000000000..c27769ba2 --- /dev/null +++ b/doc/en/member/settings.md @@ -0,0 +1,34 @@ +### Settings + +Hubzilla allows a wide range of settings for behaviour, appearance, features, channels, etc. +You can access most settings via the main menu, where you will find the Settings menu item. + + + + + +Various categories of settings are provided: + +- Account settings +- Channel settings +- Privacy settings +- Display settings +- Manage locations - if clones of your channel exist + +If you are in the stream view, you will see a small cogwheel (⚙) next to the main menu, which you can use to access the + +- stream settings + +There are also hidden settings + +- Additional functions + +which you cannot access via the menu or an icon. + +#include doc/en/usermanual/account_settings.md; +#include doc/en/usermanual/channel_settings.md; +#include doc/en/usermanual/privacy_settings.md; +#include doc/en/usermanual/display_settings.md; +#include doc/en/usermanual/channel_locations.md; +#include doc/en/usermanual/stream_settings.md; +#include doc/en/usermanual/additional_features.md; diff --git a/doc/en/member/share.md b/doc/en/member/share.md new file mode 100644 index 000000000..42478372e --- /dev/null +++ b/doc/en/member/share.md @@ -0,0 +1,5 @@ +### Share + +When posts are shared (forwarded), a post by another user is posted again on your own channel. A new conversation is created in your own channel. Comments are added to the new conversation and not to the original one. + +Sharing posts only works from the stream or your own channel, but not from a ‘third-party’ channel. diff --git a/doc/en/member/show_source_code.md b/doc/en/member/show_source_code.md new file mode 100644 index 000000000..8f5aa4962 --- /dev/null +++ b/doc/en/member/show_source_code.md @@ -0,0 +1,13 @@ +### Show source code + +You can use this function to display the source code of a post. The content is therefore not rendered in formatted form, but includes the text including all markup tags (Markdown, bbCode, HTML). +The function therefore seems to be more for advanced or very curious users. + +However, it does contain a feature that can be helpful for everyone. + +In addition to the internal post ID, there are two hyperlinks: ‘plink’ and ‘llink’. + + + +‘plink’ means “permalink” and corresponds to the [link to the source](link_to_source.md). +‘llink’ means “local link” and refers to the location of the post on your own instance (hub). Clicking on it does not cause you to leave your own instance, but displays the post in the single view. diff --git a/doc/en/member/stream_settings.md b/doc/en/member/stream_settings.md new file mode 100644 index 000000000..429222e04 --- /dev/null +++ b/doc/en/member/stream_settings.md @@ -0,0 +1,9 @@ +#### Stream settings + +The stream settings are not accessed via Main Menu → Settings, but via the small cogwheel symbol (⚙) next to the main menu, which appears there as soon as you open the stream view. + + + +The stream settings can be used to select the display of the stream and the features available there (e.g. stream filters, saving search queries, etc.). + + diff --git a/doc/en/member/superblock.md b/doc/en/member/superblock.md new file mode 100644 index 000000000..34fa00752 --- /dev/null +++ b/doc/en/member/superblock.md @@ -0,0 +1,15 @@ +### Superblock + +The ‘Superblock’ app is a moderation method for your own stream. While Hubzilla's normal functionality only allows you to block users you are connected to using the contact tool, Superblock works regardless of whether you are connected to a contact or not. + +If you notice a user in the stream with whom you are not connected (because their posts are shared by a contact from your own address book) and - for whatever reason - you do not want to have any posts from this Fediverse user in the stream, you can achieve this with the ‘Superblock’ app. + +To do this, click on the small white triangle in the avatar of the user you want to block. + +A pull-down menu opens, which contains the menu item ‘Block completely’ at the bottom. Clicking on this menu item places the user in the superblock list. Posts from this user will no longer appear in their own stream. Affected posts are immediately hidden in the stream. In addition, this user will no longer be able to read your posts, regardless of their authorisations, nor will they be able to post to your channel. + +If you select the ‘Superblock’ app in the app menu (top right ⋮), a list of all blocked contacts is displayed. + +A ‘rubbish bin icon’ is displayed next to each contact. Click on this icon to remove the user from the block list. The user can then follow you again, see your posts and also comment on them and their posts will also appear in the stream again (e.g. by sharing a contact). + +Superblock is not installed and activated by default for new channels. diff --git a/doc/en/member/tags.md b/doc/en/member/tags.md new file mode 100644 index 000000000..d9a9f4b67 --- /dev/null +++ b/doc/en/member/tags.md @@ -0,0 +1,5 @@ +## Tags + +Tags (also called thematic tags, hashtags or topical tags) Tags are displayed by prefixing the tag name with the ‘#’ character. This creates a link in the post to a generalised website search for the specified term. For example, #cars will provide a search link for all posts that mention ‘cars’ on your website. Topical tags are usually at least three characters long. Shorter search terms are unlikely to return search results, but this depends on the database configuration. + +Thematic tags are also usually not linked if they are purely numeric, e.g. #1. If you wish to use a numeric hashtag, please include descriptive text such as #2012-elections or enclose the entire tag in double quotes (e.g. #"2012″). Double quotes are also required if the tag contains spaces (#"My Tag") and may be required if the tag contains punctuation (#"EndsWithPeriod." Or #"Exciting !!!"). diff --git a/doc/en/member/the_grid.md b/doc/en/member/the_grid.md new file mode 100644 index 000000000..5f7b39665 --- /dev/null +++ b/doc/en/member/the_grid.md @@ -0,0 +1,3 @@ +## The grid + +The ‘Grid’ is the name given to the network of all Hubzilla hubs that communicate with each other via the Nomad protocol. The grid is effectively a subset of the Fediverse and includes all Hubzilla servers. diff --git a/doc/en/member/the_stream.md b/doc/en/member/the_stream.md new file mode 100644 index 000000000..964a11a7b --- /dev/null +++ b/doc/en/member/the_stream.md @@ -0,0 +1,7 @@ +## The stream + +The stream is the list of posts, comments and boosts from users in the Fediverse. It is sorted in reverse chronological order (the most recent posts appear at the top). Exactly which posts are shown here depends largely on your authorisation settings. + +The stream (also known as the ‘timeline’ in other Fediverse services) can be filtered using various filters: by direct messages, events, polls, privacy groups, forums, flagged posts, your own posts, saved folders and names. + +The stream in the Fediverse is not created by algorithms that select supposedly interesting content for the user, but is determined exclusively by the user himself. In Fediverse, you, the user, are the algorithm for the stream. diff --git a/doc/en/member/toggle_star_status.md b/doc/en/member/toggle_star_status.md new file mode 100644 index 000000000..3d5a08c13 --- /dev/null +++ b/doc/en/member/toggle_star_status.md @@ -0,0 +1,8 @@ +### Toggle Star Status + +Switching the marking star should not be confused with ‘starring’ (= favouriting) other feed services (e.g. Mastodon). While ‘starring’ in these services represents a positive evaluation of the post, which corresponds most closely to a ‘link’, marking with a star in Hubzilla is comparable to setting a bookmark. By toggling (one click sets the star, another removes it again), the post is set as a kind of bookmark for the user. +You can recognise a ‘starred’ post by the star symbol at the bottom left. + + + +In the stream view, you will find the entry ‘Marked posts’ in the left sidebar. If you click on it, all marked posts are displayed in (reverse) chronological order in the stream. diff --git a/doc/en/member/websites.md b/doc/en/member/websites.md new file mode 100644 index 000000000..320d0e98d --- /dev/null +++ b/doc/en/member/websites.md @@ -0,0 +1,139 @@ +## Websites + +The Websites app allows you to create static websites in your channel. Websites remain on your hub and are not federated. However, you can share the link to the website and enable all users in the Fediverse to visit your website. + +When you open the app, you will be taken to the website overview. The pages will be accessible at `<your-instance-URL>/page/<your-channel-name>/<page-link-title>`. + + + +In the left sidebar, there is a widget with the design tools for ‘blocks’, ‘menus’, ‘layouts’ and ‘pages’. +Below that, there is another widget that allows you to export and import web pages. + +The centre section lists the existing web pages. You can edit, share and delete them. There is also a button to create a new web page: ‘Create’. + +When you click on this button, the web page editor opens. + + + +You now have the choice of how you want to design the website: with bbCode, with HTML, with Markdown, with plain text or with the Comanche layout language. + +You can also specify which layout (if you have created one or more using the layout design tool) should be used to display the web page. + +Next is the input field for the optional page title, as well as (also optional) a summary, and (mandatory) the page URL. + +Below that is the text editor for the content of the website. + +If you just want to create a very simple website with formatting and other markup elements, it is sufficient to create it in the website editor using plain text, HTML, bbCode or Markdown. This way you get a website without a special layout (without sidebars, without menus etc.). + +For more sophisticated websites, it is recommended that you work with blocks, layouts and menus. + +### Blocks + +Blocks can be parts of web pages. The basic HTML code of a block looks like this + +``` + <div> + block content + </div> +``` + +If a block has the content type text/html, it can also contain menu items. The example content of + +``` + <p>HTML block content</p> + [menu]menuname[/menu] +``` + +will produce HTML like this + +``` + <div> + <p>HTML block content</p> +<div> +<ul> +<li><a href=‘#’>Link 1</a></li> +<li><a href=‘#’>Link 2</a></li> +<li><a href=‘#’>Link 3</a></li> +</ul> +</div> +</p> +``` + +A block can also contain the actual content of the website via the `$content` macro. +To do this, create a block with only + +``` + $content +``` + +as content. +For a block to appear on the website, it must be defined within a region in the page layout. + +``` + [region=aside] + [block]blockname[/block] + [/region] +``` + +The appearance of the block can be manipulated in the page layout. +You can assign your own classes + +``` + [region=aside] + [block=myclass]blockname[/block] + [/region] +``` + +will produce the following HTML + +``` + <div class=‘myclass’> + Block Content + </div> +``` + +The wrap variable can be used to free a block from its enclosing `<div></div>`tag + +``` + [region=aside] + [block][var=wrap]none[/var]blockname[/block] + [/region] +``` + +This HTML is generated + +``` +Block content +``` + +With the block editor, blocks can be created just as easily as web pages. + + + +### Menus + +The menu editor is used to easily create navigation menus. + + + +The menu must be assigned a unique name (this name can be used to reference it later in the website and in blocks). Entering a title is optional. You can also choose whether the menu is available for adding bookmarks. This feature makes it possible to add links marked as bookmarks from the stream to the menu with a single click. + +Click ‘Submit and continue’ to create the menu. + + + +The dialogue for adding a menu entry will now open. You must enter a name for the menu entry (‘Name of the link’) and the destination of the link. This can be a URL or the name of another menu (which is then integrated as a submenu). + +You can influence the sorting of the menu entries by entering a number at ‘Order in list’. + +If the URL is an external link to a source on another hub, you can ensure that you are authenticated at the target and that restricted content is available if necessary by setting the ‘Use Magic-Auth if available’ switch. + +You can also specify whether links should open in a new window or tab. + +Click on ‘Submit and proceed’ to create further entries. ‘Submit and finish’ ends the entry of menu items. Menus can, however, be edited and added to at any time. + +### Layouts + +Layouts are used to define the general structure of web pages. They are designed using the Comanche page description language, a variant of bbCode. You have to give the layout a name. The definition of the layout is then entered in the text field. This is also where you can define the contents of the various regions. + + diff --git a/doc/en/member/wikis.md b/doc/en/member/wikis.md new file mode 100644 index 000000000..37c6864e7 --- /dev/null +++ b/doc/en/member/wikis.md @@ -0,0 +1,31 @@ +## Wikis + +The ‘Wiki’ app makes it possible to create wikis in your own channel. +Wiki pages are not federated and remain on your own hub. + +The wiki app offers simple, classic wiki functionality. Wiki posts can be created as plain text, Markdown text or BBcode text. + + + +To view (or edit) a wiki, select the corresponding wiki from the list on this page. +If you want to create a new wiki, click on the button ‘+ Create new’. +An input form will open in which you enter the name of the wiki and define the content type (as standard). You can use a switch to determine that only the selected content type (text, Markdown, BBcode) must be used for all wiki entries. You can also use a switch to turn the creation of a status post about wiki creation on or off. + + + +You can also set up detailed [permission rights](permissions_content.md) for a wiki. +Click on ‘Submit’ to create the wiki and open the home page. +The default view of a wiki page is always ‘View’, in which the text is rendered according to the source code. You can switch to the ‘Edit’ view using the tabs at the top to access the editor mode. +If you have edited the page and then switch back to View, the changes will be displayed immediately. +If you want to save the page, enter a suitable comment in the input field below the text and click on ‘Save’. The wiki page has been created. +Using the third tab, labelled ‘History’, you can view the changes made to the wiki page and, if you wish, undo changes. This is a wiki-typical form of version control. + + + + + +As you create more wiki pages, they will be listed in the left sidebar, from where they can also be accessed. + +For collaborative editing of a wiki, it is necessary to grant the users who are allowed to work on the wiki appropriate rights. In the case of a Public, Personal or Community Forum channel, this is done by means of a corresponding contact role in which the editing of the wiki pages is authorised. This permission is not granted by default for the channel roles mentioned (permission can be granted for a user-defined channel role, but it then applies generally and cannot be withdrawn again using a contact role). + +If you want to exclude individual wikis from this, you must restrict their visibility via the permission settings of the wiki (padlock). |
