Template:CodeBlock/doc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 13: | Line 13: | ||
| align=center | {{Code|{{param|tag=kbd|1}}}} | | align=center | {{Code|{{param|tag=kbd|1}}}} | ||
| Your code.<br>It is recommended to wrap the template content with the {{Code|select=1|<nowiki>}} tag. | | Your code.<br>It is recommended to wrap the template content with the {{Code|select=1|<nowiki>}} tag. | ||
| {{CodeBlock|<nowiki>{{CodeBlock|Hello, World!}}</nowiki>}} | | {{CodeBlock|margin=5px|<nowiki>{{CodeBlock|Hello, World!}}</nowiki>}} | ||
| {{Doc/PreviewBlock|margin=5px|{{CodeBlock|margin=0|Hello, World!}}}} | | {{Doc/PreviewBlock|margin=5px|{{CodeBlock|margin=0|Hello, World!}}}} | ||
|- | |- | ||
| align=center | {{Code|{{param|tag=kbd|margin}}}} | | align=center | {{Code|{{param|tag=kbd|margin}}}} | ||
| Controls margins. | | Controls margins. | ||
| {{CodeBlock|<nowiki>{{CodeBlock|margin=0 20px 0 20px|Hello, World!}}</nowiki>}} | | {{CodeBlock|margin=5px|<nowiki>{{CodeBlock|margin=0 20px 0 20px|Hello, World!}}</nowiki>}} | ||
| {{Doc/PreviewBlock|margin=5px|{{CodeBlock|margin=0 20px 0 20px|Hello, World!}}}} | | {{Doc/PreviewBlock|margin=5px|{{CodeBlock|margin=0 20px 0 20px|Hello, World!}}}} | ||
|- | |- | ||
Line 25: | Line 25: | ||
:* {{Code|select=1|1}} - Outlined version; | :* {{Code|select=1|1}} - Outlined version; | ||
:* {{Code|style=3|Default}} - Default style that is based on Markdown. | :* {{Code|style=3|Default}} - Default style that is based on Markdown. | ||
| {{CodeBlock|<nowiki>{{CodeBlock|style=1|Hello, World!}}</nowiki>}} | | {{CodeBlock|margin=5px|<nowiki>{{CodeBlock|style=1|Hello, World!}}</nowiki>}} | ||
| {{Doc/PreviewBlock|margin=5px|{{CodeBlock|style=1|margin=0|Hello, World!}}}} | | {{Doc/PreviewBlock|margin=5px|{{CodeBlock|style=1|margin=0|Hello, World!}}}} | ||
|- | |- | ||
| align=center | {{Code|{{param|tag=kbd|limited}}}} | | align=center | {{Code|{{param|tag=kbd|limited}}}} | ||
| Limits the block height to 400 pixels and enables scrolling. | | Limits the block height to 400 pixels and enables scrolling. | ||
| {{CodeBlock|<nowiki>{{CodeBlock|limited=1|1. Hello World | | {{CodeBlock|margin=5px|<nowiki>{{CodeBlock|limited=1|1. Hello World | ||
2. Hello World | 2. Hello World | ||
3. Hello World | 3. Hello World | ||
Line 59: | Line 59: | ||
| align=center | {{Code|{{param|tag=kbd|src}}}} | | align=center | {{Code|{{param|tag=kbd|src}}}} | ||
| The source of your code. | | The source of your code. | ||
| {{CodeBlock|<nowiki>{{CodeBlock|src=light.rad|forcetextureshadow props_foliage/urban_tree01.mdl}}</nowiki>}} | | {{CodeBlock|margin=5px|<nowiki>{{CodeBlock|src=light.rad|forcetextureshadow props_foliage/urban_tree01.mdl}}</nowiki>}} | ||
| {{Doc/PreviewBlock|margin=5px|{{CodeBlock|src=light.rad|margin=0|forcetextureshadow props_foliage/urban_tree01.mdl}}}} | | {{Doc/PreviewBlock|margin=5px|{{CodeBlock|src=light.rad|margin=0|forcetextureshadow props_foliage/urban_tree01.mdl}}}} | ||
|- | |- | ||
| align=center | {{Code|{{param|tag=kbd|lang}}}} | | align=center | {{Code|{{param|tag=kbd|lang}}}} | ||
|The name of the language displayed on the right side of the header. | |The name of the language displayed on the right side of the header. | ||
| {{CodeBlock|<nowiki>{{CodeBlock|lang=cs|using System; | | {{CodeBlock|margin=5px|<nowiki>{{CodeBlock|lang=cs|using System; | ||
namespace HelloWorld | namespace HelloWorld |
Revision as of 11:01, 27 January 2023

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.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
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.
|
||
{{{margin}}}
|
Controls margins. | ||
{{{style}}}
|
The style of the template. The following styles are available:
|
||
{{{limited}}}
|
Limits the block height to 400 pixels and enables scrolling. | See below | |
{{{height}}}
|
Controls the height of the block. Does not work without {{{limited}}}. The maximum height is 400 pixels. |
Header
The parameters for adding a header with the code source and the name of the programming language are described below. Template:ModernNote
Name | Description | Example | Preview |
---|---|---|---|
{{{src}}}
|
The source of your code. | ||
{{{lang}}}
|
The name of the language displayed on the right side of the header. |