diff options
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/member/assets/bookmarker-save-icon.png | bin | 0 -> 33987 bytes | |||
| -rw-r--r-- | doc/en/member/assets/bookmarks-menu-dropdown.png | bin | 0 -> 53526 bytes | |||
| -rw-r--r-- | doc/en/member/assets/privacy-group-tool-public.png | bin | 0 -> 39262 bytes | |||
| -rw-r--r-- | doc/en/member/assets/privacy-tool-3.png | bin | 0 -> 140093 bytes | |||
| -rw-r--r-- | doc/en/member/member_guide.bb | 177 |
5 files changed, 95 insertions, 82 deletions
diff --git a/doc/en/member/assets/bookmarker-save-icon.png b/doc/en/member/assets/bookmarker-save-icon.png Binary files differnew file mode 100644 index 000000000..6a7c10eb9 --- /dev/null +++ b/doc/en/member/assets/bookmarker-save-icon.png diff --git a/doc/en/member/assets/bookmarks-menu-dropdown.png b/doc/en/member/assets/bookmarks-menu-dropdown.png Binary files differnew file mode 100644 index 000000000..137ae52ad --- /dev/null +++ b/doc/en/member/assets/bookmarks-menu-dropdown.png diff --git a/doc/en/member/assets/privacy-group-tool-public.png b/doc/en/member/assets/privacy-group-tool-public.png Binary files differnew file mode 100644 index 000000000..828cb6411 --- /dev/null +++ b/doc/en/member/assets/privacy-group-tool-public.png diff --git a/doc/en/member/assets/privacy-tool-3.png b/doc/en/member/assets/privacy-tool-3.png Binary files differnew file mode 100644 index 000000000..ba896403d --- /dev/null +++ b/doc/en/member/assets/privacy-tool-3.png diff --git a/doc/en/member/member_guide.bb b/doc/en/member/member_guide.bb index 2b772d1c5..e3d62a4b5 100644 --- a/doc/en/member/member_guide.bb +++ b/doc/en/member/member_guide.bb @@ -46,17 +46,17 @@ 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. +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. +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. +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] @@ -65,7 +65,7 @@ By default all posts and published items are sent to your 'Friends' privacy grou [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. +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] @@ -77,11 +77,11 @@ The channel is a typical forum. By default posts and published items are public. [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. +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. +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] @@ -89,29 +89,29 @@ By default all posts and published items are sent to your 'Friends' privacy grou [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. +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. +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. +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. +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. +Set all the privacy and permissions manually to suit your specific needs. [h3]Creating channels[/h3] @@ -184,17 +184,17 @@ First, you need to find some channels to connect to. There are two primary ways 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. +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. +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. +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 @@ -209,7 +209,7 @@ Some communications offer more than one protocol. If you wish to connect with so 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. +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] @@ -234,7 +234,7 @@ Permissions in $Projectname are more complete than you may be used to. This allo [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. +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] @@ -242,8 +242,8 @@ When you create a channel we allow you to select different 'roles' for that chan 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. + +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. @@ -252,17 +252,17 @@ We highly recommend that you use the "typical social network" settings when you [*= 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. @@ -279,7 +279,7 @@ We highly recommend that you use the "typical social network" settings when you [*= 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 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. @@ -334,50 +334,63 @@ $Projectname supports several markup languages for advanced formatting of conten [/table] [h3]Tags And Mentions[/h3] -Like many other platforms, $Projectname uses a special notation inside messages to indicate "tags" or contextual links to other entities. [h4]Mentions[/h4] -Channels are tagged by simply preceding their name with the @ character. +You can mention a channel by simply preceding their name with the [code]@[/code] character, like this: [code] @Jack [/code] -When you start to mention somebody, it will create an auto-complete box to select from your immediate connections. Select one as appropriate. +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. -If the person mentioned is in the list of recipients for the post, they will receive a tag notification. -[h4]Deliverable Mentions[/h4] +[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. -The [b]![/b] character designates a deliverable mention to a forum or special channel which allows "re-delivery of mentions". +[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] -[code] -@Gardening - mention the Gardening forum -[/code] +You can also just tag a channel with a [i]privacy tag[/i]. -[code] -!Gardening - mention the Gardening Forum and also post to the Gardening "network" (e.g. send to all the forum members; if you have permission to do so) -[/code] +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. -Note: In previous releases, forums were delivered by using @forum+ with a plus sign at the end. This mechanism is no longer supported. +[h4]Mentioning forums[/h4] -[h4]Private Mentions[/h4] -If you wish to restrict a post to a single person or a number of people, you can do this by selecting channels or privacy groups from the privacy tool. You can also just tag them with a privacy tag. A privacy tag is a name preceded by the two characters @! - and in addition to tagging these channels, will also change the privacy permissions of the post to only include them. You can have more than one privacy tag, for instance @!bob and @!linda will send the post only to Bob and Linda. This mechanism over-rides the privacy selector. +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] -Forums may be mentioned in the same way. !!dogs 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. +You may also tag privacy groups which are "public". -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) @!Friends - 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. +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. +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 # 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 mentioning 'cars' 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 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. #1. If you wish to use a numeric hashtag, please add some descriptive text such as #2012-elections or enclose the entire tag in double quotes (for example #"2012"). Doubles quotes are also required if the tag contains spaces (#"My Tag") and may be required if the tag contains punctuation characters (#"EndsWithPeriod." or #"Exciting!!!"). +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 #^ followed by the link. Often these are generated automatically. If the 'bookmarker' addon is installed, this sequence will be converted to a bookmark icon when viewing the post or comment online, and clicking the icon will save the bookmark. If the bookmarker addon is not installed, the post 'dropdown menu' contains a link for saving the bookmark or bookmarks. +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. @@ -386,7 +399,7 @@ Where possible please use the auto-complete window to select tag and mention rec @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 billy@server1.hubzilla.org and billy@server2.hubzilla2.org, you will need to supply the complete address or the results will be ambiguous and the wrong person may be tagged. +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" @@ -401,10 +414,10 @@ $Projectname allows members and allowed connections to create static webpages. 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. +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 @@ -417,7 +430,7 @@ Blocks can be parts of webpages. The basic HTML of a block looks like this If a block has text/html content type it can also contain menu elements. Sample content of [code] - <p>HTML block content</p> + <p>HTML block content</p> [menu]menuname[/menu] [/code] @@ -484,7 +497,7 @@ will produce this HTML 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 +Element definitions must be stored in the repo root under folders called [code] /pages/ /blocks/ @@ -502,15 +515,15 @@ Page element metadata is specified in a JSON-formatted file called [code]page.js [*] layout [*] contentfile [/list] -[b]Example[/b] +[b]Example[/b] -Files: -[code] +Files: +[code] /pages/my-page/page.json /pages/my-page/my-page.bbcode -[/code] +[/code] Content of [code]page.json[/code]: -[code] +[code] { "title": "My Page", "pagelink": "mypage", @@ -518,7 +531,7 @@ Content of [code]page.json[/code]: "layout": "my-layout", "contentfile": "my-page.bbcode" } -[/code] +[/code] [h5] Layout elements [/h5] Layout element metadata is specified in a JSON-formatted file called [code]layout.json[/code] with the following properties: @@ -527,13 +540,13 @@ Layout element metadata is specified in a JSON-formatted file called [code]layou [*] description [*] contentfile [/list] -[b]Example[/b] +[b]Example[/b] Files: [code] /layouts/my-layout/layout.json /layouts/my-layout/my-layout.bbcode -[/code] +[/code] Content of [code]layout.json[/code]: [code] { @@ -552,14 +565,14 @@ Block element metadata is specified in a JSON-formatted file called [code]block. [*] mimetype [*] contentfile [/list] -[b]Example[/b] +[b]Example[/b] Files: -[code] +[code] /blocks/my-block/block.json /blocks/my-block/my-block.html [/code] -Content of [code]block.json[/code]: +Content of [code]block.json[/code]: [code] { @@ -581,7 +594,7 @@ Currently there are five layout templates, unless your site provides additional [dl terms="b"] [*= default] -The default template defines a "nav" region across the top, "aside" as a fixed width sidebar, +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] @@ -644,7 +657,7 @@ This will select the theme named "suckerberg". By default your channel [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. +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] @@ -693,13 +706,13 @@ Your webpage creation tools allow you to create menus and blocks, in addition to [menu]mymenu[/menu] [/code] -This places the menu called "mymenu" at this location on the page, which must be inside a region. +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. +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] @@ -734,8 +747,8 @@ Widgets and arguments are specified with the 'widget' and 'var' tags. [/code] -This loads the "recent_visitors" widget and supplies it with the argument "count" set to "24". - +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. @@ -760,7 +773,7 @@ You can use an 'if' construct to make decisions. These are currently based on sy [/code] - The 'else' clause is optional. + The 'else' clause is optional. Several tests are supported besides boolean evaluation. @@ -848,7 +861,7 @@ To delete attachments or change the permissions on the stored files, visit [obse [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. +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] @@ -909,8 +922,8 @@ Now you need to add any user you want to be able to mount dav to the davfs2 grou [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 +[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 @@ -925,7 +938,7 @@ Edit /etc/fstab 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 +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] @@ -965,7 +978,7 @@ With some webservers and certain configurations, you may find davfs2 creating fi [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. +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. @@ -989,7 +1002,7 @@ Note, if you are already logged in to the web interface via Konqueror, you will 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. +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. @@ -1023,13 +1036,13 @@ 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. +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. +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. +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: @@ -1046,9 +1059,9 @@ The saved search widget will provide autocompletion of channels (the results are Select the 'Remove Channel' link on your channel settings page or visit the URL: - [baseurl]/removeme + [baseurl]/removeme -You will need to confirm your password and the channel you are currently logged into will be removed. +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] @@ -1059,8 +1072,8 @@ If you have identity clones on other hubs this only removes by default the chan 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. + +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] |
