도움말:틀

This page is a translated version of the page Help:Templates and the translation is 20% complete.
Outdated translations are marked like this.
PD 주의사항: 이 문서를 편집하면 CC0에 따라 당신의 기여한 것을 배포하는 데 동의하는 것으로 간주됩니다. 자세한 내용은 퍼블릭 도메인 도움말 문서를 확인 하세요. PD

여러 문서에 포함할 기본 글이 있다면, 미디어위키 틀 기능이 유용하게 쓰입니다. 확장 도구나 미디어 파일과는 다르게 틀에는 중앙 저장소가 없습니다. 틀은 새로 작성하거나, 또는 기존의 작업을 위키피디어와 같은 다른 위키에서 복사하여 목적하는 위키로 불러올 수 있습니다.

만들기

틀은 그 내용이 다른 문서에서 나타나도록embedded or transcluded 설계된 표준 위키 문서입니다. 틀은 그 이름이 "틀:"이라는 접두어prefix와 함께 사용되고, 이름공간에 포함되도록 하는 관행을 따릅니다. 이를 바탕으로, 당신은 create them like any other wiki page.

틀을 사용하는 가장 쉬운 방법은 다음과 같다. 당신이 만약 "틀:환영합니다."이라는 페이지를 아래와 같은 내용과 함께 만든다면:

안녕하세요! 위키에 오신 것을 환영합니다.

당신은 지금 막 새로운 틀을 만들었습니다! 이제 아래와 같이 코드를 입력하면:

{{환영합니다}}

그 모든 페이지에서 "안녕하세요! 위키에 오신 것을 환영합니다."가 {{환영합니다}} 대신 보여진다. 틀의 내용은 다른 페이지에 "포함(transclude: transfer + include)"된다.

이제 다른 사람을 환영하고 싶은 어느 페이지의 어느 부분에나 {{환영합니다}}를 입력하면 된다. 예를 들어 100개의 페이지에서 사용되었다고 치자. 만약 틀의 내용을 다음과 바꾼다면:

안녕하세요! 경이로운 위키에 오신 것을 환영합니다.

그리고 그 틀이 사용된 100개의 페이지를 다시 접속해보면, 기존의 내용이 아닌 새로 작성한 내용을 볼 수 있다. 이 방법을 이용하여 100개 페이지의 내용을 일일이 고치지 않을 수 있다.

이것이 틀의 기본 원리다. 또한 틀을 좀 더 활용할 수 있는 추가적인 기능이 있다.

사용

틀 역시 하나의 위키 문서이며, 세 가지 방법으로 다른 위키 문서에서 사용될 수 있다.

  • {{이름}}은 이 코드를 포함하고 있는 문서를 웹 브라우저로 열 때, "[[틀:이름]]" 문서의 내용을 그 위치에 포함시킨다. (즉, 항상 최신의 "[[틀:이름]]" 문서의 내용을 포함하게 됩니다.) 틀을 호출하는 코드(the template call)가 문서의 원본에 남아있기 때문에, 이후 발생한 틀:이름에 관한 모든 변화는 틀을 호출하는 코드를 포함하는 문서에서 보이게 됩니다. 또한, 그 문서는 틀과 연결된link to 문서들의 목록에 포함될 것이다.

{{subst:이름}} - 이 유형의 틀 호출template call이 사용되면, 틀 호출 코드는 그 코드를 포함하는 문서가 저장되는 동시에 틀:이름에 속한 내용의 정태적 복제static copy에 의해 대체됩니다. 다시 말해, 틀:이름의 내용의 사본이 틀 호출 코드를 대신하여 들어가게 될 것이다. 문서와 틀 사이에는 아무런 연결고리link도 남지 않게 되므로, 문서와 틀은 서로 아무런 영향도 주고받지 않은 채 편집될 수 있습니다. 효과 면에서는, 이런 식으로 내용을 대체하는 것과, 단순히 키보드로 문서의 원본이 되도록 타이핑하는typing 것 사이에 큰 차이가 없습니다. Template:이름 - 이 코드는 틀이 다른 틀이나 parser functions를 포함하는 경우에 재귀적recursive으로 대체하는 것을 허용합니다. See 도움말:문자열 대체 for more information.

  • {{msgnw:이름}}{{이름}}와 동일하지만, <nowiki>를 사용한 것 처럼 위키 문서 문법을 처리하지 않고 문서를 포함시킨다.

In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:

  • {{Template:Pagename}} transcludes the page titled Template:Pagename (equivalent to {{Pagename}})
  • {{Talk:Pagename}} transcludes the page titled Talk:Pagename
  • {{:Pagename}} transcludes the page titled Pagename (i.e., in the main namespace)
    • {{subst::Pagename}} substitutes the contents of the page titled Pagename

If the specfied namespace doesn't exist, the full title is assumed to be a template:

  • {{Foo:Bar}} transcludes Template:Foo:Bar

변수

To enrich the mechanism of transclusion, MediaWiki allows parameters to be passed to a template when it is transcluded. Parameters allow the template to produce different contents or have different behaviors.

Suppose you wish to insert a little thank you note in the talk page of other users, such as:

A little thank you... for all your effort. hugs, Me

The thank you note will have a reason (in this case, "all your effort") and a signature ("Me"). Your objective is that any user be able to thank any other user, for any reason whatsoever.

So that the note will look similar everywhere it is used, you can define a template called Template:Thankyou , for example. Although the note should look similar whenever a user thanks another user, its specific contents (i.e. the reason and the signature) will be different. For that reason, you should pass them as parameters. If we ignore the remaining elements to format the box and place the image, the core content of the template will be this:

'''A little thank you...'''
for {{{1}}}.
hugs, {{{2}}}

Notice the use of {{{1}}} and {{{2}}}. This is the way to identify, within templates, the parameters that will be passed in when the template is used. Note that, within the template, each parameter is surrounded by three braces: {{{ }}}. This is different from normal template name usage.

When using the template on a page, you fill in the parameter values, separated by a "pipe" character (|). MediaWiki allows parameters to be passed to the template in three ways: Anonymously, Numbered, and Named.

익명 변수

To pass in anonymous parameters, list the values of those parameters sequentially:

{{Thankyou|all your effort|Me}}

In this case, the {{Thankyou}} template receives parameters {{{1}}}=all your effort and {{{2}}}=Me, producing:

A little thank you... for all your effort. hugs, Me

The order in which anonymous parameters are passed in is crucial to its behavior. Reversing the order of the parameters, like so:

{{Thankyou|Me|all your effort}}

would produce this result:

A little thank you... for Me. hugs, all your effort

Identifying parameters by order (with {{{1}}}, etc.) works only with anonymous parameters. Any parameters identified by name, as shown below, will not be accessible to the template using ordinal numbers.
If an equal sign appears inside the argument to an anonymous template parameter, that parameter may be misinterpreted as a named parameter (which is explained below in this document) treating the text before the equal sign as the parameter name and the text after it as the argument value. This is a common problem when you need to include an external link, or an HTML element with attributes (see 작업 T16235). The workaround is to use named parameters instead, or even numbered parameters as explained in the following section.

수로 지정된 변수

To pass in parameters by number, identify each parameter when passing it:

{{Thankyou|2=Me|1=your friendship}}

This time, template {{Thankyou}} receives parameters {{{1}}}=your friendship and {{{2}}}=Me, though they have been supplied in inverse order, and produces:

A little thank you... for your friendship. hugs, Me

This may also be useful when any of the numbered parameters contains an "=" sign.
Examples:
<span lang="en" dir="ltr" class="mw-content-ltr">{{Thankyou|1=adding “=”|2=Me}}</span>

produces:

A little thank you... for adding “=”. hugs, Me

  경고: This also requires numbering each other parameter.

이름으로 지정된 변수

The third way of passing parameters is by name instead of numbers. In this case, the template contents would be changed to:

'''A little thank you...'''
for {{{reason}}}.
hugs, {{{signature}}}

Within the template, we use {{{reason}}} and {{{signature}}} to identify each parameter, instead of a number. To pass these parameters by name, identify each parameter when passing it:

{{Thankyou|signature=Me|reason=being who you are}}

In this case, template {{Thankyou}} receives parameters {{{reason}}}=being who you are and {{{signature}}}=Me and produces:

A little thank you... for being who you are. hugs, Me

Named parameters are case-sensitive, so:

{{Thankyou|signature=Me|Reason=being who you are|reason=being case-sensitive}}

produces:

A little thank you... for being case-sensitive. hugs, Me

The advantage of using named parameters in your template, besides also being flexible in the order parameters can be passed, is that it makes the template code much easier to understand if there are many parameters.

기본 값

If you transclude a template that expects parameters, but do not provide their arguments, in this way:

{{Thankyou}}

in the numbered parameters example above you would get the following:


A little thank you... for {{{1}}}. hugs, {{{2}}}


Since no arguments were passed in, the template presents the parameters themselves, instead of their respective values. In these cases, it may be useful to define default values for the parameters, i.e. values that will be used if no value is passed in. For example, if the template contents are changed to:

'''A little thank you...'''
for {{{reason|everything}}}.
hugs, {{{signature|Me}}}

then {{{reason|everything}}} defines that if no argument is provided for parameter {{{reason}}}, then the value everything will be used. Similarly, {{{signature|Me}}}, defaults parameter {{{signature}}} to value Me. Now, transcluding the template again without passing any argument results in the following:

A little thank you... for everything. hugs, Me

The value of a parameter can be an empty string. For example, in {{foo|bar=}} or {{foo|bar=|baz=qux}}, the foo template considers the bar parameter to be "". This is different from omitting the parameter altogether, which leaves it undefined and triggers the default value mechanism described above.
If you need to treat an empty string the same way as a missing parameter, you can use a conditional operator through an extension like ParserFunctions. For instance, {{#if:{{{1|}}}|{{{1|}}}|undefined}} returns undefined if the parameter is either undefined or empty, while {{{1|undefined}}} does so only if the parameter is undefined.

Often default values are used to specify alternate names of parameters. For example, if you have {{{a|{{{b|}}} }}}, the template will first look for a parameter named "a". If it is not set, it will use the parameter named "b". If neither "a" nor "b" is set, it will output nothing.

Evaluation

This is an advanced topic which you can skip unless you need it.

Generally speaking, template parameters are substituted into the template after tokenization, but as is. They are not evaluated until they are used.

This has a few consequences. First of all, if you have a Template:Start containing {{mytemplate, and a Template:End containing |foo=bar}}, and put {{start}}{{end}} on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.

The second consequence of this is dead-code elimination. If you make a template call like {{foo|{{DISPLAYTITLE:Bar}} }}, and Template:Foo does not contain {{{1}}}, then the displaytitle is not used, since it is only evaluated when needed, and there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the int: magic word that varies by user language.

Template calls starting with the magic word subst: or safesubst: are evaluated in a separate first pass that only happens at save time, along with ~~~~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker". This means you cannot manipulate the results with parser functions like padleft: or similar functions from extensions, as they see the strip marker instead of the result of the parser function.

Recursion in templates

Including a template in itself won't throw MediaWiki into infinite recursion. MediaWiki will stop the recursion with the template's name in bold. For example, if the content of Template:Aaaa is a {{Aaaa}} z, it'll display "a a Template loop detected: Template:Aaaa z z".

Forbidden idiom

This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments. In this forbidden example template:d can either be called {{d|20200311}} or {{d|y=2020|m=3|d=11}}. If called in the first manner, it recurses into itself with the second argument structure (obtained using string parser functions), which then follows a unified processing path.

{{#if:{{{1|}}}|{{d|y={{#sub:{{{1}}}|0|4}}|m={{#sub:{{{1}}}|4|2}}|d={{#sub:{{{1}}}|6|2}}}}|<!-- processing path with arguments y,m,d regardless of original call pattern -->}}

If template:d is modified to recurse into template:d/2 and template:d/2 is an identical manual copy of template:d this idiom works fine as the self-recursion safeguard operates dynamically and not statically.

A feasible way for the MediaWiki software to loosen the self-recursion rule would be to require that each recursive call have a distinct argument count from all previous active calls, at most once recursing with the argument count non-decreasing. That would provide a strong guarantee against infinite self-recursion while enabling useful idioms such as the one described here in a flexible manner.

If the processing path is of low complexity, a simple solution using only one template is to handle each calling convention on a separate if/else branch, duplicating the logic of the processing path within each case. If the processing path is more complex, each call-structure case can delegate to an implementation template with a unified call structure which provides the final template behaviour.

Tables in parameters

Since the pipe character (|) and equality sign (=) have different meanings in template calls and wikitables, in order to use table markup in the value of a template parameter one generally needs to "escape" those characters (i.e., protect them from interpretation as template markup) using special sequences:

  • the built-in magic word {{!}} provides an "escaped" version of | since MediaWiki 1.24
  • the built-in magic word {{=}} provides an "escaped" version of = since MediaWiki 1.39

Before the introduction of these magic words, many wikis used templates to accomplish the same things. On such a wiki, the magic words take precendence over the same-named templates.

Example table

A B C
A1 B1 C1
A2 B2 C1

Table code:

{| class=wikitable
!A!!B!!C
|-
|A1||B1||C1
|-
|A2||B2||C1
|}

Escaped table code:

{{{!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!}}{{!}}B1{{!}}{{!}}C1
{{!}}-
{{!}}A2{{!}}{{!}}B2{{!}}{{!}}C2
{{!}}}

Note that the first left-brace ({) is interpreted as a literal left-brace character because it is immediately followed by the {{!}} magic word. Similarly, the last right-brace (}) is interpreted as a literal right-brace character because it is immediately preceeded by the same magic word. However, in some cases these brace characters do cause problems, so some wikis provide templates for escaping these characters, as well:

  • the template call {{(}} might provide an "escaped" version of {
  • the template call {{)}} might provide an "escaped" version of }

Some wikis go even further and provide other convenience templates like {{(!}}, {{!)}}, {{!!}}. On such a wiki, the code can be simplified a bit to this form:

{{(!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!!}}B1{{!!}}C1
{{!}}-
{{!}}A2{{!!}}B2{{!!}}C2
{{!)}}

틀 포함 제어하기

By default, a template's content is displayed in its entirety, both when viewed directly and when included in another page. However, you can control which parts of a template will be seen and included by the use of the ‎<noinclude>, ‎<includeonly> and ‎<onlyinclude> tags.

‎<noinclude>‎</noinclude> 의 사이에 있는 내용은 그 문서를 직접 접근할 때만 화면에 표시되며, 다른 문서에 포함되어 나타나지는 않는다. 유용하게 사용될 수 있는 경우는 다음과 같다.

  • 틀 사용 방법과 같은 내용

Likewise, anything between ‎<includeonly> and ‎</includeonly> will be processed and displayed only when the page is being included, but not when the template page is being viewed directly, and is useful in situations such as:

  • Categorizing pages which include the template. Note: when changing the categories applied by a template in this fashion, the categorization of the pages which include that template may not be updated until some time later: this is handled by the job queue . To force the re-categorization of a particular page, open that page for editing and save it without changes.
  • Ensuring that the template's code is not executed when viewing the template page itself. Typically this is because it expects parameters, and its execution without parameters has an undesired result.

Everything outside ‎<noinclude> and ‎<includeonly> is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page. The focus is on what is inside these two tags.

Everything outside ‎<onlyinclude> tags is discarded in the transclusion. Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude. The focus is on what is outside this tag.

Nesting of these tags is also possible.

The three partial transclusion tags enable all possible combinations of what is processed and rendered. Comments also fill a role.

틀 조직하기

틀을 효과적으로 사용되려면, 사용자가 틀을 찾아서, 사용하는 방법을 찾아야 합니다.

To find them, users can:

  1. Click 특수 문서 목록 > 모든 문서 목록
  2. In the 이름공간: list, choose Template and click 보기.

To give usage information, include an example like this one on the template page:

<noinclude>
== Usage ==
Welcome users:
{{Thankyou|reason=your reason|signature=your signature}}
</noinclude>

그러면, 사용자는 간단히 예제를 복사해서 사용할 수 있게 된다.

While editing a page, a list of all templates used is available under the editing form, in a collapsible section titled "이 문서에서 사용한 틀:" (also named "이 미리 보기에서 사용하고 있는 틀:", or "이 문단에서 사용하고 있는 틀:" depending on the context). This list provides a convenient link to the template's page, as well as information about its protection status. Redirected templates are shown in italics, with the redirect target added as a separate list item.

틀에 링크걸기

A template page can be linked to like any other wiki page. For example, the link Template:Navbar is generated using the wikicode [[Template:Navbar]].

On many wikis, Template:Tl can be used to provide a link to a template formatted in a way that shows the "double curly-braces" wikicode necessary to transclude the template without actually doing the tranclusion. For example, the code {{tl|Navbar}} may be used to create the link {{Navbar}}.

This construct is commonly used when referring to templates in template documentation, on help pages, and on talk pages. The same effect can be achieved by using {{[[Template:Navbar|Navbar]]}}, but the {{tl}} approach involves much less typing. On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element or as monospace type. If not (as on this wiki), another similarly named template may do so. See, for example, the "See also" section of our Template:Tl documentation.

한 위키에서 다른 위키로 복사하기

Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates.

미디어위키 코드

If you have import rights (specifically importupload) on the new wiki:

  1. Go to Special:Export on the original wiki, and download an .xml file with the complete history of all necessary templates, as follows:
    • Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
    • Select the box "틀 포함하기".
    • Select the box "현재 버전만 포함하고, 전체 역사는 포함하지 않음".
    • "내보내기" 클릭.
  1. Go to Special:Import on the new wiki and upload the .xml file.

If you don't have import rights on the new wiki:

  1. Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
  1. On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
  1. Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

This will copy the entire code necessary, and will suffice for some templates. Note that only page elements parsed in rendering the page get exported, consequently documentation subpages are not exported as part of this process. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well and also copy the code in the modules.

After successfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

확장 기능

An extension often used in templates is ParserFunctions. Visit page 도움말:확장기능:파서 함수 and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the 확장기능:ParserFunctions extension. To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having {{#invoke: }} in template code is a good sign for it. In case it's used, you need to install the 확장기능:Scribunto extension and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS와 자바스크립트 코드

Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.

  1. Look for the use of CSS classes (text like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
  1. If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.

같이 보기

General template usage

  • m:Help:Template – much more thorough manual on how exactly templates function
  • m:Help:Advanced templates – describes even more advanced techniques such as dynamic template calls and variable parameter names

Special constructs used in templates

Other relevant information

External links