aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorredmatrix <mike@macgirvin.com>2016-10-05 17:25:49 -0700
committerredmatrix <mike@macgirvin.com>2016-10-05 17:27:02 -0700
commit87ee48bd84bc712ebdccd8286f01b8da3e5c3cba (patch)
tree18e06d42f1a29348e4bee076c072f47ee4964f44 /doc
parent24f9bb41df83e61ba5f978bad6518fe993e3a33d (diff)
downloadvolse-hubzilla-87ee48bd84bc712ebdccd8286f01b8da3e5c3cba.tar.gz
volse-hubzilla-87ee48bd84bc712ebdccd8286f01b8da3e5c3cba.tar.bz2
volse-hubzilla-87ee48bd84bc712ebdccd8286f01b8da3e5c3cba.zip
update hook documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/hook/bbcode.bb5
-rw-r--r--doc/hook/bbcode_filter.bb7
-rw-r--r--doc/hooklist.bb5
3 files changed, 16 insertions, 1 deletions
diff --git a/doc/hook/bbcode.bb b/doc/hook/bbcode.bb
index 2996a8528..f6b8711b0 100644
--- a/doc/hook/bbcode.bb
+++ b/doc/hook/bbcode.bb
@@ -1 +1,6 @@
[h2]bbcode[/h2]
+
+
+Called at end of bbcode to html conversion.
+
+Hook argument contains the converted text string.
diff --git a/doc/hook/bbcode_filter.bb b/doc/hook/bbcode_filter.bb
new file mode 100644
index 000000000..efeb2e1b0
--- /dev/null
+++ b/doc/hook/bbcode_filter.bb
@@ -0,0 +1,7 @@
+[h2]bbcode_filter[/h2]
+
+
+Called at beginning of bbcode to html conversion.
+
+Hook argument contains the text string to be converted.
+
diff --git a/doc/hooklist.bb b/doc/hooklist.bb
index e48fbee7c..d190166f0 100644
--- a/doc/hooklist.bb
+++ b/doc/hooklist.bb
@@ -68,7 +68,10 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the
called when converting bbcode to markdown
[zrl=[baseurl]/help/hook/bbcode]bbcode[/zrl]
- Called when converting bbcode to HTML
+ Called at end of converting bbcode to HTML
+
+[zrl=[baseurl]/help/hook/bbcode_filter]bbcode_filter[/zrl]
+ Called when beginning to convert bbcode to HTML
[zrl=[baseurl]/help/hook/bb_translate_video]bb_translate_video[/zrl]
Called when extracting embedded services from bbcode video elements (rarely used)