diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/about/about.bb (renamed from doc/about/about_hubzilla.bb) | 11 | ||||
| -rw-r--r-- | doc/about/project.bb (renamed from doc/about/hubzilla_project.bb) | 0 | ||||
| -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 | 6 | ||||
| -rw-r--r-- | doc/toc.html | 4 | ||||
| -rw-r--r-- | doc/tutorials/personal_channel.html | 10 |
7 files changed, 33 insertions, 15 deletions
diff --git a/doc/about/about_hubzilla.bb b/doc/about/about.bb index e9485ffa6..2affe2cba 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. diff --git a/doc/about/hubzilla_project.bb b/doc/about/project.bb index 7a584687d..7a584687d 100644 --- a/doc/about/hubzilla_project.bb +++ b/doc/about/project.bb 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..0b74a4df2 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -317,6 +317,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/toc.html b/doc/toc.html index 11635930e..9a01af39f 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> 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 + |