틀:Code/doc: 두 판 사이의 차이
(update /doc) |
(→Usage: update) |
||
| 4번째 줄: | 4번째 줄: | ||
==Usage== |
==Usage== |
||
Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [[mw:Extension:SyntaxHighlight |
Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [[mw:Extension:SyntaxHighlight]]). This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|syntaxhighlight}}. See [[Help:Wiki markup]] for an explanation of what the various tags do. |
||
If the content includes an equals sign (=), you must specify the parameter explicitly: <code><nowiki>{{code|1=date=30 Feb 2010}}</nowiki></code>. |
If the content includes an equals sign (=), you must specify the parameter explicitly: <code><nowiki>{{code|1=date=30 Feb 2010}}</nowiki></code>. |
||
The template uses the <code><nowiki><syntaxhighlight></nowiki></code> tag with the attribute <code> |
The template uses the <code><nowiki><syntaxhighlight></nowiki></code> tag with the attribute <code>inline=1</code>. This works like the combination of the <code><nowiki><code></nowiki></code> and <code><nowiki><nowiki></nowiki></code> tags, applied to the expanded wikitext. For example, <code><nowiki>{{code|some '''wiki''' text}}</nowiki></code> will '''''not''''' render the word "wiki" in bold, and will render the tripled-single-quotes: |
||
:{{code|some '''wiki''' text}} |
:{{code|some '''wiki''' text}} |
||
2016년 4월 8일 (금) 00:52 판
 | This is a documentation subpage for 틀:Code. It contains usage information, categories and other content that is not part of the original 틀 page. |
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use 틀:Tag or 틀:Tag. See Help:Wiki markup for an explanation of what the various tags do.
If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.
The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:
some '''wiki''' text
However, {{code|a {{template}} call}} will still invoke the template:
a [[:틀:Template]] call
Use 틀:Tag around the template name to avoid this problem:
a {{template}} call
When used inline with regular text, 틀:Tnull generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
foo {{code|bar baz}} quux.
is well spaced:
- foo
bar bazquux.
versus:
foo {{code|bar baz}} quux.
which is going to be visually confusing for many:
- foo
bar bazquux.
because "foo" and "bar" will seem more closely associated than "bar" and "baz"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
Use parameter {{{2}}} (unnamed, as 틀:Para, or more explicitly as 틀:Para) to specify a language for mw:Extension:SyntaxHighlight GeSHi. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though html4strict and html5 are valid values, as are php, perl, css, javascript, mysql and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.
This template does not need to be substituted.
Examples
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use 틀:Tag as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
The above example shows the HTML rendered by the citation template, including the hidden metadata.
See also
