aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorzotlabs <mike@macgirvin.com>2017-09-24 21:26:12 -0700
committerzotlabs <mike@macgirvin.com>2017-09-24 21:26:12 -0700
commit137f5b3dbc05b35bc1a05c8d2b34abed0ebd2e9b (patch)
treea22b1a9cda49a821f0adea14977beb15ee3db9f2
parente1cd51d8d9494ab3ddaae0ca9cb5c60ea7931eaa (diff)
downloadvolse-hubzilla-137f5b3dbc05b35bc1a05c8d2b34abed0ebd2e9b.tar.gz
volse-hubzilla-137f5b3dbc05b35bc1a05c8d2b34abed0ebd2e9b.tar.bz2
volse-hubzilla-137f5b3dbc05b35bc1a05c8d2b34abed0ebd2e9b.zip
doc page for the new channel_links hook
-rw-r--r--doc/hook/channel_links.bb12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/hook/channel_links.bb b/doc/hook/channel_links.bb
new file mode 100644
index 000000000..c0243dac6
--- /dev/null
+++ b/doc/hook/channel_links.bb
@@ -0,0 +1,12 @@
+[h2]channel_links[/h2]
+
+Called when generating the Link HTTP header for the channel page. Different protocol stacks can add links to this header.
+
+Hook data = array
+ 'channel_address' => channel nickname, no checking is done to see if it is valid
+ 'channel_links' => array of channel links in the format
+ 'url' => url of resource
+ 'rel' => link relation
+ 'type' => MIME type
+
+All fields are required \ No newline at end of file