중요
번역은 여러분이 참여할 수 있는 커뮤니티 활동입니다. 이 페이지는 현재 100.00% 번역되었습니다.
19. 부록 : 이 교재에 공헌하기
이 교재에 자료를 추가하려면, 이 부록에 명시된 지침을 따라야 합니다. 이 부록에 있는 조건들을 — 좀 더 명확히 하려는 목적이 아니라면 — 수정해서는 안 됩니다. 이 교재의 품질과 일관성을 유지하기 위해서입니다.
19.1. 리소스 다운로드하기
GitHub 에서 이 문서의 소스를 구할 수 있습니다. 깃(git) 버전 컨트롤 시스템 사용법에 대해서는 GitHub.com 에 문의하십시오.
19.2. 교재 서식
이 교재는 reStructuredText 마크업 언어를 사용하는 파이썬 문서 생성자인 Sphinx 를 이용해서 작성됐습니다. 이 도구들의 사용법은 각 해당 사이트에서 알 수 있습니다.
19.3. 강의 추가하기
새 강의를 추가하려면:
먼저 (최상위
qgis-training-manual디렉터리 바로 아래에) 새 디렉터리를 새 강의의 이름으로 생성하십시오.이 새 디렉터리에
index.rst라는 파일을 생성합니다. 빈 파일인 채로 놔두십시오.최상위 디렉터리에 있는
index.rst파일을 여십시오. 첫 줄은 다음과 같습니다... toctree:: :maxdepth: 2 foreword/index introduction/index
index가 뒤에 붙는 디렉터리 이름 목록이라는 것을 알 수 있습니다. 이 목록이 최상위 인덱스 파일을 각 디렉터리의 인덱스 파일에 연결합니다. 이 목록의 순서가 문서 내부의 강의 순서를 결정합니다.
이 목록에서 새 강의 이름(예를 들면 새 디렉터리에 부여한 이름)을 사용자가 원하는 순서에 추가하고, 뒤에
/index를 붙이십시오.뒤에 오는 강의는 이전 강의에서 배운 지식을 기반으로 하는 것과 같이 강의 순서가 논리적이어야 한다는 사실을 기억하십시오.
새 강의의 인덱스 파일(
강의_이름/index.rst)을 여십시오.페이지의 맨 위에 강의 제목을 생성하십시오:
별표(
*)들로 이루어진 첫 줄을 작성하십시오.그 다음 줄에
Module마크업 구문으로 시작하는 강의 이름을 작성하십시오.다음 줄에 다시 첫 줄과 동일한 개수의 별표를 입력하십시오.
참고
밑줄(underline)과 윗줄(overline)이 강의 제목을 담고 있는 줄보다 짧아서는 안 됩니다.
그 다음 줄은 빈 줄로 남겨두십시오.
강의의 목적 및 내용을 설명하는 짧은 글을 작성하십시오.
한 줄을 띄운 다음, 다음 텍스트를 추가하십시오:
.. toctree:: :maxdepth: 2 lesson1 lesson2
이때
lesson1,lesson2등은 여러분이 계획한 수업 제목들입니다.
강의 수준의 인덱스 파일은 다음과 같이 보일 것입니다:
*******************************************************************************
Module: Module Name
*******************************************************************************
Short paragraph describing the module.
.. toctree::
:maxdepth: 2
lesson1
lesson2
19.4. 수업 추가하기
새 강의 또는 기존 강의에 수업을 추가하려면:
강의 디렉터리를 여십시오.
(새 강의인 경우, 앞에서 생성했던)
index.rst파일을 여십시오.계획한 수업의 이름들이 앞에서와 같이
toctree지시문 아래 나열되어 있는지 확인하십시오.강의 디렉터리에 새 파일을 생성하십시오.
해당 파일의 이름을 강의의
index.rst에 적은 수업 이름과 정확히 동일하게 지정한 다음, 확장자.rst를 추가하십시오.
참고
편집 작업의 경우,
.rst파일은 일반 텍스트 파일(.txt)과 정확히 동일하게 동작합니다.
수업을 작성하기 전에
Lesson마크업 구문으로 시작하는 수업 이름을 작성하십시오.그 다음 줄에 수업 제목보다 짧아서는 안 되는 등호(
=)로 이루어진 줄을 작성하십시오.그 다음 줄은 빈 줄로 남겨두십시오.
수업의 목표를 간단히 설명하십시오.
주제에 대한 일반적인 소개를 포함시키십시오. 이 교재의 기존 수업들을 참고하십시오.
그 아래에 다음 구문으로 시작하는 새 문장을 작성하십시오:
**The goal for this lesson:**
이 수업을 완료하면 얻을 수 있는 결과를 간단히 설명하십시오.
수업의 목표를 문장 하나 또는 두 개로 설명할 수 없을 경우, 해당 주제를 수업 여러 개로 나누는 편이 좋습니다.
각 수업은 다음 단계에서 설명하는 것처럼 여러 절들로 세분화됩니다.
19.5. 절 추가하기
절(section)에는 “따라해보세요(follow along)” 및 “혼자서 해보세요(try yourself)” 두 가지 유형이 있습니다.
“따라해보세요” 절은 사용자에게 QGIS의 지정 측면을 사용하는 방법을 가르치기 위한 상세한 지침들로 이루어집니다. 일반적으로 중간 중간 스크린샷이 들어가는, 가능한 한 명확한 단계별 지침들을 제공합니다.
“혼자서 해보세요” 절은 사용자가 직접 시도해볼 수 있는 간단한 과제를 부여합니다. 이 과제는 보통 과제를 완수하는 방법을 보여주거나 설명하는, 또는 가능한 경우 예상되는 산출물을 보여주는, 과제 아래의 해답란에 있는 항목과 연결됩니다.
각 절은 난이도에 따라 분류됩니다. 초급 절은 ★☆☆, 중급은 ★★☆, 고급은 ★★★ 로 표시합니다.
19.5.1. “따라해보세요” 절 추가하기
이 절을 시작하려면, (앞에서 설명한 대로) 의도한 난이도를 나타내는 마크업 구문을 적으십시오.
한 칸 띄운 다음
Follow Along:이라고 작성하십시오.다시 한 칸 띄운 다음 절 이름을 쓰십시오. (맨 첫 글자만 대문자로 적고, 합당한 명사일 경우에도 첫 글자를 대문자로 적습니다.)
그 다음 줄에 절 제목보다 짧아서는 안 되는 빼기표/붙임표(
-)로 이루어진 줄을 작성하십시오.절의 목적을 설명하는 간단한 소개문을 작성하십시오. 그 다음 시연할 과정에 대한 자세한 (클릭 단계별) 지침을 작성하십시오.
각 절에 필요한 대로 내부 링크, 외부 링크 및 스크린샷을 첨부하십시오.
가능하다면, 결론을 내리는 동시에 자연스럽게 다음 절으로 이어지는 문단으로 각 절을 끝내도록 합니다.
19.5.2. “혼자서 해보세요” 절 추가하기
이 절을 시작하려면, (앞에서 설명한 대로) 의도한 난이도를 나타내는 마크업 구문을 적으십시오.
한 칸 띄운 다음
Try Yourself:라고 작성하십시오.그 다음 줄에 절 제목보다 짧아서는 안 되는 빼기표/붙임표(
-)로 이루어진 줄을 작성하십시오.사용자가 완수하길 바라는 예제를 설명하십시오. 필요할 경우 이전 절, 수업, 또는 강의를 언급하십시오.
텍스트만으로 이루어진 설명이 명확하지 않을 경우, 요구 사항을 명확하게 하는 스크린샷을 첨부하십시오.
대부분의 경우 해당 절이 할당하는 과제를 완수하는 방법에 대한 답안을 제공하고자 할 것입니다. 그러려면 예제 지침 아래에 해답란을 생성하고 채워야 합니다.
먼저 답안을 담고 있는, 접을 수 있는 사용자 정의 위젯을 생성하십시오:
.. admonition:: Answer :class: dropdown
이 블록을 기준으로 들여쓰기를 유지한 채, 필요한 경우 링크 및 이미지를 사용해서 해당 과제를 완수하는 방법에 대한 지침을 작성하십시오.
19.6. 결론 추가하기
수업을 끝내려면:
In Conclusion구문을 작성하고, 그 다음 줄에 그보다 짧아서는 안 되는 빼기표/붙임표(-)로 이루어진 줄을 작성하십시오.해당 수업에서 다루었던 개념들을 설명하는, 수업의 결론을 작성하십시오.
19.7. 더 읽어볼 거리 절 추가하기
이 절이 꼭 필요한 것은 아닙니다.
Further Reading구문을 작성하고, 그 다음 줄에 그보다 짧아서는 안 되는 빼기표/붙임표(-)로 이루어진 줄을 작성하십시오.적합한 외부 웹사이트로 연결되는 링크를 첨부하십시오.
19.8. 다음은 무엇을 배우게 될까요? 절 추가
What's Next?구문을 작성하고, 그 다음 줄에 그보다 짧아서는 안 되는 빼기표/붙임표(-)로 이루어진 줄을 작성하십시오.현재 수업이 어떻게 다음 수업 또는 강의를 위해 사용자를 준비시켰는지 설명하십시오.
필요할 경우 이전 수업의 “다음은 무엇을 배우게 될까요?” 절이 새 수업을 언급하도록 변경하는 일을 잊지 마십시오. 기존 수업들 사이에 또는 기존 수업들 뒤에 새 수업을 삽입하는 경우 필요한 작업입니다.
19.9. 마크업 사용하기
이 문서의 표준을 준수하려면, 여러분의 텍스트에 표준 마크업을 추가해야 합니다.
19.9.1. 새로운 개념
여러분이 새로운 개념을 설명하는 경우, 해당 개념의 이름을 별표(*)로 둘러싸 기울임꼴로 만들어야 합니다.
This sample text shows how to introduce a *new concept*.
19.9.2. 강조
새로운 개념이 아닌 중요한 용어를 강조하려면, 해당 용어를 이중 별표(
**)로 둘러싸 굵은 글씨로 만들어야 합니다.너무 자주 사용하지 않도록 주의하십시오! 강조를 너무 많이 사용할 경우 독자에게 소리를 지르거나 잘난 체하는 것으로 보일 수 있습니다.
This sample text shows how to use **emphasis** in a sentence. Include the
punctuation mark if it is followed by a **comma,** or at the **end of the
sentence.**
19.9.3. Images
이미지를 추가하는 경우, 수업 파일 옆에
img폴더를 생성해서 이 폴더에 이미지를 저장하십시오.문서에 이미지를 다음과 같이 추가하십시오:
.. figure:: img/image_file.extension :align: center
이미지 마크업 위아래에 빈 줄을 삽입하는 것을 잊지 마십시오.
19.9.4. 내부 링크
링크를 위한 앵커(anchor)를 생성하려면, 사용자가 링크가 가리키게 하고자 하는 곳 위에 다음과 같은 줄을 작성하십시오:
.. _link-name:
이 라인 위아래에 빈 줄을 삽입하는 것을 잊지 마십시오.
링크를 생성하려면, 다음과 같이 참조시키십시오:
:ref:`Descriptive link text <link-name>`
19.9.5. 외부 링크
외부 링크를 생성하려면 다음과 같이 작성하십시오:
`Descriptive link text <link-url>`_
19.9.6. 고정폭 텍스트 사용하기
사용자가 입력해야 하는 텍스트, 경로 이름, 테이블이나 열 이름 같은 데이터베이스 요소의 이름 등을 작성할 때,
고정폭 텍스트(monospaced text)로 써야 합니다. 다음은 그 예시입니다:Enter the following path in the text box: ``path/to/file``.
19.9.7. GUI 항목 라벨 작업
버튼 같은 GUI 항목을 언급하는 경우, 그 명칭을 GUI 라벨 서식 으로 써야 합니다. 다음은 그 예시입니다:
To access this tool, click on the :guilabel:`Tool Name` button.
사용자가 버튼을 클릭할 필요 없이, 도구 이름만을 언급할 경우에도 역시 적용됩니다.
19.9.9. 주석 추가하기
텍스트 안에 강의의 흐름의 일부로 쉽게 녹아들지 못 하는 추가적인 세부 사항을 설명하는 주석을 추가해야 할 수도 있습니다. 해당 마크업은 다음과 같습니다:
[Normal paragraph.] .. note:: Note text. New line within note. New paragraph within note. [Unindented text resumes normal paragraph.]
19.10. 감사합니다!
이 프로젝트에 공헌해주셔서 감사합니다! 당신 덕분에 QGIS의 접근성을 향상시키고 전체 QGIS 프로젝트에 가치를 더할 수 있습니다.