Template:CodeBlock: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(The source code has been reworked.)
Line 1: Line 1:
<onlyinclude><includeonly>{{#switch:{{{1}}}
<onlyinclude><includeonly><!--
|#default=<div style="background-color: rgba(0,0,0,.3); border-radius: 4px; overflow: hidden; font-family: monospace; font-size: 1.2em; line-height: 1.125rem; text-indent: 0; white-space: pre-wrap; padding: .5em; margin: {{{margin|.5em 0 0 0}}};">{{{1|}}}</div>
--><div style="{{#if:{{{limited|}}}|max-height: 400px; height: {{{height|auto}}};|}}background-color:{{#switch:{{{style|}}}|#default=rgba(0,0,0,.3)|1=rgb(0,0,0,.1)}};{{#switch:{{{style|}}}|#default= |1=border:1px solid rgba(255,255,255,.1);}}border-radius:4px; {{#if:{{{limited|}}}|overflow-y:auto; overflow-x:hidden;|overflow:hidden;}} font-family:monospace; font-size:1.2em; line-height:1.125rem; text-indent:0; white-space:pre-wrap; padding:.5em; margin: {{{margin|.5em 0 0 0}}}"><!--
|limited=<div style="max-height: 400px; height: {{{height|auto}}}; background-color: rgba(0,0,0,.3); border-radius: 4px; overflow-y: auto; overflow-x: hidden; font-family: monospace; font-size: 1.2em; line-height: 1.125rem; text-indent: 0; white-space: pre-wrap; padding: .5em; margin: {{{margin|.5em 0 0 0}}};">{{{2|}}}</div>
-->{{#switch:{{{header|}}}|#default=|1=<div style="width:100%; background-color:rgba(0,0,0,.1); border:1px solid rgba(255,255,255,.1); font-family:monospace; font-size:1.0em; line-height:1.125rem; text-indent:0; white-space:pre-wrap; padding:.5em; margin-top:-0.6em; margin-left:-0.6em; margin-bottom:0.5em">{{{1|}}}{{#if:{{{lang|}}}|<div style="float: right;">{{#switch:{{{lang|}}}|#default={{{lang|}}}|plain=Plain Text|html=HTML|css=CSS|scss=SCSS|less=LESS|js=JavaScript|json=JSON|php=PHP|c=C|cs=C#|cpp=C++|pascal=Pascal|python=Python|java=Java|squirrel=Squirrel|lua=Lua|glua=gLua}}</div>|}}</div>}}<!--
|outline=<div style="background-color: rgb(0,0,0,.1); border: 1px solid rgba(255,255,255,.1); border-radius: 4px; overflow: hidden; font-family: monospace; font-size: 1.2em; line-height: 1.125rem; text-indent: 0; white-space: pre-wrap; padding: .5em; margin: {{{margin|.5em 0 0 0}}};">{{{2|}}}</div>
-->{{#switch:{{{header|}}}|#default={{{1|}}}|1={{{2|}}}}}<!--
|outline-limited=<div style="max-height: 400px; height: {{{height|auto}}}; background-color: rgba(0,0,0,.1); border: 1px solid rgba(255,255,255,.1); border-radius: 4px; overflow-y: auto; overflow-x: hidden; font-family: monospace; font-size: 1.2em; line-height: 1.125rem; text-indent: 0; white-space: pre-wrap; padding: .5em; margin: {{{margin|.5em 0 0 0}}};">{{{2|}}}</div>
--></div></includeonly></onlyinclude>{{doc}}
}}</includeonly></onlyinclude>{{doc}}

Revision as of 09:06, 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)
Curly brackets white.pngTemplate Documentation [view] [edit]
Icon-translate.png Available doc translations
View
Page history

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.
Icon-Bug.pngBug: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.pngNote: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}}
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>}}
using System; namespace HelloWorld { internal class Program { static void Main(string[] args) { Console.WriteLine("Hello World"); } } }