Help:TemplateData/ko

는 위키텍스트 틀과 변수에 관한 정보를 저장하는 방법입니다. 이로써 시각 편집기는 해당 정보를 검색하고 틀 편집기 안에 표시할 수 있게 되며, 해당 틀을 사용하는 문서를 더 쉽게 편집할 수 있습니다. 이 밖에도 스크립트, 도구, 소도구 등의 장소에서 사용됩니다.

틀데이터 확장기능은 위키미디어 재단에 의해 모든 위키에 설치되어 있습니다. 위키를 직접 소유하고 있다면, Extension:TemplateData를 설치해야 합니다.

틀데이터의 문법은 사용자가 틀 문서에 구조화된 조그마한 부분의 데이터를 기록하거나, 해당 틀 문서(틀 설명문서 등)에 끼워넣을 수 있게 해줍니다. 틀에 이 구조화된 데이터가 있으면 시각 편집기에 올바르게 표시할 수 있습니다. 복잡하게 들릴 수 있겠지만 실제로는 매우 쉽습니다.

틀데이터 편집기
더 단순한 방법으로 틀데이터를 편집하기 위해 내장된 도구가 있습니다.

틀데이터 편집기를 사용하려면, 틀의 문서(또는 설명문서의 하위 문서)로 이동한 다음 "편집" 버튼을 누르십시오. 그러면 열려있는 편집 창 바로 위에 "" 버튼이 나타납니다.

틀데이터 편집을 위해 GUI 도구로 들어가려면 이 버튼을 누르십시오.

편집기를 사용하면 틀 변수를 추가하고 가장 일반적인 속성을 설정할 수 있습니다. 편집한 문서에 이미 틀데이터 블록이 포함되어 있다면 이미 문서화된 정보는 틀데이터 편집기에서 올바른 문서를 열 때 자동으로 표시됩니다. 첫 번째 상자에 틀에 관한 짧은 설명을 플레인 텍스트로 추가하거나 수정할 수 있습니다. 그 다음 "제안되는 변수 추가" 및 "변수 추가" 버튼을 사용하여 해당 틀이 사용하는 변수의 이름과 속성을 문서화할 수 있습니다.

틀 문서가 보호되어 있다면 틀 코드를 하위 문서로 복사-붙여넣기 한 다음 그 위치에서 "제안되는 변수 추가" 버튼을 사용하고 틀데이터 내용을 복사하고 하위 문서로 돌아와 틀 코드 제거를 위해 편집한 다음 틀데이터 내용을 붙여넣을 수 있습니다. 틀데이터 내용을 하위 문서의 어느 위치에 붙여넣을지 확인하려면 틀데이터를 내용추가 없이 편집합니다. 그다음에 태그, 및 그 사이에 있는 내용을 아까 복사한 틀데이터로 덮어씁니다.

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. You can also provide an example how to use the parameter. The only required field is Name (the first field in each row), which is where you record the exact, case-sensitive name of the parameter. In the "Type" dropdown menu, you can choose the type of content that the parameter should receive, such as a string (for plain-text answers), page (for links to other pages), or dates. If the template will produce an error if this parameter is left blank, please mark it as "Required". If the parameter is commonly used or recommended, then mark it as "Suggested". The "Remove parameter information" button will delete the parameter's entry from TemplateData.



When you are finished documenting each of the parameters, click "Apply" to insert the pre-formatted TemplateData into the open editing box. You must still save the page, using the normal "Save" button underneath the editing window.

Caution: The TemplateData editor will place TemplateData on either the template page or on a documentation subpage. You determine where the TemplateData will be added by opening (editing) the page that you want the TemplateData to be placed on. However, if multiple TemplateData blocks are placed on the same template, then only one of those TemplateData blocks will be used. If there is already TemplateData on a page, then you need to edit the page where the TemplateData was previously placed to avoid accidentally creating multiple blocks of TemplateData.

제한 및 질문

 * 없는 기능 — TemplateData is an example of a tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * 틀 내의 표시 지연 — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in the visual editor. However, it is possible that it will take several hours before the metadata will show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change and without adding any edit summary.
 * 현재 이슈 — 현재 버그와 기능 요청 목록은 위키미디어 버그 트래커에서 볼 수 있습니다.

틀데이터의 위치
TemplateData shall be on the page it describes, or be transcluded into it. In a template, it shall typically be wrapped into tags. On normal page rendering, it displays autogenerated documentation as shown in #Example.

틀데이터의 구조
TemplateData's structure is based around the JSON standard. Note that all descriptions in TemplateData must be in plain text (no wikitext, no links, etc.).

The first thing to do is to type out a pair of  tags, anywhere on the template's documentation subpage, like so:

This tells the software that everything between the two tags is TemplateData, and should be referenced when the template is used.

예시
The descriptions inside TemplateData follow a standard layout; let's say that you have a template called "Commons" for linking to a Commons category about a topic. It takes one mandatory parameter: the name of the category on Commons. The TemplateData would look something like this:

This would display, in the template, like so:

{   "description": "A template for linking to a commons category about an article", "params": { "1": {           "label": "Commons category", "description": "The commons category you want to link to.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

설명 및 변수
Once you're done, hit "save". If you've made errors, it will not let you save (which is disruptive, but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.

Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

Note that each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).

사용자 지정 형식
When editing custom format strings in the TemplateData editor you can either type  or press the enter key to represent a newline; in either case it will display as   in the entry field.

{| class="wikitable" ! style="width:25%" | Objective ! Format string ! 출력 each template on its own line
 * + Examples of formats you can use
 * Inline formatting
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * Indent each parameter
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Pipe characters at the end of the previous line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Template at the start of a line, indent-aligned parameters, pipe beforehand
 * could also be written as  or.
 * could also be written as  or.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:

Auto value
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use the prefix  with the values to make them stick:

여러 개의 변수
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:

비슷한 변수
When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.

Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

Syntax Error in JSON / Bad JSON format
Due to a long standing bug, users using the old wikitext editor are able to save pages which have certain types of invalid JSON, such as duplicate keys or trailing commas (details: ). However if you attempt to save this page in a JavaScript based editor, such as VisualEditor or the 2017 Wikitext editor, you will see an error message "Syntax error in JSON," as the JavaScript parser is stricter and doesn't allow invalid JSON. Additionally, if you attempt to open up such invalid JSON with the Template Data GUI editor, you will see the error message, "Bad JSON format." To fix these errors, you can enter the JSON block into an external JSON validator, such as JSONLint, and it will highlight the problematic commas and keys so they can be removed.

다른 도구

 * : A toolbar dialog window for entering template wikitext via an form built from TemplateData.
 * TemplateData Wizard: A tool that generates TemplateData through an interactive interface.
 * Skeleton TemplateData generator: A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint: A tool that allows you to validate manually-written JSON to help find errors in the syntax.
 * List of all templates with TemplateData on this wiki
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data