위키백과:템플릿 설명서

템플릿MediaWiki의 매우 강력한 기능이지만 새로운 사용자에게 혼란을 줄 수 있고 심지어 경험이 많은 사용자도 더 복잡한 것을 이해하는데 어려움을 겪을 수 있다. 따라서 템플릿에는 사용적합성을 개선하기 위한 문서가 수반되어야 한다.

템플릿 설명서는 템플릿의 기능과 사용 방법을 설명해야 한다. 다른 곳에 주의를 집중하는 경험 많은 기여자를 포함하는 템플릿 구문의 복잡성에 대한 완전한 지식이 없는 사용자가 올바르게 사용할 수 있을 정도로 간단해야 한다. 특히 매우 널리 사용되는 템플릿의 경우 더욱 그러하다.

편집자는 템플릿 문서 페이지가 확립된 커뮤니티 표준 및 원칙과 일치하지 않는 경우 공식 정책 또는 지침을 따라야 한다. 또한 편집자는 템플릿 문서 페이지를 마치 정책인 것처럼 "쿼트"하지 마십시오(이 방법 가이드 포함). 템플릿 문서 페이지는 커뮤니티에 의해 철저히 조사된 위키백과 정책과 달리 별로(있을 경우) 설명 없이 작성될 수 있다(WP: 참조).세부사항에 대한 지역적 합의).

포함시킬 내용

템플릿 문서에는 다음이 포함되어야 한다.

  • 템플릿의 기본 목적: 템플릿이 수행하는 작업과 즉시 명확하지 않은 경우, 템플릿이 왜 필요한지. 이름이나 용도가 비슷한 다른 템플릿이 있다면 잘못된 템플릿이 사용될 가능성을 줄이기 위해 해당 템플릿을 언급하는 것이 좋다. Mobile 웹 사이트의 {{Navbox 가시성} 부족, 특정 국가 또는 기간에만 템플릿을 사용해야 하는지, 템플릿 사용을 선택하기 전에 편집자가 알아야 할 다른 사항 등 중요한 제한 사항을 포함하십시오.
  • 템플릿의 매개 변수: 번호가 매겨지는지, 이름이 지정되는지 또는 선택적인지 여부, 그리고 만약 매겨진 경우 기본값은 무엇이며 어떤 영향을 미치는가. 매개변수가 제한된 값 집합만 취할 수 있거나, 예를 들어 "예", "아니오" 또는 숫자만 사용할 수 있는 경우, 이 점을 명확히 설명해야 한다.
  • 사용 예제: 사용해야 하는 정확한 wikitext와 이를 통해 생성되는 결과를 지정하십시오. wikitxt는 다음과 같이 동봉될 수 있다. <code>...</code> 컨테이너, 명확하게 하기 위해 easy to copy, like this. 선택적 매개변수를 포함하거나 포함하지 않고 여러 가지 방법으로 템플리트를 사용할 수 있는 경우, 예를 들어, 다양한 예를 제공한다. 그렇게 하는 좋은 방법은 템플릿 자체를 문서화(즉, 실시간 예시 사용)에 몇 번이고 매번 다른 매개변수를 사용하여 각 경우에 사용되는 매개변수를 나열하는 것이다. Template:Xpd를 사용하면 wikitext에 템플릿 호출을 두 번 넣지 않고도 수행할 수 있다.
  • 템플릿데이터 태그: 위키백과 참조:템플릿데이터/튜토리얼.
  • 관련 템플릿: 템플릿이 일련의 템플릿 중 하나일 경우 이러한 템플릿에 대한 링크를 포함하십시오. 특히 시리즈의 모든 템플릿이 다른 템플릿에서 연결되었는지 확인하십시오. 이렇게 하면 탐색 작업이 쉬워지므로 (이 용도로 별도의 탐색 템플릿이 유용할 수 있다. 참고: 템플릿:보호 템플릿).
  • 해당되는 경우 범주(InterWikimedia 링크Wikidata에 나열되어야 함 – 위키백과:위키다타). 문서와 마찬가지로 범주는 다음 항목 내에 나열되어야 한다. <noinclude>...</noinclude> 템플릿의 컨테이너 또는 내부 <includeonly>{{Sandbox other ...}}</includeonly> 문서 페이지에 있는 경우 태그를 지정하십시오. 많은 템플릿 범주를 사용할 수 있음: 범주:위키피디아 템플릿에서 검색해 보십시오.

영어 위키피디아는 수백 개의 다른 위키피디아와 자매 프로젝트를 위한 템플릿의 원천이다. 종종, 템플릿은 완전히 자급자족적이어서 프로세스가 쉽다: 내용은 단순히 다른 위키에서 새로운 템플릿 페이지로 복사되고 모든 것이 작동된다. 그러나 더 복잡한 템플릿에서 템플릿은 모듈을 호출하거나,다른 템플릿을 초월하거나, 별도의 템플릿과 쌍을 이루는 경우에만 작동하거나,특정 전투 근무 지원 또는 자바 스크립트 코드가 작동해야할 수 있다. 이러한 경우, 본 문서에 필요한 템플릿 또는 기타 코드의 간략한 목록을 문서 끝에 포함시키는 것이 도움이 된다.

어디에 둘 것인가.

템플릿 네임스페이스에 있는 템플릿 페이지는 해당 템플릿의 모양과 동작을 제어하는 템플릿 코드의 위치 입니다. 일반적으로 렌더링된 템플리트: 페이지(편집 탭의 편집 창이나 코드가 보호되는 템플리트의 경우, 소스 탭은 렌더링된 템플리트 자체로, 템플리트의 렌더링된 문서를 표시하는 별도의 섹션 뒤에 다음이 있는 카테고리: 템플릿이 속함

그러나 템플릿 설명서에 대한 편집 가능한 Wikicode는 템플릿 자체의 별도의 하위 페이지에 배치되는 경우가 많으며, 이 하위 페이지는 템플릿 페이지의 끝 부분에 배치된다. 이것은 종종 복잡한 템플릿 코드를 설명서에서 분리하여 문서를 더 쉽게 편집하고 템플릿 코드의 우발적인 편집 오류 수를 줄인다. 또한 필요한 경우 템플릿을 보호할 수 있어 중요한 템플릿 코드에 대한 편집 액세스가 제한되며, 누구나 템플릿의 설명서를 편집할 수 있다. 이 방법을 "템플릿-doc 페이지 패턴"이라고도 한다.

템플릿 페이지의 모든 분류 문서(TemplateData 포함)는 항상 다음 항목으로 동봉되어야 한다. <noinclude>...</noinclude> 다른 페이지에서 템플릿을 사용할 때 나타나지 않도록 컨테이너.

문서 하위 페이지 작성 방법

템플릿에 설명서 넣기

템플릿을 생성(게시)할 때는 {{documentation}}을(를) 넣어야 한다. 그런 다음 문서 페이지가 생성됨 [view] [edit] [history] [purge] 링크. 이 창에서 클릭하는 템플릿 설명서를 생성하고 편집할 수 있음 [edit] 연결하다

{{documentation}}}을(를) 사용한 템플릿 문서 하위 페이지의 이름을 지정하고 다음과 같은 일반 패턴을 사용하여 포맷하여 일관성을 유지한다.

템플릿 이름이 지정되었다고 가정해 보십시오. Template:X. 템플릿을 편집하여 템플릿 코드의 끝에 다음을 추가하거나, {{subst:doc-code}}}을(를) 사용하십시오.

[--last line of your template code--]<무인용>{noinclude}}<!--- 여기 말고 위키다타에 있는 /doc 하위 페이지와 인터위키스에 카테고리를 추가한다!> </noinclude> 

이것은 템플릿 페이지의 하단에 있는 {{documentation}}을(를) 초월한다.

중요: 개구부 확인 <noinclude> 템플릿 코드 또는 텍스트의 마지막 문자 바로 뒤에 시작되며, 새 줄에서 시작되지 않으며, 공백이 개입되지 않는다. 그렇지 않으면 사용할 때 템플릿 아래에 여분의 공간이 삽입되는데, 일반적으로 이 공간이 필요하지 않다.

템플릿이 이미 보호되어 있는 경우 관리자에게 이 작업을 요청하거나 를 사용하여 편집을 요청하십시오. {{edit protected}} 템플릿의 대화 페이지에서. 문서 및 범주가 이미 섹션에 존재하는 경우, 다음 섹션에 포함됨 <noinclude>...</noinclude> 컨테이너, 해당 컨테이너를 문서 하위 페이지(해당 컨테이너를 동봉해야 함)로 이동하십시오. <includeonly>...</includeonly>() 두 개의 별도 페이지로 문서를 분할하지 않는 것이 가장 좋다.

자동 생성

사용하다 [create] 사전 로드된 문서 하위 페이지를 자동으로 생성하기 위한 빈 문서 상자 하단의 링크. 해당 주석 줄 아래 상단 줄과 카테고리 뒤에 문서를 삽입하고 나중에 페이지를 편집할 때 레이아웃이 유지되도록 주석을 그대로 두십시오. 관련 템플릿, 정책 페이지, 프로젝트 등은 "참고" 섹션을 추가하여 연결할 수 있다. 하위 페이지를 저장하십시오.

수동생성

설명서 하위 페이지를 수동으로 생성하려면 이름을 사용하여 하위 페이지를 생성하십시오. Template:X/doc. {{Documentation 하위 페이지}}의 세부 정보를 참조하거나 다음 표준 wikitxt를 복사하여 페이지를 시작하십시오.

{{문서 하위페이지}}}<!--  페이지 하단에 표시된 범주위키다타에서 인터위키스(interwikis) --> == 사용 == <포함 전용>{모래박스 기타 <!-- 아래범주; 위키다타에서 인터위키스(interwikis) --}}/포함 전용. 

맨 위 줄에는 현재 페이지를 설명하는 메시지와 템플릿 페이지에 대한 링크가 표시된다. 하위 페이지를 저장하고 "템플리트 사용:문서화".

템플릿 데이터 포함

리드 그래프와 사용 테이블을 수동으로 작성하는 대신 {{Format TemplateData} 템플릿이 대부분의 작업을 수행할 수 있다. 테이블 인터페이스에 TemplateData를 작성한 다음 다음과 같은 템플릿 호출로 묶으십시오. {{Format TemplateData 1=<templatedata>...</templatedata>}} 페이지 맨 위에

노트

/doc 하위 페이지의 토크 페이지를 템플릿 자체의 토크 페이지로 리디렉션할 수 있다. 그러면 템플릿과 설명서와 관련된 모든 이야기는 같은 대화 페이지에 남게 될 것이다. 예를 들어, 리디렉션 Template talk:X/docTemplate talk:X.

또한 문서 페이지가 두 템플릿의 사용량을 모두 포함하는 경우 다른 템플릿의 /doc 하위 페이지로 리디렉션될 수 있다. 이 경우 설명서를 보거나 편집하는 링크를 클릭하면 리디렉션의 대상이 직접 열린다. 리디렉션 자체에 액세스해야 하는 경우(예: 리디렉션을 제거하고 별도의 문서 페이지를 작성하려면), 브라우저 상단의 위치 표시줄을 클릭하여 템플릿 URL로 이동한 후 마지막에 /doc을 추가하십시오.

빈칸

문서에서 복사하여 다른 페이지에 붙여넣을 수 있는 빈 템플릿을 생성하려면 다음을 사용하십시오.

{{subst:#tag:pre {{subst:Parameters code base={{subst:BASEPAGENAME}}}} style=overflow: auto;}}

고유한 속성 이름으로 채워진 템플릿의 인스턴스를 생성하려면 다음을 사용하십시오.

{{subst:Parameters demo base={{subst:BASEPAGENAME}} _base=}}

카테고리 및 인터위키 링크

  • 템플릿 자체를 범주에 배치하려면 [[Category:Category name]] 안쪽에 암호를 붙이다 <includeonly>...</includeonly> 문서 하위 페이지의 섹션.
  • 템플릿 자체에 대한 인터위키 링크를 만들려면 Wikidata로 이동하여 페이지에 링크를 추가하는 지침을 따르십시오.
  • 문서 하위 페이지를 범주에 넣으려면 [[Category:Category name]] 내부를 암호로 하다 <noinclude>...</noinclude> 문서 하위 페이지의 섹션.
  • 템플리트가 문서를 카테고리에 배치하려면(문서에 템플리트가 포함된 경우) [[Category:Category name]] 안쪽에 암호를 붙이다 <includeonly>...</includeonly> 템플릿 페이지의 섹션. 템플릿 코드 내의 정확한 위치는 범주 코드가 실행되는 방법에 영향을 미칠 수 있다.

/computer 및 /testcase

템플릿을 변경하기 전에 먼저 템플릿 코드를 샌드박스에 복사하고 몇 가지 테스트 케이스를 실행하는 것이 좋을 수 있다. 템플릿은 수천 또는 수백만 페이지에 표시될 수 있기 때문이다. 템플릿에 "/샌드박스" 및 "/테스트케이스"라는 이름의 하위 페이지를 만들면 템플릿의 녹색 상자가 자동으로 이를 감지하고 해당 페이지에 대한 링크를 헤더에 표시한다. 위키백과 참조:자세한 내용을 보려면 템플릿 샌드박스테스트 사례.

여러 템플릿, 하나의 문서 페이지

여러 개의 템플릿이 함께 작동하거나 매우 유사할 때, 함께 문서화하는 하나의 문서 페이지를 유지 관리하는 것이 종종 명확하고 더 쉽다. 가장 간단한 방법은 템플릿 중 하나에 전체 문서 페이지를 만든 다음 다른 템플릿에서 "소프트 리디렉션"을 만드는 것이다. 예: {{wrap}}}을(를) 참조하십시오.

템플릿 페이지에서 직접

문서 하위 페이지가 생성되지 않은 경우, {{documentation} 템플릿은 content= 실제 템플릿 페이지의 매개 변수, 그런 다음 템플릿 자체를 범주에 배치하려면 추가 [[Category:Category name]] 문서 템플릿의 내용 뒤에 예를 들어, 실제 템플릿 페이지에 배치하는 경우:

<!--템플릿 코드의 마지막 줄--><무효> {{문서화    내용물 = <!-- 템플릿. 문서화 -->  [[카테고리:카테고리 이름을 붙이다]] [[카테고리:카테고리 이름2]] }}</없음> 

문서가 필요하지 않은 경우

표시된 템플릿이 문서로 사용될 수 있는 페이지에 링크되면 별도의 설명서가 불필요하므로 작성할 필요가 없다. 예를 들어 스텁 템플릿은 {{asbox} 템플릿을 기본으로 사용하여 해당 템플릿을 사용하는 모든 스텁 템플릿에 대해 이미 사전 로드된 공통 문서를 표시하므로 추가 설명서가 필요하지 않다.

팁과 요령

문서 작성을 용이하게 하기 위한 몇 가지 팁:

  • {{1800년일본해}}}}과같은템플릿에대한 링크는{{1800년tlp일본해}}을(를)작성하면삽입할 수 있다. 유사한 템플릿은 {{tlp}}을(를) 참조하십시오.
  • HTML 태그: <ref group="note">...</ref> {{tag}}}로 쉽게 삽입할 수 있다. 이 예는 {{tag ref params=group="note"}}}로 기재되어 있다.
  • Equals 기호 = {{=}}과(와) 함께 삽입할 수 있다. 예를 들어, {{Citation required date=1900-02-29}}은(는) {{tlp 인용 필요일자{{=}1900-02-29}에 의해 만들어진다. 다른 편집자의 경우 읽기 쉽지 않은 등가 표기법 &#61은 피하십시오.
  • 싱글 잊지마 <nowiki /> 태그. [[]<nowiki />예]가 [[example]이 되고 [ []이 된다.<nowiki />http://en.wikipedia.org no link]는 [http://en.wikipedia.org no link]이다. WP 참조:노위키 자세한 내용은.
  • 범주에 대한 링크의 경우 {{cat}}을(를) 사용하십시오. 예를 들어 잘못된 매개 변수 구문}을(를) 가진 {{cat 템플릿이 Category가 되는 경우:매개 변수 구문이 잘못된 템플릿.
  • 템플릿의 /sandbox 및 /테스트케이스 페이지(있는 경우)의 분류를 억제하려면 설명서 하위 페이지 하단에 있는 다음 코드를 사용하십시오.
<오직>{{모래톱을 치다 타사의  {{시험장 타사의   <!-- 분류 아래에  선을 긋다, 마음에 들다; 인터위키스 에서 위키다타 -->  }}}}</영화만> 
  • 템플릿이 하위 infobox인 경우 설명서가 깨진 것으로 나타난다. [포함 전용] 태그를 추가하여 이 문제를 방지하십시오.
{{일부 infobox(차일드) 템플릿 자식 = </포함 전용> 레이블1 = Hello data1 = 월드 }}}{noincludement}}</noinclude> 

참고 항목