aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMario Vavti <mario@mariovavti.com>2017-05-31 09:56:35 +0200
committerMario Vavti <mario@mariovavti.com>2017-05-31 09:56:35 +0200
commit47d55694a4c84b6c12c0db61a69bcac8b671b20e (patch)
treeb15e96f4ea67e2214a66a9d28dafaf53d25b98ec /doc
parent087f9784e3c5a860ed2b86e7f9e8e9f312038546 (diff)
parentf0e615dee529e031663576286345141ad2996974 (diff)
downloadvolse-hubzilla-47d55694a4c84b6c12c0db61a69bcac8b671b20e.tar.gz
volse-hubzilla-47d55694a4c84b6c12c0db61a69bcac8b671b20e.tar.bz2
volse-hubzilla-47d55694a4c84b6c12c0db61a69bcac8b671b20e.zip
Merge branch '2.4RC'2.4
Diffstat (limited to 'doc')
-rw-r--r--doc/Widgets.md1
-rw-r--r--doc/about/hubzilla_project.bb3
-rw-r--r--doc/database/db_account.bb1
-rw-r--r--doc/dev-function-overview.md4
-rw-r--r--doc/developer/api_zot.bb2
-rw-r--r--doc/hook/author_is_pmable.bb14
-rw-r--r--doc/hook/probe_well_known.bb3
-rw-r--r--doc/hooklist.bb8
-rw-r--r--doc/member/member_guide.bb2
-rw-r--r--doc/toc.html70
10 files changed, 58 insertions, 50 deletions
diff --git a/doc/Widgets.md b/doc/Widgets.md
index 8442bf687..4ad899a0f 100644
--- a/doc/Widgets.md
+++ b/doc/Widgets.md
@@ -117,6 +117,7 @@ Some/many of these widgets have restrictions which may restrict the type of page
* forums - provide a list of connected public forums with unseen counts for the current logged-in channel.
<br />&nbsp;<br />
+* activity - provide a list of authors of unread network content for the current logged-in channel.
* album - provides a widget containing a complete photo album from albums belonging to the page owner; this may be too large to present in a sidebar region as is best implemented as a content region widget.
* args:
diff --git a/doc/about/hubzilla_project.bb b/doc/about/hubzilla_project.bb
index 7a584687d..f9bc920f8 100644
--- a/doc/about/hubzilla_project.bb
+++ b/doc/about/hubzilla_project.bb
@@ -182,4 +182,5 @@ even if we have had our occasional disagreements.
[li]Simó Albert i Beltran[/li]
[li]Manuel Reva[/li]
[li]Manuel Jiménez Friaza[/li]
-[/list] \ No newline at end of file
+[li]Gustav Wall aka "neue medienordnung plus"[/li]
+[/list]
diff --git a/doc/database/db_account.bb b/doc/database/db_account.bb
index 354f2d3a8..35d7a9eb3 100644
--- a/doc/database/db_account.bb
+++ b/doc/database/db_account.bb
@@ -58,7 +58,6 @@ define ( 'ACCOUNT_PENDING', 0x0010 );
* Account roles
*/
-define ( 'ACCOUNT_ROLE_ALLOWCODE', 0x0001 ); // 1 - this account can create content with PHP/Javascript
define ( 'ACCOUNT_ROLE_SYSTEM', 0x0002 ); // 2 - this is the special system account
define ( 'ACCOUNT_ROLE_DEVELOPER', 0x0004 );
define ( 'ACCOUNT_ROLE_ADMIN', 0x1000 ); // 4096 - this account is an administrator
diff --git a/doc/dev-function-overview.md b/doc/dev-function-overview.md
index fa8a98ff3..cd2526ead 100644
--- a/doc/dev-function-overview.md
+++ b/doc/dev-function-overview.md
@@ -15,10 +15,6 @@ Returns authenticated numeric channel_id if authenticated and connected to a cha
Returns authenticated string hash of Red global identifier, if authenticated via remote auth, or an empty string.
-* get_app()
-
-Returns the global app structure ($a). No longer used as App is a static class
-
* App::get_observer()
returns an xchan structure representing the current viewer if authenticated (locally or remotely).
diff --git a/doc/developer/api_zot.bb b/doc/developer/api_zot.bb
index 1314f90b5..ddca65b4d 100644
--- a/doc/developer/api_zot.bb
+++ b/doc/developer/api_zot.bb
@@ -28,7 +28,7 @@ GET /api/z/1.0/files
Options:
- - hash
+ - filehash
return only entries matching hash (exactly)
- filename
diff --git a/doc/hook/author_is_pmable.bb b/doc/hook/author_is_pmable.bb
new file mode 100644
index 000000000..708350673
--- /dev/null
+++ b/doc/hook/author_is_pmable.bb
@@ -0,0 +1,14 @@
+[h2]author_is_pmable[/h2]
+
+Called from thread action menu before returning a 'send mail' link for the post author. Not all authors will be able to receive private mail, for instance those on other networks with incompatible mail systems.
+
+By default author_is_pmable() returns true for 'zot' xchans, and false for all others.
+
+The plugin is passed an array
+
+ [ 'xchan' => $author_xchan, '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/probe_well_known.bb b/doc/hook/probe_well_known.bb
deleted file mode 100644
index 62898c536..000000000
--- a/doc/hook/probe_well_known.bb
+++ /dev/null
@@ -1,3 +0,0 @@
-[h2]probe_well_known[/h2]
-
-This hook is under construction and not currently used - see include/probe.php \ No newline at end of file
diff --git a/doc/hooklist.bb b/doc/hooklist.bb
index fcd0e2aff..6933edad2 100644
--- a/doc/hooklist.bb
+++ b/doc/hooklist.bb
@@ -28,7 +28,7 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the
[zrl=[baseurl]/help/hook/account_settings]account_settings[/zrl]
Called when generating the account settings form
-[zrl=[baseurl]/help/hook/settings_account]account_settings_post[/zrl]
+[zrl=[baseurl]/help/hook/account_settings_post]account_settings_post[/zrl]
Called when posting from the account settings form
[zrl=[baseurl]/help/hook/activity_received]activity_received[/zrl]
@@ -64,6 +64,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the
[zrl=[baseurl]/help/hook/authenticate]authenticate[/zrl]
Can provide alternate authentication mechanisms
+[zrl=[baseurl]/help/hook/author_is_pmable]author_is_pmable[/zrl]
+ Called from the thread action menu to determine if we can send private mail to the post author
+
[zrl=[baseurl]/help/hook/bb2diaspora]bb2diaspora[/zrl]
called when converting bbcode to markdown
@@ -491,9 +494,6 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the
[zrl=[baseurl]/help/hook/prepare_body_init]prepare_body_init[/zrl]
Called before generating the HTML for a displayed conversation item
-[zrl=[baseurl]/help/hook/probe_well_known]probe_well_known[/zrl]
- under construction
-
[zrl=[baseurl]/help/hook/proc_run]proc_run[/zrl]
Called when invoking PHP sub processes
diff --git a/doc/member/member_guide.bb b/doc/member/member_guide.bb
index 2edaa321b..50f0b581b 100644
--- a/doc/member/member_guide.bb
+++ b/doc/member/member_guide.bb
@@ -836,7 +836,7 @@ WebDAV using Windows 7 graphical user interface wizard:
1. Left-click the Start-button to open the start menu.
2. Right-click the My computer icon to access its menu.
3. Left-click Map network drive... to open the connection dialog wizard.
-4. Type #^[url=https://example.net/dav/your_channel_name]https://example.net/dav/your_channel_name[/url] in the textbox and click the Complete button where &quot;example.net&quot; is the URL of your hub.
+4. Type '[baseurl]/dav/nickname' in the textbox (replace nickname with your channel nickname) and click the Complete button.
5. Type your $Projectname channel nickname. IMPORTANT - NO at-sign or domain name.
6. Type your $Projectname password
diff --git a/doc/toc.html b/doc/toc.html
index 3c9c5c299..11635930e 100644
--- a/doc/toc.html
+++ b/doc/toc.html
@@ -1,30 +1,30 @@
<div class="" id="accordion">
- <div class="panel">
+ <div class="">
<div class="">
<h3 class="panel-title">
About
</h3>
</div>
- <div id="about" class="panel-collapse collapse in">
- <ul class="list-group">
- <li class="doco-list-group-item"><a href="/help/about/about_hubzilla">About Hubzilla</a></li>
- <li class="doco-list-group-item"><a href="/help/about/hubzilla_project">Hubzilla project</a></li>
- <li class="doco-list-group-item"><a href="/help/about/about_hub">About this hub</a></li>
- </ul>
+ <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_hub">About this hub</a>
+ </div>
</div>
</div>
- <div class="panel">
+ <div class="">
<div class="">
<h3 class="panel-title">
Members
</h3>
</div>
- <div id="members" class="panel-collapse collapse in">
- <ul class="list-group">
- <li class="doco-list-group-item"><a href="/help/member/member_guide">Guide</a></li>
- <li class="doco-list-group-item"><a href="/help/member/bbcode">BBcode Reference</a></li>
- <li class="doco-list-group-item"><a href="/help/member/member_faq">FAQ</a></li>
- </ul>
+ <div id="members" class="doco-section">
+ <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/member/member_faq">FAQ</a>
+ </div>
</div>
</div>
<div class="panel">
@@ -33,12 +33,12 @@
Administrators
</h3>
</div>
- <div id="administrators" class="panel-collapse collapse in">
- <ul class="list-group">
- <li class="doco-list-group-item"><a href="/help/admin/administrator_guide">Guide</a></li>
- <li class="doco-list-group-item"><a href="/help/admin/hub_snapshots">Hub Snapshots</a></li>
- <li class="doco-list-group-item"><a href="/help/database">Database Tables</a></li>
- </ul>
+ <div id="administrators" class="doco-section">
+ <div class="flex-column">
+ <a class="nav-link" href="/help/admin/administrator_guide">Guide</a>
+ <a class="nav-link" href="/help/admin/hub_snapshots">Hub Snapshots</a>
+ <a class="nav-link" href="/help/database">Database Tables</a>
+ </div>
</div>
</div>
<div class="panel">
@@ -47,14 +47,14 @@
Developers
</h3>
</div>
- <div id="developers" class="panel-collapse collapse in">
- <ul class="list-group">
- <li class="doco-list-group-item"><a href="/help/developer/developer_guide">Guide</a></li>
- <li class="doco-list-group-item"><a href="/help/developer/covenant">Code of Conduct</a></li>
- <li class="doco-list-group-item"><a href="/help/developer/zot_protocol">Zot Protocol</a></li>
- <li class="doco-list-group-item"><a href="/help/developer/api_zot">Zot API</a></li>
- <li class="doco-list-group-item"><a href="/help/hooklist">Hooks</a></li>
- </ul>
+ <div id="developers" class="doco-section">
+ <div class="flex-column">
+ <a class="nav-link" href="/help/developer/developer_guide">Guide</a>
+ <a class="nav-link" href="/help/developer/covenant">Code of Conduct</a>
+ <a class="nav-link" href="/help/developer/zot_protocol">Zot Protocol</a>
+ <a class="nav-link" href="/help/developer/api_zot">Zot API</a>
+ <a class="nav-link" href="/help/hooklist">Hooks</a>
+ </div>
</div>
</div>
<div class="panel">
@@ -63,10 +63,10 @@
Tutorials
</h3>
</div>
- <div id="tutorials" class="panel-collapse collapse in">
- <ul class="list-group">
- <li class="doco-list-group-item"><a href="/help/tutorials/personal_channel">Personal Channel</a></li>
- </ul>
+ <div id="tutorials" class="doco-section">
+ <div class="flex-column">
+ <a class="nav-link" href="/help/tutorials/personal_channel">Personal Channel</a>
+ </div>
</div>
</div>
</div>
@@ -74,16 +74,16 @@
toc = {};
// Generate the table of contents in the side nav menu (see view/tpl/help.tpl)
$(document).ready(function () {
- $(".panel-collapse.in").find('a').each(function(){
+ $(".doco-section").find('a').each(function(){
var url = document.createElement('a');
url.href = window.location;
var pageName = url.href.split('/').pop().split('#').shift().split('?').shift();
var linkName = $(this).attr('href').split('/').pop();
if(pageName === linkName) {
- var tocUl = $(this).closest('li').append('<ul>').find('ul');
+ var tocUl = $(this).closest('a').append('<ul>').find('ul');
tocUl.removeClass(); // Classes are automatically added to <ul> elements by something else
tocUl.toc({content: "#doco-content", headings: "h3"});
- tocUl.addClass('toc-content sub-menu');
+ tocUl.addClass('toc-content');
tocUl.attr('id', 'doco-side-toc');
}