:설명문서

(틀:틀 설명문서에서 넘어옴)
틀 설명문서[보기] [편집] [역사] [새로 고침]

이 틀은 틀의 사용법과 예제를 추가할 때 사용합니다. 이 틀은 지금 보는 것과 같은 녹색 상자 안에 자동으로 "/설명문서"의 내용을 가져와서 보여줍니다.

사용법

편집

대개의 경우 이 틀은 아무런 매개 변수 없이, 틀의 아랫부분에 <noinclude></noinclude>로 둘러싸서 씁니다.

<!--작성한 원래 틀의 내용--><noinclude>

{{설명문서}}
<!-- 분류는 /설명문서 안에 넣어주세요. -->
</noinclude>

그러면 틀은 자동으로 "/설명문서" 안의 내용을 불러서 보여줍니다.

다른 틀의 설명을 불러다가 보여줄 수도 있습니다:

<!--작성한 원래 틀의 내용--><noinclude>

{{ 설명문서|:다른 /설명문서}}
</noinclude>

다른 틀의 설명문서를 불러들일 때는 분류 처리에 신경을 써야 합니다.

설명을 직접 달 수도 있습니다.:

<!--작성한 원래 틀의 내용--><noinclude>

{{ 설명문서
| 내용 = 틀에 관한 설명.
}}
</noinclude>

내용= 변수가 사용되면, 오른쪽 위의 [편집] [새로 고침] 상자는 보이지 않습니다. 만약 "/설명문서" 하위문서가 존재하면 상자 아래에 링크는 표시됩니다.

필요에 따라서 첫 변수와 내용 변수를 다음처럼 함께 사용할 수도 있습니다:

<!--작성한 원래 틀의 내용--><noinclude>

{{ 설명 문서
| 1 = :다른 /설명문서
| 내용 = {{:다른 /설명문서|변수}
}}
</noinclude>

두 변수가 함께 사용되면, 1에 주어진 문서 이름을 이용해서 [편집] [새로 고침] 링크가 나타나며, 상자 안의 내용은 "내용 ="의 내용이 표시됩니다. 위의 예에서는 내용 변수에 "{{틀:다른 틀/설명문서|변수}}"의 내용이 불러들여집니다.

좋은 습관

편집

이 틀을 부르는 코드는 원래 틀의 내용 아래에 "<noinclude>" 앞의 공백 없이 바로 붙여주면 됩니다. (공백이 있을 경우, 틀을 부르는 곳에서 원치 않는 공백이 추가됩니다.)

틀 자체를 위한 분류는 "/설명문서"의 아랫 부분에 <includeonly></includeonly> 태그로 감싼 부분에 넣으면 됩니다.

만약 설명문서 안에서 <includeonly>나 <noinclude> 태그를 설명문 안에 표시해줄 필요가 있다면, "<"를 "&lt;", ">"를 "&gt;"로 바꿔주세요.

제목

편집

틀 이름공간 안에서 이 틀이 사용되면, 다음과 같은 제목이 표시됩니다:

틀 설명문서

다른 문서, 예컨대 "위키백과:"나 "사용자:" 문서에서는 다음과 같이 표시됩니다:

설명문서

파일 (그림) 문서에서는 다음과 같이 표시됩니다:

요약

제목 변수를 이용하여 제목에 표시되는 내용을 바꿀 수 있습니다:

{{틀 설명문서| 제목 = 정보상자 설명문서 }}

만약 제목 변수가 아무 내용없이 사용되면 아무 제목도 표시되지 않고, [편집] [새로 고침]도 표시되지 않습니다:

{{틀 설명문서| 제목 = }}

제목-모양 변수를 이용하여 CSS 값을 추가할 수 있습니다. 따옴표(" ")는 없어야 하며, 마지막 반쌍점(;)은 있어야 합니다. 예를 들면:

heading-style = color: red; font-size: 150%;

연결 상자

편집

설명 상자 아래에는 설명문서에 관한 메타 정보가 표시됩니다. 틀을 부를 때의 변수와 이름공간에 따라 링크 상자 안의 표시 내용은 조금씩 다를 수 있습니다. 경우에 따라서는 연결 상자가 표시되지 않을 수도 있습니다.

연결 상자를 숨기려면, 변수에 "|연결상자 = off"를 추가하세요.

연결상자 변수를 이용해서 이 틀에 추가적인 내용을 넣을 수 있습니다. 예를 들면:

|연결상자=이 설명은 [[틀:나라자료/설명문서]]를 이용해서 자동으로 만들었습니다.

자동 기능

편집

틀 설명문서가 없다면, [만들기] 링크를 눌러서 기본적인 내용이 채워진 설명문서 초안을 로드할 수 있습니다. "/연습장"과 "/시험장"도 없을 경우 [만들기] 링크를 누르면 기본적이 내용이 채워집니다.

틀이 보호되었을 경우에는 자동으로 {{보호-틀}} 틀을 불러들여 오른쪽 위에 회색 또는 붉은색 자물쇠를 보여줍니다. 따로 틀이나 틀 설명문서 안에 {{보호}} 틀을 넣을 필요가 없습니다.

이 틀이 "/연습장"에서 불릴 경우, 자동으로 {{틀 연습장 안내}} 틀의 내용을 보여줍니다.

기본정렬 값을 {{PAGENAME}}으로 설정합니다. 따라서 틀 설명문서 안에서 틀 분류에 일일이 정렬 값을 적지 않아도 됩니다.

같이 보기

편집