Quelltext der Seite Vorlage:Code/doc

{{Documentation subpage}}
<!-- Categories go at the bottom of this page. -->
== Description ==
This is a combination of the parser function {{tag|syntaxhighlight}} and the template {{tl|pre2}}. It allows for code coloring depending on programming language conventions (like {{tag|syntaxhighlight}}) and inherits {{tl|pre2}}'s ability for creating a horizontal slider if necessary (and requested). Also: It adds buttons to copy ''code'' into the clipboard.

{{ambox|type=info|text=If you want to code wikitext, use lang ''html'', ''html4strict'', ''moin'' or ''xml'', since the parser function does not have a mediawiki or wikitext lang.}}


{{ambox|type=delete|text=If your wiki code contains calls to ''templates'', ''parser tags'' or ''parser functions'', you have to encode them in {{tli|text|''unstrip''|&lt;nowiki&gt;'''your call here'''&lt;/nowiki&gt;}}!}}

== Parameters ==
;1
;lang
:The language used for color coding. Consult extension syntaxhighlight's documentation for a [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages list of supported programming languages]
;2
;code
:The actual code displayed in the box. '''{{colors|darkred||Warning: }}''' If your code contains an equal sign (=), you have to specify the parameter name as either {{code snippet|code{{=}}}} or {{code snippet|2{{=}}}}, otherwise the display of text will be botched up.
;3
;scroll
:''optional'' If you don't want a horizontal slider for long text, set this to {{code snippet|no}}
;id
:''optional'' If you want rhe div containing your code having an id-attribute, pass it along with this parameter
;line
:''optional'' If you want line numbering, set this to anything other than ''off''
;start
:''optional'' If you want your line numbering to start at anything else than 1, put this value here (works only in conjunction with ''line'')
;highlight
:''optional'' If you want line highlighted, list them here.
:you can list values seperated by a comma or give a range or both: 1,4,9,11-13

== Usage ==
<pre>
{{code|bash|code=#!/bin/bash
mysql --defaults-file=/etc/mysql/debian.cnf}}
</pre>
renders as
{{code|bash|code=#!/bin/bash
mysql --defaults-file=/etc/mysql/debian.cnf}}

If you omit the paramater name ({{code snippet|code=code=}}), thus writing

<pre>
{{code|bash|#!/bin/bash
mysql --defaults-file=/etc/mysql/debian.cnf}}
</pre>
your output will look like this:
{{code|bash|#!/bin/bash
mysql --defaults-file=/etc/mysql/debian.cnf}}

a more complex example with parameters <code>lang=lua|line=1|start=1|highlight=7,9</code>:

{{code|lang=lua|line=1|start=1|highlight=7,9|code=
local templateClass = require('Module:Template/class')
local classDebug = require('Module:Debug/class')

-- ****************************************************************
-- *                         inheritance                          *
-- ****************************************************************
local className = templateClass:subclass('Name')
-- setting class's configuration data
className.myConfiguration[tostring(className)] = mw.loadData('Module:Name/config')

-- ****************************************************************
-- *                          properties                          *
-- ****************************************************************

local _private = setmetatable({}, {__mode = 'k'})   -- weak table storing all private attributes
}}

== See also ==
* {{tl|code snippet}} for short code text in sentences
* {{tl|pre}} for a pre box with line wraps
* {{tl|pre2}} for a pre box with horizontal slider
* {{tag|pre}}

<includeonly>
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- ADD CATEGORIES AFTER THIS LINE -->
[[Category:Text manipulation templates]]
}}
</includeonly>