Template:CodeBlock/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
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|<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}}}}
|-
|-
Line 75: Line 75:
         }
         }
     }
     }
}</nowiki>}}
}}}</nowiki>}}
| {{Doc/PreviewBlock|margin=5px|{{CodeBlock|lang=cs|margin=0|<nowiki>using System;
| {{Doc/PreviewBlock|margin=5px|{{CodeBlock|lang=cs|margin=0|<nowiki>using System;



Revision as of 11:00, 27 January 2023

English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文(臺灣) (zh-tw)
Edit-copy.png
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.

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.
{{CodeBlock|margin=0 20px 0 20px|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!
{{{limited}}} Limits the block height to 400 pixels and enables scrolling.
{{CodeBlock|limited=1|1. Hello World 2. Hello World 3. Hello World 4. Hello World}}
See below
{{{height}}} Controls the height of the block.
Does not work without {{{limited}}}.
The maximum height is 400 pixels.
{{CodeBlock|limited=1|height=34px|1. Hello World 2. Hello World 3. Hello World 4. Hello World}}
1. Hello World 2. Hello World 3. Hello World 4. Hello World

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.
{{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=cs|using System; namespace HelloWorld { internal class Program { static void Main(string[] args) { Console.WriteLine("Hello World"); } } }}}
The source was not specified
cs
using System; namespace HelloWorld { internal class Program { static void Main(string[] args) { Console.WriteLine("Hello World"); } }