-
Notifications
You must be signed in to change notification settings - Fork 0
Styleconventions
This article explains how to integrate (external) plugins and dokukit-functions to imitate the KIT corporate design in the best way.
The convention is to start a page with a headsection (if necessary)
====== Headline ======
Combined with the ''useheading'' option and the dynamic sidebar this heading will be shown as pagename in the navigation and searchbar. In this place you can of course use special characters, capitals, spaces etc...
To get a table that looks like the official KIT way, the first row has to be a single cell with title attribute (title text within two ^
).
Minimal example:
^ Table with alignment ^^^
|**left head** | **center head** |**left head** |
| left | center | left |
| left | center | left |
which should result into something like
A more advanced usage of tables including the hidden plugin and the sortable plugin could be this:
<hidden 2015>
<sortable>
|**Titel** |**Autor** |**URL** |
|**Higgs Physics ** |M. Krämer (TP), M. Mühlleitner (TP) \\ KA-TP-01-2015, SFB/CPP-14-115, SLAC-PUB-16201, TTK-15-05 |[[http://de.arxiv.org/abs/arXiv:1501.06658|http://de.arxiv.org/abs/arXiv:1501.06658]] |
|**Higher-order QCD corrections to supersymmetric particle production and decay at the LHC ** |M. Krämer (TP), M. Mühlleitner (TP) \\ KA-TP-02-2015, SFB/CPP-14-114, SLAC-PUB-16200, TTK-15-04 |[[http://de.arxiv.org/abs/arXiv:1501.06655|http://de.arxiv.org/abs/arXiv:1501.06655]] |
</sortable>
</hidden>
By clicking the caption one can hide/show the table. It is sort-able by every column.
If html is enabled, you can format your Pages with every possible HTML code. If you do so, don't use the WYSIWYG editor because it does not interpret the html (even worse, it will autolink urls and stuff that may already within a href in your html).
It is recommended to not overuse selfmade html code. Try to adopt the KIT style as good as possible, wich is perfectyl done by using the implemented dokuwiki functions.
To our knowledge dokuwiki don't provides a good calendar plugin. To reach a great majority a good choice is a ics based external calendar (like google or nextcloud), because nearly everyone has such a calendar backend and therefore can sync its own one.
To embed the calendar (or other external applications) evil inlineframes can be used, therefore HTML has to be allowed in the admin panel. Get the right calendar config (it has at least to be public) and the embed code like described in this article.
Afterwards you have to put the code into <HTML></HTML>
tags, that dokuwiki knows to interpret it as html:
<HTML>
<iframe src="https://www.google.com/calendar/embed?src=youremail@gmail.com&ctz=Europe/Berlin"
style="border: 0" width="760" height="600" frameborder="0" scrolling="no">
</iframe>
</HTML>
Adjust the width and height parameter to your satisfaction (width=760px fits the standard width of the template).
Sometimes you may want text besides a picture. Therefore you could either use dokuwiki tables with the tablewidth-plugin (which can look ugly because of their alternating color) or use <div>
s within a html area. A simple example could be:
<HTML>
<div>
<div style="position:relative;float:left;">
</HTML>
{{ :namespace:image.jpg?200|}}
<HTML>
</div>
<div style="position:relative;float:left;text-align:left;">
</HTML>
====== Pagetitle ======
some text \\
besides the image \\
<HTML>
</div>
</div>
</HTML>
Another possibility is to use the column-plugin.
General information can be found here.
Sometimes, in specific namespaces, you won't start with a blank page e.g. creating pages for employees. They all should look the same, so templates are be very useful.
You will need write access on the server to implement page templates. If you don't, just create a simple page with the content and ask someone who has.
Templates for the current namespace have to be named ''_template.txt'' and lie in the root of the namespace. If they are called ''__template.txt'' (note the double underscore) they will be inherited in subnamespaces.
Since dokuwiki converts the leading single underscore, the template file is not editable/reachable from the web interface. To avoid that, create a symlink ''template.txt -> _template.txt'', then the template can simply edited via the page ''template''. Note that all the newly created files need to have the apaches group/owner id.