wcag
1.0.0
請使用此分支作為拉力請求的目標，直到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>將導致正確的鏈接。
如果鏈接文本與規範術語（例如“ Web Pages”（請注意複數）具有不同的形式，則可以提供有關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每個理解頁面的文件，稱為指南中的成功標准文件文件填充了提供預期結構的模板。將模板結構放在適當的位置，並在各節中添加適當的內容。 class =“指令”的元素提供有關該部分中要包含的內容的指導；您可以根據需要刪除這些元素，但不必刪除這些元素。示例的模板提出了一個子彈列表或一系列子段，請選擇其中一種方法，然後從模板中刪除另一個方法。技術的模板包括“情況”的子段，如果不需要，請刪除該包裝部分。
從WCAG規範中的相關成功標準中引用了了解文件；這些鏈接由腳本發布。
當前，正式理解頁面的出版物位置是https://www.w3.org/wai/wcag21/understanding/。根據需要更新此內容；並可以自動化。
技術在技術文件夾中，並通過技術將其分組為子文件夾。每種技術都是一個獨立的文件，該文件的格式為HTML格式，具有常規的元素，類和ID結構。
該技術模板顯示了技術的結構。主要部分位於具有特定ID的頂級<部分>元素中：元，適用性，描述，示例，測試，相關，資源。需要描述和測試部分；建議使用適用性和示例部分；相關和資源部分是可選的。元部分提供了在創作過程中的技術的上下文，但被刪除以供出版。該技術的標題在<h1>元素中。具有class="instructions"元素提供有關填充模板的信息。應在開發技術時將它們刪除，但如果不刪除，則會被發電機忽略。請勿在真實內容上複製class="instructions" 。
技術可以使用臨時樣式表來促進草稿的審查。此樣式表被其他樣式表和正式出版的結構所取代。要使用此樣式表，請添加<link rel="stylesheet" type="text/css" href="../../css/editors.css"/>到技術的頭部。
技術可以包括圖像。將圖像文件放在相關技術的img文件夾中 - 意味著技術的所有技術共享一組通用圖像。使用相對鏈接加載圖像。大多數圖像應加載<figure>元素，並用位於圖底部的<figcaption>標記。 <figure>元素必須具有id屬性。小型內聯圖像可以加載帶有合適alt文本的<img>元素。
技術應包括簡短的代碼示例，以演示如何撰寫該技術的內容。代碼示例應該易於閱讀，通常本身不會完成內容。可以提供更完整的示例作為工作示例（見下文）。鏈接到每個示例底部的工作示例，在a <p class="working-example">元素中，包含一個相對鏈接到../../working-examples/{example-name}/ example-name }/。
可以在有用的地方提供對其他技術的交叉引用。通常，應該在“相關技術”部分中提供它們，但可以在其他地方提供。如果使用相同的技術，則使用相對鏈接來引用技術， {Technique ID} ，或../{Technology}/{Technique ID}否則。如果該技術仍在開發中並且沒有正式ID，請參考開發文件的路徑。如果該技術正在另一個分支中開發，請使用該技術的Rabgit版本使用絕對的URI。
對準則和成功標準的交叉引用應使用相對的URI來了解該項目的理解頁面。指南的其他部分的交叉引用應對W3C TR頁面上發布的指南使用絕對URI，這是一個以https://www.w3.org/TR/WCAG21/#開頭的URI。請注意，基於理解文檔中的信息，生成器在發佈時添加了與哪些技術相關的指南或成功標準的引用，因此通常不需要或建議與這些文檔的冗餘鏈接。
維基（Wiki）維持了從事技術工作的一般優先事項和過程。
新技術應使用從技術標題縮短版本中得出的文件名。編輯人員將在工作組接受時將技術分配給ID並重命名。例如，一種技術“使用IMG元素上的Alt屬性來提供簡短的文本替代方案”可能會使用“ IMG-Alt-Short-text-Alternatives.html”作為文件名。編輯人員將在工作組接受時將其分配一個正式ID，並將其重命名。
每種新技術都應在新分支中創建。分支和文件的設置是通過create-techniques.sh腳本自動化的，可以使用bash運行。命令行是：
bash create-techniques.sh < technology > < filename > < type > " <title> "<technology>是該技術的技術目錄<filename>是該技術的臨時文件名（無擴展）<type>是“技術”或“失敗”<title>是該技術的標題，用引號封閉並用逃脫特殊字符這將自動以下步驟：
一旦設置了技術分支和文件，請填充內容並請求評論：
存儲庫中的技術是普通的HTML文件，其格式最少。為了出版到編輯的草稿和W3C位置，基於高架的構建過程，用於模板和Cheerio進行轉換。更多詳細信息，包括用於本地預覽的說明，可以在“構建過程”回復中找到。
發電機將技術作為套件一起編譯為具有格式和導航的套件。它執行某些結構，例如上述上述頂級部分和標準化標題。它試圖處理交叉參考鏈接，以確保URI在出版時工作。最重要的角色之一是用該技術與之相關的指南或成功標準的參考填充適用性部分。此信息來自理解文件。正確使用技術模闆對於啟用此功能很重要，並且MAL形成技術可能會導致發電機失敗。
過時的技術不應從存儲庫中刪除。取而代之的是，可以使用YAML的前後標記它們。例如：
---
obsoleteSince : 22
obsoleteMessage : |
This failure relates to 4.1.1: Parsing, which was removed as of WCAG 2.2.
---obsoleteSince表示該技術過時時最早的WCAG 2版本（如果應該有效地過時，則可以將其設置為20 ，例如，對於涉及不推薦使用的HTML元素的技術）obsoleteMessage指示要在此技術部分中顯示的消息如果整個技術已過時（例如閃光燈和銀燈），則這些屬性也可以在技術子目錄級別上指定，例如通過techniques/flash/flash.11tydata.json 。請注意，這種情況特別需要JSON格式，因為這在用於組裝技術數據的構建過程中被高度和其他代碼所消耗。
信息文檔是從WCAG 2.2和2.1的同一源文件中生成的，因為它們之間的大多數內容在它們之間是一致的。 （為了維護單獨的編輯草案，指南本身繼續在單獨的分支機構，例如WCAG-2.1上維護。）
在為較舊版本構建信息的文檔時，構建系統會介紹針對新版本的成功標準，進而依次與這些標準相關的任何技術。
在一些情況下，內容可能需要迎合特定版本，在本節中解釋。
注意：這僅適用於techniques和understanding文件夾（不是guidelines ）。
如果應在信息豐富的文檔中顯示精確的版本編號，請插入{{ versionDecimal }} 。這將替換為十進制劃分的版本號，例如2.1或2.2。
如果與多個版本有關的文檔保留有關更新版本中更新的特定呼叫，則可以將class="wcagXY" class="wcag22"所涉及的散文周圍的元素（例如，WCAG 2.2） 。這將導致從早期版本中省略散文，並以“ wcag xy中的new in wcag xy：”中的前綴顯示。
此類也可以與note類一起應用，在這種情況下，“（WCAG XY中的新）”將附加到適用版本中的“ Note”標題上，並且該註釋將隱藏在早期版本中。
在撰寫本文時（2024年11月），WCAG 2.1和2.2之間的變更日誌相同。這些已被分為單獨的版本特定於_includes/techniques/changelog/*.html以支持從同一分支機構構建多個版本的信息文檔。
技術中的示例應為簡短的易於徵用的代碼示例，介紹該技術在內容中的使用方式。因此，示例應重點介紹該技術描述的特定功能，而不包括相關內容，例如樣式，腳本，周圍的Web內容等。
通常希望提供更全面的示例，這些示例顯示了行動中的技術，而不會干擾主技術文檔。這些示例還顯示了使該技術運行所需的完整代碼，包括完整的樣式和腳本文件，圖像，頁面代碼等。通常，這些“工作示例”在主示例的底部引用，其中包括在主示例的底部技術。
工作示例存儲在存儲庫的working-examples目錄中。每個示例都有其自身的子目錄，以包含使示例起作用所必需的多個文件。在某些情況下，多個工作示例將共享共同資源；這些存儲在工作示例目錄的適當子目錄中，例如， 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/ ://rawgit.com/w3c/wcag/main/main/working-examples/alt-attribute/。批准示例後，編輯將更新鏈接。WCAG 2.2已準備好翻譯。要翻譯WCAG 2.2，請遵循有關如何翻譯WCAG 2的說明。
