Skip to content
정성태 edited this page Jan 17, 2017 · 6 revisions

한글 번역 문서

https://django-document-korean.readthedocs.io/ko/latest/

위 번역 문서는 저장소가 업데이트 될때마다 자동으로 만들어집니다.

번역 참여 방법

소개

많은 사용자 층을 가진 파이썬 웹 프레임워크 Django는 많은 사람들의 기여로 문서화도 충실하게 되어있습니다. 분량도 2만 4천 문장 이상으로 상당한 규모입니다. 대부분의 Django 개발에 필요한 지식을 담고 있습니다.

목적

우리는 협업을 통해 영어로 작성된 Django 공식 문서를 한글로 번역하는 작업을 진행하고자 합니다.

협업을 원활하게 진행하기 위한 도구들이 있습니다. 그 중 웹 기반의 번역 플랫폼인 트랜시펙스(www.transifex.com)를 사용합니다. Django 공식 문서는 읽기 쉬운 WYSIWYG마크업 언어이자 해석 시스템인 ReST(reStructuredText)로 작성되었고, 파이썬계의 문서화 도구인 Sphinx(www.sphinx-doc.org)로 생성되었습니다.

이 문서는 ReST 문법, 트랜시펙스 사용, 스핑크스 빌드, 공식문서로의 반영에 대한 안내를 통해 번역 작업 참가자에게 도움을 주기위한 문서입니다.

ReST(reStructuredText) 문법

원문 Django 공식 문서가 ReST로 작성되었기 때문에 번역을 할 때 내용 중간중간 ReST 마크업들이 보이게 됩니다. 이 부분을 그대로 반영하여 번역문을 작성하여야 문서가 온전하게 출력됩니다. 눈에 익을 정도만 알아두시면 도움이 됩니다.

아래 표는 Inline Markup을 몇 개 정리한 것입니다.

Plain text Typical result Notes
*emphasis* emphasis 이탤릭체
**strong emphasis** strong emphasis 볼드체
`interpreted text` 오른쪽 노트 참조 해석 된 텍스트의 출력 및 의미는 도메인 또는 응용 프로그램에 따라 달라짐. 인덱스 엔트리나 명시적 설명 마크업(예 : 프로그램 식별자와 같은)에 사용될 수 있슴.
(역자주; 도메인별 설정에 따라 달라진다는 의미같습니다. Djangno 문서의 경우 단독으로 쓰이는 경우는 보지 못하였고, :doc: 이나 :djadmin:, :ref: 와 함께 사용되는 경우가 많습니다.
원문)
``inline literal`` inline literal 일반적인 고정폭 문자열로 그려짐. 공백은 유지되지만 줄 바꿈은 적용되지 않음.
reference_ reference 간단한 하이퍼링크 참조. Hyperlink Targets

External hyperlinks, like Python_. 와 같이 링크를 걸 단어에 underscore를 1개 붙여 작성하고, 하단에 대상을 다음과 같이
.. _Python: https://www.python.org/ 추가하면

External hyperlinks, like Python 와 같이 링크가 걸리게 보여집니다.

링크의 대상을 내부에 추가할 수도 있습니다.

External hyperlinks, like `Python https://www.python.org/`_.와 같이 작성할 경우
External hyperlinks, like Python 이렇게 출력됩니다.
`phrase reference`_ phrase reference 하이퍼링크(구문)
anonymous__ anonymous 하이퍼링크 참조의 경우
1.이름지어진 하이퍼링크 참조가 있고
2.익명의 하이퍼링크 참조가 있습니다.
상단의 underscore를 1개 사용한 경우가 이름 지어진 하이퍼링크입니다.
underscore를 2개 사용하는 이름지어진 하이퍼링크는 대상을 명확히 지정하지 않습니다. 대신 문서 내의 익명의 하이퍼 링크 및 대상 순서로 인식합니다. 첫 번째 익명 참조는 첫 번째 익명 대상에 연결됩니다. 그러므로 문서 내에서 익명의 하이퍼 링크 참조 수는 익명 대상 수와 일치해야 하겠죠.

더 많은 내용은 공식문서를 참고 바랍니다.

트랜시펙스 사용

위에서 이야기한 것처럼 트랜시펙스(www.transifex.com)는 웹 기반 번역 플랫폼이므로 별다른 준비물이 필요하지 않습니다. 웹브라우져만 있다면 언제 어디서든 번역작업을 할 수 있습니다.

번역을 하기 위해 진행할 순서는 다음과 같습니다.

  1. 트랜시펙스 계정 만들기
  2. 장고 문서 한글화 프로젝트 가입
  3. 번역하기

1. 트랜시펙스 계정 만들기

https://www.transifex.com/signup/ 에 가서 가입합니다. 중간에 번역 프로젝트를 생성할 것인지 다른 프로젝트에 참여할 것인지 선택하는 부분이 있는데… 당장 생성할 것이 아니라면 참여쪽을 선택하시면 됩니다.
가입할 때 기입한 메일로 인증 메일로 발송되므로 메일을 확인하여 계정을 활성하는 것을 잊지마세요.

2. 장고 문서 한글화 프로젝트 가입

원래는 Explore 페이지에서 참여하고자하는 프로젝트를 검색하면 되는데, 현재 검색이 잘되지 않습니다. 이 링크 https://www.transifex.com/sk8erchoi/django-docs-korean/를 클릭해서 현재 우리가 진행 중인 프로젝트 페이지로 방문합니다.


Join Team 버튼을 클릭하여 가입신청을 합니다.


프로젝트 매니져가 신청을 승인하면 번역 작업이 가능합니다. 대부분 1일 이내로 승인이 이루어지나 늦어질 경우 페이스북 그룹에 메시지를 남겨주세요.

3. 번역하기

번역을 하기위한 영문 Django 공식 문서 파일들이 트랜시펙스 프로젝트에 모두 업로드된 상태이므로 바로 진행하시면 됩니다.

아래 그림은 로그인 후 대시 보드 화면입니다.


Translate 버튼을 클릭해주세요.


번역할 언어를 선택하세요.(Korean)


번역할 부분을 선택하세요. (현재 intro 가 완료된 상태이고 howto에 참여하시면 됩니다.)


실제 번역하는 화면입니다. 왼쪽이 원문입니다. 번역할 부분을 클릭하시면 됩니다. 선택된 문자열은 오른쪽 상단에 UNTRANSLATED STRING에 출력됩니다. 그 아래 (빨간색 화살표)부분에 한글을 입력하시고 Save 버튼이나 Save all 버튼을 클릭하시면됩니다. Tab 키를 누르시면 저장과 동시에 다음 문장으로 이동합니다.


참고할 내용

  • Copy source string 원문을 그대로 복사할 때 사용합니다. Rest 문법이 적용된 구문이 많을 경우 사용하시면 도움이 됩니다.
  • Machine translate 구글 번역기의 번역 결과를 출력해주나… 현재 동작을 안합니다.
  • Revert translation 번역결과를 되돌릴 때 사용합니다.

스핑크스빌드

작성중...

공식문서로 포함

작성중...