diff --git a/odmf/static/media/help/odmf-markdown.md b/odmf/static/media/help/odmf-markdown.md index 89b94897..000203b9 100644 --- a/odmf/static/media/help/odmf-markdown.md +++ b/odmf/static/media/help/odmf-markdown.md @@ -5,13 +5,28 @@ Markdown - a simple way to format web content In some places, eg. comments [Markdown][1] syntax can be used to enhance the appearance of the text. **But you don't need to care!** +The official [Markdown description][2] contains a lot of possibilities, +here only the most important and the ODMF-extensions to markdown are explained + This help page is written using Markdown +Making captions +---------------- + +Lines can be turned into captions of different levels (translated to `` tags), by starting with `#`: + +# `# bla` --> `

bla

` +## `## bla2` --> `

bla2

` +### `### bla2` --> `

bla3

` + Creating links -------------------- +The special links to ODMF-objects, like files, datasets, users etc. work of course only in ODMF not in other tools +using Markdown. + * `file:/template/` links to a file or folder on the server. Use this to link to manuals, thesis etc. ==> file:template * `ds:370` links to a dataset ==> ds:370 * `site:18` links to a site ==> site:18 @@ -32,8 +47,7 @@ Formatting * You can *emphasize* or **strong emphazise** text in this way: `*emphasize*` or `**strong emphazise**` * You can insert a line break by doing two line breaks in your text * You can insert a horizontal line by `------` on a single line - * You can use arrows like this `--> ==> <-- <==` to get this --> ==> <-- <== - * You can insert warnings, errors and boxes. See below. + * You can use arrows like this `--> ==> <-- <==` to get this --> ==> <-- <== (ODMF only) * You can do some more stuff with Markdown, have a look [here][1] and [here][2] or at the