Help:Editing: Difference between revisions

Revision as of 06:41, 27 January 2018

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.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
{{file\|doc\|Macro.doc\|Makro}}	→	Makro

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

Syntax highlighting uses the SyntaxHighlighter Extension.

To highlight code, enclose it with source tags, e.g. <source lang="fortran"> </source>, oder <source lang="vbnet"> </source>.
Example:

<source lang="fortran" highlight="5">
      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)

[mustermann_2008-1] 1.0 ^1.1 Mustermann, M. (2008): Mein Buch

[1]

@@ Line 4: / Line 4: @@
 * [http://meta.wikimedia.org/wiki/Help:Contents Englische Hilfe]
 * [http://meta.wikimedia.org/wiki/Hilfe Deutsche Hilfe]
+==Kommentare==
+Für Diskussionen eignen sich die Mediawiki-eigenen [{{fullurl:Special:PrefixIndex|from=&namespace=1}} Diskussionsseiten] der einzelnen Artikel.
+<div class="comment">
+Beispielkommentar
+</div>
+Es ist aber auch möglich, Kommentare direkt in den Text einer Seite zu setzen, indem man folgende Syntax benutzt:
+<source lang="html5"><div class="comment">
+Beispielkommentar
+</div></source>
+In jedem Fall ist es sinnvoll, seine Kommentare mit der Zeichenfolge <code><nowiki>~~~~</nowiki></code> zu signieren (fügt Namen und Uhrzeit des Bearbeiters ein)
 ==Literaturangaben==
 Für die Angabe von Literaturverweisen ist die [http://www.mediawiki.org/wiki/Extension:Cite/Cite.php Cite] Extension installiert.
-Um die mehrfache Eingabe von Literaturangaben zu vermeiden bekommt jede Literaturangabe eine eigene Seite, und zwar im Namensraum '''[{{fullurl:Spezial:Präfixindex|namespace=100}} Literatur:]'''. Die Literaturangabe kann dann auf beliebig vielen Seiten über Vorlageneinbindung eingebunden werden.
+Um die mehrfache Eingabe von Literaturangaben zu vermeiden bekommt jede Literaturangabe eine eigene Seite, und zwar im Namensraum '''[{{fullurl:Special:PrefixIndex|from=&namespace=100}} Literatur:]'''. Die Literaturangabe kann dann auf beliebig vielen Seiten über Vorlageneinbindung eingebunden werden.
 '''Beispiel:''' <br/>
@@ Line 53: / Line 65: @@
 '''Erläuterung:'''
 * Alles, was sich zwischen den '''<code><nowiki><noinclude></nowiki></code>''' Tags befindet, wird ''nicht'' mit eingebunden und dient nur zur Vorschau der Literaturangabe.
-* Der Teil '''<code><nowiki>{{{1|xxxx}}}</nowiki></code>''' wird, wenn vorhanden, durch den Übergabeparameter ersetzt, ansonsten wird der Text nach dem <code>|</code> verwendet (im Beispiel <code>Mustermann (2008)</code>).
+* Der Teil '''<code><nowiki>{{{1|xxxx}}}</nowiki></code>''' wird, wenn vorhanden, durch den Übergabeparameter ersetzt, ansonsten durch <code>xxxx</code> (im Beispiel <code>Mustermann (2008)</code>).
 * Der Text zwischen den '''<code><nowiki><ref></nowiki></code>''' Tags wird angezeigt, wenn man den Tag '''<code><nowiki><references/></nowiki></code>''' auf einer Seite benutzt (sollte am Ende der Seite geschehen).
 * Das Attribut '''<code><nowiki>name</nowiki></code>''' des <code><nowiki><ref></nowiki></code>-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 <code><nowiki>doi:XXXXXXXX</nowiki></code> werden automatisch mit dem DOI-Resolver <nowiki>http://dx.doi.org</nowiki> verlinkt.
 ==Dokumente einbinden==
@@ Line 77: / Line 92: @@
 ==Syntaxhervorhebung==
-Syntaxhervorhebung von Code-Passagen erfolgt mit [http://qbnz.com/highlighter/ GeSHi - Generic Syntax Highlighter] (Wiki Extension von [http://www.mediawiki.org/wiki/Extension:Geshi hier]).
+Syntax highlighting uses the [https://www.mediawiki.org/wiki/Extension:SyntaxHighlighter SyntaxHighlighter Extension].
-Den hervorzuhebenden Code einfach mit Tags der entsprechenden Sprache umschließen, z.B. <code>&lt;fortran&gt;&lt;/fortran&gt;</code>, <code>&lt;vb&gt;&lt;/vb&gt;</code> oder <code>&lt;vbnet&gt;&lt;/vbnet&gt;</code>.<br/>
+To highlight code, enclose it with source tags, e.g. <code><nowiki><source lang="fortran"> </source></nowiki></code>, oder <code><nowiki><source lang="vbnet"> </source></nowiki></code>.<br/>
-Beispiel:
+Example:
 {| cellpadding="2" cellspacing="0" border="0"
 |<pre>
-<fortran>
+<source lang="fortran" highlight="5">
        FUNCTION Test
 c         Kommentar
@@ Line 90: / Line 105: @@
            variable(1) = variable2 + 5.03  ! Kommentar
        END FUNCTION
-</fortran>
+</source>
 </pre>
 | &rarr;
-| <fortran>
+| <source lang="fortran" highlight="5">
        FUNCTION Test
 c         Kommentar
@@ Line 100: / Line 115: @@
            variable(1) = variable2 + 5.03  ! Kommentar
        END FUNCTION
-</fortran>
+</source>
 |}
@@ Line 124: / Line 139: @@
 ==Integration mit Bugzilla und WebSVN==
-Zusätzlich zu den standardmäßigen [http://meta.wikimedia.org/wiki/Help:Magic_words magischen Wörtern] in MediaWiki, sind in dieser Wiki-Installation die folgenden Wörter registriert:
+<del>Zusätzlich zu den standardmäßigen [http://meta.wikimedia.org/wiki/Help:Magic_words magischen Wörtern] in MediaWiki, sind in dieser Wiki-Installation die folgenden Wörter registriert:</del>
-* '''Bug''' gefolgt von einer Zahl wird automatisch mit dem entsprechenden Bug in [http://130.83.196.154/bugzilla/ Bugzilla] verlinkt. (z.B. Bug 1)
+*<del> '''Bug''' gefolgt von einer Zahl wird automatisch mit dem entsprechenden Bug in [http://bugs.bluemodel.org/ Bugzilla] verlinkt. (z.B. Bug 1)</del>
-* '''Rev''' oder '''Rev.''' gefolgt von einer Zahl wird automatisch mit der entsprechenden Revisionsansicht in [http://130.83.196.154/websvn WebSVN] verlinkt. (z.B. Rev 1)
+*<del> '''Rev''' oder '''Rev.''' gefolgt von einer Zahl wird automatisch mit der entsprechenden Revisionsansicht in [http://websvn.bluemodel.org WebSVN] verlinkt. (z.B. Rev 1)</del>
-: ''Verlinkung erfolgt momentan nur automatisch auf die Repository 'BlueM'!''
+<del>;Achtung: ''Verlinkung erfolgt momentan nur automatisch auf die Repository 'BlueM.Sim'!'' </del>
+<del>Siehe auch den entsprechenden [[MediaWiki SVN Patch]] hierfür.</del>
-Siehe auch den entsprechenden [[MediaWiki SVN Patch]] hierfür.
+''no longer working, workaround using interwiki links:''<br>
+<nowiki>[[bugzilla:2]]</nowiki> &rarr; [[bugzilla:2]]<br>
+<nowiki>[[rev:2]]</nowiki> &rarr; [[rev:2]] (assumes the repository BlueM.Sim)''