Added config option 'index_in_browser':

- 'hide': like today, table of contents and chapter index will not be visible in the browser view - 'display placeholder': a placeholder will be display showing the user in the browser that a table of contents or chapter index will be inserted after export. It also reminds the user to update the index after export.
lpaulsen93 · Feb 9, 2016 · 143ab25 · 143ab25
1 parent 5db3fdf
commit 143ab25
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 12 deletions.
diff --git a/conf/default.php b/conf/default.php
@@ -32,8 +32,9 @@
 $conf['disable_links'] = 'No';
 
 // TOC settings
-$conf['toc_maxlevel']    = '';
-$conf['toc_leader_sign'] = '.';
-$conf['toc_indents']     = '0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5';
-$conf['toc_pagebreak']   = 'Yes';
-$conf['toc_style']       = 'color:black;';
+$conf['toc_maxlevel']     = '';
+$conf['toc_leader_sign']  = '.';
+$conf['toc_indents']      = '0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5';
+$conf['toc_pagebreak']    = 'Yes';
+$conf['toc_style']        = 'color:black;';
+$conf['index_in_browser'] = 'hide';
diff --git a/conf/metadata.php b/conf/metadata.php
@@ -34,8 +34,9 @@
 
 $meta['disable_links'] = array('multichoice', '_choices' => array('No', 'Yes'));
 
-$meta['toc_maxlevel']    = array('numeric');
-$meta['toc_leader_sign'] = array('string');
-$meta['toc_indents']     = array('string');
-$meta['toc_pagebreak']   = array('multichoice', '_choices' => array('Yes', 'No'));
-$meta['toc_style']       = array('string');
+$meta['toc_maxlevel']     = array('numeric');
+$meta['toc_leader_sign']  = array('string');
+$meta['toc_indents']      = array('string');
+$meta['toc_pagebreak']    = array('multichoice', '_choices' => array('Yes', 'No'));
+$meta['toc_style']        = array('string');
+$meta['index_in_browser'] = array('multichoice', '_choices' => array('hide', 'display placeholder'));
diff --git a/helper/config.php b/helper/config.php
@@ -352,6 +352,15 @@ public function __construct() {
                   'hasMeta'            => true,
                   'addMetaAtStartOnly' => false,
                   'refresh'            => false);
+        // Index display in browser
+        $this->config ['index_in_browser'] =
+            array('value'              => NULL,
+                  'DWGlobalName'       => NULL,
+                  'hasGlobal'          => true,
+                  'hasURL'             => true,
+                  'hasMeta'            => true,
+                  'addMetaAtStartOnly' => false,
+                  'refresh'            => false);
     }
 
     /**

diff --git a/lang/de-informal/lang.php b/lang/de-informal/lang.php
@@ -11,4 +11,12 @@
 $lang['export_odt_button']     = 'ODT exportieren';
 $lang['tpl_not_found']         = 'FEHLER: Die ODT Vorlage "%s" konnte im Vorlagenverzeichnis "%s" nicht gefunden werden. Der Export wurde abgebrochen.';
 $lang['toc_title']             = 'Inhaltsverzeichnis';
+$lang['chapter_title']         = 'Kapitelinhalt';
+$lang['toc_msg']               = 'Ein Inhaltsverzeichnis wird an dieser Stelle eingefügt.';
+$lang['chapter_msg']           = 'Ein Kapitelverzeichnis wird an dieser Stelle eingefügt.';
+$lang['update_toc_msg']        = 'Bitte vergessen Sie nicht, das Inhaltsverzeichnis nach dem Export zu aktualisieren.';
+$lang['update_chapter_msg']    = 'Bitte vergessen Sie nicht, das Kapitelverzeichnis nach dem Export zu aktualisieren.';
+$lang['needtitle']             = 'Bitte Titel angeben!';
+$lang['needns']                = 'Bitte geben Sie einen vorhandenen Namensraum an.';
+$lang['empty']                 = 'Sie haben noch keine Seiten gewählt.';
 
diff --git a/lang/de/lang.php b/lang/de/lang.php
@@ -11,6 +11,11 @@
 $lang['export_odt_button']     = 'ODT exportieren';
 $lang['tpl_not_found']         = 'FEHLER: Die ODT Vorlage "%s" konnte im Vorlagenverzeichnis "%s" nicht gefunden werden. Der Export wurde abgebrochen.';
 $lang['toc_title']             = 'Inhaltsverzeichnis';
+$lang['chapter_title']         = 'Kapitelinhalt';
+$lang['toc_msg']               = 'Ein Inhaltsverzeichnis wird an dieser Stelle eingefügt.';
+$lang['chapter_msg']           = 'Ein Kapitelverzeichnis wird an dieser Stelle eingefügt.';
+$lang['update_toc_msg']        = 'Bitte vergessen Sie nicht, das Inhaltsverzeichnis nach dem Export zu aktualisieren.';
+$lang['update_chapter_msg']    = 'Bitte vergessen Sie nicht, das Kapitelverzeichnis nach dem Export zu aktualisieren.';
 $lang['needtitle']             = 'Bitte Titel angeben!';
 $lang['needns']                = 'Bitte geben Sie einen vorhandenen Namensraum an.';
 $lang['empty']                 = 'Sie haben noch keine Seiten gewählt.';
diff --git a/lang/en/lang.php b/lang/en/lang.php
@@ -11,8 +11,13 @@
 // template not found in the directory
 $lang['tpl_not_found'] = 'ERROR : the ODT template "%s" was not found in the templates directory "%s". The export has been aborted.';
 
-// default TOC title
-$lang['toc_title'] = 'Table of Contents';
+// default TOC and chapter index title
+$lang['toc_title']          = 'Table of Contents';
+$lang['chapter_title']      = 'Chapter Index';
+$lang['toc_msg']            = 'A Table of Contents will be inserted here.';
+$lang['chapter_msg']        = 'A Chapter Index will be inserted here.';
+$lang['update_toc_msg']     = 'Please remember to update the Table Of Contents after export.';
+$lang['update_chapter_msg'] = 'Please remember to update the Chapter Index after export.';
 
 $lang['needtitle']         = "Please provide a title.";
 $lang['needns']            = "Please provide an existing namespace.";

diff --git a/style.css b/style.css
@@ -27,3 +27,17 @@
     background-position: left -45px;
 }
 
+/* Style for Table of contents and chapter index preview */
+p.index_preview_odt {
+    border: 2pt dashed gray;
+    background-color: whitesmoke;
+    padding: 10pt;
+}
+
+#text.index_preview_odt {
+    color: black;
+}
+
+#reminder.index_preview_odt {
+    color: red;
+}
diff --git a/syntax.php b/syntax.php
@@ -128,12 +128,16 @@ public function render($format, Doku_Renderer $renderer, $data) {
                     } elseif($format == 'metadata') {
                         /** @var Doku_Renderer_metadata $renderer */
                         $renderer->meta['relation']['odt']['toc'] = $info_value;
+                    } elseif($format == 'xhtml') {
+                        $this->insert_index_preview ($renderer, 'toc');
                     }
                 break;
                 case 'chapter-index': // Insert chapter index in exported ODT file
                     if($format == 'odt') {
                         /** @var renderer_plugin_odt_page $renderer */
                         $renderer->render_index('chapter', $info_value);
+                    } elseif($format == 'xhtml') {
+                        $this->insert_index_preview ($renderer, 'chapter');
                     }
                 break;
                 case 'disablelinks': // Disable creating links and only show the text instead
@@ -207,4 +211,29 @@ public function render($format, Doku_Renderer $renderer, $data) {
         return false;
     }
 
+    /**
+     * Insert a browser preview for an index.
+     *
+     * @param  Doku_Renderer $renderer The current renderer
+     * @param  string        $type     The index type ('toc' or 'chapter)'
+     */
+    function insert_index_preview ($renderer, $type='toc') {
+        if ($this->config->getParam ('index_in_browser') == 'hide') {
+            return;
+        }
+        switch ($type) {
+            case 'toc':
+                $msg = $this->getLang('toc_msg');
+                $reminder = $this->getLang('update_toc_msg');
+            break;
+            case 'chapter':
+                $msg = $this->getLang('chapter_msg');
+                $reminder = $this->getLang('update_chapter_msg');
+            break;
+        }
+        $renderer->doc .= '<p class="index_preview_odt">';
+        $renderer->doc .= '<span id="text" class="index_preview_odt">'.$msg.'</span><br>';
+        $renderer->doc .= '<span id="reminder" class="index_preview_odt">'.$reminder.'</span>';
+        $renderer->doc .= '</p>';
+    }
 }