Help:Templates/ko

여러 문서에 반복하여 입력해야 할 문장이 있는 경우, MediaWiki의 틀 기능이 유용하게 사용될 수 있다. (도움말 namespace의 모든 문서에 포함되어있는 위와 같은 tag가 틀 기능의 좋은 사용예이다.)

틀 생성하기
틀(Template) 이름은  로 시작하며, 다른 보통의 문서를 만드는 것과 같은 방법으로 생성할 수 있다.

The simplest use of templates is as follows. If you create a page called "Template:Welcome" with contents:

Hello! Welcome to the wiki.

you'll have created your first template! If you then insert the code:

in any other page, when that page is viewed the text "Hello! Welcome to the wiki." will appear instead of. The template content is "transcluded" into the other page, i.e. it is integrated in the page.

You can then insert  at any point of any page where you wish to welcome someone. Suppose it is used in 100 pages. If you then change the template contents to:

Hi there! Welcome to this wonderful wiki.

and revisit any of the 100 pages where the template was used, you'll see the new text instead of the original one. In this way, you have changed the content of 100 pages without editing them, because the template is transcluded into these pages.

This is the basic mechanism. There are several additional features of transclusion that enrich this mechanism and make templates very useful.

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


 * 은 이 코드를 포함하고 있는 문서를 웹 브라우저로 열 때, "틀:이름" 문서의 내용을 그 위치에 포함시킨다. (즉, 항상 최신의 "틀:이름" 문서의 내용을 포함하게 된다.)* 은 이 코드를 포함하고 있는 문서에, "틀:이름" 문서의 내용을 그 위치에 포함시켜서 저장한다. (즉, 문서를 작성하던 시점의 "틀:이름" 문서의 내용을 포함하게 된다.)*  — this was introduced to allow for substitution that doesn't break transclusion, see w:en:Help:Substitution.* 은  와 동일하지만,  를 사용한 것 처럼 위키 문서 문법을 처리하지 않고 문서를 포함시킨다.

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


 * includes *   includes  *   includes  **   replaces itself with the contents of

If no such namespace exists, the full title is assumed to be a template:


 * includes

틀에서 매개변수 사용하기
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:

The thank you note will have a reason (in this case, "all your effort") and a signature ("Me"). Your objective is that any user is 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. hugs,

Notice the use of  and. 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.

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

In this case, the  template receives parameters   and , producing:

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

would produce this result:

Note: identifying parameters by order (with, etc) works only with anonymous parameters. If your page identifies any parameter by number or name, as shown below, this method will no longer be available to the template which receives them.

틀에 이름이 없는 매개변수 사용하기
To pass in parameters by number, identify each parameter when passing it:

This time, template  receives parameters   and , though they have been supplied in inverse order, and produces:

틀에 이름이 지정된 매개변수 사용하기
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. hugs,

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

In this case, template  receives parameters   and   and produces:

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.

Default values
If you transclude a template that expects parameters, but do not provide them, in this way:

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

Since no parameters 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. hugs,

then  defines that if no parameter   is provided, then the value   will be used. Similarly,, defaults parameter   to value. Now, transcluding the template again without passing any parameter, results in the following:

틀의 포함 영역 제어하기
와  를 사용하면 틀의 포함 영역을 제어할 수 있다.

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


 * 틀 분류를 작성할 때* 다른 언어로 작성된 틀에 대한 연결들을 작성할 때* 틀 사용 방법과 같은 내용

반대의 역할을 하는 것이 이다. 와  사이의 문자열은 문서가 다른 문서에 포함될 때에만 화면에 나타난다. 간단한 사용예가 틀을 사용하는 모든 문서들은 category에 포함시키면서, 틀은 그 분류에 포함시키지 않는 경우이다.


 * 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 . 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  and   tags 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.

틀 정리하기
틀이 효과적으로 사용되기 위해서는 사용자들이 틀을 쉽게 찾아서 사용할 수 있도록 해야한다. 가장 간단한 방법은 틀 문서에 사용 예제를 입력해 두는 것이다.

To find them, users can:
 * 1) Click Special Pages > All Pages
 * 2) In the Namespace list, choose Template and click Go.

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

Usage
Welcome users:

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

Copying from one wiki to another
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.

MediaWiki code
If you have import rights on the new wiki:# 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.#* Check the box "Include templates".#* Uncheck the box "Include only the current revision".#* Click Export.# Go to Special:Import on the new wiki and upload the .xml file.

If you don't have import rights on the new wiki:# Go to Special:Export on the original wiki, and download an .xml file with the latest version only of all necessary templates, as follows:#* Enter the name of the template in the big text box.#* Check the box "Include templates".#* Check the box "Include only the current revision".#* Click Export.#* Open the file in a text editor and replace certain XML entities with the corresponding characters: &amp;lt; → <, &amp;gt; → >, &amp;quot; → " and &amp;amp; → &. Because of XML syntax rules, these entities appear in the XML file, but they should not appear in the edit box of the MediaWiki instance.#* Manually copy the text inside the  tag of each listed template into a similarly named template in your wiki. In the edit summary of each template, link to the original page for attribution.

This will copy the entire code necessary, and will suffice for some templates.

Extensions
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. 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  in template code is a good sign for it. In case it's used, you need to install the and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS and JavaScript code
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 priviledges, because you'll be editing system messages in the "MediaWiki:" namespace.


 * 1) Look for the use of CSS classes (text like  ) in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy them to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.# 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.

같이 보기

 * Special:MyLanguage/Help:External searches – a template special use case example
 * Special:MyLanguage/Help:Magic words – fancy stuff you may find in some templates
 * Special:MyLanguage/Help:Parser functions in templates
 * – contains a much more thorough manual on how exactly templates function
 * – describes even more advanced techniques such as dynamic template calls and variable variables
 * – embedding pages from namespaces other than.