From 87ee48bd84bc712ebdccd8286f01b8da3e5c3cba Mon Sep 17 00:00:00 2001 From: redmatrix Date: Wed, 5 Oct 2016 17:25:49 -0700 Subject: update hook documentation --- doc/hook/bbcode.bb | 5 +++++ doc/hook/bbcode_filter.bb | 7 +++++++ doc/hooklist.bb | 5 ++++- 3 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 doc/hook/bbcode_filter.bb (limited to 'doc') 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) -- cgit v1.2.3