Wikipedia:템플릿 문서

무료 백과 사전, 위키피디아에서
탐색으로 이동 검색으로 이동

템플릿 은 MediaWiki 의 매우 강력한 기능 이지만 새로운 사용자에게는 혼란을 줄 수 있으며 숙련된 사용자라도 더 복잡한 것을 이해하는 데 어려움을 겪을 수 있습니다. 따라서 템플릿은 사용성을 향상시키기 위한 문서 와 함께 제공되어야 합니다.

템플릿 문서는 템플릿이 무엇을 하고 어떻게 사용하는지 설명해야 합니다. 템플릿 구문의 복잡성에 대한 완전한 지식이 없는 사용자(다른 곳에 관심을 집중하는 경험 많은 기여자를 포함)가 올바르게 사용할 수 있을 만큼 간단해야 합니다. 이것은 매우 널리 사용되는 템플릿의 경우에 특히 그렇습니다.

편집자는 템플릿 문서 페이지가 확립된 커뮤니티 표준 및 원칙과 일치하지 않는 경우 공식 정책 또는 지침 을 따라야 합니다. 편집자는 또한 이 방법 가이드를 포함하여 마치 정책인 것처럼 템플릿 문서 페이지를 "인용"하지 않아야 합니다 . 커뮤니티에서 철저히 검토한 Wikipedia 정책과 달리 템플릿 문서 페이지는 토론 없이 작성할 수 있습니다 (자세한 내용은 WP:Local Consensus 참조).

무엇을 포함할 것인가

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

  • 템플릿 의 기본 목적 : 수행하는 작업과 즉시 명확하지 않은 경우 수행해야 하는 이유. 유사한 이름이나 목적을 가진 다른 템플릿이 있는 경우 잘못된 템플릿이 사용될 가능성을 줄이기 위해 해당 템플릿을 언급하는 것이 좋습니다. 템플릿을 특정 국가 또는 기간에만 사용해야 하는 경우 모바일 웹사이트에 {{ Navbox 가시성 }}이 없는 경우 또는 편집자가 템플릿을 사용하기로 선택하기 전에 알아야 할 기타 사항 과 같은 중요한 제한 사항 을 포함합니다.
  • 템플릿 의 매개변수 : 번호가 매겨졌는지, 이름이 지정되었는지 또는 선택 사항인지, 그렇다면 기본값은 무엇이며 어떤 영향을 미치는지. 매개변수가 제한된 값 세트만 사용할 수 있거나 어떤 방식으로든 제한되는 경우(예: "예", "아니오" 또는 숫자만 사용할 수 있는 경우) 이를 명확하게 설명해야 합니다.
  • 사용 예 : 사용해야 하는 정확한 위키텍스트와 그것이 생성하는 결과를 지정합니다. wikitext는 <code>...</code>명확하게 하기 위해 컨테이너에 포함될 수 있습니다 easy to copy, like this. 예를 들어 선택적 매개변수를 포함하거나 포함하지 않고 템플릿을 여러 가지 방법으로 사용할 수 있는 경우 다양한 예를 제공합니다. 그렇게 하는 좋은 방법은 템플릿 자체를 문서에 몇 번 삽입하고(즉, 라이브 예제 사용) 매번 다른 매개변수를 사용하고 각 경우에 사용된 매개변수를 나열하는 것입니다. {{ Xpd }}를 사용하면 wikitext에 템플릿 호출을 두 번 넣지 않고도 이 작업을 수행할 수 있습니다.
  • TemplateData 태그: Wikipedia:TemplateData/Tutorial 을 참조하십시오 .
  • 관련 템플릿 : 템플릿이 일련의 템플릿 중 하나인 경우 이에 대한 링크를 포함합니다. 특히 시리즈의 모든 템플릿이 다른 템플릿과 연결되어 있는지 확인하세요. 이렇게 하면 탐색이 더 쉬워집니다. (이 목적에는 별도의 탐색 템플릿이 유용할 수 있습니다(예: {{ 보호 템플릿 }}).
  • 해당되는 카테고리 ( InterWikimedia 링크 는 Wikidata 에 나열되어야 합니다자세한 정보는 Wikipedia:Wikidata 참조). 문서와 마찬가지로 카테고리는<noinclude>...</noinclude>템플릿의 컨테이너 내에 나열되거나<includeonly>{{Sandbox other||...}}</includeonly>문서 페이지에 배치된 경우 태그 내에 나열되어야 합니다. 많은 템플릿 카테고리를 사용할 수 있습니다. 카테고리:위키피디아 템플릿 을 참조하여 찾아보세요.

영어 Wikipedia는 수백 개의 다른 Wikipedia 및 자매 프로젝트를 위한 템플릿 소스입니다. 종종 템플릿은 완전히 독립적이므로 프로세스가 쉽습니다. 내용이 다른 Wiki의 새 템플릿 페이지에 복사되기만 하면 모든 것이 작동합니다. 그러나 더 복잡한 템플릿에서는 템플릿이 모듈을 호출하거나 다른 템플릿을 포함하지 않을 수 있으며 별도의 템플릿과 쌍을 이루는 경우에만 작동하거나 작동하려면 특정 CSS 또는 JavaScript 코드가 필요합니다. 이러한 경우 문서의 끝에 템플릿 또는 필요한 기타 코드의 간략한 목록을 포함하는 것이 좋습니다.

어디에 놓을까

렌더링된 템플릿 페이지 자체(위키코드와 반대)를 볼 때 일반적으로 제목 바로 아래에 표시되는 것은 렌더링된 템플릿 자체이고, 그 뒤에 템플릿의 렌더링된 문서를 표시하는 별도의 섹션이 있고, 템플릿이 속한 범주가 뒤따릅니다. . 템플릿 페이지의 모든 종류의 카테고리 및 문서( TemplateData 포함 )는 항상 noinclude 태그 로 묶어야 템플릿이 다른 페이지에서 사용될 때 표시되지 않습니다.

템플릿 문서 에 대한 편집 가능한 wikicode 는 종종 템플릿 자체의 별도 하위 페이지 에 배치되고 템플릿 페이지의 끝에 삽입됩니다. 이것은 종종 복잡한 템플릿 코드를 문서에서 분리하여 문서를 더 쉽게 편집하고 템플릿 코드에서 실수로 편집하는 오류의 수를 줄입니다. 또한 필요한 경우 템플릿을 보호 할 수 있어 중요한 템플릿의 코드에 대한 편집 액세스를 제한하는 동시에 누구나 해당 템플릿의 문서를 편집할 수 있습니다. 이 방법을 "템플릿-문서 페이지 패턴"이라고도 합니다.

문서 하위 페이지를 만드는 방법

템플릿에 문서 넣기

템플릿을 생성(게시)할 때 {{ 문서 }} 를 넣어야 합니다 . 그런 다음 링크가 있는 문서 페이지가 생성 [view] [edit] [history] [purge]됩니다. 이 창 링크를 클릭하여 템플릿 설명서를 만들고 편집할 수 있습니다 [edit].

{{ documentation }}을(를) 사용하는 템플릿 문서 하위 페이지는 일관성을 위해 다음과 같은 일반 패턴을 사용하여 이름이 지정되고 형식이 지정됩니다.

템플릿 이름이 Template:X. 템플릿을 편집하고 템플릿 코드 끝에 다음을 추가하거나 {{subst: doc-code }}를 사용합니다. 

[--템플릿 코드의 마지막 줄--] <noinclude>
{{선적 서류 비치}}
<!-- 여기가 아니라 /doc 하위 페이지와 Wikidata의 인터위키에 카테고리를 추가하세요! -->
</포함하지 않음>

템플릿 페이지 하단에 {{ 문서 }}가 포함됩니다.

중요 사항: 여는 것이 새 줄이나 중간 공백이 아니라<noinclude> 템플릿 코드 또는 텍스트의 마지막 문자 바로 뒤에 시작 하는지 확인하십시오 . 그렇지 않으면 템플릿을 사용할 때 일반적으로 원하지 않는 추가 공간이 템플릿 아래에 삽입됩니다.

템플릿이 이미 보호되어 있는 경우 관리자 에게 이를 요청하거나 템플릿의 토론 페이지에서 를 사용하여 편집을 요청 하십시오. 문서 및 카테고리가 컨테이너 내에 포함된 섹션에 이미 존재하는 경우 문서를 두 개의 개별 페이지에 분할하지 않는 것이 가장 좋으므로 문서 하위 페이지(여기서 포함해야 함)로 이동 합니다.{{edit protected}}<noinclude>...</noinclude><includeonly>...</includeonly>

자동 생성

[create]빈 문서 상자 하단에 있는 링크를 사용 하여 미리 로드된 문서 하위 페이지를 자동으로 생성합니다. 맨 위 줄 뒤에 문서를 삽입하고 적절한 주석 줄 아래에 범주를 삽입하십시오. 주석은 그대로 두어 나중에 페이지를 편집할 때 레이아웃이 유지되도록 합니다. 관련 템플릿, 정책 페이지, 프로젝트 등은 "참조 항목" 섹션을 추가하여 연결할 수 있습니다. 서브페이지를 저장합니다.

수동 생성

설명서 하위 페이지를 수동으로 만들려면 이름이 인 하위 페이지를 만듭니다 Template:X/doc. 자세한 내용은 {{ Documentation subpage }}를 참조하거나 다음 표준 wikitext를 복사하여 붙여넣어 페이지를 시작하세요. 

{{ Documentation  subpage }} 
<!-- 이 페이지 하단에 카테고리를 추가하고 Wikidata에서 인터위키를 추가 -->
== 사용법 ==


<includeonly> {{ 샌드박스  기타 || 
<!--  이 줄 아래 의 카테고리  ; Wikidata 의 인터위키 -->      

}} </includeonly>

맨 윗줄에는 현재 페이지를 설명하는 메시지와 템플릿 페이지에 대한 링크가 표시됩니다. 하위 페이지를 저장하고 " 템플릿 사용:문서 " 섹션의 지침을 따릅니다.

템플릿 데이터 사용

리드 그래프와 사용 테이블을 수동으로 작성하는 대신 {{ Format TemplateData }} 템플릿이 대부분의 작업을 수행할 수 있습니다. 테이블 인터페이스에 TemplateData를 작성한 다음 {{Format TemplateData|1=<templatedata>...</templatedata>}}페이지 상단과 같이 템플릿 호출로 래핑하기만 하면 됩니다.

노트

/doc 서브페이지의 토론 페이지를 템플릿 자체의 토론 페이지로 리디렉션할 수 있습니다. 그런 다음 템플릿 및 해당 문서와 관련된 모든 대화는 동일한 토론 페이지에서 끝납니다. 예를 들어 로 리디렉션 Template talk:X/doc합니다 Template 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>템플릿 코드 내의 정확한 배치는 카테고리 코드가 실행되는 방식에 영향을 미칠 수 있습니다.

/샌드박스 및 /테스트 케이스

템플릿을 변경하기 전에 먼저 템플릿 코드를 샌드박스에 복사하고 몇 가지 테스트 케이스를 실행하는 것이 좋습니다. 템플릿이 수천 또는 수백만 페이지에서 표시될 수 있기 때문입니다. 템플릿에 대해 정확히 " /sandbox " 및 " /testcases "라는 이름의 하위 페이지를 생성하면 템플릿의 녹색 {{documentation}}상자가 이를 자동으로 감지하고 헤더에 해당 페이지에 대한 링크를 표시합니다. 자세한 내용은 Wikipedia:템플릿 샌드박스 및 테스트 사례 를 참조하세요.

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

여러 템플릿이 함께 작동하거나 매우 유사할 때 함께 문서화하는 단일 문서 페이지를 유지 관리하는 것이 더 명확하고 쉬운 경우가 많습니다. 이를 수행하는 가장 간단한 방법은 템플릿 중 하나에서 전체 문서 페이지를 만든 다음 다른 템플릿에서 "소프트 리디렉션"을 만드는 것입니다. 예를 들어 {{ wrap }}를 참조하세요.

템플릿 페이지에서 직접

문서 하위 페이지가 생성되지 않고 {{ 문서 }} 템플릿이 |content=실제 템플릿 페이지의 매개변수와 함께 사용되는 경우 템플릿 자체를 범주에 [[Category:Category name]]배치하려면 문서 템플릿 내부 콘텐츠 뒤에 추가합니다. 예를 들어 실제 템플릿 페이지에 배치하는 경우: 

<!--템플릿 코드의 마지막 줄--> <noinclude> 
{{ 문서 
 |  내용  = 
<!--  템플릿  문서  -->

[[ 카테고리 : 카테고리  명 ]] 
[[ 카테고리 : 카테고리 명2  ]] }} </noinclude >

문서가 필요하지 않을 때

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

팁과 요령

다음은 문서 작성을 용이하게 하는 몇 가지 팁입니다.

  • {{ Japanese year |1800}} 과 같은 템플릿에 대한 링크는 {{ tlp |Japanese year|1800}} 를 작성하여 삽입할 수 있습니다 . 유사한 템플릿 은 {{ tlp }}를 참조하세요.
  • <ref group="note">...</ref>{{ tag }} 와 같은 HTML 태그 를 쉽게 삽입할 수 있습니다. 이 예는 {{ tag |ref|params=group="note"}} 로 작성되었습니다.
  • 등호 = 는 {{=}} 와 함께 삽입할 수 있습니다 . 예를 들어, {{ Citation required |date=1900-02-29}} 는 {{ tlp |Citation required|date{{=}}1900-02-29}} 에 의해 작성 되었습니다. 등가 표기법 = 다른 편집자가 읽기 쉽지 않습니다.
  • <nowiki />단일 태그 를 잊지 마십시오 . [[ <nowiki />예]]는 [[예]]가 되고, [ <nowiki />http://en.wikipedia.org 링크 없음]은 [ http://en.wikipedia.org 링크 없음]이 됩니다. 자세한 내용은 WP:NOWIKI 를 참조하십시오.
  • 카테고리에 대한 링크는 {{ cat }}를 사용하세요. 예를 들어, {{ cat |Templates with wrong parameter syntax}} 는 잘못된 매개변수 구문이 있는 Category:Templates 가 됩니다 .
  • 템플릿의 /sandbox 및 /testcases 페이지(있는 경우)의 분류를 억제하려면 문서 하위 페이지 하단에서 다음 코드를 사용하십시오.
<includeonly> {{ 샌드박스  기타 || {{ 테스트 케이스  기타 || 
<!--  이 줄 아래 에 카테고리  를 지정 하십시오 . Wikidata 의 인터위키 -->       

}}}} </includeonly>
  • 템플릿이 하위 정보 상자 인 경우 문서가 손상되어 나타납니다. <includeonly> 태그를 추가하여 이를 방지합니다.
{{일부 정보 상자(자식) 템플릿
| 자식 = <includeonly>예</includeonly>
| label1 = 안녕하세요
| 데이터1 = 세계
}}<noinclude>{{문서}}</noinclude>

또한보십시오

Retrieved from "https://en.wikipedia.org/w/index.php?title=Wikipedia:Template_documentation&oldid=1075313817"
0.11763501167297