문서 검토와 수정 편집하기

Raspbie (토론 | 기여)님의 2021년 8월 16일 (월) 02:48 판 (→‎기초 문법)

경고: 이 문서의 오래된 판을 편집하고 있습니다. 이것을 게시하면, 이 판 이후로 바뀐 모든 편집이 사라집니다.

경고: 로그인하지 않았습니다. 편집을 하면 IP 주소가 공개되게 됩니다. 로그인하거나 계정을 생성하면 편집자가 사용자 이름으로 기록되고, 다른 장점도 있습니다.

= 문서 시작하기 =

양자정보과학기술 연구회 위키는 미디어 위키 문법에 기반해 있습니다. 상세한 문법에 관한 설명은 [https://www.mediawiki.org/wiki/MediaWiki 미디어 위키 공식 위키]를 참조할 수 있습니다.

= 검토진들의 업무 =

해당 위키의 내용들은 Word로 작성된 문서를 변환 프로그램을 통해 미디어 위키 마크업 언어로 변환한 것입니다. 때문에, 의도치 못한 문법적 오류, 그림의 위치, 크기 문제, 불필요한 구조의 문법 등이 발생할 수 있습니다. 검토진들은 해당 사항들에 대해, Word 문서와 비교하여 적절한 문서가 될 수 있도록 해당 문서를 수정해야 합니다. 주로 다음과 같은 문제들이 알려져 있습니다.

* 그림의 크기 문제: 변환 과정에서 Word 문서 안의 상대적 그림 크기를 모두 고려해 변환하는 작업은 불가능 합니다. 때문에 가로 700px 크기로 그림들이 고정되어 있습니다.
* 그림의 caption: 일부는 caption이 Word 포멧 상의 문제로 인식되지 않아 그림 외부에 있는 경우가 있습니다. 
* 불필요한 수식 구조: 예로 <code>\sin</code> 형태의 코드가 <code>\text{sin}</code> 형태로 되어있는 경우가 있습니다.
* 수식 오류 1: 예로 문서의 소단원 목록에 수학 수식 코드가 들어간 경우가 있습니다. 이는 단원 제목의 구문 <code>== {단원} ==</code> 형태로 두기 때문에 발생하는 문제입니다. 수학 수식에서 <code>=</code>가 빈번히 사용될 경우 연속된 두 <code>=</code> 사이 내용이 단원으로 인식될 수 있습니다. 수식을 나타내는 시작, 끝 태그 <code>\[ \]</code>와 해당 구문 사이의 새 줄이 없도록 하여 해결할 수 있습니다.
* 수식 오류 2: 일부 수학 수식들에서 문법 오류로 렌더링이 이상이 생긴 경우가 있습니다. 해당 내역은 latex 문법에 맞게 수정해야 합니다.
* 각주 오류: <code>(저자, 연도)</code>에는 기본적으로 주 처리가 되어야 하나 패턴인식 문제로 할당이 되지 않은 경우도 있습니다.

해당 내용들은 검토 과정에서 수정해야 하는 내역입니다.

아래 문법 단원에서는 공식 미디어 위키 도움말을 링크하고, 검토진들이 사용할 일부 문법에 관한 내용에 대해 기술하고 있습니다.

= 문법 =

== 기초 문법 ==

다음의 공식문서를 참조할 수 있습니다. [https://www.mediawiki.org/wiki/Help:Formatting/ko 미디어 위키:도움말:서식 지정]

{| class="wikitable"
| name
| source
| result
|-
| 제목
| <pre>
== 제목 2 ==
=== 제목 3 ===
==== 제목 4 ====
==== 제목 5 ====</pre>
| 
== 제목 2 ==
=== 제목 3 ===
==== 제목 4 ====
==== 제목 5 ====
|-
| 이탤릭
| <pre>''이탤릭''</pre>
| ''이탤릭''
|-
| 볼드체
| <pre>'''볼드체'''</pre>
| '''볼드체'''
|-
| 리스트
| 
<pre>
* 1
* 2
** 2-1
*** 2-1-1
* 3</pre>
| 
* 1
* 2
** 2-1
*** 2-1-1
* 3
|-
| 리스트 숫자
| 
<pre>
# 1
# 2
## 2-1
### 2-1-1
# 3</pre>
| 
# 1
# 2
## 2-1
### 2-1-1
# 3
|}

== 링크 ==

다음의 공식문서를 참조할 수 있습니다. [[https://www.mediawiki.org/wiki/Help:Links/ko 미디어 위키:도움말:링크]]

== 그림 ==

다음의 공식문서를 참조할 수 있습니다. [https://www.mediawiki.org/wiki/Help:Images/ko 미디어 위키:도움말:그림]

미디어 위키 엔진에서 그림을 불러올 때, 기본적으로 서버 내에 있는 그림만을 대상으로 합니다. 본 위키에서는 외부 이미지 호출이 가능하도록 되어있습니다.

=== 내부 그림 ===

그림 구문은 다음의 구조를 가집니다.

<pre> [[File:{image name}|{option}|{caption}]]</pre>

<code>File</code>은 서버 내 파일을 나타내는 접두사입니다. 이 구문은 서버내에 있는 파일만을 대상으로 합니다.
예를 들어서 양자 회로 SDK인 Qiskit의 로고가 본 서버에 <code>Qiskit-Logo.svg</code>란 이름으로 저장되어 있습니다. 
이를 가로 크기 200px의 크기로 문서에 삽입하려면 다음과 같은 문법을 사용할 수 있습니다.

{|class="wikitable"
| source
| output
|-
|
<pre>[[File:Qiskit-Logo.svg|200px|Qisikit logo]]</pre>
|
[[File:Qiskit-Logo.svg|200px|Qisikit logo]]
|}

'''변환 문서의 기본 구문'''

기본적으로 변환된 문서의 그림 구문은 다음과 같은 구조를 가지고 있습니다.

<pre>[[File:{img name}|frame|700px|{caption}]]</pre>

=== 크기와 위치 조정 ===

<code>{option}</code>에는 다양한 설정이 들어갈 수 있습니다. 여기서는 간단히 위치와 크기를 조정하는 방법에 대해 알아 봅시다.

'''수평 위치 조정'''

해당 위키 기본 변환 문서는 <code>thumb</code> 포멧으로 그림이 들어가 있습니다. 이 이미지 포멧은 기본적으로 오른쪽으로 그림을 배열합니다. 위에서 쓴 Quiskit 로고를 변환 문서 형식으로 나타내 봅시다(가독성을 위해 크기를 조금 줄였습니다.).

'''주의.1 ''': 만약 구문에 <code>thumb</code>이 아닌 <code>frame</code>으로 들어가 있다면, <code>thumb</code>으로 모두 바꾸어주어야 합니다. <code>frame</code>는 이미지를 '''원본 크기'''로 렌더링 합니다.

'''주의.2 ''': 만약 caption이 뜨지 않는다면, <code>thumb</code>이 구문에 들어가 있는지 확인해 봐야 합니다. caption은 별도의 형식 지정이 없을시, 활성화 되어있지 않습니다. 예로 위의 Qiskit 로고 예시는 caption이 나오지 않는데 이는 형식 지정이 없기 때문입니다.

<pre>[[File:Qiskit-Logo.svg|thumb|200px|Qisikit logo]]</pre>

[[File:Qiskit-Logo.svg|thumb|200px|Qisikit logo]]

이때, <code>thumb</code> 앞에 위치 지정자를 넣어 그림의 위치를 적절하게 조정할 수 있습니다. 다음의 지정자가 있습니다.

<pre>[[File:Qiskit-Logo.svg|{location identifier}|thumb|200px|Qisikit logo]]</pre>

* center
* left
* right: <code>thumb</code>의 기본 위치 지정자

<pre>[[File:Qiskit-Logo.svg|left|thumb|150px|left]]</pre>

[[File:Qiskit-Logo.svg|thumb|left|100px|caption:left]]

<pre>[[File:Qiskit-Logo.svg|center|thumb|150px|center]]</pre>

[[File:Qiskit-Logo.svg|thumb|center|100px|caption:center]]

<pre>[[File:Qiskit-Logo.svg|right|thumb|150px|right]]</pre>

[[File:Qiskit-Logo.svg|thumb|right|100px|caption:right]]

'''크기 조정'''

총 4 가지 크기 지정 방법이 있습니다.

* <code>{width}px</code> — 높이를 제한하지 않고 주어진 최대 폭의 픽셀 이내로 맞게 너비를 조절합니다. (Only whole-number pixel values are supported. A space character between the width value and "px" is permitted.)
* <code>x{height}px</code> — 너비를 제한하지 않고 주어진 최대 폭의 픽셀 이내로 맞게 높이를 조절합니다. Only whole-number pixel values are supported. A space character between the height value and "px" is permitted.
* <code>{width}x{height}px</code> — 주어진 너비와 높이 이내로 맞게 크기를 조절합니다. Only whole-number pixel values are supported. A space character between the width value and "px" is permitted.
* <code>upright</code> — 사용자의 선호에 따라 합리적인 치수 이내에 맞게 조절합니다. (너비보다 높이가 큰 이미지에 적합) Setting |upright=1.0| will display the image at the user's default image width. |upright=2.0| will display the image at double the user's default width.

=== 외부 그림 ===

외부 서버에 있는 경우 img 파일을 나타내는 url이 필요하고, 서버 내 그림에 사용한 구문이 아닌 다른 구문을 사용해야합니다.

위에서 예시로 든, Qisikit 로고는 Wikipedia 서버에 저장되어 있습니다[https://upload.wikimedia.org/wikipedia/commons/5/51/Qiskit-Logo.svg].

먼저, 외부 이미지는 해당 url 자체로 엔진에서 이미지로 처리합니다.(svg 파일 포멧은 자동으로 처리되지 않습니다. 후술할 img tag를 사용하세요)

<pre>https://upload.wikimedia.org/wikipedia/commons/thumb/5/51/Qiskit-Logo.svg/256px-Qiskit-Logo.svg.png</pre>

https://upload.wikimedia.org/wikipedia/commons/thumb/5/51/Qiskit-Logo.svg/256px-Qiskit-Logo.svg.png

이 경우 caption을 넣고 싶다면 다음과 같이 표를 이용해서 작성해야 합니다.

<pre>
{|
| <image url>
|-
| caption
|}
</pre>

예시

<pre>
{|
| https://upload.wikimedia.org/wikipedia/commons/thumb/5/51/Qiskit-Logo.svg/256px-Qiskit-Logo.svg.png
|-
| caption: Qiskit logo 
|}
</pre>

{|
| https://upload.wikimedia.org/wikipedia/commons/thumb/5/51/Qiskit-Logo.svg/256px-Qiskit-Logo.svg.png
|-
| caption: Qiskit logo 
|}

더 상세한 설정이 필요한 경우(예: resizing) [https://developer.mozilla.org/ko/docs/Web/HTML/Element/img Mozilla 재단의 html img tag] 문서를 참조하세요. 단, 미디어 위키 엔진은 보안상의 이유로 html tag 사용을 기본으로 막고 있습니다. 무분별한 html tag 사용은 유지 보수를 어렵게 하고 보안 문제의 위협이 있습니다.

== 표 ==

다음의 공식문서를 참조할 수 있습니다. [https://www.mediawiki.org/wiki/Help:Tables/ko 미디어 위키:도움말:표]

요약:

한국양자정보학회 위키에서의 모든 기여는 다른 기여자가 편집, 수정, 삭제할 수 있다는 점을 유의해 주세요. 만약 여기에 동의하지 않는다면, 문서를 저장하지 말아 주세요.
또한, 직접 작성했거나 퍼블릭 도메인과 같은 자유 문서에서 가져왔다는 것을 보증해야 합니다(자세한 사항은 한국양자정보학회 위키:저작권 문서를 보세요). 저작권이 있는 내용을 허가 없이 저장하지 마세요!

취소 편집 도움말 (새 창에서 열림)

이 문서에서 사용한 틀:

틀:가짜 단락 (편집)

원본 주소 "https://wiki.qisk.or.kr/문서_검토와_수정"

문서 검토와 수정 편집하기

둘러보기 메뉴

검색