위키백과:템플릿데이터/튜토리얼

---

• 메인 페이지
• MediaWiki 또는 로컬 피드백
• 샌드박스 (계정은 필요 없음)

---

정보

---

• 개발자들은 왜 이것을 만들고 있는가?
  • 사용자 테스트 데이터
• 설명서:
  • 입문 자습서
  • 사용자 안내서
  • 바로 가기 키
  • 자주 묻는 질문(또는 MediaWiki에서)
• 개발:
  • 로드맵
  • 업데이트
  • 주간 상태 보고서

---

도와줘

---

• 도움말 페이지 업데이트
• 템플릿 데이터 추가(튜토리얼)
• 문서 번역 및 현지화

---

리서치

---

• 메인 리서치 페이지

---

기타

---

• 사용자 지정
• 알려진 문제
• 의견 요청(RfCs): 2013년 7월 a, 2013년 7월 b, 2015년 7월, 2015년 9월

TemplateData는 VisualEditor가 이를 검색하여 템플릿 편집기를 채울 수 있도록 매개변수 이름 또는 템플릿 설명과 같은 템플릿에 대한 정보를 저장하는 방법이다.표시되는 실제 템플리트에 대해서는 아무것도 변경하지 않으며, 템플리트데이터를 사용하여 수행할 수 있는 어떤 작업도 기존 위키백과 템플리트의 기능에 영향을 미치거나 "파쇄"할 수 없다(템플릿데이터에 나타나는 실수로 인해 편집자가 관련 템플리트 또는 매개변수를 잘못 사용할 수 있으므로 여전히 주의가 필요함).) TemplateData는 미디어에 의해 제어된다.사용자가 구조화된 데이터의 작은 비트를 템플릿 페이지에 쓰거나 해당 템플릿 페이지(예: 표준 문서 페이지)로 변환할 수 있는 Wiki의 TemplateData 확장.템플릿에 이러한 구조화된 데이터가 있으면 VisualEditor에 적절하게 표시될 수 있다.이것이 복잡하게 들릴지 모르지만, 실제로는 매우 쉽다.

TemplateData 사용 방법

TemplateData의 구조

TemplateData의 중앙 구조는 JSON 형식으로 인코딩되며 스키마는 상당히 단순하다.제일 먼저 해야 할 일은 한 켤레를 타이핑하는 것이다.<TemplateData>내부 템플릿 페이지 자체에 태그 직접 표시<noinclude>...</noinclude>태그 또는 템플릿 설명서 하위 페이지에 다음과 같은 태그가 있는 경우:

<템플릿데이터> 템플릿데이터는 </템플릿데이터>로 이동한다.

N.B. 앞의 코드는 그대로 사용할 경우 잘못된 코드이므로, 사용할 경우 JSON 오류를 발생시킬 수 있다. 자세한 내용은 아래 #TemplateData 정보 완료를 참조하십시오.

이것은 소프트웨어에 두 태그 사이의 모든 것이 TemplateData이며, 템플릿이 사용될 때 참조되어야 함을 알려준다.TemplateData 자체는 템플릿 내에서 설정할 수 있는 파라미터를 식별하는 표준 레이아웃을 따른다.

영어 위키백과에서는 {{Format TemplateData} 템플릿을 사용하여 템플릿 설명서에서 사용하기에 적합한 TemplateData의 보다 "일반적인" 프레젠테이션을 생성할 수도 있다.위의 내용 대신 문서 페이지의 맨 위에 다음과 같이 기록하십시오.

{{포맷 템플릿 데이터  1=<템플릿 데이터> 템플릿 데이터 간다 여기에 </템플릿데이터> 토씨=1 }} 

템플릿 데이터

TemplateData가 내부 템플릿 페이지에 추가됨<noinclude></noinclude>태그 또는 템플릿의 문서 페이지에 있는 태그.권한이 없는 사용자의 편집을 막기 위해 메인 템플릿 페이지가 잠기는 경우도 있다.이 경우 TemplateData는 /doc 페이지에만 추가할 수 있으며, 해당 페이지에 대한 링크는 기본 페이지 하단에 있다.

TemplateData는 일반적으로 템플릿에 대한 설명 정보 뒤에 "참조" 섹션 앞에 배치된다.

참고: {{TemplateData 헤더}를 <templatedata> 태그 바로 앞에 추가해야 한다.이렇게 하면 페이지를 TemplateData 문서로 분류하고 나중에 템플릿과 문서를 구성할 수 있다.

매개변수 식별

템플릿에 매개 변수가 없는 경우 단순 줄의 TemplateData 블록을 완료하십시오. "params": {}. 이 줄을 포함하지 않으면 페이지를 저장할 수 없다.이렇게 하면 템플릿의 TemplateData가 완료된다.

그러나 대부분의 템플릿에는 날짜, URL, 아티클 이름, 이미지, 숫자 또는 문자열과 같은 매개 변수가 있다.템플릿에 사용되거나 사용될 수 있는 매개 변수를 결정하십시오.매개변수는 동일한 기호로 전달될 수 있다.예를 들어,{{cite web}}템플릿은 다음과 같은 인용을 완료하기 위해 전달된 값이다.url=,title=,access-date=, 등. 그 대신 다른 매개변수를 그들의 위치에 의해 사용할 수 있다.이 경우 숫자 "를 사용하십시오.1", "2매개변수 이름 대신 " 등.

기본 페이지 또는 하위 페이지의 템플릿 설명서는 템플릿에 설정할 수 있는 매개변수와 각 매개변수가 포함해야 할 사항을 요약할 수 있다.또한 TemplateDate는 템플릿 문서 페이지에 포함되어야 한다.

TemplateData 정보 완료

TemplateData 정보는 편집자가 템플릿을 사용하는 방법에 대한 정보일 뿐이라는 점을 기억하십시오.정보 오류를 포함하는 TemplateData 항목을 만들면 문서에서 해당 템플릿을 사용하려는 편집자에게 문제가 발생할 수 있지만 여기서 수행하는 작업은 해당 템플릿에 영향을 미치지 않는다.

가장 먼저 작성해야 할 정보는 다음과 같다."description"전체 템플릿의 경우, 템플릿이 수행하는 작업을 간략하게 설명하고 사용자가 이를 사용하고자 하는 위치와 방법을 설명한다.템플릿이 생성되어 사용자보다 먼저 다른 사람에 의해 어떤 종류의 설명을 제공받은 경우, 템플릿의 기본 페이지 또는 하위 페이지 맨 위에서 수집하는 정보를 사용할 수 있으며, 이 정보를 복사하여 여기에 붙여넣을 수 있다.따옴표 안에 넣고 쉼표로 따르십시오."description": "This template generates an information box for Croatian football players",. TemplateData 테이블에서 다음과 같은 모든 wikitxt를 입력했다는 점에 유의하십시오.[[Croatian football]]어떤 기능도 보유하지 않으며, 문자의 문자인 일반 비연계 텍스트로 나타날 것이다.

다음, 다음 항목을 생성하십시오."params"가새(brace)로 막다.{그리고}이 블록 내부에 다음 항목 중 일부를 사용하여 템플릿에서 사용하는 각 파라미터에 대한 하위 블록을 생성해야 한다.대부분은 선택 사항이지만, 당신이 더 많은 정보를 줄수록 다른 사람들이 템플릿을 다시 사용하는 것이 더 쉬워질 것이다.

• 짧은 임의 항목 만들기 또는 사용"name"위키백과 템플리트 소프트웨어에서 읽을 매개변수.사용하는 경우 또는 템플릿에 둘 이상의 단어가 포함된 매개 변수 이름이 있는 경우, 이러한 이름을 항상 밑줄로 구분하십시오._다음과 같은 경우:ocean_size(즉, 매개변수 이름에 공백이 없음)큰따옴표 사이에 놓고 콜론(colon)으로 따라 한 번 더 가새로 블록을 만드십시오.{그리고}다음과 같은 경우:"ocean_size": { }또는"range_map": { }. {{Infobox Fabergé alg}}과 같은 많은 템플릿에는 "이름"이라고 하는 변수가 있으므로 이 파라미터에 대한 JSON 코드가 기록된다는 점에 유의하십시오."name": { }. 다음 코드는 이제 이러한 가새 범위 내에 들어가며, 각 가새 끝에는 쉼표로 구분되지만 마지막에는 쉼표로 구분되지 않으며, 추가 가새도 없다(참고 항목 순서는 관련이 없다는 점에 유의하십시오. JSON TemplateData 코드를 읽을 때 일관된 패턴으로 정렬됨).
  • 그"label"entry는 템플릿 편집기에 표시될 매개 변수의 사용자가 읽을 수 있는 제목이다.레이블의 첫 번째 문자를 대문자로 표시하고(결과 표에서 가장 왼쪽 값이 되므로) 다음과 같이 따옴표로 표시하십시오."Ocean size":.
  • 매개 변수 입력"description"(즉, 템플릿 전체가 아닌 특정 파라미터에 대한 설명).이는 템플릿의 기본 또는 문서 페이지에 이미 작성되었을 수 있으며 복사하여 제자리에 붙여넣을 수 있다.이 정보를 인용구에 넣으세요.만약 당신이 당신의 설명이 인용구에 단어나 구를 표시하기를 원한다면, 당신은 백슬래시를 넣어 인용 부호를 피해야 한다.\이렇게 바로 앞에:"This parameter indicates the \"size\" of the ocean"따옴표 바로 앞에 백슬래시를 제공하지 않는 경우, JSON 소프트웨어는 이 표시를 파라미터 블록의 끝 부분으로 해석할 것이다. 즉, 백슬래시는 JSON에게 "날 따라오는 따옴표를 직접 계산하지 마십시오. 눈에 보이는 따옴표로 표시하고 더 나아가서 파라미터 끝의 따옴표를 찾으십시오."라고 말한다.따옴표로 표시하려는 단어가 매개 변수 설명의 맨 끝에 있으면 입력만 하면 된다.\""다음과 같은 경우:"This parameter indicate the ocean \"size\""원하는 대로 두 개의 따옴표 사이에 다른 문장 부호(콤마, 세미콜론, 대장, 가새, 괄호, 이중괄호 등)를 포함할 수 있다.그러나 실제 백슬래시가 필요한 경우\본문의 일부로서, 다음과 같은 또 다른 백슬래시로도 그 부분을 피해야 할 것이다.\\.
  • 선택적으로 매개 변수 상태에 대한 플래그를 설정할 수 있다.
    • "required"매개 변수 작성은 해당 템플릿에 대해 필수 사항.이 설정만true템플릿에 값이 필요하며 값을 설정하지 않으면 템플릿이 깨진다(Cite 웹의 URL처럼).이 플래그에 대한 항목은 단어여야 함true또는false, 인용 부호 없음.
    • "suggested"이 변수는 템플릿의 대부분의 사용자가 작성하고자 할 변수(예: 인용의 출처 날짜)라고 말한다.템플릿에 제안된 매개 변수가 항상 하나 이상 있어야 함.맘에 들다required, 두 단어 중 하나를 사용하라.true또는false, 인용 부호 없음.
    • "deprecated"이 파라미터가 정기적으로 사용 중인지 아닌지를 플래그로 설정할 수 있음 - 뿐만 아니라true사용자가 대신 무엇을 해야 하는지에 대한 간단한 설명을 쓸 수 있다.드물다.
  • 그"aliases"그룹에서는 이 매개변수의 다른 이름을 나열할 수 있으며, 매개변수의 입력은 단일 괄호로 묶는다."aliases": [ "2", "Caption", "imagecaption" ]. 별칭은 기본 이름 대신 템플릿이 수락하려는 매개 변수의 대체 이름이다.별칭은 별도의 매개변수 객체에 문서화되지 않는다.
• 그"autovalue"항목을 입력하면 VisualEditor 및 기타 도구를 통해 이 매개 변수를 표준 값(wikitext)으로 미리 채우도록 지시할 수 있다. 이 텍스트는 사용자가 편집할 때 매개 변수 상자에 표시되며 저장될 때 템플릿 호출에 추가된다.이것은 사용자가 템플릿을 추가하는 날짜를 자동으로 설정하는 정리 템플릿에 유용할 수 있다.예를 들어, 추가"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"편집자가 템플릿을 사용할 때(예: 편집) "2022년 3월"이 자동으로 추가된다.자동 값은 템플릿 대화 상자에서 제공된 값을 제거하기만 하면 편집자가 변경할 수 있다.이 하위 그룹 기반 방법은 <ref> 태그, 갤러리 태그 또는 기타 확장별 태그 내에서 사용되는 템플릿에는 적용되지 않는다는 점에 유의하십시오.TemplateData 코드를 작성하는 사람이 설정했는지 여부에 관계없이 이 항목은 결과 TemplateData 테이블에 항목으로 표시되며, 수동으로 작성하지 않으면 "빈"이라는 단어가 뒤따른다.
• 그"default"설정을 사용하면 이 매개 변수가 설정되지 않은 경우(또는 설정되지만 공백으로 남겨진 경우) 템플릿의 작업을 표시할 수 있다. 이 텍스트는 사용자가 편집할 때 매개 변수 상자에 밝은 회색 텍스트로 표시되지만 사용자가 템플릿 호출에 값을 수동으로 재정의하지 않는 한 저장되지 않는다.드문 경우. 이 항목은 항상 결과 TemplateData 테이블에 표시되며, TemplateData 코드를 작성하는 사용자가 수동으로 작성하지 않을 경우 "비어 있음"이라는 단어가 뒤따른다.
• 그"example"입력은 사용자가 이 변수에 대해 작성할 수 있는 항목의 예를 표시할 수 있으며, 입력 유형이 이미 다음 항목으로 설정된 경우 문자별 문자"type"매개변수(아래 참조), 예제는 이를 반영해야 한다(즉, 유형이 "wiki-page-name"으로 설정된 경우 예제에 "File:" 또는 "Image:"와 같은 접두사를 포함해서는 안 된다.예제의 전체 텍스트를 따옴표로 묶으십시오.분명히, 이것은 실제 예가 인용 부호 자체를 포함하지 않을 수도 있다는 것을 의미한다.TemplateData 코드를 작성한 사용자가 작성하지 않은 경우, "비어 있음"이라는 단어가 뒤따른다.
• 그"type"템플릿 편집기가 해당 파라미터를 해석하는 방법을 제어하는 기능.이는 몇 가지 값 중 하나일 수 있으며, 사용된 값 중 하나는 큰따옴표로 묶어야 한다.

• "inherits". 이것은 또 다른 매개변수의 핵심이다.현재 매개 변수는 이 매개 변수로부터 상속되며 로컬 속성이 상속된 매개 변수를 재정의한다.아주 드물다.현재 템플리트화된 하위 블록에 이 매개변수를 포함하면 페이지가 필수 속성 "파람"을 찾을 수 없게 된다. 오류 및 예상 테이블을 생성하지 못함

둘 이상의 매개 변수 하위 블록이 템플릿에 전달되는 경우 닫힌 가새 뒤에 쉼표를 추가해야 한다.},, 하위 블록들 사이에.세트의 마지막 하위 블록 뒤에 쉼표를 표시하지 말고, 마지막 닫힘 버팀대가 있는지 확인하십시오.}.

추가 옵션"format"VisualEditor가 템플릿을 저장할 때 템플릿의 wikitext 코드가 포맷되는 방식을 결정한다.이것은 선택사항을 가질 수 있다."format": "inline"(기본값) 또는"format": "block". 인라인 옵션으로 템플릿의 wikitxt를 단일 행으로 포맷함{{Sister project project = commons text = page in commons}}블록 옵션으로 각 파라미터는 단일 라인을 취함

{{인포박스 텔레비전 쇼_name = 테드 신부 장르 = 코미디}}}

이 옵션은 여러 개의 매개 변수를 가진 infobox와 같이 매우 복잡한 템플릿에 대해 선호할 수 있다.설명서 페이지에는 "이 템플릿은 매개 변수의 인라인 형식을 선호한다." 또는 "이 템플릿은 매개 변수의 블록 형식을 선호한다"라는 라인이 있는 형식을 나타냈다.

저장하다

끝나면 '저장'을 눌러라.오류가 발생하면 저장하지 않게 된다. 이는 JSON이 첫 번째 코드 오류가 발생한 위치를 알려주지 않고 실수로 잘못된 형식의 테이블을 올리거나 "파쇄"할 수 없다는 것을 의미하므로 다소 답답할 수 있다.코드 오류로 인해 저장할 수 없는 경우 다음과 같은 몇 가지 일반적인 문제를 참조하십시오.

• 모든 시작 인용문인지 여부(") 코드가 올바른 위치에 있는 종료 인용문과 일치하는지 여부
• 매개 변수에 대한 설명과 같은 문자열에"그게 엔트리의 끝에 있지 않다고 생각하나?그렇다면 다음 구성 요소로 교체해 보십시오.'.
• 모든 개구부 가새(braction brace().{) 클로징 버팀대와 일치().})은(는) 정확한 위치에?
• 매개 변수 블록 사이에 쉼표가 있는가?(하나 있어야 한다.

프로그램을 통해 이러한 오류를 수동으로 검색하는 것은 지루하고 어려울 수 있다.다행히도, JSON을 위한 많은 프로그램 점검 웹사이트가 존재하며, 적어도 프로그램이 처음 오류를 발견한 선을 식별할 것이다.[1]은 꽤 효과가 있는 것 같은 것 중 하나이다.문제가 있는 JSON 코드를 복사하여 웹사이트의 해당 상자에 붙여넣고 코드를 확인하도록 요청하십시오. 문서의 모든 오류를 항목화하지는 않지만, 코드 수정 시 큰 도움이 될 수 있는 첫 번째 오류를 나타낼 수 있다.

페이지를 성공적으로 저장하면 TemplateData가 VisualEditor에 통합되는 데 몇 분 정도 걸릴 수 있다.몇 분 후에도 통과되지 않으면 기본 템플릿에서 null을 편집하여 이 문제를 해결할 수 있다.많은 템플리트가 보호되므로 {{editprotected}}을(를) 사용하거나 위키백과 대화에 메모를 남겨 null 편집을 요청하십시오.VisualEditor/TemplateData 자습서.

작업 예제

{{Str 왼쪽}} 템플릿은 다음과 같이 사용하는 간단한 템플릿{{Str left <string> <count>}}입력의 처음 몇 글자를 나타내기 위해.두 개의 매개변수를 가지고 있는데, 두 매개변수는 모두 이름이 지정되지 않았으며(이 매개변수는 템플릿의 위치에 의해서만 인식됨), 두 매개변수 모두 필요하다.따라서 이 템플릿의 TemplateData는 다음과 같을 수 있다.

<목화목> {  "description": "입력 시작부터 처음 몇 자를 주어라",  "파람스": {   "1": {    "label": "입력",    "description": "잘라서 세는 끈",    "required": 진실의,    "형식": "끈"   },   "2": {    "label": "길이",    "description": "반환해야 할 입력 문자 수",    "required": 진실의,    "형식": "숫자"   }  } } </templatedata> 

... 템플릿에 다음과 같이 표시된다.

전체 빈 템플릿데이터 블록

당신은 이것을 복사해서 붙여넣기만 하면 당신 자신의 것을 만들 때 사용할 수 있다.

<목화목> {  "description": "zzzzz",  "파람스": {   "첫 번째 매개 변수": {    "label": "x",    "description": "xxx",    "required": 거짓의,    "suggested": 거짓의,    "example":"x",    "사용되지 않음": 거짓의,    "별칭": [],    "자동값": "자동 값",    "기본값": "기본값",    "형식": "끈"   },   "두 번째 매개 변수": {    "label": "Y",    "description": "yyy",    "required": 거짓의,    "suggested": 거짓의,    "example": "x",    "사용되지 않음": 거짓의,    "별칭": [],    "자동값": "자동 값",    "기본값": "기본값",    "형식": "숫자"   }  },     "세트": { } } </templatedata> 

공유 문서

많은 템플릿이 동일한 문서를 공유한다.TemplateData를 하위 페이지에 두면 문서 페이지가 일반적으로 보호되지 않아 모든 편집자가 문서를 업데이트할 수 있다는 장점이 있다.그러나 TemplateData가 공유 문서 페이지에 포함된 경우 일부 템플릿이 잘못된 템플릿 데이터 섹션을 선택하게 된다.

이 문제는 TemplateData를 개별 하위 페이지(Template:col-begin/doc에서 Template:Col-begin/TemplateData) 또는 템플릿 페이지 자체({collapse top} 참조)대안 기법은 각 스위치 블록에 서로 다른 템플리트 섹션이 있는 문서 페이지에서 사용하는 것이다.

도움

오류가 발생하면 피드백 페이지에서 무엇을 하려 했는지 설명하십시오. 그러면 기꺼이 도와 드리겠습니다.

예

매개 변수가 없는 템플릿: {{fixed}}.매개 변수는 빈 목록으로 제공되어야 한다는 점에 유의하십시오.

<템플라타>{ "설명" : "틱 마크를 표시하고 고정된 단어를 표시한다.매개 변수를 사용하지 않음.", "params": { }</templatedata"

별칭이 있는 템플릿 {{quote}}:

<>templatedata>,{"설명":"블록을 인용 추가합니다.","params":{"텍스트":{"라벨":"텍스트","설명":"그 텍스트를 인용하다","형식":"문자열","필요한":거짓,"가명":["1,"quote"]},"서명하":{"라벨":"서명하","설명":"그것을 인용하자면 사람은","형식":."string", "필수": false, "aliases": [2, "cite" ] ], "source": { label": "source", "description": "type": "string", "필수": false, "aliases": [3" } }/templata.

기본값 {{col-6}이(가) 있는 템플릿.참고 기본값은 매개변수가 지정되지 않은 경우 템플릿에서 사용하는 값이다.이 예에서는"format": "block"옵션의

<>templatedata>,{"설명":"6개가 있을 때 열은{{col-begin}과 디렉터리 사용할 새 칼럼을 시작합니다.","params":{"폭":{"라벨":"폭","설명":"열 너비.","형식":"문자열","기본":"16.66%","가명":["w"],"을 요구한다.d":false }, "경고": { "경고", "설명": "수평 정렬", "유형": "끈", "기본값": "좌", "필수": "필수": "경고": {레이블: "경고 정렬": "수직 정렬", "기본값": "상단""유형": "string", "throught": false } }, "format": "block" } </divatedata>

제한사항 및 질문

TemplateData는 기존 템플릿을 편집하는 데 유용하지만, 현재 새 템플릿을 생성할 때 매개 변수를 자동으로 가져오지 않는다.그것을 할 수 있는 능력이 지금 작용하고 있다.구현과 기존 템플릿에 나타나는 것 사이에는 약간의 지연이 있는데, 이것은 디버깅을 약간 어렵게 만든다.또한 TemplateData가 생성된 후 VisualEditor에 나타나기 전에 약간의 지연이 있다.

템플릿 데이터는 이전에 65,535바이트로 제한되었다(Phabricator:T53740).{{Infobox Officeholder}}와 같이 많은 파라미터를 사용하는 일부 템플릿의 경우 이 한도를 초과할 수 있지만, 현재 코드가 압축되어 한도를 증가시킨다.

도구

TemplateData 편집기

• TemplateDataEditor TemplateData를 쉽게 추가하는 사용자 스크립트.
• 다른 템플릿 데이터 편집기
• 템플리트데이터 스켈레톤 - 템플리트의 원본을 읽고 사용된 모든 매개변수를 찾아 나열된 매개변수가 있는 스켈레톤 문서를 출력하십시오.Javascript 도구 상자 팝업.
• 모듈:TemplateDataGenerator – 스켈레톤 생성기를 템플릿으로 사용하여 하위 시스템에 연결.
• {{Format TemplateData}}(모듈 사용:템플릿 데이터 형식) 문서 페이지에서 템플릿 데이터 섹션의 모양을 포맷하는 데 도움이 된다.
• 루:코바하르하르드:TemplateDataDoc은 TemplateData에서 빈 복사본 및 사용 예제를 작성할 수 있다.그 모듈은 러시아어로 되어 있다.

외부 링크

MediaWiki에 관련된 문서가 있음: 확장:템플릿데이터#템플릿 정의데이터 블록

• Jsonlint는 템플릿 데이터 구문의 오류를 찾는 데 도움이 되는 JSON 검증 도구.