Merge pull request #190 from micgro42/nsexport

Add syntax to export namespace to pdf

Author: Klap-in

_test/syntax_exportlink.test.php

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * General tests for the imagemap plugin
+ *
+ * @group plugin_dw2pdf
+ * @group plugins
+*/
+class dw2pdf_syntax_exportlink_test extends DokuWikiTest {
+
+    public function setUp() {
+        parent::setUp();
+    }
+
+    protected $pluginsEnabled = array('dw2pdf');
+
+    function test_parser () {
+        global $ID;
+        $ID = 'foo:bar:start';
+        $parser_response = p_get_instructions('~~PDFNS>.:|Foo~~');
+        $expected_parser_response = array(
+            'plugin',
+            array(
+                'dw2pdf_exportlink',
+                array(
+                    'link' => '?do=export_pdfns&pdfns_ns=foo:bar&pdfns_title=Foo',
+                    'title' => 'Export namespace "foo:bar:" to file Foo.pdf',
+                    5,
+                    1,
+                ),
+                5,
+                '~~PDFNS>.:|Foo~~',
+            ),
+            1,
+        );
+        $this->assertEquals($expected_parser_response,$parser_response[2]);
+        $renderer_response = p_render('xhtml',$parser_response,$info);
+        $expected_renderer_response = 'doku.php?id=foo:bar:start&amp;do=export_pdfns&amp;pdfns_ns=foo:bar&amp;pdfns_title=Foo" class="wikilink2" title="foo:bar:start" rel="nofollow">Export namespace &quot;foo:bar:&quot; to file Foo.pdf</a>';
+        $trimmed_renderer_response = substr($renderer_response,strpos($renderer_response,'doku.php'),-5);
+        $trimmed_renderer_response = trim($trimmed_renderer_response);
+        $this->assertEquals($expected_renderer_response,$trimmed_renderer_response);
+    }
+}
+

lang/de/lang.php

@@ -2,11 +2,12 @@
 
 /**
  * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
- * 
+ *
  * @author Juergen-aus-Koeln <h-j-schuemmer@web.de>
  */
 $lang['export_pdf_button']     = 'PDF exportieren';
 $lang['needtitle']             = 'Bitte Titel angeben!';
 $lang['needns']                = 'Bitte geben Sie einen vorhandenen Namensraum an.';
 $lang['empty']                 = 'Sie haben noch keine Seiten gewählt.';
 $lang['tocheader']             = 'Inhaltsverzeichnis';
+$lang['export_ns']             = 'Exportiere Namensraum "%s:" in Datei %s.pdf';

lang/en/lang.php

@@ -5,3 +5,4 @@
 $lang['needns']            = "Please provide an existing namespace.";
 $lang['empty']             = "You don't have pages selected yet.";
 $lang['tocheader']         = "Table of Contents";
+$lang['export_ns']         = 'Export namespace "%s:" to file %s.pdf';

syntax/exportlink.php

@@ -0,0 +1,81 @@
+<?php
+/**
+ * DokuWiki Plugin dw2pdf (Syntax Component)
+ *
+ * For marking changes in page orientation.
+ *
+ * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
+ * @author     Sam Wilson <sam@samwilson.id.au>
+ */
+/* Must be run within Dokuwiki */
+if(!defined('DOKU_INC')) die();
+
+/**
+ * Syntax for page specific directions for mpdf library
+ */
+class syntax_plugin_dw2pdf_exportlink extends DokuWiki_Syntax_Plugin {
+
+    /**
+     * Syntax Type
+     *
+     * Needs to return one of the mode types defined in $PARSER_MODES in parser.php
+     *
+     * @return string
+     */
+    public function getType() {
+        return 'substition';
+    }
+
+    /**
+     * Sort for applying this mode
+     *
+     * @return int
+     */
+    public function getSort() {
+        return 41;
+    }
+
+    /**
+     * @param string $mode
+     */
+    public function connectTo($mode) {
+        $this->Lexer->addSpecialPattern('~~PDFNS>(?:.*?)\|(?:.*?)~~', $mode, 'plugin_dw2pdf_exportlink');
+    }
+
+    /**
+     * Handler to prepare matched data for the rendering process
+     *
+     * @param   string       $match   The text matched by the patterns
+     * @param   int          $state   The lexer state for the match
+     * @param   int          $pos     The character position of the matched text
+     * @param   Doku_Handler $handler The Doku_Handler object
+     * @return  bool|array Return an array with all data you want to use in render, false don't add an instruction
+     */
+    public function handle($match, $state, $pos, Doku_Handler $handler) {
+        global $ID;
+        $ns = substr($match,8,strpos($match,'|')-8);
+        $id = $ns . ':start';
+        resolve_pageid(getNS($ID),$id,$exists);
+        $ns = getNS($id);
+        $title = substr($match,strpos($match,'|')+1,-2);
+        $link = '?do=export_pdfns&pdfns_ns=' . $ns . '&pdfns_title=' . $title;
+        return array('link' => $link, 'title' => sprintf($this->getLang('export_ns'),$ns,$title),$state, $pos);
+    }
+
+    /**
+     * Handles the actual output creation.
+     *
+     * @param string        $mode     output format being rendered
+     * @param Doku_Renderer $renderer the current renderer object
+     * @param array         $data     data created by handler()
+     * @return  boolean                 rendered correctly? (however, returned value is not used at the moment)
+     */
+    public function render($mode, Doku_Renderer $renderer, $data) {
+        if($mode == 'xhtml') {
+            $renderer->internallink($data['link'],$data['title']);
+            return true;
+        }
+        return false;
+    }
+
+}