add hooks to allow loading custom help documentation

diff --git a/EVENTS.txt b/EVENTS.txt
index 25d95fe068345a6ca81b706843f7054ad3ffa7ac..a79687bae180b71511f21a90a425faf3da79823c 100644 (file)
--- a/EVENTS.txt
+++ b/EVENTS.txt
@@ -227,3 +227,11 @@ StartNewQueueManager: before trying to start a new queue manager; good for plugi
 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
 - $action: action object being shown
 - $user: current user
+
+StartLoadDoc: before loading a help doc (hook this to show your own documentation)
+- $title: title of the document
+- $output: HTML output to show
+
+EndLoadDoc: after loading a help doc (hook this to modify other documentation)
+- $title: title of the document
+- $output: HTML output to show

diff --git a/actions/doc.php b/actions/doc.php
index 54ae1380362b618f2ea22e0bfe78c1dd0aaca77e..7387c162075195b19e6f719234a1ffa84e3fa440 100644 (file)
--- a/actions/doc.php
+++ b/actions/doc.php
@@ -58,12 +58,24 @@ class DocAction extends Action
     function handle($args)
     {
         parent::handle($args);
-        $this->title    = $this->trimmed('title');
-        $this->filename = INSTALLDIR.'/doc-src/'.$this->title;
-        if (!file_exists($this->filename)) {
-            $this->clientError(_('No such document.'));
-            return;
+
+        $this->title  = $this->trimmed('title');
+        $this->output = null;
+
+        if (Event::handle('StartLoadDoc', &$this->title, &$this->output)) {
+
+            $this->filename = INSTALLDIR.'/doc-src/'.$this->title;
+            if (!file_exists($this->filename)) {
+                $this->clientError(_('No such document.'));
+                return;
+            }
+
+            $c = file_get_contents($this->filename);
+            $this->output = common_markup_to_html($c);
+
+            Event::handle('EndLoadDoc', $this->title, &$this->output);
         }
+
         $this->showPage();
     }
 
@@ -93,9 +105,7 @@ class DocAction extends Action
      */
     function showContent()
     {
-        $c      = file_get_contents($this->filename);
-        $output = common_markup_to_html($c);
-        $this->raw($output);
+        $this->raw($this->output);
     }
 
     /**