틀:설명문서/설명문서 및 미디어위키: 문서 사이의 차이

< 틀:설명문서(문서 사이의 차이)
위키백과>Sije
편집 요약 없음
 
imported>Gaon12
편집 요약 없음
 
1번째 줄: 1번째 줄:
{{틀 설명문서 안내}}
{{틀:위키 엔진}}
<!-- 이 줄 아래부터 틀 설명문서를 작성하십시오. -->
여기는 {{틀|틀 설명문서}} 틀입니다.


이 틀을 이용해서 틀에 설명을 다는 자세한 방법은 [[위키백과:틀 설명문서]]를 참고하세요.
[[파일:MediaWiki.svg|150px]]


이 틀은 지금 보는 것과 같은 녹색 상자 안에 자동으로 "/설명문서"의 내용을 가져와서 보여줍니다.  
{{인용문|Beacause ideas want to be free.|미디어위키 슬로건}}


== 사용법 ==
==정보==
대개의 경우 이 틀은 아무런 매개 변수 없이, 틀의 아랫부분에 <code>&lt;noinclude></code> 및 <code>&lt;/noinclude></code>로 둘러싸서 씁니다.
# [[오픈 소스]] 위키 엔진 프로그램
# [[PHP]]를 기반으로 한다.
# 2002년 위키피디아에서 사용 하기 위해 개발된 프로그램으로, 2003년 미디어위키라고 이름을 바꾸었다.


<pre>
==장점==
<!--작성한 원래 틀의 내용--><noinclude>
===다양한 DB 지원===
# DB를 사용하므로 안정성이 높다. 파일 DB를 사용하는 [[도쿠 위키]]등은 파일이 손상되면 읽어 올 수 없기 때문이다.
# 현재 [[MySql]], [[MariaDB]], [[PostgreSQL]], [[SQLite]]을 지원하며, 제한적으로 [[Oracle DB]]와 [[MSSQL]]을 지원한다.<ref>다양한 DB를 지원하기 때문에 XML 가져오기(import)시에도 사용하는 DB로 변환하여 사용한다.</ref>
===강력한 확장기능===
# [[XE]]의 모듈에 해당하는 확장기능을 지원한다. 미디어위키 자체에서 지원하지 않는 기능들(예를 들어 유튜브 영상 첨부 등)을 지원 할 수 있도록 해준다.
===방대한 양의 개발 문서===
# 개발 문서가 잘 써져 있어 개발시 많은 도움이 된다.
# 물론 영어가 대다수라 한국어로 작성된 문서는 보기 드물다. 자세한 내용은 [[미디어위키#개발 문서의 한글화 부족|하단의 개발 문서의 한글화 부족]] 문단을 참고하자.
===웹 인스톨러 존재===
# 웹 인스톨러가 있기 때문에 편하게 설치가 가능하다.
# 물론 마지막에 LocalSettings.php 파일을 index.php가 있는 최상단에 업로드 해야 하지만<ref>FTP를 사용하기 귀찮다면 마지막 부분에 LocalSettings.php를 에디터로 열고 모든 내용을 드래그 후 복사(클립보드에 복사)해 놓은 상태로 SSH로 접속해 최상단 폴더로 이동 후 'vi LocalSettings.php'(다른 에디터를 사용해도 된다.)를 입력 후 붙혀넣기 후 저장해도 된다. 이때 파일명의 대소문자에 유의하자</ref>
===검색 기능===
# 검색 기능이 우수하다.
# 구글 검색을 붙혀야 한다는 몇몇 유저들의 의견도 있지만, 단어 입력시 문서가 존재한다면 문서로 이동하는 기능들은 다른 엔진들에게도 있지만, 옵션에 따라 해당 단어가 포함되어 있는지의 여부도 설정 할 수 있는 점은 다른 위키 엔진에서 찾아 볼 수 없는 기능이다.


{{틀 설명문서}}
===다양한 스킨들의 존재===
<!-- 분류와 인터위키는 /설명문서 안에 넣어주세요. -->
# 스킨들이 다양하다.
</noinclude>
# [[깃허브]]에 [https://github.com/search?q=mediawiki+skins mediawiki skins]라고 검색을 하더라도 많은 수의 스킨들이 있다.
</pre>
# 이 점은 다른 위키 엔진들이 가지고 있는 스킨 수를 훨씬 앞지르는 숫자이다.


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


다른 틀의 설명을 불러다가 보여줄 수도 있습니다:
==단점==
===무겁다===
# 원래 미디어위키는 위키미디어에서 사용하려는 목적으로 만든것으로써 소규모 위키(가온 위키도)에서 사용하기엔 무리가 있다.
# 위키미디어는 램을 박으면 되지만, 소규모 위키의 경우에는 재정적인 문제 등이 있기 때문에 캐시를 박아야 한다. 아래의 [[미디어위키#해결 방안|해결 방안]] 문단을 참고하자.
===해결 방안===
====가벼운 스킨 사용====
# [[가온 위키]]이 사용하는 리버티 스킨은 무거운 편에 속한다. 멋 따윈 버린다면 기본 스킨을 쓰는게 좋다.<ref>기본 스킨을 사용하면 좋은 점이 더 있는데, 확장 기능들 중에서 기본 스킨들만 지원하는 <del>무식한</del>확장 기능들이 존재하기 때문이다. 물론 그런 확장 기능을 사용하지 않거나 자신이 수정 할 수 있다면 상관은 없지만</ref>
# 리버티 스킨과 같이 엔진에 api를 호출해 값을 얻어오는 기능<ref>리버티 엔진 PC 버전에서 우측의 최근 글 변경</ref>이 있다면 로드 시간 중에 값을 가져오는 기능도 포함되므로 없애는 방법도 좋은 방법이다.
====캐시 때려 박기====
# 캐시를 때려 박으면 캐시된 값을 가져오기 때문에 그만큼 CPU 부하도 줄며 로드 속도도 빨라진다.
# 브라우저 캐시를 설정하면 바뀐 파일만 로드하기 때문에 빨라진다. 단 '''재 방문 시에만 해당'''한다. [https://icon.town/icon/23626#Apache 아파치 브라우저 캐시 설정] [https://icon.town/icon/23626#Nginx 엔진엑스 브라우저 캐시 설정]
===설정 파일 의존===
# 다른 엔진들과 달리 미디어위키는 [[LocalSettings.php]] 파일에 의존한다.
# 그렇기 때문에 확장 기능 설정이나 미디어위키 설정 변경시에도 코어 변경이 필요 없는 경우 대부분 LocalSettings.php 파일에 추가/수정/제거를 한다.
# 이 부분이 좋지 못하다는 것은 해당 파일이 손상된 경우에는 접속이 불가능하다. 물론 재생성이 가능하지만 일부 설정이 바이바이 할 수도 있다.
# 문서는 DB에 저장하지만 설정은 파일에 저장한다는 것이 문제가 많다.


<pre>
===태그의 복잡성?===
<!--작성한 원래 틀의 내용--><noinclude>
# 이 부분은 호불호(?)가 갈리는 편이다. [[HTML]] 태그처럼 <nowiki><태그>내용</태그></nowiki> 이런 식으로 태그를 사용한다.
# 태그 안 내용이 짧다면 보기에 간결하지만 내용이 복잡하다면 타유저의 태그 수정이 불편하다.
# 거기에 이중태그가 불가능 하다. 예를 들어 <nowiki><ref>이런 것이<ref>불가능하다</ref></ref></nowiki>


{{틀 설명문서|틀:다른 틀/설명문서}}
===개발 문서의 한글화 부족===
</noinclude>
# 개발 문서는 대부분 영문으로 작성되어 있기 때문에 영어를 못하는 경우에는 번역기에 의존해야 한다.
</pre>
# 이는 엔진의 한글화와 대조되는 부분이다.


다른 틀의 설명문서를 불러들일 때는 분류와 인터위키의 처리에 신경을 써야 합니다.
==사용처==
# 위키백과
# [[리브레 위키]] (https://librewiki.net)
# [[제타위키]] (https://zetawiki.com)
# [[가온 위키]] (https://www.gaonwiki.com)
# 그 외에도 많은 곳에서 사용중이다.


설명을 직접 달 수도 있습니다.:
==각주==
 
<pre>
<!--작성한 원래 틀의 내용--><noinclude>
 
{{틀 설명문서
| 내용 = 틀에 관한 설명.
}}
</noinclude>
</pre>
 
'''내용=''' 변수가 사용되면, 오른쪽 위의 [편집] [새로 고침] 상자는 보이지 않습니다. 만약 "/설명문서" 하위문서가 존재하면 상자 아래에 링크는 표시됩니다.
 
필요에 따라서 첫 변수와 '''내용''' 변수를 다음처럼 함께 사용할 수도 있습니다:
 
<pre>
<!--작성한 원래 틀의 내용--><noinclude>
 
{{틀 설명 문서
| 1 = 틀:다른 틀/설명문서
| 내용 = {{틀:다른 틀/설명문서|변수}
}}
</noinclude>
</pre>
 
두 변수가 함께 사용되면, '''1'''에 주어진 문서 이름을 이용해서 [편집] [새로 고침] 링크가 나타나며, 상자 안의 내용은 "내용 ="의 내용이 표시됩니다. 위의 예에서는 '''내용''' 변수에 "<code><nowiki>{{틀:다른 틀/설명문서|변수}}</nowiki></code>"의 내용이 불러들여집니다.
 
== 좋은 습관 ==
이 틀을 부르는 코드는 원래 틀의 내용 아래에 "<code>&lt;noinclude></code>" 앞의 공백 없이 바로 붙여주면 됩니다. (공백이 있을 경우, 틀을 부르는 곳에서 원치 않는 공백이 추가됩니다.)
 
틀 자체를 위한 분류와 인터위키는 "/설명문서"의 아랫 부분에 <code>&lt;includeonly>&lt;/includeonly></code> 태그로 감싼 부분에 넣으면 됩니다. 보다 복잡한 예는 [[위키백과:틀 설명문서#분류와 인터위키 링크]]를 참고하세요.
 
만약 설명문서 안에서 &lt;includeonly>나 &lt;noinclude> 태그를 설명문 안에 표시해줄 필요가 있다면, "<code>&lt;</code>"를 "<code>&amp;lt;</code>", "<code>&gt;</code>"를 "<code>&amp;gt;</code>"로 바꿔주세요.
 
== 제목 ==
틀 이름공간 안에서 이 틀이 사용되면, 다음과 같은 제목이 표시됩니다:
:[[File:Template-info.svg|32px]] '''틀 설명문서'''
 
다른 문서, 예컨대 "위키백과:"나 "사용자:" 문서에서는 다음과 같이 표시됩니다:
:'''설명문서'''
 
파일 (그림) 문서에서는 다음과 같이 표시됩니다:
:'''요약'''
 
'''제목''' 변수를 이용하여 제목에 표시되는 내용을 바꿀 수 있습니다:
 
:<code><nowiki>{{틀 설명문서| 제목 = 정보상자 설명문서 }}</nowiki></code>
 
만약 '''제목''' 변수가 아무 내용없이 사용되면 아무 제목도 표시되지 않고, [편집] [새로 고침]도 표시되지 않습니다:
 
:<code><nowiki>{{틀 설명문서| 제목 = }}</nowiki></code>
 
'''제목-모양''' 변수를 이용하여 [[CSS]] 값을 추가할 수 있습니다. 따옴표(<code>" "</code>)는 없어야 하며, 마지막 반쌍점(<code>;</code>)은 있어야 합니다. 예를 들면:
:<code>heading-style = color: red; font-size: 150%;</code>
 
== 연결 상자 ==
설명 상자 아래에는 설명문서에 관한 메타 정보가 표시됩니다. 틀을 부를 때의 변수와 이름공간에 따라 링크 상자 안의 표시 내용은 조금씩 다를 수 있습니다. 경우에 따라서는 연결 상자가 표시되지 않을 수도 있습니다.
 
연결 상자를 숨기려면, 변수에 "<code>|연결상자 = off</code>"를 추가하세요.
 
'''연결상자''' 변수를 이용해서 이 틀에 추가적인 내용을 넣을 수 있습니다. 예를 들면:
<pre>|연결상자=이 설명은 [[틀:나라자료/설명문서]]를 이용해서 자동으로 만들었습니다.</pre>
 
== 자동 기능 ==
틀 설명문서가 없다면, [만들기] 링크를 눌러서 기본적인 내용이 채워진 설명문서 초안을 로드할 수 있습니다. "/연습장"과 "/시험장"도 없을 경우 [만들기] 링크를 누르면 기본적이 내용이 채워집니다.
 
틀이 보호되었을 경우에는 자동으로 {{틀|보호-틀}} 틀을 불러들여 오른쪽 위에 회색 또는 붉은색 자물쇠를 보여줍니다. 따로 틀이나 틀 설명문서 안에 {{틀|보호}} 틀을 넣을 필요가 없습니다.
 
이 틀이 "/연습장"에서 불릴 경우, 자동으로 {{틀|틀 연습장 안내}} 틀의 내용을 보여줍니다.
 
기본정렬 값을 {{<nowiki></nowiki>PAGENAME}}으로 설정합니다. 따라서 틀 설명문서 안에서 틀 분류에 일일이 정렬 값을 적지 않아도 됩니다.
 
== 같이 보기 ==
* {{틀|틀 설명문서 안내}}
* [[위키백과:틀 설명문서]]
* [[위키백과:틀 연습장과 시험장]]
 
<includeonly>
[[분류:틀 설명문서| ]]
[[분류:판형 틀]]
[[분류:틀 이름공간 틀]]
 
[[als:Vorlage:Dokumentation]]
[[ar:قالب:توثيق]]
[[as:Template:Documentation]]
[[ba:Ҡалып:Doc]]
[[bar:Vorlage:Dokumentation]]
[[bg:Шаблон:Документация]]
[[br:Patrom:Implijout patromoù]]
[[bs:Šablon:Dokumentacija]]
[[ca:Plantilla:Ús de la plantilla]]
[[ckb:داڕێژە:Documentation]]
[[cs:Šablona:Dokumentace]]
[[cy:Nodyn:Doc]]
[[da:Skabelon:Dokumentation]]
[[de:Vorlage:Dokumentation]]
[[diq:Template:Documentation]]
[[dsb:Pśedłoga:Dokumentacija]]
[[el:Πρότυπο:Τεκμηρίωση προτύπου]]
[[en:Template:Documentation]]
[[eo:Ŝablono:Dok]]
[[es:Plantilla:Documentación]]
[[et:Mall:Dokumentatsioon]]
[[eu:Txantiloi:Txantiloi dokumentazioa]]
[[fa:الگو:توضیحات]]
[[fr:Modèle:Documentation]]
[[ga:Teimpléad:Documentation]]
[[gl:Modelo:Uso de marcador]]
[[he:תבנית:תיעוד]]
[[hsb:Předłoha:Dokumentacija]]
[[hu:Sablon:Sablondokumentáció]]
[[hy:Կաղապար:Փաստաթղթեր]]
[[ia:Patrono:Documentation]]
[[id:Templat:Dokumentasi]]
[[it:Template:Man]]
[[ja:Template:Documentation]]
[[ku:Şablon:Belgekirin]]
[[la:Formula:Documentation]]
[[lad:Xablón:Uso de Templates]]
[[lez:Шаблон:Doc]]
[[ltg:Taiss:Dokumentaceja]]
[[lv:Veidne:Dokumentācija]]
[[map-bms:Cithakan:Dokumentasi]]
[[ml:ഫലകം:വിവരണം]]
[[ms:Templat:Dokumentasi]]
[[nds-nl:Mal:Dokumentatie]]
[[nl:Sjabloon:Sjabdoc]]
[[no:Mal:Dokumentasjon]]
[[nso:Template:Documentation]]
[[pl:Szablon:Dokumentacja]]
[[pt:Predefinição:Documentação]]
[[ro:Format:Documentație]]
[[ru:Шаблон:Doc]]
[[se:Málle:Documentation]]
[[simple:Template:Documentation]]
[[sk:Šablóna:Dokumentácia]]
[[sl:Predloga:Dokumentacija]]
[[sq:Stampa:Dokumentacion]]
[[sr:Шаблон:Документација]]
[[stq:Foarloage:Dokumentation]]
[[sv:Mall:Dokumentation]]
[[sw:Kigezo:Documentation]]
[[te:మూస:Documentation]]
[[tl:Suleras:Documentation]]
[[tpi:Template:Template doc]]
[[tr:Şablon:Belgeleme]]
[[tt:Калып:Doc]]
[[uk:Шаблон:Документація]]
[[ur:سانچہ:Documentation]]
[[war:Batakan:Documentation]]
[[yo:Àdàkọ:Aṣàlàyé]]
[[zh:Template:Documentation]]

2019년 1월 28일 (월) 18:05 판

미디어위키 문법
미디어위키 리버티 엔진
나무위키 문법
the seed openNAMU 나무마크 (확장기능) PressDo
기타 문법을 사용하는 엔진들
도쿠위키 모니위키

MediaWiki.svg

-

Beacause ideas want to be free.

 
— 미디어위키 슬로건

정보

  1. 오픈 소스 위키 엔진 프로그램
  2. PHP를 기반으로 한다.
  3. 2002년 위키피디아에서 사용 하기 위해 개발된 프로그램으로, 2003년 미디어위키라고 이름을 바꾸었다.

장점

다양한 DB 지원

  1. DB를 사용하므로 안정성이 높다. 파일 DB를 사용하는 도쿠 위키등은 파일이 손상되면 읽어 올 수 없기 때문이다.
  2. 현재 MySql, MariaDB, PostgreSQL, SQLite을 지원하며, 제한적으로 Oracle DBMSSQL을 지원한다.[1]

강력한 확장기능

  1. XE의 모듈에 해당하는 확장기능을 지원한다. 미디어위키 자체에서 지원하지 않는 기능들(예를 들어 유튜브 영상 첨부 등)을 지원 할 수 있도록 해준다.

방대한 양의 개발 문서

  1. 개발 문서가 잘 써져 있어 개발시 많은 도움이 된다.
  2. 물론 영어가 대다수라 한국어로 작성된 문서는 보기 드물다. 자세한 내용은 하단의 개발 문서의 한글화 부족 문단을 참고하자.

웹 인스톨러 존재

  1. 웹 인스톨러가 있기 때문에 편하게 설치가 가능하다.
  2. 물론 마지막에 LocalSettings.php 파일을 index.php가 있는 최상단에 업로드 해야 하지만[2]

검색 기능

  1. 검색 기능이 우수하다.
  2. 구글 검색을 붙혀야 한다는 몇몇 유저들의 의견도 있지만, 단어 입력시 문서가 존재한다면 문서로 이동하는 기능들은 다른 엔진들에게도 있지만, 옵션에 따라 해당 단어가 포함되어 있는지의 여부도 설정 할 수 있는 점은 다른 위키 엔진에서 찾아 볼 수 없는 기능이다.

다양한 스킨들의 존재

  1. 스킨들이 다양하다.
  2. 깃허브mediawiki skins라고 검색을 하더라도 많은 수의 스킨들이 있다.
  3. 이 점은 다른 위키 엔진들이 가지고 있는 스킨 수를 훨씬 앞지르는 숫자이다.


단점

무겁다

  1. 원래 미디어위키는 위키미디어에서 사용하려는 목적으로 만든것으로써 소규모 위키(가온 위키도)에서 사용하기엔 무리가 있다.
  2. 위키미디어는 램을 박으면 되지만, 소규모 위키의 경우에는 재정적인 문제 등이 있기 때문에 캐시를 박아야 한다. 아래의 해결 방안 문단을 참고하자.

해결 방안

가벼운 스킨 사용

  1. 가온 위키이 사용하는 리버티 스킨은 무거운 편에 속한다. 멋 따윈 버린다면 기본 스킨을 쓰는게 좋다.[3]
  2. 리버티 스킨과 같이 엔진에 api를 호출해 값을 얻어오는 기능[4]이 있다면 로드 시간 중에 값을 가져오는 기능도 포함되므로 없애는 방법도 좋은 방법이다.

캐시 때려 박기

  1. 캐시를 때려 박으면 캐시된 값을 가져오기 때문에 그만큼 CPU 부하도 줄며 로드 속도도 빨라진다.
  2. 브라우저 캐시를 설정하면 바뀐 파일만 로드하기 때문에 빨라진다. 단 재 방문 시에만 해당한다. 아파치 브라우저 캐시 설정 엔진엑스 브라우저 캐시 설정

설정 파일 의존

  1. 다른 엔진들과 달리 미디어위키는 LocalSettings.php 파일에 의존한다.
  2. 그렇기 때문에 확장 기능 설정이나 미디어위키 설정 변경시에도 코어 변경이 필요 없는 경우 대부분 LocalSettings.php 파일에 추가/수정/제거를 한다.
  3. 이 부분이 좋지 못하다는 것은 해당 파일이 손상된 경우에는 접속이 불가능하다. 물론 재생성이 가능하지만 일부 설정이 바이바이 할 수도 있다.
  4. 문서는 DB에 저장하지만 설정은 파일에 저장한다는 것이 문제가 많다.

태그의 복잡성?

  1. 이 부분은 호불호(?)가 갈리는 편이다. HTML 태그처럼 <태그>내용</태그> 이런 식으로 태그를 사용한다.
  2. 태그 안 내용이 짧다면 보기에 간결하지만 내용이 복잡하다면 타유저의 태그 수정이 불편하다.
  3. 거기에 이중태그가 불가능 하다. 예를 들어 <ref>이런 것이<ref>불가능하다</ref></ref>

개발 문서의 한글화 부족

  1. 개발 문서는 대부분 영문으로 작성되어 있기 때문에 영어를 못하는 경우에는 번역기에 의존해야 한다.
  2. 이는 엔진의 한글화와 대조되는 부분이다.

사용처

  1. 위키백과
  2. 리브레 위키 (https://librewiki.net)
  3. 제타위키 (https://zetawiki.com)
  4. 가온 위키 (https://www.gaonwiki.com)
  5. 그 외에도 많은 곳에서 사용중이다.

각주

  1. 다양한 DB를 지원하기 때문에 XML 가져오기(import)시에도 사용하는 DB로 변환하여 사용한다.
  2. FTP를 사용하기 귀찮다면 마지막 부분에 LocalSettings.php를 에디터로 열고 모든 내용을 드래그 후 복사(클립보드에 복사)해 놓은 상태로 SSH로 접속해 최상단 폴더로 이동 후 'vi LocalSettings.php'(다른 에디터를 사용해도 된다.)를 입력 후 붙혀넣기 후 저장해도 된다. 이때 파일명의 대소문자에 유의하자
  3. 기본 스킨을 사용하면 좋은 점이 더 있는데, 확장 기능들 중에서 기본 스킨들만 지원하는 무식한확장 기능들이 존재하기 때문이다. 물론 그런 확장 기능을 사용하지 않거나 자신이 수정 할 수 있다면 상관은 없지만
  4. 리버티 엔진 PC 버전에서 우측의 최근 글 변경
• 현재 페이지 URL 줄이기