Features des AP-Wikis

[Kai-Martin Knaak]Den relevanten Inhalt von "apwiki_features.txt" in den "advanced_editor_hints.txt" einbauen.

Versteckte Inhalte

Um die Lesbarkeit des Wikis zu erhöhen, soll über das Plugin “folded” die Möglichkeit einzelne Inhalte zu verstecken bereitgestellt werden. Und so sieht das dann aus:

Wenn Sie mehr darüber erfahren wollen klicken Sie bitte hier

Auskommentieren

Das Plugin comment verhilft dem APwiki zur Möglichkeit, Teile des Quelltextes ignorieren zu lassen. Dabei haben Kommentare die gleiche Syntax wie bei C und anderen Programiersprachen. Ein Kommentar beginnt mit /* und er endet mit */. Alles dazwischen wird ignoriert. Das funktioniert sogar über mehrere Zeilen hinweg.

/* Dieser Text ist
         auskommentiert */

Anmerkungen

Dokuwiki hat von Haus aus einen Mechanismus zur Darstellung von Anmerkungen eingebaut 1). Die Syntax dafür besteht in doppelten runden Klammern um den als Anmerkung gedachten Text:

 ((ANMERKUNG))

Im Fließtext schrumpft die Anmerkung zu einer Nummer zusammen. Diese Nummer ist ein Link an das Ende der Seite, wo die Anmerkungen der Reihe nach gesammelt sind. Auch die umgekehrte Richtung wird unterstützt: Die Nummer unten auf der Seite ist ein Link nach oben, wo die Anmerkung aufgerufen wird. Außerdem wird die Anmerkung in einem Pop-Up angezeigt, wenn die Maus über der Nummer sitzt.

Innerhalb einer Anmerkung funktionieren nicht alle Formatierungen, aber doch einige. Bilder und Links sind kein Problem2). Eine weitere Einschränkung betrifft Überschriften. Weder können Anmerkungen an Überschriften angehängt werden, noch können sie selber Überschriften enthalten3).

Formeln

Für Formeln hat dieses Wiki das Mathjax-Plugin installiert. Die Syntax ist weitgehend an LaTeX angelehnt. Formeln im Fließtext werden bei Mathjax von \$-Zeichen eingerahmt: $E = mc^2$ Abgesetzte Formeln erreicht man wie in plain-TeX mit doppelten \$-Zeichen (\$\$): $$ f(x) = \frac{d}{dx}\left( \int_{0}^{x} \text{d}u \; f(u)\,\right)$$

$$ f(x) = \frac{d}{dx}\left( \int_{0}^{x} \text{d}u \; f(u)\,\right)$$

Man kann Gleichungen ähnlich wie in LaTeX mit einer align-Umgebung auf das Gleichheitszeichen ausrichten: \begin{align*} e^x & = 1 + x + \frac{x^2}{2} + \frac{x^3}{6} + \cdots \\ & = \sum_{n\geq 0} \frac{x^n}{n!} \end{align*}

\begin{align*}
e^x & = 1 + x + \frac{x^2}{2} + \frac{x^3}{6} + \cdots \\
    & = \sum_{n\geq 0} \frac{x^n}{n!}
\end{align*}

Bilder hochladen und in den Text einbinden

Dokuwiki verwaltet Bilder und andere Dateien in einem baumartigen Verzeichnis, das dem Baum der Wikiseiten enspricht. Ein Bild wird zunächst dort hochgeladen und dann im Wikitext aufgerufen. Dieser Screencast zeigt, den Ablauf:

Bilder aus dem Kopier-Puffer hochladen

Das imgpaste-Plugin beschleunigt das Einbinden von Bildern:

  1. Ein Bild in den Kopier-Puffer des Computers kopieren (z.B. mit Ctrl+C).
  2. Auf einer Dokuwiki-Seite einen Edit-Kopf drücken.
  3. Die Tastenkombination Ctrl+V drücken → Das Bild aus dem Kopier-Puffer wird hochgeladen und ein dazu passender Befehl wird im Edit-Fenster erzeugt.
  4. Die Seite speichern.

Videos hochladen und in den Text einbinden

Videos werden genau wie Fotos in Dokuwiki eingebunden. Einziger Unterschied ist, das beim Video das Format *.mp4 sein sollte. Man kann mit einem optionalen Argument ein Bild angeben, das als Vorschau zu dem Video angezeigt wird. Dieses Bild wird wie ein normales Bild in den Medienbaum von Dokuwiki hochgeladen. Der Screencast oben wurde mit diesem Befehl eingebunden

{{ https://flowcasts.uni-hannover.de/nodes/wDmgZ/res0720.mp4?500x300px&:a_mechanik:kippender_besenstiel:bilder_in_dokuwiki_einbinden.png |Screencast zum Einbinden von Bildern}}

Bilderrahmen

Das Logo des Physikpraktikums in einer Vorschau mit Rahmen und Bildunterschrift. Dieser Rahmen wird vom Plugin imagebox zur Verfügung gestellt.

Bilder können in einen Rahmen gestellt und mit einer Bildunterschrift ausgestattet werden. Dafür ergänzt man den normalen Bilder-Link, der bei Dokuwiki in doppelten geschweiften Klammern besteht, um ein weiteres Paar von eckigen Klammern. Insgesamt ergibt sich:

[{{ PFAD-ZUM-BILD?200|BILDUNTERSCHRIFT}}]]

Dabei bewirkt das Leerzeichen links von “Pfad”, dass das Bild an den rechten Rand verschoben wird. Die “?200” bestimmen die Breite des Vorschaubilds.

Tabellen am Rand

Temp. (°C) Pt100 (Ω) Pt1000 (Ω)
-200 18.5 185
-195 20.7 207
-194 21.1 211
-190 22.8 228
-185 25.0 250
-180 27.1 271

Eine Tabelle in einer abgerundeten Box am rechten Seitenrand mit einer Beschreibung.

Bei Dokuwiki unterbrechen Tabellen normalerweise zeilenfüllend den Fließtext. Mit der <WRAP>-Umgebung kann man eine Tabelle an den Rand schieben und den Text darum herum fließen lassen. Dabei kann man explizit vorgeben, wie breit die Box dargestellt wird. Die Tabelle in der Box passt sich dann an diese Vorgaben an. Die Breite wird sinnvollerweise abhängig von der Schriftgröße gemacht (Einheit “em”). Dann gibt es weniger Überraschungen bei Anwendern, die in ihrem Browser ungewöhnliche Schriftgrößen verwenden:

Tabelle mit Box-Umgebung
<WRAP round box right width 15em>
^  Temp. (°C) ^  Pt100 (Ω) ^  Pt1000 (Ω) ^
|  -200 |  18.5 |  185 |
|  -195 |  20.7 |  207 |
|  -194 |  21.1 |  211 |
|  -190 |  22.8 |  228 |
|  -185 |  25.0 |  250 |
|  -180 |  27.1 |  271 |
Eine Tabelle in einer abgerundeten Box am rechten Seitenrand mit einer Beschreibung.
</WRAP>

WRAP clear

An den Fensterrand verschobene Bilder werden vom Fließtext umflossen. Die Bilder selbst werden in der Reihenfolge dargestellt, in der sie im Fließtext auftauschen. Das kann bei vielen, großen Bildern dazu führen, dass Text und Bilder auseinander driften. Mit Tabellen gibt es das gleiche Problem.

Ein <WRAP clear/> sorgt dafür, dass weiterer Fließtext sich erst hinter allen bis dahin aufgerufenen Bildern und Tabellen anschließt.

aplogo

Alle Dateien in einem Ordner

Im Ordner /srv/www/htdocs/ap/data/media/wiki/qplogo liegt das Logo des Physikpraktikums in verschiedenen Grafikformaten vor. Die diversen Dateien können automatisch in einer Tabelle, oder in einer Liste angezeigt werden. Mit vielen Optionen kann man das Ergebnis beeinflussen. Eine Tabelle mit einer Angabe der Dateigröße hat sich bewährt:

[n/a: No match]
 {{filelist>:wiki:qplogo:qp*&style=table&tableshowsize=1}}

Die Formate, die Dokuwiki als Bild darstellen kann, sind dabei die offiziell vom W3C für das WWW empfohlenen: PNG, JPG und SVG. Grafiken mit diesem Typ können in einer Galerie dargestellt werden

 {{gallery>wiki:qplogo?lightbox&showname&4}}

Gallerien werden wie einzelne Bilder, oder Tabellen platziert. Mit SPACE links, und/oder rechts von den geschweiften Klammern bestimmt die Ausrichtung relativ zum Fließtext. Damit gelten sie außerdem als “Floats”. Wenn man ihre Darstellung an einer bestimmten Stelle erzwingen will, sollte man zu <WRAP clear/> greifen.

Suchen und ersetzen

In der Default-Version des Edit-Fensters von Dokuwiki gibt es keine Funktion für Suchen-und-Ersetzen. Das Plugin toolbox ergänzt einen Knopf, der wie ein Schraubenschlüssel aussieht. Dahinter verbirgt sich ein Menü, dessen letzter Punkt “search and replace” ist.

Alle User einer Gruppe

Das Plugin groupusers erzeugt eine Tabelle aller User, die einer, oder mehreren Gruppen angehören:

{{groupusers|nomail>group1[,group2,...]}}

Admin-Log

Das Admin-Log sammelt die Anpassungen für dieses Wiki im Vergleich zum Default, wie er im Februar 2013 von http://dokuwiki.org geladen wurde.

1)
Anmerkungen werden im Fließtext als hochgestellte Nummern dagestellt.
2)
pplogo
Vor dem Schriftzug mit dem Beugungsbild hatte das Praktikum ein Logo, dass aus zwei Rücken an Rücken gestellten “P” bestand. Die beiden Buchstaben stehen für “PhysikPraktikum”. Logo-Designer interpretieren in das gespiegelte P sicher auch noch etwas von einer “anderen Sicht” hinein. Dieses Logo ist sehr symmetrisch – vielleicht sogar etwas zu symmetrisch. Dadurch wirkt es recht statisch. Mit zwei Punkten wird schnell ein Gesicht daraus.
3)
Der Haupt-Entwickler von Dokuwiki hat an dieser Stelle eine klare Meinung – Überschriften sollten keine Links enthalten. Er weigert sich konsequent, entsprechende Erweiterungen in das Projekt aufzunehmen. Es gibt sogar eine FAQ zu dem Thema.
You could leave a comment if you were logged in.