이 지점을 2016 년 7 월 10 일까지 풀 요청 대상으로 사용하십시오.
이 저장소는 WCAG 2 용 컨텐츠를 개발하고 관련 문서 및 기술을 이해하는 데 사용됩니다.
@@ 완료
WCAG 2 스타일 가이드도 참조하십시오
WCAG 2.0은 후속 버전의 WCAG와는 다른 파일 구조로 유지되었습니다. WCAG 2.0의 소스 파일은 WCAG20 폴더에 있으며 주로 보관 목적으로 존재합니다. 해당 폴더의 컨텐츠를 편집하지 마십시오.
WCAG 2.1 이상의 내용은 아래 파일 구조에 따라 구성됩니다. WCAG 저장소에는 WCAG 2의 소스 및 보조 파일, WCAG 2 이해 및 결국 기술이 포함되어 있습니다. 또한 문서의 자동 형식을 지원하는 보조 파일도 포함되어 있습니다. 다수 편집을 용이하게하기 위해 각 성공 기준은 기본 지침에 포함될 수있는 HTML 조각으로 구성된 별도의 파일에 있습니다. 주요 파일은 다음과 같습니다.
guidelines/index.html
주요 가이드 라인 파일guidelines/sc/{version}/*.html
각 성공 기준에 대한 파일guidelines/terms/{version}/*.html
각 정의에 대한 파일understanding/{version}/*.html
각 성공 기준에 대한 파일 이해 여기서 {version}
은 "20"이고 컨텐츠는 WCAG 2.0에서 나왔습니다. "21"은 WCAG 2.1, "22", WCAG 2.2 등에 도입 된 컨텐츠에 사용됩니다.
성공 기준 관리자는 가이드 라인 문서에 포함 할 준비가되어 후보 성공 기준을 준비합니다. 성공 기준을 준비하려면 다음 단계를 따르십시오.
#1
참조하십시오.성공 기준은 일관성을 보장하기 위해 몇 가지 클래스 속성 값을 가진 HTML 요소의 간단한 구조를 사용합니다. 이 구조에서 향상된 스크립트 및 스타일 키. 제공하는 콘텐츠는 중괄호로 표시됩니다. 주석 후 항목은 선택 사항입니다.
< section class =" sc " >
< h4 > {SC Handle} </ h4 >
< p class =" conformance-level " > {Level} </ p >
< p class =" change " > {Change} </ p >
< p > {Main SC Text} </ p >
<!-- if SC has sub-points -->
< dl >
< dt > {Point Handle} </ dt >
< dd > {Point Text} </ dd >
</ dl >
<!-- if SC has notes -->
< p class =" note " > {Note} </ p >
</ section >
참고 SC 번호를 제공하지 않습니다. 숫자는 지정되고 나중에 자동으로 생성 될 가능성이 높습니다.
제공하는 값은 아래에 설명되어 있습니다. 이러한 각 컨텐츠의 예는 성공 기준 2.2.1을 참조하십시오.
`요소가 제공 될 수 있습니다.
SC와 함께 용어 정의를 제공하는 경우 다음 형식을 사용하여 각 guidelines/terms/{version}
디렉토리, 한 파일에 포함시킵니다.
< dt > < dfn id =" dfn-{shortname} " > {Term} </ dfn > </ dt >
< dd > {Definition} </ dd >
dfn
요소는 스크립트에 이것이 용어이며 특수 스타일 및 링크 기능을 유발한다는 것을 알려줍니다. 용어에 연결하려면 href
속성이없는 <a>
요소를 사용하십시오. 링크 텍스트가 용어와 동일하면 링크가 올바르게 생성됩니다. 예를 들어, 페이지에 <dfn>web page</dfn>
이라는 용어가있는 경우 <a>web page</a>
형식의 링크는 적절한 링크가됩니다.
링크 텍스트가 표준 용어 (예 : "웹 페이지"(복수)와 다른 형식을 갖는 경우 data-lt
속성으로 정의라는 용어에 대한 힌트를 제공 할 수 있습니다. 이 예에서는 <dfn data-lt="web pages">web page</dfn>
으로 용어를 수정하십시오. 이 용어의 여러 대체 이름은 <dfn data-lt="web pages|page|pages">web page</dfn>
같은 선행 또는 후행 공간이없는 파이프 문자로 분리 될 수 있습니다.
성공 기준 당 하나의 이해 파일과 색인이 있습니다.
understanding/index.html
인덱스 페이지, 사용 가능한 개별 이해 페이지에 대한 참조를 추가해야합니다.understanding/{version}/*.html
각 이해 페이지에 대한 파일, 가이드 라인의 성공 기준 파일과 동일합니다.파일에는 예상 구조를 제공하는 템플릿이 채워집니다. 템플릿 구조를 제자리에두고 섹션 내에서 적절하게 내용을 추가하십시오. 클래스가있는 요소 = "지침"이 해당 섹션에 포함 할 내용에 대한 지침을 제공합니다. 원하는 경우 해당 요소를 제거 할 수 있습니다. 예제 템플릿은 총알 목록 또는 일련의 하위 섹션을 제안하고 해당 접근법 중 하나를 선택하고 템플릿에서 다른 방법을 제거합니다. 기술의 템플릿에는 "상황"의 하위 섹션이 포함되어 있지 않으면 해당 래퍼 섹션을 제거하십시오.
파일 이해는 WCAG 사양의 관련 성공 기준에서 참조됩니다. 이 링크는 스크립트에 의해 입력됩니다.
페이지 이해를위한 공식 간행물 위치는 현재 https://www.w3.org/wai/wcag21/understanding/입니다. 이 콘텐츠는 필요에 따라 업데이트됩니다. 자동화 될 수 있습니다.
기술은 기술 폴더에 있으며 기술별로 서브 폴더로 그룹화합니다. 각 기술은 정기적 인 요소, 클래스 및 ID의 구조를 갖춘 HTML 형식의 독립형 파일입니다.
기술 템플릿은 기술의 구조를 보여줍니다. 기본 섹션은 메타, 적용 가능성, 설명, 예제, 테스트, 관련, 리소스와 같은 특정 ID가있는 최상위 <섹션> 요소입니다. 설명 및 테스트 섹션이 필요합니다. 적용 가능성 및 예제 섹션을 권장합니다. 관련 및 리소스 섹션은 선택 사항입니다. 메타 섹션은 저작 중 기술에 대한 컨텍스트를 제공하지만 출판을 위해 제거됩니다. 이 기술의 제목은 <h1>
요소에 있습니다. class="instructions"
있는 요소 템플릿을 채우는 것에 대한 정보를 제공합니다. 기술이 개발 될 때 제거해야하지만 제거되지 않으면 발전기에 의해 무시됩니다. 실제 콘텐츠에서 class="instructions"
복사하지 마십시오.
기술은 임시 스타일 시트를 사용하여 드래프트 검토를 용이하게 할 수 있습니다. 이 스타일 시트는 공식 간행물을위한 다른 스타일 시트와 구조로 대체됩니다. 이 스타일 시트를 사용하려면 <link rel="stylesheet" type="text/css" href="../../css/editors.css"/>
기술 헤드에 추가하십시오.
기술에는 이미지가 포함될 수 있습니다. 관련 기술의 img
폴더에 이미지 파일을 배치합니다. 즉, 기술에 대한 모든 기술을 의미합니다. 공통 이미지 세트를 공유하십시오. 상대 링크를 사용하여 이미지를로드하십시오. 대부분의 이미지에는 <figure>
요소가로드되고 그림 하단에 <figcaption>
이 위치합니다. <figure>
요소에는 id
속성이 있어야합니다. 작은 인라인 이미지에는 적합한 alt
텍스트가있는 <img>
요소가로드 될 수 있습니다.
기술에는 기술에 따른 컨텐츠를 작성하는 방법을 보여주기 위해 간단한 코드 예제가 포함되어야합니다. 코드 예제는 읽기 쉽고 일반적으로 그 자체로 내용을 완성해서는 안됩니다. 보다 완전한 예제는 작업 예제로 제공 될 수 있습니다 (아래 참조). <p class="working-example">
요소에서 각 예제의 맨 아래에있는 작업 예 ../../working-examples/{example-name}/
대한 링크.
유용한 경우 다른 기술에 대한 교차 참조가 제공 될 수 있습니다. 일반적으로 그들은 "관련 기술"섹션에 제공되어야하지만 다른 곳에 제공 될 수 있습니다. 동일한 기술 인 경우 {Technique ID}
기술을 참조하기 위해 상대 링크를 사용하거나 그렇지 않으면 ../{Technology}/{Technique ID}
. 이 기술이 아직 개발 중이고 공식 ID가없는 경우 개발 파일의 경로를 참조하십시오. 이 기술이 다른 지점에서 개발중인 경우 기술의 RawGit 버전에 절대 URI를 사용하십시오.
가이드 라인 및 성공 기준에 대한 교차 참조는 해당 항목의 이해 페이지에 상대 URI를 사용해야합니다. 가이드 라인의 다른 부분에 대한 교차 참조는 https://www.w3.org/TR/WCAG21/#
로 시작하는 URI 인 W3C TR 페이지에 게시 된 지침에 절대 URI를 사용해야합니다. 이해 문서의 정보를 바탕으로 발행시 발행기에 기술과 관련된 기술과 관련된 가이드 라인 또는 성공 기준에 대한 참조는 일반적으로 필요하거나 조언하지 않습니다.
기술에 대한 일반적인 우선 순위와 프로세스는 위키에서 유지됩니다.
새로운 기술은 기술 제목의 짧은 버전에서 파생 된 파일 이름을 사용해야합니다. 편집자는 기술에 ID를 할당하고 작업 그룹에서 수락 할 때 파일의 이름을 바꿉니다. 예를 들어, "IMG 요소의 ALT 속성을 사용하여 짧은 텍스트 대안을 제공하기 위해"IMG-ALT-SHORT-TEXT-ALTERNATIVES.HTML "을 파일 이름으로 사용할 수 있습니다. 편집자는 공식 ID를 할당하고 워킹 그룹에서 수락 할 때 파일의 이름을 바꿉니다.
각 새로운 기술은 새 지점에서 만들어야합니다. 분기 및 파일의 설정은 Bash로 실행할 수있는 Create-Techniques.sh 스크립트를 통해 자동화됩니다. 명령 줄은 다음과 같습니다.
bash create-techniques.sh < technology > < filename > < type > " <title> "
<technology>
은이 기술의 기술 디렉토리입니다<filename>
은 기술의 임시 파일 이름 (확장 제외)입니다.<type>
은 "기술"또는 "실패"입니다.<title>
은 기술의 제목이며, 따옴표로 둘러싸여 로 특수 캐릭터를 탈출합니다.다음 단계를 자동화합니다.
기술 지점과 파일이 설정되면 내용을 채우고 검토를 요청하십시오.
저장소의 기술은 최소한의 서식을 가진 일반 HTML 파일입니다. 편집자 초안 및 W3C 위치에 출판 되려면 기술은 템플릿을위한 Eleventy와 Transformation의 치어리오를 기반으로 빌드 프로세스에 의해 형식화됩니다. 로컬 미리보기 지침을 포함한 자세한 내용은 빌드 프로세스 readme에서 찾을 수 있습니다.
Generator는 기술을 형식 및 내비게이션 기능을 갖춘 스위트로 함께 컴파일합니다. 위에서 설명한 최상위 섹션 순서 및 표준화 제목과 같은 특정 구조를 시행합니다. URI가 출판시 작동하는지 확인하기 위해 교차 참조 링크를 처리하려고 시도합니다. 가장 실질적인 역할 중 하나는이 기술과 관련된 지침 또는 성공 기준에 대한 참조로 적용 가능성 섹션을 채우는 것입니다. 이에 대한 정보는 이해 문서에서 비롯됩니다. 이 기능을 활성화하려면 기술 템플릿의 올바른 사용이 중요하며, Malformed 기술로 인해 생성기가 실패 할 수 있습니다.
쓸모없는 기술은 저장소에서 제거해서는 안됩니다. 대신, 그들은 YAML 프론트 마술을 사용하여 표시 될 수 있습니다. 예를 들어:
---
obsoleteSince : 22
obsoleteMessage : |
This failure relates to 4.1.1: Parsing, which was removed as of WCAG 2.2.
---
obsoleteSince
기술이 더 이상 사용되지 않았을 때 가장 초기 버전의 WCAG 2를 나타냅니다 (이는 모든 버전에서 효과적으로 쓸모 없어야하는 경우 20
으로 설정 될 수 있습니다.obsoleteMessage
이 기술 섹션에 표시되는 메시지가 표시됩니다. 전체 기술이 더 이상 사용되지 않는 경우 (예 : Flash 및 Silverlight), 이러한 특성은 techniques/flash/flash.11tydata.json
통해 기술 하위 디렉토리 수준에서 지정 될 수 있습니다. 이 경우에는 기술 데이터를 조립하는 데 사용되는 빌드 프로세스에서 Eleventy 및 추가 코드 모두에 의해 소비 되므로이 경우에는 구체적으로 JSON 형식이 필요합니다.
유익한 문서는 WCAG 2.2 및 2.1의 동일한 소스 파일에서 생성됩니다. (가이드 라인 자체는 별도의 편집자 초안을 유지하기 위해 WCAG-2.1
예를 들어 별도의 지점에서 계속 유지되고 있습니다.)
이전 버전에 대한 유익한 문서를 구축 할 때 빌드 시스템은 최신 버전에만 해당되는 성공 기준을 제목으로하고 해당 기준과 독점적으로 관련된 기술을 정리합니다.
이 섹션에서는 컨텐츠가 특정 버전을 수용해야 할 수있는 몇 가지 사례가 있습니다.
참고 : 이것은 techniques
과 understanding
내 에서만 적용됩니다 ( guidelines
아님 ).
유익한 문서 내에 정확한 버전 번호를 표시 해야하는 경우 {{ versionDecimal }}
삽입하십시오. 이는 소수점이 지정된 버전 번호 (예 : 2.1 또는 2.2로 대체됩니다.
다중 버전과 관련된 문서가 최신 버전의 업데이트에 대한 특정 콜 아웃을 보증하는 경우, class="wcagXY"
해당 산문을 둘러싼 요소에 적용될 수 있습니다 (예 : WCAG 2.2의 경우 class="wcag22"
). . 이로 인해 산문은 이전 버전에서 생략되고 해당 버전의 "WCAG XY의 새로운"접두사로 표시됩니다.
이 클래스는 note
클래스와 함께 적용될 수 있으며,이 경우 "(WCAG XY의 새)" "NEAT"제목에 해당 버전의 제목에 추가되며 노트는 이전 버전에 숨겨집니다.
글을 쓰는 시점 (2024 년 11 월)에서 기술 인덱스의 변경 로그는 WCAG 2.1과 2.2 사이에 동일합니다. 이들은 동일한 지점에서 여러 버전의 유익한 문서 구축을 지원하기위한 향후 방지를위한 _includes/techniques/changelog/*.html
기술의 예는 컨텐츠에서 기술이 어떻게 사용되는지에 대한 소비하기 쉬운 코드 샘플이어야합니다. 따라서 예제는 기술이 설명하는 특정 기능에 중점을두고 스타일, 스크립트, 주변 웹 컨텐츠 등과 같은 관련 컨텐츠를 포함하지 않아야합니다.
종종보다 포괄적 인 예를 제공하는 것이 바람직하며,이 기술은 주요 기술 문서를 방해하지 않고 작동하는 기술을 보여줍니다. 이 예제는 또한 풀 스타일 및 스크립트 파일, 이미지, 페이지 코드 등을 포함하여 기술을 작동시키는 데 필요한 완전한 코드를 보여줍니다. 기술.
작업 예제는 저장소의 working-examples
디렉토리에 저장됩니다. 각 예제는 자체 하위 디렉토리에 있으며 예제를 작동시키는 데 필요한 여러 파일을 포함합니다. 경우에 따라 여러 작업 예제가 공통 자원을 공유합니다. 이들은 Working-Pamples 디렉토리의 적절한 하위 디렉토리 (예 : working-examples/css
, working-examples/img
, working-examples/script
에 저장됩니다. 가능한 경우 이러한 일반적인 자원을 참조하십시오. 그렇지 않으면 하위 디렉토리를 사용하여 적절한 경우 구성된 예제 디렉토리에 리소스를 배치하십시오.
작업 예제를 작성하려면 :
example-
에서 시작하여 예를 들어 예를 들어 예를 들어 example-alt-attribute
의미 적으로 식별합니다.working-examples/alt-attribute/
에 사용 된 접두사를 뺀 것입니다.index.html
의 이름을 지정하십시오. 그렇지 않으면 적절한 파일 이름을 만듭니다.../css/example.css
)를 사용하여 여러 예제 중 공유 된 리소스를 참조하십시오. 다른 리소스를 동일한 디렉토리에 주된 예와 같은 예를 들어, working-examples/alt-attribute/css/alt.css
함께 배치하십시오.https://rawgit.com/w3c/wcag/main/working-examples/alt-attribute/
의 참조 작업 예제. 편집자는 예제가 승인되면 링크를 업데이트합니다.WCAG 2.2는 번역 준비가되었습니다. WCAG 2.2를 번역하려면 WCAG 2를 번역하는 방법에 대한 지침을 따르십시오.