This document contains frequently asked questions about the content on this website and the software used to manage it.
Website Software
Questions related to the software used to run this website are answered here.
What software do you use to host the website?
We are using Confluence from Atlassian. We are very grateful to Atlassian for their support of Open Source and the Open Source licenses Atlassian offers to us.
We also make extensive use of Confluence extensions from Adaptavist. In particular, the Theme Builder plugins from Adaptavist allow us to design the Confluence themes to create a look and feel for the entire website.
Content Creation
General questions about how to create content on this website are answered in this section.
Should I use rich text editor or wiki markup to create content?
The choice is up to you. If you make infrequent updates and small updates then rich text editor may be your best option as you don't need to learn the wiki markup. However, for any serious content creation you will most likely want to use the wiki markup as it is much more powerful in terms of how you can style and layout your document. It is worth the effort to learn the wiki notation in that case.
How do I create links?
Linking within OpenRemote website
Easiest way to get started is to use either the "Insert/Edit Link" button in the toolbar if you're in "Rich Text" mode, or "Insert Link" button if you're in "Wiki Markup" mode. The button will provide you with an user interface that helps you locate the document you want to link to.
Important thing to understand with linking is that the website is divided into what is called "spaces". Basically the elements you see in the navigation menu on the OpenRemote frontpage are all distinct spaces. So in order to link effectively, you need to have an "alias" (the name that is used in your document to represent the link), the name of the "space" you want to link to and finally the name of the document.
When you click on the "Insert Link" button, the popup page asks you for the above-mentioned information. You can then search for the page you want to link to by choosing a space name and keywords for your search. You can search "All Spaces" which means all of the website, or if you know which "space" (area) the document you are looking for is, simply select the correct space from the list.
If you want to see all the documents in the space you've chosen, just enter '*' as the search term.
Once you find the page you were looking for, click on it to select it. You can now type in the alias for it which will appear as text in your document. Optionally you can also add a tooltip which will be shown when a user hovers the mouse pointer over the link you've created.
Linking to external websites
TODO
Wiki Markup
Questions related to the use of wiki markup are answered here. Read the following for quick introduction how to edit and style your documents on this website.
How do I create links?
There are many different ways to link, and here we just cover the basics. For full treatise, please refer to the [Confluence Documentation|]
TODO
How do I add "info" section into my page?
When editing content, switch to /Wiki Markup/ tab. There, you can add {info} tag around content you want rendered as info block:
{info}
Pay attention to this information!
{info}
The above results in:
 | Pay attention to this information! |
How do I create a "notice" section in my page?
When editing content, switch to /Wiki Markup/ tab. There, you can add {note} tag around content you want rendered as notice block:
{note}
Notice! You should read this!
{note}
The above results in:
 | Notice! You should read this! |
How do I escape special characters such as '{' in my page?
Use backslash to escape, e.g. \ { produces the '{' sign.
Page attachments
Questions related attaching additional media to a wiki page
When I add a PNG image as thumbnail an ugly black box is shown around it!
This appears to be a Confluence bug. The original PNG image transparency is preserved fine but not honored with the generated thumbnail image.
At the moment the solution is to avoid using transparent PNG images for thumbnails. Displaying them in original size works fine.
