*italic*
**bold**
***bold and italic***
~~~
IF xTrue THEN
// Especially useful for code ;)
END_IF
~~~
* Item 1
* Item 1.1
* Item 1.2
* Item 2
* [ ] Unchecked item
* [x] Checked item
* [ ] Subitem
# Header 1
## Sub-Header
### Sub-Sub-Header
# Header 2
Here comes a horizontal rule:
---
This text comes after the rule.
A very common design technique which works pretty well for mobile and desktop views, is the separation of regions by a different background and / or foreground color. This is supported by the macro 'section'. Supported are hex color code and color names. Additionally to the color, you can also change the default text-alignment within this region.
[[section bgcolor=#FF0000 color=#00FF00]]
[[section bgcolor=red color=green]]
[[section align=left]]
[[section align=center]]
[[section align=right]]
Especially in combination with those sections, it makes sense to change the layout a bit and stretch it over the whole width. This can be achieved with the "startpage" macro:
[[startpage]]
To show multiple images in a slideshow, you can simply use this macro. You can define an image URL, captions and durations to control the display a bit. Then all image slides on your wiki will be faded in and out. This also means, that you can have only one slideshow per page.
[[slide src=image.png time=3 number="1/3" caption="image caption" width=100%]]
A full example:
[[slide src=https://www.w3schools.com/howto/img_nature_wide.jpg time=3 number="1/3" caption="nature"]][[slide src=https://www.w3schools.com/howto/img_snow_wide.jpg time=5 number="2/3" caption="snow"]][[slide src=https://www.w3schools.com/howto/img_mountains_wide.jpg time=10 number="3/3" caption="mountains"]]
Note: avoid newlines between the slides, as those will be shown in markdown.
Most links are detected within the text:
https://www.google.com
you@somewhere.com
To be explicit, just add brackets around it:
<https://www.google.com>
<you@somewhere.com>
To define your own link text:
Click [here](https://www.google.com)
Relative links to headings on the same page can be realized with named links and a hash:
Jump to the [prerequisites](#prerequisite-packages)
...
# Prerequisite Packages
...
The name of the heading anchor is the name of the heading in lower case and with dashes instead of spaces.
The macro 'url' only creates the URL, not a full link. This way you can more easily extend the URL.
[[url target=profile]] # Outputs the URL as text
[link to profile]([[url target=profile]]) # Create a link to the user profile of the current user
[create new blog post]([[url target=blog]]/new) # Create a link to create a new blog post
You can link other tools, pages, tickets, ...
[MyWikiPage] # Wiki - name of wiki page
[#123] # Tracker - ticket number
[bugs:#1] # Tracker - explicit tool selection
[r10721] # SVN - revision number
[3b9d48] # Git & Mercurial - first 6 characters of revision hash
[2012/02/my-post] # Blog - post slug, including YYYY/MM/ prefix
[a6d38f98] # Discussion Thread - thread id
[a6d38f98#42f8] # Discussion Post - thread_id#post_id
[projectname:wiki:Home]
[projectname:code:3b9d48]
@Username
[[img src=attached-image.jpg]]
[[img src=attached-image.jpg width=50%]]
Standard icons are the ones which are also used on the CODESYS Forge Website. They can have a different foreground and background color. And they can also have a circle or rectangle shape. You define them like this:
[[icon name=fa-gavel]]
[[icon name=fa-gavel shape=circle size=20 outersize=60 color=white bgcolor=blue]]
By default, the icons have a background, to avoid it just set the size and outersize to the same value and bgcolor to "inherit":
[[icon name=fa-gavel shape=rectangle size=30 outersize=30 color=black bgcolor=inherit]]
[[embed url=https://www.youtube.com/watch?v=UvH572rz1Ng]]
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell
You can easily include other wiki pages:
[[include ref=SamplePage]]
Also, you can embed a file directly from a repository! Just skip the ref parameter and pass repository, path and optional revision:
[[include repo=code path=README.md]]
[[include repo=myproject:code path=/ew/forms.py rev=fa61e7]]
[[include repo=prj:myproject:code path=/ew/forms.py]]
[[download url=https://forge.codesys.com/...]]
[[download url=https://forge.codesys.com/... label=installer]]
The layout of the download button can be influenced with the following attributes:
Example:
[[download url=https://forge.codesys.com/... label=installer float=none align=center]]
[[drone]]
[[drone repo=code]]
[[neighborhood_feeds tool_name=wiki max_number=10 sort=pubdate]]
[[neighborhood_blog_posts max_number=10 sort=timestamp]]
[[project_blog_posts max_number=10 sort=timestamp mount_point=news]]
[[members]]
[[project_screenshots]]