aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hook
diff options
context:
space:
mode:
authormrjive <mrjive@mrjive.it>2015-12-04 10:32:14 +0100
committermrjive <mrjive@mrjive.it>2015-12-04 10:32:14 +0100
commit051346325609f5f2e78ef0deaf182c65d7823bbc (patch)
treef3660377b3daf6599623d2e4fb95b4d33c30d8cc /doc/hook
parent53a796afcc0cff6f9e3f51457df4506a43db1945 (diff)
parent8a9d743f6f518d3af35014130dcef8f148148113 (diff)
downloadvolse-hubzilla-051346325609f5f2e78ef0deaf182c65d7823bbc.tar.gz
volse-hubzilla-051346325609f5f2e78ef0deaf182c65d7823bbc.tar.bz2
volse-hubzilla-051346325609f5f2e78ef0deaf182c65d7823bbc.zip
Merge pull request #9 from redmatrix/master
updating from original codebase
Diffstat (limited to 'doc/hook')
-rw-r--r--doc/hook/logger.bb16
-rw-r--r--doc/hook/nav.bb27
2 files changed, 43 insertions, 0 deletions
diff --git a/doc/hook/logger.bb b/doc/hook/logger.bb
new file mode 100644
index 000000000..8fe989abd
--- /dev/null
+++ b/doc/hook/logger.bb
@@ -0,0 +1,16 @@
+[h2]logger[/h2]
+
+Called when making an entry to the application logfile
+
+Hook data:
+
+ array(
+ 'filename' => name of logfile relative to application basedir. String.
+ 'loglevel' => the log level of this log entry, if this is higher than the configured maximum loglevel
+ this hook will not be called. Integer.
+ 'message' => The formatted log message, ready for logging. String.
+ 'logged' => boolean, default is false. Set to true to prevent the normal logfile entry to be made
+ (e.g. if the plugin is configured to handle this aspect of the function, or if it is determined
+ that this log entry should not be made)
+ )
+
diff --git a/doc/hook/nav.bb b/doc/hook/nav.bb
index 847573620..b52f90602 100644
--- a/doc/hook/nav.bb
+++ b/doc/hook/nav.bb
@@ -1 +1,28 @@
[h2]nav[/h2]
+
+Called when generating the main navigation bar and menu for a page
+
+Hook data:
+
+ array(
+ 'usermenu' => array( 'icon' => photo URL, 'name' => channel name )
+ 'nav' => array(
+ 'usermenu' => usermenu (photo menu) link array
+ (channel home, profiles, photos, cloud, chats, webapges ...)
+ 'loginmenu' => login menu link array
+ 'network' => grid link and grid-notify
+ 'home' => home link and home-notify
+ 'intros' => intros link and intros-notify
+ 'notifications' => notifications link and notifications-notify
+ 'messages' => PM link and PM-notify
+ 'all_events' => events link and events notfiy
+ 'manage' => manage channels link
+ 'settings' => settings link
+ 'register' => registration link
+ 'help' => help/doc link
+ 'apps' => apps link
+ 'search' => search link and form
+ 'directory' => directory link
+ )
+
+