diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/about/about.bb (renamed from doc/about/about_hubzilla.bb) | 17 | ||||
| -rw-r--r-- | doc/about/project.bb (renamed from doc/about/hubzilla_project.bb) | 0 | ||||
| -rw-r--r-- | doc/addons.bb | 14 | ||||
| -rw-r--r-- | doc/admin/administrator_guide.md | 57 | ||||
| -rw-r--r-- | doc/bugs.bb | 21 | ||||
| -rw-r--r-- | doc/developer/api_zot.bb | 17 | ||||
| -rw-r--r-- | doc/hook/author_is_pmable.bb | 2 | ||||
| -rw-r--r-- | doc/hook/can_comment_on_post.bb | 13 | ||||
| -rw-r--r-- | doc/hook/connection_remove.bb | 9 | ||||
| -rw-r--r-- | doc/hook/legal_webbie.bb | 10 | ||||
| -rw-r--r-- | doc/hook/legal_webbie_text.bb | 7 | ||||
| -rw-r--r-- | doc/hooklist.bb | 12 | ||||
| -rw-r--r-- | doc/member/bbcode.html | 7 | ||||
| -rw-r--r-- | doc/member/member_guide.bb | 37 | ||||
| -rw-r--r-- | doc/toc.html | 6 | ||||
| -rw-r--r-- | doc/tutorials/personal_channel.html | 10 |
16 files changed, 147 insertions, 92 deletions
diff --git a/doc/about/about_hubzilla.bb b/doc/about/about.bb index e9485ffa6..b927e80c0 100644 --- a/doc/about/about_hubzilla.bb +++ b/doc/about/about.bb @@ -1,7 +1,7 @@ -[h3]What is Hubzilla?[/h3] +[h3]What is $Projectname?[/h3] $Projectname is a [b]free and open source[/b] set of web applications and services running on a special kind of web server, called a "hub", that can connect to other hubs in a decentralised network we like to call "the grid", providing sophisticated communications, identity, and access control services which work together seamlessly across domains and independent websites. It allows anybody to publicly or [b]privately[/b] publish content via "channels", which are the fundamental, cryptographically secured identities that provide authentication independently of the hubs which host them. This revolutionary liberation of online identity from individual servers and domains is called "nomadic identity", and it is powered by the Zot protocol, a new framework for decentralised access control with fine-grained, extensible permissions. -[h3]Right... so what is Hubzilla?[/h3] +[h3]Right... so what is $Projectname?[/h3] From the practical perspective of hub members who use the software, $Projectname offers a variety of familiar, integrated web apps and services, including: [ul] [li]social networking discussion threads[/li] @@ -15,14 +15,9 @@ While all of these apps and services can be found in other software packages, on [h3]Software Stack[/h3] The $Projectname software stack is a relatively standard webserver application written primarily in PHP/MySQL and [url=https://github.com/redmatrix/hubzilla/blob/master/install/INSTALL.txt]requiring little more than a web server, a MySQL-compatible database, and the PHP scripting language[/url]. It is designed to be easily installable by those with basic website administration skills on typical shared hosting platforms with a broad range of computing hardware. It is also easily extended via plugins and themes and other third-party tools. -[h3]Additional Resources and Links[/h3] -[list][*][url=http://hubzilla.org]Hubzilla project website[/url] -[*][url=https://github.com/redmatrix/hubzilla]Hubzilla core code repository[/url] -[*][url=https://github.com/redmatrix/hubzilla-addons]Hubzilla official addons repository[/url][/list] - [h3]Glossary[/h3] [dl terms="b"] -[*= hub] An instance of the Hubzilla software running on a standard web server +[*= hub] An instance of this software running on a standard web server [*= grid] The global network of hubs that exchange information with each other using the Zot protocol. @@ -115,7 +110,7 @@ Posts and messages may be created with an expiration date, at which time they wi [h4]Service Federation[/h4] -In addition to addon "cross-post connectors" to a variety of alternate networks, there is native support for importation of content from RSS/Atom feeds and using this to create special channels. Also, an experimental but working implementation of the Diaspora protocol allows communication with people on the Friendica and Diaspora decentralised social networks. This is currently marked experimental because these networks do not have the same level of privacy and encryption features and abilities as $Projectname and may present privacy risks. +In addition to addon "cross-post connectors" to a variety of alternate networks, there is native support for importation of content from RSS/Atom feeds and using this to create special channels. Plugins are also available to communicate with others using the Diaspora and GNU-Social (OStatus) protocols. These networks do not support nomadic identity or cross-domain access control; however basic communications are supported to/from Diaspora, Friendica, GNU-Social, Mastodon and other providers which use these protocols. There is also experimental support for OpenID authentication which may be used in Access Control Lists. This is a work in progress. Your $Projectname hub may be used as an OpenID provider to authenticate you to external services which use this technology. @@ -195,7 +190,7 @@ Any content created in $Projectname remains under the control of the member (or Similar to any other modern blogging system, social network, or a micro-blogging service, $Projectname supports the uploading of files, embedding of videos, linking web pages. [h4]Previewing/Editing[/h4] -Post can be previewed prior to sending and edited after sending. +Posts and comments can be previewed prior to sending and edited after sending. [h4]Voting/Consensus[/h4] Posts can be turned into "consensus" items which allows readers to offer feedback, which is collated into "agree", "disagree", and "abstain" counters. This lets you gauge interest for ideas and create informal surveys. @@ -206,4 +201,4 @@ $Projectname can be extended in a number of ways, through site customisation, pe [h4]API[/h4] -An API is available for use by third-party services. This is based originally on the early Twitter API (for which hundreds of third-party tools exist). It is currently being extended to provide access to facilities and abilities which are specific to $Projectname. Access may be provided by login/password or OAuth and client registration of OAuth applications is provided. +An API is available for use by third-party services. A plugin also provides a basic implementation of the Twitter API (for which hundreds of third-party tools exist). Access may be provided by login/password or OAuth, and client registration of OAuth applications is provided. diff --git a/doc/about/hubzilla_project.bb b/doc/about/project.bb index f9bc920f8..f9bc920f8 100644 --- a/doc/about/hubzilla_project.bb +++ b/doc/about/project.bb diff --git a/doc/addons.bb b/doc/addons.bb index 6fa9510f5..85bb2dca3 100644 --- a/doc/addons.bb +++ b/doc/addons.bb @@ -2,12 +2,12 @@ [list=1] [*] abcjsplugin - Create musical scores in your posts [*] adultphotoflag - prevents nsfw photos from being displayed in public albums +[*] authchoose - only send identity assertions to sites of friends [*] b2tbtn - provide button to go directly to top of page if you are scrolled a long way down [*] bbmath - use complex math expressions in your posts [*] bookmarker - replace #^ with bookmark link in posts [*] buglink - provide a bug reporting icon in the lower-left corner of every page [*] calc - a scientific calculator -[*] cdav - CalDAV/CardDAV server [*] chess - cross domain identity aware interactive chess games [*] chords - generate fingering charts and alternatives for every known guitar chord [*] custom_home - set a custom page as the hub start page @@ -15,15 +15,19 @@ [*] dirstats - show some interesting statistics generated by the directory server [*] docs - alternate documentation pages [*] donate - provides a project donation page +[*] dreamhost - provide a more reliable service on Dreamhost shared hosting [*] dwpost - crosspost to Dreamwidth +[*] emojione - allow emojis as emoticons [*] extcron - use an external cron service to run your hub's scheduled tasks +[*] firefox - provide a link to install the Firefox Sharing API [*] flattrwidget - provides a "Flattr Us" button [*] flip - create upside down text [*] fortunate - displays random quote (fortune cookie). Requires setting up a fortune server. [*] friendica - Friendica (DFRN) protocol. Under development. [*] frphotos - import photo albums from Friendica [*] gnusoc - GNU-Social (OStatus) protocol. Under development. -[*] hexit - headecimal conversion tool +[*] hexit - hexadecimal conversion tool +[*] hilite - allow language-specific highlighted code blocks in posts [*] hubwall - send an admin email to all hub accounts [*] ijpost - crosspost to Insanejournal [*] irc - connect to IRC chatrooms @@ -50,6 +54,7 @@ [*] nsfw - Highly recommended plugin to collpase posts with inappropriate content [*] openclipatar - choose a profile photo from hundreds of royalty free images [*] openid - OpenID authentication and OpenID server. Your OpenID URL is [observer.baseurl]/id/[observer.webname] +[*] opensearch - allow your site to become a browser search provider [*] openstreetmap - render locations and maps using OpenStreetMap [*] pageheader - display text at the top of every page on the site [*] phpmailer - alternate mail delivery system with more configurability @@ -71,7 +76,7 @@ [*] smiley_pack - extend the built-in smilie (emoticon) support [*] smileybutton - provides a smiley selector on the post window [*] startpage - set a personal preferred page to redirect after logging in. -[*] statistics_json - Diaspora statistics generator +[*] statistics - Diaspora statistics generator [*] statusnet - GNU-social and StatusNet crosspost [zrl=[baseurl]/help/addons_gnusocial]Posting To Gnu Social[/zrl] [*] std_embeds - allow unfiltered embeds for popular providers like youtube, vimeo and soundcloud [*] superblock - Highly recommended - completely block an offensive channel from your stream @@ -79,9 +84,12 @@ [*] tictac - 3D tic-tac-toe [*] torch - flashlight app [*] tour - feature tour for new members +[*] tripleaes - demo plugin for providing custom encryption algorithms [*] twitter - crosspost to Twitter +[*] twitter_api - Twitter/Statusnet compatible API [*] upload_limits - discover what server setting (there are a few) may be causing large photo uploads to fail [*] visage - show visitors to your channel +[*] webmention - process webmentions [*] wholikesme - provides a page to display what connections have 'liked' your posts the most [*] webRTC - use an external server (mayfirst.org) to negotiate webRTC hookups [*] wppost - crosspost to WordPress (or other wordpress XMLRPC service) diff --git a/doc/admin/administrator_guide.md b/doc/admin/administrator_guide.md index c233d8564..9e0ee3c59 100644 --- a/doc/admin/administrator_guide.md +++ b/doc/admin/administrator_guide.md @@ -150,7 +150,7 @@ web-based administrative tools to function: #### Official addons ##### Installation -Navigate to your webThen you should clone the addon repository (separately). We'll give this repository a nickname of 'hzaddons'. You can pull in other hubzilla addon repositories by giving them different nicknames:: +Navigate to your website. Then you should clone the addon repository (separately). We'll give this repository a nickname of 'hzaddons'. You can pull in other hubzilla addon repositories by giving them different nicknames:: cd mywebsite util/add_addon_repo https://github.com/redmatrix/hubzilla-addons.git hzaddons @@ -162,7 +162,7 @@ For keeping the addon tree updated, you should be on your top level website dire util/update_addon_repo hzaddons Create searchable representations of the online documentation. You may do this - any time that the documentation is updated : +any time that the documentation is updated : cd mywebsite util/importdoc @@ -196,59 +196,35 @@ The installation script was originally designed for a small hardware server behi 1. `service apache2 reload` 1. Open your domain with a browser and step throught the initial configuration of $Projectname. -### Server Roles +### Recommended Addons -$Projectname can be configured in many different ways. One of the configurations available at installation is to select a 'server role'. There are currently three server roles. We highly recommend that you use 'standard' unless you have special needs. +We recommend the following addons be installed on all public sites: + nsfw - hide inappropriate posts/comments + superblock - block content from offensive channels -#### Basic +### Federation Addons -The 'basic' server role is designed to be relatively simple, and it doesn't present options -or complicated features. The hub admin may configure additional features at a site level. -This role is designed for simple social networking and social network federation. Many features -which do not federate easily have been removed, including (and this is somewhat important) -"nomadic identity". You may move a channel to or from a basic server, but you may not clone -it. Once moved, it becomes read-only on the origination site. No updates of any kind will be -provided. It is recommended that after the move, the original channel be deleted - as it is -no longer useable. The data remains only in case there are issues making a copy of the data. +Several web communities have begun to converge using common protocols. The protocols involved are somewhat limited in their abilities. The GNU-Social protocol for instance offers no privacy modes, and the Diaspora protocol is somewhat restrictive in what kinds of communications are allowed. All comments must be signed in a very unique manner by the original author. The ActivityPub protocol is also being considered and may be supported at a future date. No other existing protocol supports nomadic location as used by this project. This presents some support challenges as some features work with some networks and don't work with others. Nevertheless the federation protocols allow connections to be made to a much larger community of people worldwide. They are provided as addons. -This role is supported by the hubzilla community. +> diaspora - The Diaspora Protocol used by Diaspora and Friendica. You should enable 'Diaspora Statistics' (statistics) first to enable all the available features. -#### Standard +> gnusoc - The GNU-Social Protocol, used by GNU-Social, Mastodon and several other communities. This addon requires you first install the 'pubsubhubbub' service (also an addon). +Each member of your site must choose whether or not to allow these protocols individually as they may conflict with several desirable core features and abilities of this software (such as channel migration and cloning). They do this from their 'Settings -> Feature/Addon Settings' page. The administrator may also set the following: -The 'standard' server role is recommended for most sites. All features of the software are -available to everybody unless locked by the hub administrator. Some features will not federate -easily with other networks, so there is often an increased support burden explaining why -sharing events with Diaspora (for instance) presents a different experience on that network. -Additionally any member can enable "advanced" or "expert" features, and these may be beyond -their technical skill level. This may also result in an increased support burden. + util/config system.diaspora_allowed 1 + util/config system.gnusoc_allowed 1 -This role is supported by the hubzilla community. +and enable these protocols automatically for all newly created channels. -#### Pro -The 'pro' server role is primarily designed for communities which want to present a uniform -experience and be relieved of many federation support issues. In this role there is -**no federation with other networks**. Additional features **may** be provided, such -as channel ratings, premium channels, and e-commerce. -By default a channel may set a "techlevel" appropriate to their technical skill. Higher -levels provide more features. Everybody starts with techlevel 0 (similar to the 'basic' -role) where all complicated features are hidden from view. Increasing the techlevel provides -more advanced or complex features. + -The hub admin may also lock individual channels or their entire site at a defined techlevel -which provides an installation with a selection of advanced features consistent with the -perceived technical skills of the members. For instance, a community for horse racing might -have a different techlevel than a community for Linux kernel developers. - -This role is not supported by the hubzilla community. ### Techlevels -Techlevels is a unique feature of Hubzilla 'pro'. It is not available in other server_roles, although it expands on the concepts introduced in $Projectname 'basic'. - We've implemented several different mechanisms in order to reduce the apparent complexity and learning curve presented to new members. At the same time, we do not wish to limit any functionality for people who are able to grasp some slightly advanced technical technical features. The first mechanism was to move several features to an optional 'Features' page where they could be enabled at will; with the default interface kept somewhat lean. The problem we had now is that the number of features began to grow dramatically, and the Feature page is daunting in possibilities. There are also features present which probably should not be available to all members, but may be extremely useful to those with technical backgrounds. @@ -257,8 +233,7 @@ The techlevels seeeks to remedy this by grouping features within different level When a new member registers, their account is provided a techlevel setting of 0. On the account settings page they may change this to any available level. A higher level opens more advanced features and possible interactions. -The account administrator may also lock a particular level, lock a maximum level, or change/re-arrange the features available to any level. Those with the minimum level are typically not very exploratory and are unlikely to discover the advanced modes. This is by design. Those that look around and desire more interactions will find them. In the absence of administrator defaults they may choose any level. As they look at the features available to the level in question, it is generally expected that they will discover some features are beyond their comprehension and it is hoped they will back off to a level where the interface and features are comfortable to their skill level. This is somewhat experimental at present and for that reason is not part of the 'standard' server role. The standard server role is preset to level '5', and the basic server role is preset to level '0', with no possibility of change. Members in these roles may find themselves overwhelmed or underwhelmed by the feature set and complexity. - +The account administrator may also lock a particular level, lock a maximum level, or change/re-arrange the features available to any level. Those with the minimum level are typically not very exploratory and are unlikely to discover the advanced modes. This is by design. Those that look around and desire more interactions will find them. In the absence of administrator defaults they may choose any level. As they look at the features available to the level in question, it is generally expected that they will discover some features are beyond their comprehension and it is hoped they will back off to a level where the interface and features are comfortable to their skill level. ### Service Classes diff --git a/doc/bugs.bb b/doc/bugs.bb index f50337648..cc1ea3a20 100644 --- a/doc/bugs.bb +++ b/doc/bugs.bb @@ -1,31 +1,32 @@ [h2]Bugs, Issues, and things that go bump in the night...[/h2] [h3]Something went wrong! Who is charge of fixing it?[/h3] -[b]Hubzilla Community Server[/b] +[b]$Projectname Community Server[/b] -Hubzilla Community Server is open source software which is maintained by "the community" - essentially unpaid volunteers. +$Projectname Community Server is open source software which is maintained by "the community" - essentially unpaid volunteers. Nobody is in charge of fixing bugs. We work together to keep the software and network running smoothly and error free. You are a member of this community, so we also require your help to provide quality software. There are no mythical "developers" who magically fix everything. It's up to all of us to pitch in and help. The first thing you need to do is talk to your hub administrator - the person who runs and manages your site. They are in the unique position of having access to the internal software and database and [b]logfiles[/b] and will need to be involved in fixing your problem. Other people "on the net" can't really help with this. The first thing the hub administrator needs to do is look at their logs and/or try to reproduce the problem. So try to be as helpful and courteous as possible in helping them look into the problem. -To find your hub administrator (if you don't know who they are) please look at [url=[baseurl]/siteinfo]this page[/url]. If they have not provided any contact info on that page or provided an "Impressum" there, see [url=[baseurl]/siteinfo/json]this site info summary[/url] under the heading "admin:". +To find your hub administrator (if you don't know who they are) please look at [url=[baseurl]/siteinfo]this page[/url]. If they have not provided any contact info on that page or provided an "Impressum" there, see [url=[baseurl]/siteinfo.json]this site info summary[/url] under the heading "admin:". + +It is highly recommended that bug reports be filed by hub administrators so that they can include the relevant logfile and database information relevant to the issue and be available to try workarounds and followup tests. Without this level of cooperation it may not be possible to fix the problem. [h3]I'm a hub administrator; what do I do?[/h3] -The software instructions which provide this server are open source and are available for your inspection. If an error message was reported, often one can do a search on the source files for that error message and find out what triggered it. With this information and the site logfiles it may be possible to figure out the sequence of events leading to the error. There could also be other sites involved, and the problem may not even be on your site but elsewhere in the network. Try to pin down the communication endpoints (hubs or sites) involved in the problem and contact the administrator of that site or those sites. Please try and provide an event time of when things went wrong so it can be found in the logs. Work with the other administrator(s) to try and find the cause of the problem. Logfiles are your friend. When something happens in the software that we didn't expect, it is nearly always logged. +The software instructions which provide this web service are open source and are available for your inspection. We encourage everybody to read it and see how everything works and verify that we aren't doing anything evil or negligent with your personal communications. If an error message was reported, often one can do a search on the source files for that error message and find out what triggered it. With this information and the site logfiles it may be possible to figure out the sequence of events leading to the error. There could also be other sites involved, and the problem may not even be on your site but elsewhere in the network. Try to pin down the communication endpoints (hubs or sites) involved in the problem and contact the administrator of that site or those sites. Please try and provide an event time of when things went wrong so it can be found in the logs. Work with the other administrator(s) to try and find the cause of the problem. Logfiles are your friend. When something happens in the software that we didn't expect, it is nearly always logged. [h3]The white screen of death[/h3] -If you get a blank white screen when doing something, this is almost always a code or syntax error. There are instructions in your .htconfig.php file for enabling syntax logging. We recommend all sites use this. With syntax logging enabled repeat the sequence which led to the error and it should log the offending line of code. Hopefully you will be able to fix the problem with this information. When you do, please submit the fix "upstream" so that we can share the fix with the rest of the project members and other communities. This is a key benefit of using open source software - we share with each other and everybody benefits. +If you get a blank white screen when doing something, this is almost always a code or syntax error. There are instructions in the site .htconfig.php file which will allow the site administrator to enabling syntax logging. We recommend all sites use this. With syntax logging enabled repeat the sequence which led to the error and it should log the offending line of code. Hopefully you will be able to fix the problem with this information. When you do, please submit the fix "upstream" so that we can share the fix with the rest of the project members and other communities. This is a key benefit of using open source software - we share with each other and everybody benefits. [h3]I'm stumped. I can't figure out what is wrong.[/h3] -At this point it might be worthwhile discussing the issue on one of the online forums. There may be several of these and some may be more suited to your spoken language. As a last resort, try "Channel One", which is in English. +At this point it might be worthwhile discussing the issue on one of the online forums. There may be several of these and some may be more suited to your spoken language. At this time, the 'Hubzilla Support' channel (support@gravizot.de) is the recommended forum for discussing bugs. -If the community developers can't help you right away, understand that they are volunteers and may have a lot of other work and demands on their time. At this point you need to file a bug report. You will need an account on github.com to do this. So register, and then visit https://github.com/redmatrix/hubzilla/issues -. Create an issue here and provide all the same information that you provided online. Don't leave out anything. +If community members with software engineering training/expertise can't help you right away, understand that they are volunteers and may have a lot of other work and demands on their time. At this point you need to file a bug report. You will need an account on github.com to do this. So register, and then visit https://github.com/redmatrix/hubzilla/issues . Create an issue here and provide all the same information that you provided online. Don't leave out anything. -Then you wait. If it's a high profile issue, it may get fixed quickly. But nobody is in charge of fixing bugs. If it lingers without resolution, please spend some more time investigating the problem. Ask about anything you don't understand related to the behaviour. You will learn more about how the software works and quite possibly figure out why it isn't working now. Ultimately it is somebody in the community who is going to fix this and you are a member of the community; and this is how the open source process works. +Then you wait. If it's a high profile issue, it may get fixed quickly. But nobody is in charge of fixing bugs. If it lingers without resolution, please spend some more time investigating the problem. Ask about anything you don't understand related to the behaviour. You will learn more about how the software works and quite possibly figure out why it isn't working now. Ultimately it is somebody in the community who is going to fix this and you are a member of the community; and this is how the open source process works. -Other developers working to fix the problem may need to find out more, so do your homework and document what is happening and everything you've tried. Don't say "I did xyz and it didn't work." That doesn't tell us anything. Tell us precisely what steps you took and what you expected the result to be, and precisely what happened as a result. If there were any error messages, don't say "there was an error message". Tell us exactly what the message said. Tell us what version you're running and any other details that may be unique about your site configuration. +Other people working to fix the problem may need to find out more, so do your homework and document what is happening and everything you've tried. Don't say "I did xyz and it didn't work." That doesn't tell us anything. Tell us precisely what steps you took and what you expected the result to be, and precisely what happened as a result. What page/URL were you looking at or what form were you filling in? If there were any error messages, don't say "there was an error message". Tell us exactly what the message said. Also tell us what hub you are using, what software version you're running and any other details that may be unique about your site configuration. It is understood that you might wish to keep some information and your connections private, however if you aren't willing to share the information other people need to reproduce/fix the problem, it may not get fixed.
\ No newline at end of file diff --git a/doc/developer/api_zot.bb b/doc/developer/api_zot.bb index ddca65b4d..b2c19d7a1 100644 --- a/doc/developer/api_zot.bb +++ b/doc/developer/api_zot.bb @@ -4,7 +4,20 @@ The API endpoints detailed below are relative to [code]api/z/1.0[/code], meaning [h3]channel/export/basic[/h3] -Export channel data +Export basic channel data + +Options: + - sections + comma-separated list of data types to export + + - posts + if true, return default sections plus 3 months of posts + + If no sections are requested, the following sections are returned: + channel, connections, config, apps, chatrooms, events, webpages, mail, wikis + + Files and large collections of posts may run into memory limits; these must generally be + requested separately. [h3]channel/stream[/h3] @@ -608,7 +621,7 @@ Optional: application or network name to display with item -- categories +- category comma separated categories for this item diff --git a/doc/hook/author_is_pmable.bb b/doc/hook/author_is_pmable.bb index 708350673..11d1185f3 100644 --- a/doc/hook/author_is_pmable.bb +++ b/doc/hook/author_is_pmable.bb @@ -6,7 +6,7 @@ By default author_is_pmable() returns true for 'zot' xchans, and false for all o The plugin is passed an array - [ 'xchan' => $author_xchan, 'result' => 'unset' ] + [ 'xchan' => $author_xchan, 'abook' => abook record, 'result' => 'unset' ] A plugin which sets the 'result' to something besides 'unset' will over-ride the default behaviour. A value of true will enable the 'send mail' link and the private mail recipient will be set to the author's xchan_hash. A value of false will disable the 'send mail' link. diff --git a/doc/hook/can_comment_on_post.bb b/doc/hook/can_comment_on_post.bb new file mode 100644 index 000000000..2cfd3b2da --- /dev/null +++ b/doc/hook/can_comment_on_post.bb @@ -0,0 +1,13 @@ +[h3]can_comment_on_post[/h3] + +Called when deciding whether or not to display a comment box for a post. + + +Hook data (array): + observer_hash => xchan_hash of current observer + item => posted item + allowed => 'unset' + + +To over-ride the default behaviour, change allowed to true or false + diff --git a/doc/hook/connection_remove.bb b/doc/hook/connection_remove.bb new file mode 100644 index 000000000..bd13ae5f2 --- /dev/null +++ b/doc/hook/connection_remove.bb @@ -0,0 +1,9 @@ +[h3]connection_remove[/h3] + +Called when deleting a connection. + + +Passed parameter array: + + 'channel_id' => channel_id of the channel removing the connection + 'abook_id' => abook_id of the connection being removed diff --git a/doc/hook/legal_webbie.bb b/doc/hook/legal_webbie.bb new file mode 100644 index 000000000..8c7d32d56 --- /dev/null +++ b/doc/hook/legal_webbie.bb @@ -0,0 +1,10 @@ +[h2]legal_webbie[/h2] + +Called when validating a channel address. By default the valid characters are +a-z,0-9,-,_, and . Uppercase ASCII characters are folded to lower and any invalid characters are stripped. + +Some federated networks require more restrictive rules. + +The hook is called with an array [ 'input' => (supplied text), 'output' => (validated text) ] + +A plugin will generally perform a regex filter or text operation on 'input' and provide the results in 'output'.
\ No newline at end of file diff --git a/doc/hook/legal_webbie_text.bb b/doc/hook/legal_webbie_text.bb new file mode 100644 index 000000000..32c74c93b --- /dev/null +++ b/doc/hook/legal_webbie_text.bb @@ -0,0 +1,7 @@ +[h2]legal_webbie_text[/h2] + +Returns a string describing the text rules applied to legal_webbie(). + +Called with an array [ 'text' => (descriptive text describing text character limitations) ] + +A plugin should return the description of the allowed characters and operation performed in the 'legal_webbie' hook to assist people when creating a new channel.
\ No newline at end of file diff --git a/doc/hooklist.bb b/doc/hooklist.bb index 6933edad2..da4d9596b 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -82,6 +82,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/build_pagehead]build_pagehead[/zrl] Called when creating the HTML page header +[zrl=[baseurl]/help/hook/can_comment_on_post]can_comment_on_post[/zrl] + Called when deciding whether or not to present a comment box for a post + [zrl=[baseurl]/help/hook/change_channel]change_channel[/zrl] Called when logging in to a channel (either during login or afterward through the channel manager) @@ -118,6 +121,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/connect_premium]connect_premium[/zrl] Called when connecting to a premium channel +[zrl=[baseurl]/help/hook/connection_remove]connection_remove[/zrl] + Called when deleting/removing a connection + [zrl=[baseurl]/help/hook/connector_settings]connector_settings[/zrl] Called when posting to the features/addon settings page @@ -317,6 +323,12 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/jot_tool]jot_tool[/zrl] Deprecated and possibly obsolete. Allows one to add action buttons to the post editor. +[zrl=[baseurl]/help/hook/legal_webbie]legal_webbie[/zrl] + Called to validate a channel address + +[zrl=[baseurl]/help/hook/legal_webbie_text]legal_webbie_text[/zrl] + Provides an explanation of text/character restrictions for legal_webbie() + [zrl=[baseurl]/help/hook/load_pdl]load_pdl[/zrl] Called when we load a PDL file or description diff --git a/doc/member/bbcode.html b/doc/member/bbcode.html index a4bc813d8..9b7080a32 100644 --- a/doc/member/bbcode.html +++ b/doc/member/bbcode.html @@ -26,6 +26,9 @@ <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> @@ -61,8 +64,10 @@ text</code></td><td> </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. Supported languages include <strong>php, css, mysql, sql, abap, diff, html, perl, ruby, vbscript, avrc, dtd, java, xml, cpp, python, javascript, js, json, sh </strong>. +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> diff --git a/doc/member/member_guide.bb b/doc/member/member_guide.bb index 50f0b581b..0a2d11a88 100644 --- a/doc/member/member_guide.bb +++ b/doc/member/member_guide.bb @@ -174,19 +174,29 @@ You can also delegate control of your channels' posts and connections, but not i [h3]Connecting To Channels[/h3] -Connections in $Projectname can take on a great many different meanings. But let's keep it simple, you want to be friends with somebody like you are familiar with from social networking. How do you do it? +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. This is incomplete, so we'll improve this paragraph later. +The next thing you can do is look at the Directory. The directory is available on every $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 don't allow any permissions, communication will be very limited. There are some quick links which you can use to avoid setting individual permissions. To provide a social network environment, "Full Sharing" is recommended. You may review the settings that are applied with the quick links to ensure they are suitable for the channel you are connecting with and adjust if necessary. Then scroll to the bottom of the page and click "Submit". +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 or GNU-Social) 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. + +To connect with RSS feeds: -You may also connect with any channel by visiting the "Connections" page of your site or the Directory and typing their "webbie" into the "Add New Connection" field. Use this method if somebody tells you their webbie and you wish to connect with them. A webbie looks like an email address; for example "bob@example.com". The process is the same as connecting via the "Connect" button - you will then be taken to the connection editor to set permissions. +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] +[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. @@ -279,7 +289,7 @@ We highly recommend that you use the "typical social network" settings when you [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 indivudal permissions on the connnection edit screen. +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] @@ -348,7 +358,7 @@ Topical tags are indicated by preceding the tag name with the # character. This Topical tags are also not 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. [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 generatd 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 #^ 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. [h4]Spaces in Tags and 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. @@ -687,14 +697,8 @@ This places a block named "contributors" in this region. Additionally 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. (TODO: list available widgets and arguments). The base system provides +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. -[code] - profile - widget which duplicates the profile sidebar of your channel page. This widget takes no arguments - tagcloud - provides a tag cloud of categories - count - maximum number of category tags to list - -[/code] Widgets and arguments are specified with the 'widget' and 'var' tags. [code] @@ -995,7 +999,7 @@ The saved search widget will provide autocompletion of channels (the results are [h4]Remove Channel[/h4] -Go to the bottom of your channel settings page or visit the URL: +Select the 'Remove Channel' link on your channel settings page or visit the URL: [baseurl]/removeme @@ -1007,7 +1011,7 @@ If you have identity clones on other hubs this only removes by default the chan [h4]Remove Account[/h4] -Go to the bottom of your account settings page or visit the URL: +Select 'Remove Account' from your account settings page or visit the URL: [baseurl]/removeaccount @@ -1016,3 +1020,4 @@ You will need to confirm your password and the account you are currently logged [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/toc.html b/doc/toc.html index 11635930e..4da01d55d 100644 --- a/doc/toc.html +++ b/doc/toc.html @@ -7,8 +7,8 @@ </div> <div id="about" class="doco-section"> <div class="flex-column"> - <a class="nav-link" href="/help/about/about_hubzilla">About Hubzilla</a> - <a class="nav-link" href="/help/about/hubzilla_project">Hubzilla project</a> + <a class="nav-link" href="/help/about/about">About</a> + <a class="nav-link" href="/help/about/project">Project</a> <a class="nav-link" href="/help/about/about_hub">About this hub</a> </div> </div> @@ -23,6 +23,7 @@ <div class="flex-column"> <a class="nav-link" href="/help/member/member_guide">Guide</a> <a class="nav-link" href="/help/member/bbcode">BBcode Reference</a> + <a class="nav-link" href="/help/bugs">Reporting Bugs</a> <a class="nav-link" href="/help/member/member_faq">FAQ</a> </div> </div> @@ -84,6 +85,7 @@ tocUl.removeClass(); // Classes are automatically added to <ul> elements by something else tocUl.toc({content: "#doco-content", headings: "h3"}); tocUl.addClass('toc-content'); + tocUl.addClass('list-unstyled'); tocUl.attr('id', 'doco-side-toc'); } diff --git a/doc/tutorials/personal_channel.html b/doc/tutorials/personal_channel.html index f2ad87077..9dbc2aaec 100644 --- a/doc/tutorials/personal_channel.html +++ b/doc/tutorials/personal_channel.html @@ -6,7 +6,7 @@ to a personal channel in a natural way.</p> <h3 id="Create_a_new_channel">Create a new channel</h3> <p>When you log in for the first time after registering, you must create a channel. -(Alternatively you can load https://grid.reticu.li/new_channel)</p> +(Alternatively you can visit https://your_website/new_channel)</p> <p><img class="img-responsive" src="/help/tutorials/assets/c9a880cc82ffa1f7c2f460397bb083bf7dc2a2b8f065e64da598b45b4a2b.png" alt="image"></p> @@ -76,7 +76,7 @@ so you can specify exactly who can access this post.</p> <h3 id="Use_an_uploaded_image_as_a_channel_cover_photo">Use an uploaded image as a channel cover photo</h3> <p>One way to add some pizzazz your channel is to add a cover photo that visitors will -see when they load your channel page. Hubzilla's integrated cloud file system +see when they load your channel page. The integrated cloud file system allows you to choose an existing photo for this purpose.</p> <p>Visit your photos in the <strong>Photos</strong> app</p> @@ -99,9 +99,9 @@ channel page will fade in as you scroll down.</p> <h3 id="Make_a_connection">Make a connection</h3> -<p>Making connections between channels to share things is what Hubzilla is all about. +<p>Making connections between channels to share things is what social communications are all about. Making a connection is simple. If you do not already know how to reach a channel's home -page, you might try a directory search by opening the <strong>Directory</strong> link on the right +page, you might try a directory search by opening the <strong>Directory</strong> link from the menu on the right side of the top navbar.</p> <p><img class="img-responsive" src="/help/tutorials/assets/ef78bc6aa3fafebd46f353514c907b3fdfe019918fc5553bb3f31388a36f.png" alt="image"></p> @@ -160,4 +160,4 @@ editor by pressing the edit button beside the <strong>Delete</strong> button.</p <p><img class="img-responsive" src="/help/tutorials/assets/c4cad3e4c356dd2a227df79bd4dc6d47edf1b66ea243f005b6b452ec366b.png" alt="image"></p> -
\ No newline at end of file + |