Help:Editing

From BlueM
Jump to: navigation, search

Wiki-Bearbeitung allgemein

Kommentare

Für Diskussionen eignen sich die Mediawiki-eigenen Diskussionsseiten der einzelnen Artikel.

Beispielkommentar

Es ist aber auch möglich, Kommentare direkt in den Text einer Seite zu setzen, indem man folgende Syntax benutzt:

<div class="comment">
Beispielkommentar
</div>

In jedem Fall ist es sinnvoll, seine Kommentare mit der Zeichenfolge ~~~~ zu signieren (fügt Namen und Uhrzeit des Bearbeiters ein)

Literaturangaben

Für die Angabe von Literaturverweisen ist die Cite Extension installiert.

Um die mehrfache Eingabe von Literaturangaben zu vermeiden bekommt jede Literaturangabe eine eigene Seite, und zwar im Namensraum Literatur:. Die Literaturangabe kann dann auf beliebig vielen Seiten über Vorlageneinbindung eingebunden werden.

Beispiel:
Ich will die Literaturangabe Mustermann (2008) zitieren:

Blablabla (siehe {{:Literatur:Mustermann_2008}})
Blablabla (siehe Mustermann (2008)[1])
oder unter Nutzung des optionalen Übergabeparameters:
{{:Literatur:Mustermann_2008|Blablabla}}
Blablabla[1]
und dann am Ende der Seite:
<references/>
  1. 1.0 1.1 Mustermann, M. (2008): Mein Buch

Dies führt dazu, dass der Inhalt der Seite Literatur:Mustermann_2008 eingebunden wird. Wenn die Seite noch nicht existiert, wird ein roter Link angezeigt, über den man diese erstellen kann. Literaturseiten sollten folgende Syntax einhalten:

{{{1|Mustermann (2008)}}}<ref name="mustermann_2008">'''Mustermann, M.''' (2008): Mein Buch</ref><noinclude>
==Vorschau==
<references/>
</noinclude>

Erläuterung:

  • Alles, was sich zwischen den <noinclude> Tags befindet, wird nicht mit eingebunden und dient nur zur Vorschau der Literaturangabe.
  • Der Teil {{{1|xxxx}}} wird, wenn vorhanden, durch den Übergabeparameter ersetzt, ansonsten durch xxxx (im Beispiel Mustermann (2008)).
  • Der Text zwischen den <ref> Tags wird angezeigt, wenn man den Tag <references/> auf einer Seite benutzt (sollte am Ende der Seite geschehen).
  • Das Attribut name des <ref>-Tags dient dazu, die Literaturangabe eindeutig zu identifizieren, so dass sie nur einmal angezeigt wird, wenn sie auf einer Seite mehrmals benutzt wird.

DOI

DOI-Angaben im Format doi:XXXXXXXX werden automatisch mit dem DOI-Resolver http://dx.doi.org verlinkt.

Dokumente einbinden

Für das Einbinden von bereits hochgeladenen Dateien so, dass auch ein entsprechendes Icon angezeigt wird, kann man folgende Syntax nutzen: {{file|pdf|datei.pdf|Anzeigetext}} (Idee kommt von hier).
Akzeptierte Dateiformate sind pdf, doc, xls, mdb, ppt, zip. Beispiele:

{{file|pdf|Ostrowski 1992 Universeller Baustein.pdf|Ostrowski}}
Ostrowski information.png
{{file|doc|Macro.doc|Makro}}
Makro information.png

Formeln

Formeln können in Form von TeX-Markup innerhalb von <math></math> Tags eingegeben werden. Ausführliche Hilfe hier: Englisch / Deutsch

FreeMind Mind Maps

Mind Maps von Freemind können wie hier beschrieben eingebettet werden.

Syntaxhervorhebung

Syntaxhervorhebung von Code-Passagen erfolgt mit GeSHi - Generic Syntax Highlighter (Wiki Extension von hier).

Den hervorzuhebenden Code einfach mit Tags der entsprechenden Sprache umschließen, z.B. <source lang="fortran"> </source>, oder <source lang="vbnet"> </source>.
Beispiel:

<source lang="fortran">
      FUNCTION Test
c         Kommentar
          REAL :: variable(n),
     +            variable2
          variable(1) = variable2 + 5.03  ! Kommentar
      END FUNCTION
</source>
      FUNCTION Test
c         Kommentar
          REAL :: variable(n),
     +            variable2
          variable(1) = variable2 + 5.03  ! Kommentar
      END FUNCTION

Hierarchie

Die Hierarchy Extension kann dazu genutzt werden, Seiten hierarchisch anzuordnen.

Hierzu braucht man eine Index-Seite in der Form:

<index>
[[BlauesModell Theorie]]
= Betriebsregelkonzept =
== Grundlegende Typen von Betriebsregeln ==
...
</index>

Und in jede Seite innerhalb der Hierarchie müssen zwei Vorlagen integriert werden:

{{HierarchieKopf}}
Inhalt der Seite
{{HierarchieFuss}}

Änderungen an der Struktur der Hierarchie können an der Index-Seite vorgenommen werden. Die Hierarchie wird immer dann neu generiert, wenn man die Index-Seite speichert.

Integration mit Bugzilla und WebSVN

Zusätzlich zu den standardmäßigen magischen Wörtern in MediaWiki, sind in dieser Wiki-Installation die folgenden Wörter registriert:

  • Bug gefolgt von einer Zahl wird automatisch mit dem entsprechenden Bug in Bugzilla verlinkt. (z.B. Bug 1)
  • Rev oder Rev. gefolgt von einer Zahl wird automatisch mit der entsprechenden Revisionsansicht in WebSVN verlinkt. (z.B. Rev 1)

;Achtung: Verlinkung erfolgt momentan nur automatisch auf die Repository 'BlueM.Sim'!

Siehe auch den entsprechenden MediaWiki SVN Patch hierfür.

no longer working, workaround using interwiki links:
[[bugzilla:2]] → bugzilla:2
[[rev:2]] → rev:2 (assumes the repository BlueM.Sim)