Template:CodeBlock/doc

This is a documentation subpage for Template:CodeBlock.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

This template formats the text as a block of code.

Parameters and Examples

Main

The main parameters are described below.

Name	Description	Example	Preview
{{{1}}}	Your code. It is recommended to wrap the template content with the <nowiki> tag.	{{CodeBlock|Hello, World!}}	Hello, World!
{{{margin}}}	Controls margins. Goes clockwise.	{{CodeBlock|margin=5px 30px 0 10px|Hello, World!}}	Hello, World!
{{{style}}}	The style of the template. The following styles are available: 1 - Outlined version; Default - Default style that is based on Markdown.	{{CodeBlock|style=1|Hello, World!}}	Hello, World!
{{{height}}}	Controls the height of the block.	{{CodeBlock|height=52px|<nowiki>1. Hello World 2. Hello World 3. Hello World 4. Hello World</nowiki>}}	1. Hello World 2. Hello World 3. Hello World 4. Hello World
{{{width}}}	Controls the width of the block.	{{CodeBlock|width=50%|<nowiki>1. Hello World 2. Hello World 3. Hello World 4. Hello World 5. Hello World </nowiki>}}	1. Hello World 2. Hello World 3. Hello World 4. Hello World 5. Hello World
{{{lines}}}	Manual: Numbered lines.	{{CodeBlock|lines=4|<nowiki>Hello World Hello World Hello World Hello World</nowiki>}}	Hello World Hello World Hello World Hello World
{{{start}}}	What number to start numbering from (default value is 1). The value can be negative.	{{CodeBlock|start=12|lines=5|<nowiki>Hello World Hello World Hello World Hello World Hello World</nowiki>}}	Hello World Hello World Hello World Hello World Hello World
{{{highlight}}}	Adds syntax highlighting for the language specified. Bug:Condenses code into one line.  [todo tested in ?]	{{CodeBlock|highlight=c|int main() {return 0;} }}	int main() { return 0; }

Header

The parameters for adding a header with the code source and the name of the programming language are described below.

Note:The header is enabled automatically when you enter one of the following parameters.

Name	Description	Example	Preview
{{{src}}}	The source of your code.	{{CodeBlock|src=light.rad|forcetextureshadow props_foliage/urban_tree01.mdl}}	light.rad forcetextureshadow props_foliage/urban_tree01.mdl
{{{lang}}}	The name of the language displayed on the right side of the header.	{{CodeBlock|lang=csharp |<nowiki>using System; namespace HelloWorld { internal class Program { static void Main(string[] args) { Console.WriteLine("Hello World"); } } }</nowiki>}}	The source was not specified C# using System; namespace HelloWorld { internal class Program { static void Main(string[] args) { Console.WriteLine("Hello World"); } } }