View source for Template:FileBox/doc

{{Template}}
<!-- Categories go at the bottom of this page. -->

Displays a block element with a file contents, optionally providing syntax highlighting. A list of recognized languages for syntax highlighting can be [[Gentoo Wiki:Syntax Highlighting|found here]].

{{Important|1=File contents may contain special characters (<kbd>{{!}}</kbd> or <kbd>=</kbd>) that break the MediaWiki templating system. You have these options to put the file contents (in order from preferred to rather-not-use) if you need to escape these characters:

# <code><nowiki>{{FileBox|1=contents}}</nowiki></code>
# <code><nowiki>{{FileBox|&lt;nowiki&gt;contents&lt;/nowiki&gt;}}</nowiki></code>
# <code><nowiki>{{FileBox|<pre>contents</pre>}}</nowiki></code> (Syntax highlighting is '''broken''' using this invocation!)
}}

== Parameters ==

{{Template Parameter Table|1=
{{Template Parameter|1|File content|required=yes}}
{{Template Parameter|filename|File name to display in the box header}}
{{Template Parameter|title|Additional title to display in the box header}}
{{Template Parameter|lang|Language of the contents, used for syntax highlighting <br />
([[Gentoo Wiki:Syntax Highlighting|here]] is a list of available languages)|default=text}}
}}

== Usage ==

See the template's [[Template:FileBox/testcases|testcases]]:
{{Template:FileBox/testcases}}

== See also ==

* {{Tl|CodeBox}}
* {{Tl|KernelBox}}

<includeonly>
[[Category:Formatting templates]]

</includeonly>
<noinclude>
[[Category:Template documentation]]
</noinclude>