DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:odt:odt-demo-page

This is an old revision of the document!


ODT Demo Page

This page demonstrates the features and capabilities of the ODT plugin and demonstrates which plugins support ODT export. To test it, proceed like this:

  • copy the page content to your wiki
  • install the ODT plugin
  • install all other plugins which you like to test for ODT support
  • export this page to ODT

Exporting this page is also a easy way to check the influence of ODT or CSS templates on the generated output. You might also like to compare the differences caused by setting the config option css_usage to off (plugins only) or basic style import.

:!: FIXME :!:
This demo page is work in progress. So a lot of examples are still missing. At the end, all plugins listed under ODT render support should have at least a little example here on the ODT demo page.

Help is always welcome. Do not be afraid to extend this page. I can easily change the page content if something is wrong or if something got broken or deleted accidentally — LarsDW223
:!: FIXME :!:

First, let's create a table of content using the following code:

{{odt>toc:title=Content;leader_sign=.;indents=0,0.5,1;pagebreak=true;styleL1="font-weight:bold;";styleL2="fontstyle:italic;";styleL3="font-style:normal;";}}

:!: The table of contents needs to be updated after export to ODT to show correct page numbers :!:

toc:title=Content;leader_sign=.;indents=0,0.5,1;pagebreak=true;styleL1="font-weight:bold";styleL2="fontstyle:italic;";styleL3="font-style:normal;";

DokuWiki Basic syntax

Basic Text Formatting

DokuWiki supports bold, italic, underlined and monospaced texts. Of course you can combine all these.

DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
Of course you can **__//''combine''//__** all these.

You can use subscript and superscript, too.

You can use <sub>subscript</sub> and <sup>superscript</sup>, too.

You can mark something as deleted as well.

You can mark something as <del>deleted</del> as well.

An external link looks like this after export to ODT: This Link points to google. The ODT plugin treats an internal link like an external one: This Link points to the start page. This only changes if the link points “inside” the exported ODT document: This Link points to the start of this document. This example only works if the page name of this page is odt-demo-page.

DokuWiki supports Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: Wiki. Interwiki links look like external links after export to ODT.

The ODT plugin renders Windows share links as plain text: Example link.

Headings

Some heading examples:

Level 1 Headline

Level 2 Headline

Level 3 Headline

Level 4 Headline

Level 5 Headline

If you would like headings to be numbered after export to ODT, then set the config option outline_list_style to Numbers. Hint: Do not worry if the heading numbers are missing in the table of contents, they will appear after updating it.

Images

Images are included in the exported ODT document. Let's see some examples:

An image link:

Resized to given width and height:

An left aligned image:

…and a centered one…

…and also one right aligned:

Lists

Of course, lists are exported to ODT as well. See the example from the DokuWiki.org Syntax page:

  • This is a list
  • The second item
    • You may have different levels
  • Another item
  1. The same list but ordered
  2. Another item
    1. Just use indention for deeper levels
  3. That's it

Text to Image Conversions

Images generated from Text to Image Conversions will also be included in the exported ODT Document. Again, see the example from the DokuWiki.org Syntax page:

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • DELETEME DELETEME

Quoting

Quoting is implemented by using tables, see the example from DokuWiki.org:

I think we should do it

No we shouldn't
Well, I say we should
Really?
Yes!
Then lets do it!

Tables

And yet another example taken from DokuWiki.org:

Heading 1 Heading 2 Heading 3
Row 1 Col 1 Row 1 Col 2 Row 1 Col 3
Row 2 Col 1 some colspan (note the double pipe)
Row 3 Col 1 Row 3 Col 2 Row 3 Col 3
Heading 1 Heading 2
Heading 3 Row 1 Col 2 Row 1 Col 3
Heading 4 no colspan this time
Heading 5 Row 2 Col 2 Row 2 Col 3

Tables look quite boring after export to ODT. There is no difference between a table header cell and a normal cell. This can be changed by using a ODT or CSS template or by setting the config option css_usage to basic style import.

Syntax Highlighting

As DokuWiki itself, the ODT plugin uses Geshi for syntax highlighting:

/**
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

Please note that links generated by Geshi will also be inserted as links into the exported ODT document.
Downloadable code blocks tagged with file just look like normal code blocks after the export:

myexample.php
<?php echo "hello world!"; ?>

Because the ODT plugin runs on the DokuWiki server, it is not possible to implement ODT support in JavaScript based Syntax highlighter plugins.

RSS/ATOM Feed Aggregation

Footnotes

Footnotes can also be exported to ODT, some examples first:

You can add footnotes 1) by using double parentheses. And another 2) footnote. And again the first one 3).

Please notice that footnotes in the ODT document are slightly different than in the browser:

  • footnotes are always displayed at the bottom of the current ODT page, not at the bottom of the end of the exported DokuWiki page
  • footnotes with the same text receive the same number (see the example above and compare it with the browser view)

Emphasis plugin

:!: This example requires the emphasis plugin to be installed :!:

Some examples for changing the font color with the emphasis plugin: ::This should be green:: :::and yellow::: ::::and red:::: (if the default color set is used). And now the same for the background colors: ;;This should be green;; ;;;and yellow;;; ;;;;and red;;;;.

Filelist plugin

:!: This example requires the filelist plugin to be installed :!:

The output generated by the filelist plugin is exported to ODT: lib/images/*&style=table&direct=1&preview=1&link=0

Keyboard plugin

:!: This example requires the keyboard plugin to be installed :!:

Key sequences generated with the keyboard plugin are exported to ODT, see the example from the plugin page:

This displays the keys <key>ALT</key> + <key>H</key>.

Pagebreak plugin

:!: This example requires the pagebreak plugin to be installed :!:

A manual pagebreak can be inserted with the following code:

<pagebreak>

Let's test it…<pagebreak>…this text should be on a new page. If the pagebreak is included or not will make no difference in the browser view.

Switchpanel plugin

:!: This example requires the switchpanel plugin to be installed :!:

SVG images can be easily included in the exported ODT document as the example from the switchpanel plugin page shows: <switchpanel> ==line:number=12 1,PC1a 2,PC2 3,PC3 6,?? ==line 1,AB 10:case=none 11,int.:color=red 12,sas:case=close </switchpanel>

1) , 3)
This is a footnote
2)
This is a different footnote
plugin/odt/odt-demo-page.1486826392.txt.gz · Last modified: 2017-02-11 16:19 by LarsDW223