Vorlage:Code/doc - Versionsgeschichte

imported>Oetterer am 11. Oktober 2022 um 09:53 Uhr

2022-10-11T09:53:25Z

← Nächstältere Version		Version vom 11. Oktober 2022, 11:53 Uhr
Zeile 1:		Zeile 1:
	{{Documentation subpage}}		{{Documentation subpage}}
			{{lua\|Module:Code}}
	<!-- Categories go at the bottom of this page. -->		<!-- Categories go at the bottom of this page. -->
	== Description ==		== Description ==
Zeile 16:		Zeile 17:
	;code		;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.		: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		;line
	:''optional'' ~~If you want~~ line ~~numbering, set this to anything other than ''off''~~		:''optional'' The line attribute enables line numbers.
	;start		;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'')		:''optional'' The start attribute (in combination with ''line'') defines the first line number of the code block.
	;highlight		;highlight
	:''optional'' ~~If you want line highlighted, list them here~~.		:''optional'' The highlight attribute specifies one or more lines that should be marked (by highlighting those lines with a different background color).
	:you can list values seperated by a comma or give a range or both: 1,4,9,11-13		:you can list values seperated by a comma or give a range or both: 1,4,9,11-13
			;inline
			:''optional'' The attribute indicates that the source code should be inline as part of a paragraph (as opposed to being its own block).
			;class
			:''optional'' The css class to use. When inline is used, class="nowrap" (on those wikis that support it; not on MediaWiki itself) specifies that line breaks should not occur at spaces within the code block.
			;style
			:''optional'' CSS styles to add



	== Usage ==		== Usage ==

imported>Oetterer am 16. April 2022 um 21:50 Uhr

2022-04-16T21:50:02Z

← Nächstältere Version	Version vom 16. April 2022, 23:50 Uhr
(kein Unterschied)

imported>Oetterer am 7. Oktober 2016 um 07:07 Uhr

2016-10-07T07:07:24Z

← Nächstältere Version		Version vom 7. Oktober 2016, 09:07 Uhr
Zeile 3:		Zeile 3:
	== Description ==		== 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.		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''\|<nowiki>'''your call here'''</nowiki>}}!}}

	== Parameters ==		== Parameters ==

mw>Oetterer: /* Parameters */

2016-02-04T06:50:26Z

Parameters

Neue Seite

{{Documentation subpage}}

== 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.

== 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 | |

[[Category:Text manipulation templates]]
}}
</includeonly>