Added support for inserting a table of contents in the exported ODT file.

Use the syntax tag '{{odt>toc:setting=value}}' or only {{odt>toc}} for using default settings.
See the function header of insert_TOC() for a detailed description of the possible settings.

The page numbers are just a counter. The TOC needs to be updated e.g. in LibreOffice to get
the real page numbers!

Author: lpaulsen93

ChangeLog.txt

@@ -1,3 +1,7 @@
+2015-07-08 LarsDW223
+
+    * Added syntax tag for including a TOC in the exported ODT file.
+
 2015-07-04 LarsDW223
 
     * Added/merged support for exporting books to ODT (interface to bookcreator plugin).

helper/stylefactory.php

@@ -273,6 +273,10 @@ public static function createParagraphStyle(&$style, $properties, $disabled_prop
               'style-display-name' => array ('section' => 'header',    'name' => 'style:display-name',      'is_attr' => false),
               'style-parent'       => array ('section' => 'header',    'name' => 'style:parent-style-name', 'is_attr' => true),
               'style-class'        => array ('section' => 'header',    'name' => 'style:class',             'is_attr' => true),
+              'style-position'     => array ('section' => 'tab-stop',  'name' => 'style:position',          'is_attr' => true),
+              'style-type'         => array ('section' => 'tab-stop',  'name' => 'style:type',              'is_attr' => true),
+              'style-leader-style' => array ('section' => 'tab-stop',  'name' => 'style:leader-style',      'is_attr' => true),
+              'style-leader-text'  => array ('section' => 'tab-stop',  'name' => 'style:leader-text',       'is_attr' => true),
               'text-align'         => array ('section' => 'paragraph', 'name' => 'fo:text-align',           'is_attr' => true),
               'text-indent'        => array ('section' => 'paragraph', 'name' => 'fo:text-indent',          'is_attr' => true),
               'margin-top'         => array ('section' => 'paragraph', 'name' => 'fo:margin-top',           'is_attr' => true),
@@ -356,6 +360,7 @@ public static function createParagraphStyle(&$style, $properties, $disabled_prop
         $header = '';
         $text = '';
         $paragraph = '';
+        $tab = '';
         foreach ($properties as $property => $value) {
             if ( empty ($disabled_props [$property]) && !empty ($properties [$property]) ) {
                 switch ($params [$property]['section']) {
@@ -388,6 +393,11 @@ public static function createParagraphStyle(&$style, $properties, $disabled_prop
                             $paragraph .= ' style:auto-text-indent="false" ';
                         }
                         break;
+
+                    case 'tab-stop':
+                        $tab .= $params [$property]['name'].'="'.$value.'" ';
+                        $tab .= self::writeExtensionNames ($params [$property]['name'], $value);
+                        break;
                 }
             }
         }
@@ -405,8 +415,14 @@ public static function createParagraphStyle(&$style, $properties, $disabled_prop
         // Build style.
         $style  = '<style:style '.$header.' style:family="paragraph"';
         $style .= '>';
-        $style .= '<style:paragraph-properties '.$paragraph.'/>';
-        $style .= '<style:text-properties '.$text.'/>';
+        $style .= '<style:paragraph-properties '.$paragraph.'>';
+        if ( !empty($tab) ) {
+            $style .= '<style:tab-stops><style:tab-stop '.$tab.'/></style:tab-stops>';
+        }
+        $style .= '</style:paragraph-properties>';
+        if ( !empty($text) ) {
+            $style .= '<style:text-properties '.$text.'/>';
+        }
         $style .= '</style:style>';
 
         return $style_name;

lang/de-informal/lang.php

@@ -10,3 +10,5 @@
 $lang['view']                  = 'Die Seite im Open Document Format exportieren';
 $lang['export_odt_button']     = 'ODT exportieren';
 $lang['tpl_not_found']         = 'WARNUNG: Die ODT Vorlage "%s" konnte im Vorlagenverzeichnis "%s" nicht gefunden werden. Es wird die Standardvorlage verwendet.';
+$lang['toc_title']             = 'Inhaltsverzeichnis';
+

lang/de/lang.php

@@ -10,3 +10,4 @@
 $lang['view']                  = 'Ins Open-Document-Format exportieren';
 $lang['export_odt_button']     = 'ODT exportieren';
 $lang['tpl_not_found']         = 'WARNUNG: Die ODT Vorlage "%s" konnte im Vorlagenverzeichnis "%s" nicht gefunden werden. Es wird die Standardvorlage verwendet.';
+$lang['toc_title']             = 'Inhaltsverzeichnis';

lang/en/lang.php

@@ -11,3 +11,5 @@
 // template not found in the directory
 $lang['tpl_not_found'] = 'WARNING : the ODT template "%s" was not found in the templates directory "%s". Using the default template.';
 
+// default TOC title
+$lang['toc_title'] = 'Table of Contents';

plugin.info.txt

@@ -1,7 +1,7 @@
 base    odt
 author 	Andreas Gohr, Aurelien Bompard, Florian Lamml, LarsDW223
 email  	andi@splitbrain.org, aurelien@bompard.org, infor@florian-lamml.de
-date   	2015-07-04
+date   	2015-07-08
 name   	Open Document Plugin
 desc   	Export the current Wiki page to a OpenOffice ODT file
 url    	http://www.dokuwiki.org/plugin:odt

renderer/book.php

@@ -59,6 +59,9 @@ public function finalize_ODTfile() {
 
         $this->meta->setTitle($this->title);
 
+        // Insert TOC (if required)
+        $this->insert_TOC();
+
         parent::finalize_ODTfile();
     }