중요

번역은 여러분이 참여할 수 있는 커뮤니티 활동입니다. 이 페이지는 현재 62.04% 번역되었습니다.

19. 부록 : 이 교재에 공헌하기

To add materials to this course, you must follow the guidelines in this Appendix. You are not allowed to alter the conditions in this Appendix except for clarification. This is to ensure that the quality and consistency of this manual can be maintained.

19.1. 리소스 다운로드

이 문서의 소스를 GitHub 에서 구할 수 있습니다. Git 버전 컨트롤 시스템 이용법에 대해서는 GitHub.com 에 문의하십시오.

19.2. 교재 서식

이 교재는 reStructuredText 마크업 언어를 사용하는 파이썬 문서 생성자인 Sphinx 를 이용해서 작성됐습니다. 이 도구들의 사용법은 각 해당 사이트에서 알 수 있습니다.

19.3. 모듈 추가

To add a new module:

1. First create a new directory (directly under the top-level of the qgis-training-manual directory) with the name of the new module.

2. Under this new directory, create a file called index.rst. Leave this file blank for now.

3. Open the index.rst file under the top-level directory. Its first lines are:

   .. toctree::
      :maxdepth: 2
   
      foreword/index
      introduction/index
   

You will note that this is a list of directory names, followed by the name index. This directs the top-level index file to the index files in each directory. The order in which they are listed determines the order they will have in the document.

1. Add the name of your new module (i.e., the name you gave the new directory), followed by /index, to this list, wherever you want your module to appear.

2. 뒤에 오는 강의는 이전 강의에서 배운 지식을 기반으로 하는 것과 같이 강의 순서가 논리적이어야 한다는 사실을 기억하십시오.

3. Open your new module’s own index file (module_name/index.rst).

4. Along the top of the page, create the module heading:

   1. write a first line of asterisks (*).

   2. Follow this with a line containing the markup phrase Module:, followed by the name of your module.

   3. End this off with another line of same number of asterisks.

   참고

   The underline and the overline should not be shorter than the line containing the module title.

5. 그 다음 줄은 빈 줄로 남겨두십시오.

6. 강의의 목적 및 내용을 설명하는 짧은 글을 작성하십시오.

7. 한 줄을 띄운 다음, 다음 텍스트를 추가하십시오.

   .. toctree::
      :maxdepth: 2
   
      lesson1
      lesson2
   

   … where lesson1, lesson2, etc., are the names of your planned lessons.

모듈 수준의 인덱스 파일은 다음과 같이 보일 것입니다.

*******************************************************************************
Module: Module Name
*******************************************************************************

Short paragraph describing the module.

.. toctree::
   :maxdepth: 2

   lesson1
   lesson2

19.4. 강의 추가

새 모듈 또는 기존 모듈에 강의를 추가하려면,

1. 모듈 디렉터리를 여십시오.

2. Open the index.rst file (created above in the case of new modules).

3. Ensure that the name of the planned lesson is listed underneath the toctree directive, as shown above.

4. 모듈 디렉터리에 새 파일을 생성하십시오.

5. Name this file exactly the same as the name you provided in the module’s index.rst file, and add the extension .rst.

참고

For editing purposes, a .rst file works exactly like a normal text file (.txt).

1. To begin writing the lesson, write the markup phrase Lesson, followed by the lesson name.

2. In the next line, write a line of equal signs (=), not shorter than the lesson title.

3. 그 다음 줄은 빈 줄로 남겨두십시오.

4. 강의의 목적을 간단히 설명하십시오.

5. 주제에 대한 일반적인 소개를 포함시키십시오. 이 교재의 기존 강의를 참고하십시오.

6. 그 아래에 다음 구문으로 시작하는 새 문장을 작성하십시오.

   **The goal for this lesson:**
   

7. 이 강의를 완료하면 얻을 수 있는 결과를 간단히 설명하십시오.

8. 강의의 목적을 문장 하나 또는 두 개로 설명할 수 없을 경우, 해당 주제를 여러 개의 강의로 나누는 것이 좋습니다.

각 강의는 다음 단계에서 설명하는 것처럼 여러 섹션으로 세분화됩니다.

19.5. 섹션 추가

섹션에는 “따라 하기(follow along)” 및 “직접 해보기(try yourself)” 두 가지 유형이 있습니다.

• “따라 하기” 섹션은 사용자에게 QGIS의 주어진 측면을 사용하는 방법을 가르치기 위한 상세한 지침들로 이루어집니다. 일반적으로 중간 중간 스크린샷이 들어가는 가능한 한 명확한 단계별 지침들을 제공합니다.

• A “try yourself” section gives the reader a short assignment to try by themselves. It is usually associated with an entry in the answer box beneath, which will show or explain how to complete the assignment, and will show the expected outcome if possible.

Every section comes with a difficulty level. An easy section is denoted by ★☆☆, moderate by ★★☆, and advanced by ★★★.

19.5.1. “따라 하기” 섹션 추가

1. 이 섹션을 시작하려면, (앞에서 설명한 대로) 의도한 난이도를 나타내는 마크업 구문을 적으십시오.

2. Leave a space and then write Follow Along:.

3. 다시 한 칸 띄운 다음 섹션 명칭을 쓰십시오. (맨 첫글자만 대문자로 적고, 합당한 명사일 경우에도 첫 글자를 대문자로 적습니다.)

4. In the next line, write a line of minuses/dashes (-), not shorter than the section title.

5. 섹션의 목적을 설명하는 간단한 소개문을 작성하십시오. 그 다음 시연할 과정에 대한 자세한 (클릭 단계별) 지침을 작성하십시오.

6. 각 섹션에 필요한 만큼 내부 링크, 외부 링크 및 스크린샷을 첨부하십시오.

7. 가능하다면, 결론을 내리는 동시에 자연스럽게 다음 섹션으로 이어지는 문단으로 각 섹션을 끝내도록 합니다.

19.5.2. “직접 해보기” 섹션 추가

1. 이 섹션을 시작하려면, (앞에서 설명한 대로) 의도한 난이도를 나타내는 마크업 구문을 적으십시오.

2. Leave a space and then write Try Yourself:.

3. In the next line, write a line of minuses/dashes (-), not shorter than the section title.

4. 사용자가 완수하길 바라는 예제를 설명하십시오. 필요할 경우 이전 섹션, 강의, 또는 모듈을 언급하십시오.

5. 텍스트만으로 이루어진 설명이 명확하지 않을 경우, 요구 사항을 명확하게 하는 스크린샷을 첨부하십시오.

In most cases, you will want to provide an answer regarding how to complete the assignment given in this section. To do so, you will need to create and feed an answer block beneath the instructions.

1. First, create the custom collapsible widget that contains the answer:

   .. admonition:: Answer
      :class: dropdown
   

2. Keeping an indentation with regard to the above block, write the instructions on how to complete the assignment, using links and images where needed.

19.6. 결론 추가

To end a lesson:

1. Write the phrase In Conclusion, followed by a new line of minuses/dashes (-).

2. Write a conclusion for the lesson, explaining which concepts have been covered in the lesson.

19.7. 참고 문헌 섹션 추가

이 섹션이 꼭 필요한 것은 아닙니다.

• Write the phrase Further Reading, followed by a new line of minuses/dashes (-).

• 적합한 외부 웹사이트로 연결되는 링크를 첨부하십시오.

19.8. 다음 주제 섹션 추가

1. Write the phrase What's Next?, followed by a new line of minuses/dashes (-).

2. 현재 강의가 어떻게 다음 강의 또는 모듈을 위해 사용자를 준비시켰는지 설명하십시오.

3. 필요할 경우 이전 강의의 “다음 주제” 섹션이 새 강의를 언급하도록 변경하는 일을 잊지 마십시오. 기존 강의들 사이에 또는 기존 강의 마지막에 새 강의를 삽입하는 경우 필요한 작업입니다.

19.9. 마크업 사용

이 문서의 표준을 준수하려면, 사용자의 텍스트에 표준 마크업을 추가해야 합니다.

19.9.1. 새로운 개념

If you are explaining a new concept, you will need to write the new concept’s name in italics by enclosing it in asterisks (*).

This sample text shows how to introduce a *new concept*.

19.9.2. 강조

• To emphasize a crucial term which is not a new concept, write the term in bold by enclosing it in double asterisks (**).

• 사용에 주의하십시오! 강조를 너무 많이 사용할 경우 독자에게 소리를 지르거나 잘난 체하는 것으로 보일 수 있습니다.

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. 이미지

• When adding an image, save it to an img folder next to the lesson file.

• 문서에 다음과 같이 이미지를 추가하십시오.

  .. figure:: img/image_file.extension
     :align: center
  

• 이미지 마크업 위아래에 빈 줄을 삽입하는 것을 잊지 마십시오.

19.9.4. 내부 링크

• 링크를 위한 앵커(anchor)를 생성하려면, 사용자가 링크가 가리키게 하고자 하는 곳 윗 줄에 다음과 같은 라인을 작성하십시오.

  .. _link-name:
  

• 이 라인 위아래에 빈 줄을 삽입하는 것을 잊지 마십시오.

• To create a link, refer to it as below:

  :ref:`Descriptive link text <link-name>`
  

19.9.5. 외부 링크

• 외부 링크를 생성하려면 다음과 같이 작성하십시오.

  `Descriptive link text <link-url>`_
  

19.9.6. 고정폭 텍스트 사용

• When you are writing text that the user needs to enter, a path name, or the name of a database element such as a table or column name, you must write it in monospaced text. For example:

  Enter the following path in the text box: ``path/to/file``.
  

19.9.7. GUI 항목 라벨링

• 버튼 같은 GUI 항목을 언급하는 경우, 그 명칭을 다음과 같이 the GUI label format 으로 써야 합니다.

  To access this tool, click on the :guilabel:`Tool Name` button.
  

• 사용자가 버튼을 클릭할 필요 없이, 도구명만을 언급할 경우에도 역시 적용됩니다.

19.9.8. 메뉴 선택

• 사용자에게 메뉴를 안내할 경우, 그 명칭을 다음과 같이 menu ► selection ► format 으로 써야 합니다.

  To use the :guilabel:`Tool Name` tool, go to :menuselection:`Plugins -->
  Tool Type --> Tool Name`.
  

19.9.9. 주석 추가

• You might need to add a note in the text, which explains extra details that can’t easily be made part of the flow of the lesson. This is the markup:

  [Normal paragraph.]
  
  .. note:: Note text.
    New line within note.
  
    New paragraph within note.
  
  [Unindented text resumes normal paragraph.]
  

19.9.10. 스폰서/작성자 주석 추가

스폰서를 대신해서 새 모듈, 강의 또는 섹션을 작성하는 경우, 스폰서가 선택한 간단한 스폰서의 메시지를 첨부해야 합니다. 이 메시지는 독자들에게 스폰서의 명칭을 알려야 하며, 스폰서가 후원하는 모듈, 강의 또는 섹션 제목 아래에 위치해야 합니다. 하지만, 꼭 스폰서 회사를 위한 광고일 필요는 없습니다.

If you have volunteered to write a module, lesson or section in your own capacity, and not on behalf of a sponsor, you may include an authorship note below the heading of the module, lesson or section that you authored. This must take the form This [module/lesson/section] contributed by [author name]. Do not add further text, contact details, etc. Such details are to be added in the “Contributors” section of the Foreword, along with the name(s) of the part(s) you added. If you only made enhancements, corrections and/or additions, list yourself as an editor.

19.10. 감사합니다!

이 프로젝트에 공헌해주셔서 감사합니다! 당신 덕분에 QGIS의 접근성을 향상시키고 전체 QGIS 프로젝트에 가치를 더할 수 있습니다.