From 9d1e8aeb7749b2bdc4f8bf0fc9390f0dd6c2c45c Mon Sep 17 00:00:00 2001 From: hochan Lee Date: Sun, 19 Feb 2023 19:58:00 +0900 Subject: [PATCH] =?UTF-8?q?[ko]=20=EA=B0=80=EC=9D=B4=EB=93=9C=20=EB=82=B4?= =?UTF-8?q?=EC=9A=A9=20=EC=B6=94=EA=B0=80=204.0=20(#11595)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: guide, instruction, directives glossary 가이드 추가 * 한국 가이드 파일들에 대한 링크 규칙 * Meta Data 안내서 추가 * 번역 to 안내서 * 안내 문구 위치 변경 및 내용 추가 Co-authored-by: SnowMarble * remove legacy guide * feat glossary guide * 문서 연결 경로 가이드 추가 * Redirects Files 안내 추가 * fix: Redirects Files commands * PR 파일 개수 안내 추가 * Mantissa 추가 * refactor translated guide title * refactor: etc guide * Dictionary 추가, glossary guide * Inline code 안내 추가 * Sparse array 추가 --------- Co-authored-by: SnowMarble --- docs/ko/README.md | 44 ++++--- docs/ko/guides/archieved/html-guide.md | 35 ++++++ .../markdown-conversion-guide.md | 4 +- docs/ko/guides/etc-guide.md | 35 +----- docs/ko/guides/github-actions-guide.md | 42 +++++++ docs/ko/guides/glossary-guide.md | 55 ++++----- docs/ko/guides/macro-guide.md | 2 +- docs/ko/guides/meta-data-guide.md | 60 +++++++++ docs/ko/guides/organizer-guide.md | 12 +- docs/ko/guides/translation-guide.md | 114 +++++++++--------- 10 files changed, 251 insertions(+), 152 deletions(-) create mode 100644 docs/ko/guides/archieved/html-guide.md rename docs/ko/guides/{ => archieved}/markdown-conversion-guide.md (93%) create mode 100644 docs/ko/guides/github-actions-guide.md create mode 100644 docs/ko/guides/meta-data-guide.md diff --git a/docs/ko/README.md b/docs/ko/README.md index b7797ed41cada0..c52ddde0304682 100644 --- a/docs/ko/README.md +++ b/docs/ko/README.md @@ -1,25 +1,31 @@ # 목차 -1. **[MDN 번역 콘텐츠에 대한 일반 지침](#MDN-번역-콘텐츠에-대한-일반-지침)** -2. **[첫 기여자들을 위한 지침 안내](#첫-기여자들을-위한-지침-안내)** +1. **[MDN 번역 콘텐츠에 대한 일반 안내서](#MDN-번역-콘텐츠에-대한-일반-안내서)** +2. **[첫 기여자들을 위한 안내서](#첫-기여자들을-위한-안내서)** 3. **[yari 빠른 사용법](#yari-빠른-사용법)** -4. **[여러 지침 안내](#여러-지침-안내)** +4. **[여러 안내서](#여러-안내서)** 5. **[자주 묻는 질문](#자주-묻는-질문)** 6. **[맺음말](#맺음말)** --- -## MDN 번역 콘텐츠에 대한 일반 지침 +## MDN 번역 콘텐츠에 대한 일반 안내서 -이 문서는 한국(ko) 지역에 대한 번역 지침입니다. 몇 가지 특정 지침을 문서화하는 페이지를 추가하고 싶은 경우, 현재 경로에 추가하거나 [Locale Teams](https://github.com/mdn/translated-content/blob/main/PEERS_GUIDELINES.md#review-teams)에 문의해주세요. +이 문서는 한국(ko) 지역에 대한 번역 안내서입니다. 몇 가지 특정 안내서를 문서화하는 페이지를 추가하고 싶은 경우, 현재 경로에 추가하거나 [Locale Teams](https://github.com/mdn/translated-content/blob/main/PEERS_GUIDELINES.md#review-teams)에 문의해주세요. -마찬가지로 추가하려는 일반 지침에 대한 좋은 아이디어가 있는 경우 환영합니다. Issue를 열고 문제에 대해 이야기해주세요. 다음은 한국어 번역 지침 원칙의 주요 내용입니다. +마찬가지로 추가하려는 일반 안내서에 대한 좋은 아이디어가 있는 경우 환영합니다. Issue를 열고 문제에 대해 이야기해주세요. 다음은 한국어 번역 안내서 원칙의 주요 내용입니다. -## 첫 기여자들을 위한 지침 안내 +## 첫 기여자들을 위한 안내서 MDN의 모든 로케일은 `en-us`를 기준으로 변역이 진행되고 있습니다. 한국 로케일[(translated-content)](https://github.com/mdn/translated-content)도 `en-us`[(content)](https://github.com/mdn/content)를 기반으로 번역이 진행되고 있습니다. **따라서, `ko`와 `en-us` 문서 사이에 차이가 있다면, 마크업을 포함하여 `en-us` 문서를 기준으로 번역하여 `translated-content` 저장소에 기여할 수 있습니다.** -[번역 지침](./guides/translation-guide.md), [용어 지침](./guides/glossary-guide.md) 및 [macro 지침](./guides/macro-guide.md)을 숙지 후 기여해주세요. +[번역 안내서](./guides/translation-guide.md), [용어 안내서](./guides/glossary-guide.md) 및 [macro 안내서](./guides/macro-guide.md)을 숙지 후 기여해주세요. + +### PR 파일 개수 + +PR 생성시에 한국 리뷰어들은 라운드 로빈 방식으로 배정이 되고 있습니다. 한 리뷰어에게 너무 많은 리뷰가 몰리지 않도록 번역 PR의 경우 1개의 파일을 넘지 않는 것을 권장합니다. + +사소한 변화 및 일괄적인 작업 PR에 대해서는 30개의 파일을 넘지 않는 것을 권장합니다. ### PR 규칙 @@ -59,22 +65,24 @@ yari 가 content repo에 내장돼있습니다. 세부 절차는 [다음 링크] 다음과 같이 진행하면 아래와 같이 실시간으로 반영사항을 확인할 수 있고 4가지 편집 버튼으로 편집할 수 있습니다. ![image](https://user-images.githubusercontent.com/22424891/117309001-002e0500-aebd-11eb-9842-8f78a99e8873.png) -## 여러 지침 안내 +## 여러 안내서 -지침은 기여 과정을 원활하고 효율적으로 만드는 데 매우 유용합니다. 기여하기 전에 다음 지침들을 주의 깊게 읽어주세요. +안내서는 기여 과정을 원활하고 효율적으로 만드는 데 매우 유용합니다. 기여하기 전에 다음 안내서들을 주의 깊게 읽어주세요. -- [번역 지침](./guides/translation-guide.md) -- [용어 지침](./guides/glossary-guide.md) -- [macro 지침](./guides/macro-guide.md) -- [기타 지침](./guides/etc-guide.md) +- [번역 안내서](./guides/translation-guide.md) +- [메타 데이터 안내서](./guides/meta-data-guide.md) +- [용어 안내서](./guides/glossary-guide.md) +- [macro 안내서](./guides/macro-guide.md) +- [github actions 안내서](./guides/github-actions-guide.md) +- [기타 안내서](./guides/etc-guide.md) -다음은 리뷰어를 위한 지침입니다. +다음은 리뷰어를 위한 안내서입니다. -- [MDN yari-content-ko 팀 지침](./guides/organizer-guide.md) +- [MDN yari-content-ko 팀 안내서](./guides/organizer-guide.md) -다음은 보관된 지침입니다. +다음은 보관된 안내서입니다. -- [마크다운 변환 지침](./guides/markdown-conversion-guide.md) +- [마크다운 변환 안내서](./guides/markdown-conversion-guide.md) ## 자주 묻는 질문 diff --git a/docs/ko/guides/archieved/html-guide.md b/docs/ko/guides/archieved/html-guide.md new file mode 100644 index 00000000000000..21fea8bae033f1 --- /dev/null +++ b/docs/ko/guides/archieved/html-guide.md @@ -0,0 +1,35 @@ +# HTML 번역 안내서 + +## heading ID 번역 + +기사 제목에는 거의 항상 ID가 주어지는데, 기사 내에서 네비게이션을 자동으로 생성하고 실시간 샘플을 생성하기 위한 코드 블록을 식별하는 등의 이유가 있습니다. 제목을 번역 할 때 ID도 같이 번역 할 필요가 없습니다. 나머지 슬러그는 번역되지 않으므로 모든 것이 일관되게 유지됩니다. + +예를 들면: + +```html +

Tutorials

+``` + +`ko` 지역 에서 + +```html +

튜토리얼

+``` + +일반적으로 모든 ID를 소문자로 작성하는 것이 좋습니다. 플랫폼은 어쨌든 렌더링시 자동으로 변환하지만 소문자로 유지하면 변환으로 인해 수동으로 만든 앵커 링크가 작동하지 않을 가능성이 적습니다. + +## HTML 소스의 줄 바꿈 + +일부 기사 소스 코드에서, 반드시 필요하지 않은 블록 수준 요소에서 줄 바꿈을 찾을 수 있습니다. 예를 들면 다음과 같습니다. + +```html +

The + HTMLCanvasElement.transferControlToOffscreen() + method transfers control to an {{domxref("OffscreenCanvas")}} object, either on the main + thread or on a worker.

+ +
OffscreenCanvas HTMLCanvasElement.transferControlToOffscreen()
+``` + +일반적으로 소스 코드에서 이와 같은 줄 바꿈을 사용하지 않으므로 원하는 경우 자유롭게 제거 할 수 있으며 새 번역을 만들 때 추가하지 마십시오. 그러나 최종 렌더링 결과에 영향을 미치지 않으므로 이를 제거하는 데 너무 많은 시간을 소비하지 마십시오. \ No newline at end of file diff --git a/docs/ko/guides/markdown-conversion-guide.md b/docs/ko/guides/archieved/markdown-conversion-guide.md similarity index 93% rename from docs/ko/guides/markdown-conversion-guide.md rename to docs/ko/guides/archieved/markdown-conversion-guide.md index 21c1b38b9201bf..b67babaedaa9f9 100644 --- a/docs/ko/guides/markdown-conversion-guide.md +++ b/docs/ko/guides/archieved/markdown-conversion-guide.md @@ -1,4 +1,4 @@ -# MDN ko locale Markdown 번역에 대한 일반 지침 +# MDN ko locale Markdown 번역에 대한 일반 안내서 > 참고: 2022.11월부터 모든 .html 파일들이 .md 파일로 변환 되었습니다. 이 파일을 참고용으로만 사용 부탁드립니다. @@ -26,7 +26,7 @@ html 파일에 대한 commit은 오로지 확장자를 바꾸는 것만 허용 일반 PR 방식대로 진행합니다. -## MDN ko locale Markdown 번역에 대한 일반 지침 (리뷰어) +## MDN ko locale Markdown 번역에 대한 일반 안내서 (리뷰어) 1. `존재하는 파일에 대한 변경 (존재하는 파일이 .html 확장자일 경우)`에 대해서는 `squash and merge`가 아닌 `rebase and merge`를 진행해야합니다. 2. 파일에 대한 Git History가 유지되는지 확인해주세요. diff --git a/docs/ko/guides/etc-guide.md b/docs/ko/guides/etc-guide.md index 0c62158d1bc234..bf7819b086976b 100644 --- a/docs/ko/guides/etc-guide.md +++ b/docs/ko/guides/etc-guide.md @@ -1,40 +1,7 @@ -# 기타 지침 +# 기타 안내서 ## code formatter 번역 기여자의 편의성을 위해 code formatter를 사용할 수 있습니다. 강제 사항은 아니지만 통일성을 위해 기준을 아래와 같이 정했습니다. code formatter의 한 종류인 Prettier의 기본 설정을 따르며, 추가적으로 `printWidth: 120`, `semi: false`, `singleQuote: true`옵션이 추가됩니다. [참고 PR](https://github.com/mdn/translated-content/pull/1065) - -## All hidden paragraphs about Browser Compatibility can be deleted - -issue: [#1008](https://github.com/mdn/translated-content/issues/1008) - -다음은 `en-us locale`에 대한 기본 compatibility 항목입니다. 현재 `ko locale`에는 여러 번역 문구들이 있습니다. 이 문구들은 모두 삭제돼야합니다. - -1차적으로 로 30가지 경우에 대해 [PR 1176](https://github.com/mdn/translated-content/pull/1176) 에서 처리했으며, 나머지 경우에 대해 정규표현식을 작성해 삭제하거나 발견시 삭제 바랍니다. - -### 기본 항목 - -- 1 - -```html - -``` - -- 2 - -```html - -``` - -- 3 - -```html - -``` diff --git a/docs/ko/guides/github-actions-guide.md b/docs/ko/guides/github-actions-guide.md new file mode 100644 index 00000000000000..2947f950e29c6d --- /dev/null +++ b/docs/ko/guides/github-actions-guide.md @@ -0,0 +1,42 @@ +# Github Actions 안내서 + +발생하는 모든 오류는 기본적으로 Github Actions에서 발생하는 로그를 참고하여, 기여자가 직접 수정해야 합니다. 해결에 어려움이 있다면 주저말고 배정된 리뷰어 분을 멘션해주세요. + +다음은 염두에 두어야 할 몇 가지 지침입니다. + +## Redirects Files + +보통의 경우 파일 삭제시 [_redirects.txt](https://github.com/mdn/translated-content/blob/main/files/ko/_redirects.txt)를 갱신해주어야 합니다. + +[yari](https://github.com/mdn/yari)에서 아래 명령어를 통해 [translated-content](https://github.com/mdn/translated-content)의 [_redirects.txt](https://github.com/mdn/translated-content/blob/main/files/ko/_redirects.txt) 파일을 갱신할 수 있습니다. + +```bash +yarn tool validate-redirects ko --strict +``` + +혹은 [content repo](https://github.com/mdn/content)에서 아래 명령어를 통해 갱신할 수 있습니다. + +```bash +yarn content validate-redirects ko --strict +``` + +## Markdown Lint + +### 한국 가이드 파일들에 대한 링크 규칙 (해당되는 파일 경로: `/docs/ko/guides/*.*`) + +/files/ko 폴더 하위에 있는 마크다운 파일들은 오류가 발생하지 않지만, /docs/ko/guides 폴더 하위에 있는 안내서와 관련된 파일들은 린트 오류가 발생하여 다음 방법으로 해결 할 수 있습니다. [참고](https://github.com/mdn/translated-content/pull/11031#discussion_r1066091908) + +Markdown Lint 규칙을 우회하기위해 `https://developer.mozilla.org/`로 시작하는 링크들은 맨 아래로 이동해서 작성합니다. + +예를들어, `[CSS 기본 박스 모델 입문](https://developer.mozilla.org/ko/docs/Web/CSS/CSS_Box_Model/Introduction_to_the_CSS_box_model)`에서 `[CSS 기본 박스 모델 입문]` 부분은 `[CSS 기본 박스 모델 입문][]`로 작성하고, + +```md +| Padding | 안쪽 여백(패딩) | | [CSS 기본 박스 모델 입문][] | +``` + +`(https://developer.mozilla.org/ko/docs/Web/CSS/CSS_Box_Model/Introduction_to_the_CSS_box_model)`부분은 페이지 가장 하단에 아래와 같이 작성해야합니다. + + +```md +[CSS 기본 박스 모델 입문]: https://developer.mozilla.org/ko/docs/Web/CSS/CSS_Box_Model/Introduction_to_the_CSS_box_model +``` diff --git a/docs/ko/guides/glossary-guide.md b/docs/ko/guides/glossary-guide.md index 72617e92f55cc4..72c0e64530aef3 100644 --- a/docs/ko/guides/glossary-guide.md +++ b/docs/ko/guides/glossary-guide.md @@ -1,4 +1,4 @@ -# 용어 지침 +# 용어 안내서 새로운 용어를 추가할 때, 기존 문서의 레거시와 [국립 국어원 한국어 어문 규범](https://kornorms.korean.go.kr/main/main.do)을 고려해 추가할 것을 권장합니다. [국립 국어원 온라인가나다](https://www.korean.go.kr/front/onlineQna/onlineQnaList.do?mn_id=216)에서 어문 규범, 어법, 표준국어대사전 내용 등에 대하여 문의할 수 있습니다. @@ -21,7 +21,7 @@ - 예: 정수 값, 소수 값, 반환 값, 기본 값 - 틀린 예: 정숫값, 소숫값, 반환값, 기본값 -## 용어 지침 `참고 링크` 우선 순위 +## 용어 안내서 `참고 링크` 우선 순위 - 1. 해당 단어에 대한 의견을 나눈 PR 링크 - 2. 적절한 ko MDN 문서 링크 @@ -40,7 +40,7 @@ | Aliasing | 별칭 | [링크](https://github.com/mdn/translated-content/pull/1779/files) | | Brief history | 간략한 역사 | [링크][HTML#%EA%B0%84%EB%9E%B5%ED%95%9C_%EC%97%AD%EC%82%AC] | | Browser compatibility | 브라우저 호환성 | [링크](https://github.com/mdn/translated-content/pull/1779/files) | -| Browser support | 브라우저 지원 | [링크](http://localhost:5042/en-us/docs/Web/API/Web_Audio_API/Using_IIR_filters#browser_support) | +| Browser support | 브라우저 지원 | [링크][Using_IIR_filters] | | Concept | 개념 | | | Conclusion | 결론 | | | Contact us | 문의하기 | | @@ -48,17 +48,23 @@ | Description | 설명 | [링크][Array] | Example | 예제 | [링크][target] | | Examples | 예제 | [링크](https://github.com/mdn/translated-content/blob/main/files/ko/web/javascript/reference/global_objects/proxy/proxy/apply/index.md) | -| Guides | 지침 | | +| Guides | 안내서 | | | In this module | 이번 과정에서는 | [링크][React_getting_started] | +| Instance properties | 인스턴스 속성 | | +| Instance methods | 인스턴스 메서드 | | | Learn More | 더 알아보기 | [링크][Mutable] | | Next steps | 다음 단계 | [링크][2D_breakout_game_Phaser] | | Polyfill | 폴리필 | [링크](https://github.com/mdn/translated-content/pull/1779/files) | | Reference | 참고서 | | | See also | 같이 보기 | [링크][target] | | Specifications | 명세서 | [링크](https://github.com/mdn/translated-content/pull/1779/files) | +| Static properties | 정적 속성 | | +| Static methods | 정적 메서드 | | +| Sticky activation | 고정 활성화 | | | Summary | 요약 | | | Syntax | 구문 | [링크][target] | | Tools & resources | 도구 & 리소스 | [링크][JavaScript] | +| Transient activation | 임시 활성화 | | | Tutorial | 자습서 | | | Usage notes | 사용 일람 | | | Web Technologies | 웹 기술들 | [링크][Introduction_to_HTML5_Game_Development] | @@ -72,35 +78,14 @@ | 용어 | 번역 | 참고 링크 | | --- | --- | --- | | Compatibility notes | 호환성 참고 사항 | [링크][target] | -| Parameters | 매개변수 | [링크](http://localhost:5042/en-US/docs/Web/API/AudioWorkletNode/AudioWorkletNode#parameters) | +| Directives | 지시어 | [링크][https://github.com/mdn/translated-content/issues/11093#issuecomment-1411005106] | +| Guide | 안내서 | [링크][https://github.com/mdn/translated-content/issues/11093#issuecomment-1411005106] | +| Instruction | 지침 | [링크][https://github.com/mdn/translated-content/issues/11093#issuecomment-1411005106] | +| Naming | 이름 지정 | | +| Parameters | 매개변수 | [링크][AudioWorkletNode] | +| Requirements | 요구 사항 | | | Value | 값 | [링크][target] | -## 안내 문구 - -각 페이지의 안내 문구에 대한 단어 정의입니다. - -**사전 순으로 용어집을 편집해주세요.** - -| 용어 | 번역 | 참고 링크 | -| --- | --- | --- | -| Note | 참고 | | -| Warning | 경고 | | -| Callout | 알림 | | -| Objective | 목표 | [링크][What_is_accessibility] | -| Prerequisites | 필요한 사전 지식 | [링크][What_is_accessibility] | - -- callout - -```markdown -> **알림:** -> -> #### 프론트엔드 웹 개발자가 되고자 하시나요? -> -> 목표를 달성하기 위한 모든 필수 정보가 들어있는 교육 과정을 준비했습니다. -> -> [**시작하기**](/en-US/docs/Learn/Front-end_web_developer) -``` - ## 공통 용어 **사전 순으로 용어집을 편집해주세요.** @@ -123,7 +108,9 @@ | Global | 전역 | | | Glossary | 용어 사전 | | | Grammar | 문법 | | +| In modern browsers | 최신 브라우저 | | | Literal | 리터럴 | | +| Mantissa | 가수부 | | | Method | 메서드 | [국립국어원 Method](https://www.korean.go.kr/front/onlineQna/onlineQnaView.do?mn_id=216&qna_seq=11976) | | Module | 모듈 | ESM에서 명시하는 모듈의 경우 '모듈'로 변역한다. | | | Module | 과정 | 어떠한 교육 과정, 단위에 의한 표현은 '과정'으로 번역한다. (예: In this module) | | @@ -180,6 +167,7 @@ | Argument | 전달인자, 인수 | | [참고 링크](https://github.com/mdn/translated-content/pull/3888) | | Blocking operation | 블로킹 연산 | | | | Callback | 콜백 | | | +| Dictionary | 사전 | | [참고 링크](https://github.com/mdn/translated-content/pull/10976#discussion_r1073704799) | | Fulfilled | 이행(함) | | | | Handler | 처리기 | 이벤트 처리기 | | | Interface | 인터페이스 | | | @@ -195,8 +183,9 @@ | Reject | 거부 | | | | Resolve | 이행 | | | | Rest parameters | 나머지 매개변수 | | [참고 링크](https://github.com/mdn/translated-content/pull/2549/files) | +| Scope | 범위 | | | | Settled | 처리 | | | -| Scope | 스코프 | | | +| Sparse array | 희소 배열 | | | | Temporal Dead Zone, TDZ | 시간상 사각지대 | | [참고 링크](https://github.com/mdn/translated-content/pull/2626/files) | | TypedArray | 형식화 배열 | | | @@ -209,6 +198,8 @@ | Request Body | 요청 본문 | | | | Response Body | 응답 본문 | | | +[AudioWorkletNode]: https://developer.mozilla.org/en-US/docs/Web/API/AudioWorkletNode/AudioWorkletNode#parameters +[Using_IIR_filters]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_IIR_filters#browser_support [CSS 기본 박스 모델 입문]: https://developer.mozilla.org/ko/docs/Web/CSS/CSS_Box_Model/Introduction_to_the_CSS_box_model [Introduction_to_HTML5_Game_Development]: https://developer.mozilla.org/en-US/docs/Games/Introduction_to_HTML5_Game_Development [HTML#%EA%B0%84%EB%9E%B5%ED%95%9C_%EC%97%AD%EC%82%AC]: https://developer.mozilla.org/ko/docs/Glossary/HTML#%EA%B0%84%EB%9E%B5%ED%95%9C_%EC%97%AD%EC%82%AC diff --git a/docs/ko/guides/macro-guide.md b/docs/ko/guides/macro-guide.md index a2be4c9d84deca..adabb0b3e6f8cf 100644 --- a/docs/ko/guides/macro-guide.md +++ b/docs/ko/guides/macro-guide.md @@ -1,4 +1,4 @@ -# macro 지침 +# macro 안내서 ## 명세서 diff --git a/docs/ko/guides/meta-data-guide.md b/docs/ko/guides/meta-data-guide.md new file mode 100644 index 00000000000000..a52fd7b5f53073 --- /dev/null +++ b/docs/ko/guides/meta-data-guide.md @@ -0,0 +1,60 @@ +# Meta Data 안내서 + +## 메타데이터 사용 + +문서의 상단에 있는 메타데이터는 `title`, `slug`, `original_slug` 그리고 `l10n.*`만 사용합니다. (참고: [#7412](https://github.com/mdn/translated-content/issues/7412)) + +영어 원문 + +```markdown +--- +title: Proxy +slug: Web/JavaScript/Reference/Global_Objects/Proxy +tags: + - Class + - ECMAScript 2015 + - JavaScript + - Proxy +- browser-compat: javascript.builtins.Proxy +--- + +{{JSRef}} + +The `Proxy` object enables you to create a proxy for another ... + : +``` + +번역본 + +```markdown +--- +title: Proxy +slug: Web/JavaScript/Reference/Global_Objects/Proxy +--- + +{{JSRef}} + +**`Proxy`** 객체는 기본적인 동작(속성 접근, 할당, 순회, 열거, 함수 ... + : +``` + +## 페이지 갱신 표시 + +번역된 페이지가 `en-US` 페이지에 대해 얼마나 뒤쳐져 있는지 알 수 있는 마땅한 방법이 없습니다. `l10n.sourceCommit` 메타데이터를 추가하여 현재 문서가 명시된 `en-US`의 hash 까지 최신 상태를 유지하고 있음을 나타낼 수 있습니다. (참고: [How to indicate "content parity" of localized documents vs en-US counterparts?](https://github.com/orgs/mdn/discussions/129)) + +- sourceCommit: `en-US` 페이지의 가장 최신 40자리 hash를 명시합니다. + +```md +--- +title: TypedArray.prototype.entries() +slug: Web/JavaScript/Reference/Global_Objects/TypedArray/entries +l10n: + sourceCommit: 2eb202adbe3d83292500ed46344d63fbbae410b5 +--- + +{{JSRef}} + +**`entries()`** 메서드는 해당 배열의 각 인덱스에 대한 키/값 쌍을 포함하는 새로운 {{jsxref("Array", "배열")}} 반복자 객체를 반환합니다. +``` + +작성한 hash는 로 접근 가능한 hash 입니다. diff --git a/docs/ko/guides/organizer-guide.md b/docs/ko/guides/organizer-guide.md index 6a5ca4d4d36c8e..32db9d3c9a6cbe 100644 --- a/docs/ko/guides/organizer-guide.md +++ b/docs/ko/guides/organizer-guide.md @@ -1,18 +1,18 @@ -# MDN yari-content-ko 팀에 대한 일반 지침 +# MDN yari-content-ko 팀에 대한 일반 안내서 -## yari-content-ko 구성원 변경에 대한 일반 지침 +## yari-content-ko 구성원 변경에 대한 일반 안내서 1. 구성원 변경 요청. 2. [PEERS_GUIDELINES.md](https://github.com/mdn/translated-content/blob/main/PEERS_GUIDELINES.md) 페이지의 `Korea (ko) content — the @yari-content-ko team, which consists of:` 수정. 3. [Localizing MDN][] 페이지의 `Active locales/Korea (ko)/Current contributors` 수정. -## 리뷰어 지침 +## 리뷰어 안내서 1. 최대 2주 이내에 모든 pull request를 검토하고 조치한다. -2. [MDN 번역 콘텐츠에 대한 일반 지침](/docs/ko/README.md#여러-지침-안내)을 숙지한다. -3. [용어 지침](./glossary-guide.md)을 숙지하여 일관된 용어를 사용한다. +2. [MDN 번역 콘텐츠에 대한 일반 안내서](/docs/ko/README.md#여러-안내서)를 숙지한다. +3. [용어 안내서](./glossary-guide.md)을 숙지하여 일관된 용어를 사용한다. -## yari-content-ko 팀 지침 +## yari-content-ko 팀 안내서 1. 1개월 이내에 실행 가능한 모든 문제를 분류하고 수정한다. 2. MDN의 Tier 1 콘텐츠를 en-US 버전과 동기화된 상태로 유지하는데 매주 조금의 진전을 보인다. diff --git a/docs/ko/guides/translation-guide.md b/docs/ko/guides/translation-guide.md index e17334b57cc481..c878eb19dccbdd 100644 --- a/docs/ko/guides/translation-guide.md +++ b/docs/ko/guides/translation-guide.md @@ -1,82 +1,78 @@ -# 번역 지침 +# 번역 안내서 -## 메타데이터 +## 문서 연결 경로 -문서의 상단에 있는 메타데이터는 `title`, `slug`, `original_slug` 그리고 `l10n.*`만 번역해줍니다. (참고: [#7412](https://github.com/mdn/translated-content/issues/7412)) +한글 문서가 존재하지 않더라도 `/en-US` 문서로 넘겨주기 때문에 한국 문서의 모든 경로는 `/ko`로 표기합니다. -영어 원문 - -```markdown ---- -title: Proxy -slug: Web/JavaScript/Reference/Global_Objects/Proxy -tags: - - Class - - ECMAScript 2015 - - JavaScript - - Proxy -- browser-compat: javascript.builtins.Proxy ---- -{{JSRef}} - -The `Proxy` object enables you to create a proxy for another ... - : ``` +// bad +[`Array`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) -번역본 - -```markdown ---- -title: Proxy -slug: Web/JavaScript/Reference/Global_Objects/Proxy ---- -{{JSRef}} - -**`Proxy`** 객체는 기본적인 동작(속성 접근, 할당, 순회, 열거, 함수 ... - : +// good +[`Array`](/ko/docs/Web/JavaScript/Reference/Global_Objects/Array) ``` -## heading ID 번역 +## Inline code -기사 제목에는 거의 항상 ID가 주어지는데, 기사 내에서 네비게이션을 자동으로 생성하고 실시간 샘플을 생성하기 위한 코드 블록을 식별하는 등의 이유가 있습니다. 제목을 번역 할 때 ID도 같이 번역 할 필요가 없습니다. 나머지 슬러그는 번역되지 않으므로 모든 것이 일관되게 유지됩니다. +원문의 인라인 코드는 번역하지 않습니다. -예를 들면: +## Block code -```html -

Tutorials

-``` +코드 블록을 번역 할 때 주석, 문자열, 변수 이름 및 출력물을 번역하는 것이 좋습니다. -`ko` 지역 에서 +그러나 구문과 같은 실제 코드 용어를 번역하지 마십시오. 예제는 작업을 마친 후에도 계속 작동해야합니다. -```html -

튜토리얼

-``` +또한, 예제 번역을 고려할 때, 일부 예제는 별도의 저장소에 있는 라이브 버전 또는 소스 코드에 연결된다는 점을 염두에 두십시오. 여러분은 또한 번역 된 페이지에서 링크 할 외부 코드 예제의 번역 된 버전을 만드는 것을 고려할 수도 있습니다. -일반적으로 모든 ID를 소문자로 작성하는 것이 좋습니다. 플랫폼은 어쨌든 렌더링시 자동으로 변환하지만 소문자로 유지하면 변환으로 인해 수동으로 만든 앵커 링크가 작동하지 않을 가능성이 적습니다. +## 안내 문구 -## code block 번역 +각 페이지의 안내 문구에 대한 단어 정의입니다. -코드 블록을 번역 할 때 주석, 문자열, 변수 이름 및 출력물을 번역하는 것이 좋습니다. +**사전 순으로 용어집을 편집해주세요.** -그러나 구문과 같은 실제 코드 용어를 번역하지 마십시오. 예제는 작업을 마친 후에도 계속 작동해야합니다. +| 용어 | 번역 | 참고 링크 | +| --- | --- | --- | +| Note | 참고 | | +| Warning | 경고 | | +| Callout | 알림 | | +| Objective | 목표 | [링크][What_is_accessibility] | +| Prerequisites | 필요한 사전 지식 | [링크][What_is_accessibility] | -또한, 예제 번역을 고려할 때, 일부 예제는 별도의 저장소에 있는 라이브 버전 또는 소스 코드에 연결된다는 점을 염두에 두십시오. 여러분은 또한 번역 된 페이지에서 링크 할 외부 코드 예제의 번역 된 버전을 만드는 것을 고려할 수도 있습니다. +### 교육 과정 callout -## HTML 소스의 줄 바꿈 +```markdown +> **알림:** +> +> #### 프론트엔드 웹 개발자가 되고자 하시나요? +> +> 목표를 달성하기 위한 모든 필수 정보가 들어있는 교육 과정을 준비했습니다. +> +> [**시작하기**](/en-US/docs/Learn/Front-end_web_developer) +``` -일부 기사 소스 코드에서, 반드시 필요하지 않은 블록 수준 요소에서 줄 바꿈을 찾을 수 있습니다. 예를 들면 다음과 같습니다. +### 카드 번역 -```html -

The - HTMLCanvasElement.transferControlToOffscreen() - method transfers control to an {{domxref("OffscreenCanvas")}} object, either on the main - thread or on a worker.

+카드는 참고, 경고 그리고 알림의 세 가지 유형이 있으며, 영어 원문에서는 다음과 같이 표시됩니다. -
OffscreenCanvas HTMLCanvasElement.transferControlToOffscreen()
+```markdown +# 참고 +> **Note:** This is a note. +# 경고 +> **Warning:** This is a warning. +# 알림 +> **Callout:** This is a callout. ``` -일반적으로 소스 코드에서 이와 같은 줄 바꿈을 사용하지 않으므로 원하는 경우 자유롭게 제거 할 수 있으며 새 번역을 만들 때 추가하지 마십시오. 그러나 최종 렌더링 결과에 영향을 미치지 않으므로 이를 제거하는 데 너무 많은 시간을 소비하지 마십시오. +이런 카드는 아래와 같이 번역해주시면 됩니다. + +```markdown +# 참고 +> **참고:** 참고입니다. +# 경고 +> **경고:** 경고입니다. +# 알림 +> **알림:** 알림입니다. +``` ## 역주/역자주 @@ -93,7 +89,7 @@ slug: Web/JavaScript/Reference/Global_Objects/Proxy 다만 진짜 강조를 해야하는 상황에는, 따옴표로 강조하고 PR로 소명합니다. -## `:` 쌍점, `;` 쌍반점 지침 +## `:` 쌍점, `;` 쌍반점 뒤의 문장 예시를 강조하기 위해 쌍점을 사용하는 경우에 `: 쌍점`은 한글 문법에 적합하지 않습니다. [(참고 이슈 링크)](https://github.com/mdn/translated-content/pull/2747#issuecomment-964241518) @@ -143,9 +139,9 @@ The properties of these objects are as follows: 이 객체들의 속성은 다음과 같습니다. ``` -## `—` 대시 지침 +## `—` 대시 -`: 쌍점, ; 쌍반점 지침`과 같은 맥락에서 `. 온점`으로 치환하는 것을 권장합니다. [(참고 이슈 링크)](https://github.com/mdn/translated-content/pull/2747#issuecomment-965500282) +`: 쌍점, ; 쌍반점 안내서`과 같은 맥락에서 `. 온점`으로 치환하는 것을 권장합니다. [(참고 이슈 링크)](https://github.com/mdn/translated-content/pull/2747#issuecomment-965500282) - 원문