Table of Contents
Polymake jupyter tutorials that should end up on the website
Jupyter notebooks support github flavored markdown gfm which will be further treated by pandocfilters and pandoc during the conversion to dokuwiki. Here are some useful links:
In order to make everything work in both jupyter and dokuwiki (and without reediting much after conversion), there are a few general things to take note of :
- Use only lower case letters, digits, hyphens and underscores for your notebook name.
[a-z0-9_-] - Do not put code (with backticks) inside of link or image captions
Others require their own section:
Markdown
Embedding images
Filenames of images should be lower case aswell and they should be base64 attached. Dragging and dropping them into the notebook creates a syntax like . 
This syntax, however, does not support image formatting inside of the notebook or the dokuwiki page it will end up on. Thus, if you need more control use img tags and their style attribute. Some examples:
An inline image: <img src=attachment:logo.png width=15 alt="tooltip" style="display: inline"> 
As a block: <img src=attachment:logo.png alt="tooltip"><img>
To display the image as a centered block in dokuwiki, like it is the default in jupyter, you may add something like style="display: block, margin-left: auto, margin-right: auto" or use the css class="center-block"
Attached images will be extracted and the conversion process handles the replacement of “attachment:” with a proper link to the image in dokuwiki.
Links
To other ipynbs:
[Tutorial on Polytopes](apps_polytope.ipynb): Tutorial on polytopes
Internal section links:
[Markdown testing](#Markdown-testing): Markdown testing
Due to differing seperation characters - in jupyter and _ in polymake dokuwiki, it is not possible to link to section headings with hyphens directly, yet simply adding a dokuwiki friendly hyperlink <a id="a_non_hyphen_free_heading"></a> is a workaround:
[A non hyphen-free heading](#a_non_hyphen_free_heading): A non hyphen-free heading
Links to sections in other ipynbs:
[Convex Hulls in the tutorial on polytopes](apps_polytope.ipynb#Convex-Hulls) Convex Hulls in the tutorial on polytopes
To something in the documentation:
[linearprogram properties](https://polymake.org/doku.php/documentation/latest/polytope/linearprogram#properties) linearprogram properties
To a downloadable file:
[filtrationexample]https://polymake.org/lib/exe/fetch.php/tutorial/filtrationexample.top filtrationexample
A non hyphen-free heading
Code
Svg and threejs output created in notebooks will also end up on the dokuwiki website. Thus, for working with notebooks that already contain svg output, it is recommended to have the perl SVG module installed and svg configured
reconfigure("common::svg.rules");
If svg is configured, it will be the prefered output for lattices in jupyter polymake.
> svg(cube(3)->HASSE_DIAGRAM->VISUAL); > cube(3)->HASSE_DIAGRAM->VISUAL;
> # two threejs outputs > cube(3)->VISUAL; > simplex(3)->VISUAL;
Markdown
For testing and comparing.
sub sup del and s
subscript supscript deleted deleted
These tags are explicitly processed while conversion.
Emphasis
This text will be italic This will also be italic
This text will be bold This will also be bold
You can combine them
Lists
Unordered
- Item 1
- Item 2
- Item 2a
- Item 2b
Ordered
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b
Task Lists
- [x] @mentions, #refs, links, formatting, and
tagssupported - [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
Tables
You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:
| First Header | Second Header |
|---|---|
| Content from cell 1 | Content from cell 2 |
| Content in the first column | Content in the second column |
Strikethrough
Any word wrapped with two tildes (like this) will appear crossed out.