틀:Code/doc: 두 판 사이의 차이
(note on embedded templates) |
(Category) |
||
(사용자 47명의 중간 판 58개는 보이지 않습니다) | |||
1번째 줄: | 1번째 줄: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> |
|||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> |
|||
{{#ifeq: {{PAGENAME}}|{{ROOTPAGENAME}}|{{High-risk|24,000+}}}} |
|||
==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}} |
||
29번째 줄: | 30번째 줄: | ||
because "foo" and "{{code|bar}}" will seem more closely associated than "{{code|bar}}" and "{{code|baz}}"; the width of the space character in a monospaced font is almost always larger than in a proportional font. |
because "foo" and "{{code|bar}}" will seem more closely associated than "{{code|bar}}" and "{{code|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|2}}, or more explicitly as {{para|lang}}) to specify a language for 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 {{code|html4strict}} and {{code|html5}} are valid values, as are {{code|php}}, {{code|perl}}, {{code|css}}, {{code|javascript}}, {{code|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. |
Use parameter {{{2}}} (unnamed, as {{para|2}}, or more explicitly as {{para|lang}}) 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 {{code|html4strict}} and {{code|html5}} are valid values, as are {{code|php}}, {{code|perl}}, {{code|css}}, {{code|javascript}}, {{code|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 [[Wikipedia:Template substitution|substituted]]. |
This template does not need to be [[Wikipedia:Template substitution|substituted]]. |
||
⚫ | |||
===Examples=== |
===Examples=== |
||
{| class="wikitable" |
|||
{{markup |
|||
! style="width:50%;" | input |
|||
⚫ | |||
! style="width:50%;" | output |
|||
⚫ | |||
|- |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
|- |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
|- |
|||
⚫ | |||
⚫ | |||
⚫ | |||
===Included templates=== |
|||
⚫ | |||
⚫ | |||
Templates used inside {{tl|code}} expose the rendered HTML— this can be useful. For example: |
|||
<div style="overflow:auto;"> |
|||
{{markup |
|||
|1=<nowiki>{{code| |
|||
{{cite web |title=Title |url=http://example.org}} |
|||
}}</nowiki> |
|||
|2={{code| |
|||
{{cite web |title=Title |url=http://example.org}} |
|||
}} |
|||
}} |
|||
</div> |
|||
The above example shows the HTML rendered by the citation template, including the hidden metadata. |
|||
== See also == |
== See also == |
||
* {{tl|codett}}, wrapper for this template that removes background and border styling |
|||
* {{tl|nowiki}} - for preventing the parsing of wiki markup and HTML in the content, e.g. in source code examples |
|||
* {{tl|mono}}, monospaced font only |
|||
* {{tl|pre}} - for larger blocks of source code and other pre-formatted text |
|||
* {{tl|Syntaxhighlight}} |
|||
* {{tl|tag}} - for using HTML elements ("tags") in prose, e.g. source code examples |
|||
* {{tl|var}} - for computer and mathematics variables |
|||
* {{tl|varserif}} - same as {{tnull|var}} but differentiates better between "I" (upper-case "i") and "l" (lower-case "L") |
|||
* {{tl|kbd}} - for indicating user input |
|||
* {{tl|samp}} - for example output |
|||
* {{tl|key press}} - for indicating the input of specific keystrokes, e.g. {{key press|Ctrl|X}} |
|||
* [[Help:Wiki markup]] |
* [[Help:Wiki markup]] |
||
⚫ | |||
<includeonly><!-- |
|||
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. --> |
|||
<includeonly>[[분류:틀|Code]]</includeonly> |
|||
[[Category:Programming typing-aid templates|{{PAGENAME}}]] |
|||
⚫ | |||
<!--[[Category:Wikipedia XHTML tag replacing templates|{{PAGENAME}}]] - Doesn't actually qualify yet; needs <code>.--> |
|||
</includeonly> |
2021년 1월 8일 (금) 08:41 기준 최신판
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 baz
quux.
versus:
foo {{code|bar baz}} quux.
which is going to be visually confusing for many:
- foo
bar baz
quux.
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
- {{codett}}, wrapper for this template that removes background and border styling
- {{mono}}, monospaced font only
- {{Syntaxhighlight}}
- Help:Wiki markup