Template:Code:Lua/doc

From Wikibooks, open books for an open world
Jump to: navigation, search

This is a template for writing Lua code examples. You can specify introductory text, code, output, and explanatory text. The Lua code is syntax highlighted using the SyntaxHighlight extension, and the output is formatted with <pre>...</pre> tags, meaning that it uses a monospace font and whitespace is preserved.

Usage[edit]

Simple usage
{{Code:Lua
| code   = 
| output = 
}}
All parameters
{{Code:Lua
| before           = 
| code             = 
| output           = 
| after            = 
| border-color     = 
| background-color = 
| output-color     = 
}}

Parameters[edit]

  • before - the introductory text. This comes before the code and the output.
  • code - the Lua code.
  • output - the output.
  • after - the explanatory text. This comes after the code and the output.
  • border-color - the hexadecimal color code for the border color, e.g. FF7777. Do not include a # symbol, as this is added by default.
  • background-color - the hexadecimal color code for the background color, e.g. FFDDDD. Do not include a # symbol, as this is added by default.
  • output-color - the hexadecimal color code for the output text color, e.g. FF0000. Do not include a # symbol, as this is added by default.

All parameters are optional.

Note: using a pipe character | in any of the parameters will break the template. This is because for the MediaWiki software, the pipe character signifies the start of a new parameter. To work around this problem you can use the code {{!}}.

Examples[edit]

All parameters[edit]

{{Code:Lua
| before = A hello world program.
| code   = print('Hello, world!')
| output = Hello, world!
| after  = The <code>print</code> command prints text. 
}}
A hello world program.

Crystal Clear app terminal.png Code:

print('Hello, world!')

Crystal Clear app kscreensaver.png Output:

Hello, world!
The print command prints text.

Just code and output[edit]

{{Code:Lua
| code   = print('Hello, world!')
| output = Hello, world!
}}

Crystal Clear app terminal.png Code:

print('Hello, world!')

Crystal Clear app kscreensaver.png Output:

Hello, world!

Just code[edit]

{{Code:Lua
| code   =
for i = 1, 10000 do
        print('Hello, world!\n')
end
}}

Crystal Clear app terminal.png Code:

for i = 1, 10000 do
	print('Hello, world!\n')
end

See also[edit]