Hilfe:Quellcode

Aus Macwrench

Wechseln zu: Navigation, Suche
HelpDocument.png
  Help.png Hilfe
 

Inhaltsverzeichnis

Quellcode in Wiki-Artikeln

Auch Quellcode lässt sich im Wiki darstellen, was wahrscheinlich hin und wieder notwendig ist - z.B. für Beispiel-Konfigurationsdateien oder Programmierereien in der Rubrik Entwicklung.

Für Programmcode und längere Codeschnippsel ist es dabei u.U. sinnvoll, diese mit Syntax-Highlighting versehen darzustellen, um die Übersichtlichkeit zu erhöhen. Dazu wird eine leicht modifizierte Version der GeSHi Syntax Highlighting Extension verwendet, die um die Funktion erleichtert wurde, lokale Dateien auszulesen und darzustellen (das Attribut src="file" wurde komplett deaktiviert). Weitere Informationen sowie eine komplette Liste aller verfügbaren Sprachen ist auf der Webseite des GeSHi Projektes (GeSHi = Generic Syntax Highlighter) zu finden

Wiki-Code

Zur Darstellung von Wiki-Code in der MediaWiki Syntax ist der Text entsprechend zu klammern, und zwar mit den dafür vorgesehenen Tags

<nowiki></nowiki>

Ohne Syntax Highlighting

Einzeilige Codeschnippsel

Für kleine Einzeiler zwischendurch gibt es die Vorlage Textt, mit der ein Stück Text im Monospaced-Font ausgegeben werden kann:

{{Texttt|EINZEILER}}

Mehrzeilige Codeschnippsel

Falls es sich aber um größere Codeabschnitte handelt, ist das recht unpraktisch, da das Zeilenumbruchshandlich nicht optimal ist. Dafür gibt es die Tags

<code> ... </code>

mit denen sich auch größere Quellcodebeispiele problemlos darstellen lassen.

Beispiel
Text für Sourcecode in einer Box wie dieser hier durch Voranstellen
eines Leerzeichens an eine (jede) Zeile. 
Bei einer Leerzeile wird die Box abgeschlossen, der
Text wird aber nicht automatisch umgebrochen!!\
sondern \
muss \
mit backslashes manuell umgebrochen werden. \
oder durch eine mit einem Leerzeichen beginnende neue Zeile 

<?php
class helloWorld {
    var $output= "";
    function setHelloWorld($text) {
        $this->output = $text;
    }
    function helloWorld() {
        echo $this->output;
    }
}
?>

Mit Syntax Highlighting

Für die Darstellung mit Syntax-Highlighting wird folgende Syntax verwendet: 

<source lang="LANGUAGECODE" LINES="BOOL">
(code)
</source>

Beispiele

PHP mit Zeilennummern

<source lang="php" lines="1"></source>

ergibt: 

  1.  <?php
  2.  class helloWorld {
  3.      var $output= "";
  4.      function setHelloWorld($text) {
  5.          $this->output = $text;
  6.      }
  7.      function helloWorld() {
  8.          echo $this->output;
  9.      }
  10.  }
  11.  ?>
HTML ohne Zeilennummern

<source lang="html4strict" lines="0"></source>

ergibt: 

<html>
    <head>
        <title>Titeltext</title>
    </head>
    <body>
    </body>
</html>
BASH-Skript ohne Zeilennummern

<source lang="bash" lines="0"></source>

ergibt: 

#!/bin/sh
echo "Hello, World!"

Unterstützte Sprachen

Derzeit (Stand: Februar 2009) unterstützte Sprachen:

A
abap, actionscript3, actionscript, ada, apache, applescript, apt_sources, asm, asp, autoit, avisynth
B
bash, basic4gl, bf, blitzbasic, bnf, boo
C
caddcl, cadlisp, cfdg, cfm, cil, c_mac, cobol, c, cpp, cpp-qt, csharp, css
D
delphi, diff, div, dosv, dot, d
E
eiffel, email
F
fortran, freebasic
G
genero, gettext, glsl, gml, gnuplot, groovy
H
haskell, hq9plus, html4strict
I
idl, ini, inno, intercal, io
J
java5, java, javascript
K
kixtart, klonec, klonecpp
L
latex, lisp, lolcode, lotusformulas, lotusscript, lscript, lua
M
m68k, make, matlab, mirc, mpasm, mxml, mysql
N
nsis
O
objc, ocaml-brief, ocaml, oobas, oracle11, oracle8
P
pascal, perl, per, php-brief, php, pic16, pixelbender, plsql, povray, powershell, progress, prolog, providex, python
Q
qbasic
R
rails, reg, robots, ruby
S
sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql
T
tcl, teraterm, text, thinbasic, tsql, typoscript
V
vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog
W
whitespace, winbatch
X
xml, xorg_conf, xpp
Z
z80

Von „http://www.macwrench.de/wiki/Hilfe:Quellcode“
Persönliche Werkzeuge