Merge pull request #96 from w3c/key-terms

Add draft key terms section

Author: JJdeGroot

.github/workflows/deploy.yml

@@ -50,6 +50,6 @@ jobs:
         with:
           path: ./
 
-      # Deploy to Github Pages
+      # Deploy to GitHub Pages
       - name: Deploy to GitHub Pages
         uses: actions/deploy-pages@v4

README.md

@@ -11,11 +11,11 @@ This repository is used to work on guidance for mobile accessibility.
 - The [comments folder](/comments) contains Markdown files with our comments on each success criterion (and principle, guidelines in the future).
 - The [sections folder](/sections) contains Markdown files for each section, such as abstract, introduction, etc.
 - The [plugins folder](/plugins) contains Javascript files with Markdown extensions
-  - [`GithubPlugin`](/plugins/github.js): adds the `[issue:<issue>]` tag to render a `Note` linking to the given Github `<issue>`.
+  - [`GitHubPlugin`](/plugins/github.js): adds the `[issue:<issue>]` tag to render a `Note` linking to the given GitHub `<issue>`.
   - [`NotePlugin`](/plugins/note.js): adds the `[note:<markdown>]` tag to render a `Note` containing the given `<markdown>`.
   - [`WcagPlugin`](/plugins/wcag.js): adds the `[wcag|wcag2ict:<id>]` tag to render a `<details>` component containing the WCAG(2ICT) section identified by the given `<id>`.
 
-Upon push to the `main` branch, the [`index.html`](index.html) file gets generated based on the [comments](/comments) and [sections](/sections) folders. Next, the `index.html` file gets commited, and then deployed to Github Pages.
+Upon push to the `main` branch, the [`index.html`](index.html) file gets generated based on the [comments](/comments) and [sections](/sections) folders. Next, the `index.html` file gets commited, and then deployed to GitHub Pages.
 
 ![Generate, Update, Deploy workflow](https://github.com/w3c/matf/actions/workflows/deploy.yml/badge.svg)
 

index.ejs

@@ -29,6 +29,10 @@
     <%- sections.comparison %>
   </section>
 
+  <section id="key-terms">
+    <%- sections.keyterms %>
+  </section>
+
   <section id="comments">
     <%- sections.comments %>
 

index.html

@@ -102,7 +102,7 @@ <h3>Comparison with the 2015 Mobile Accessibility Working Draft Note</h3>
 <ul>
 <li>
       <div class="note">
-        <p>Work In Progress</p>
+        <p><strong>Work In Progress</strong>. See: <a href="#key-terms">Key Terms section</a></p>
 
       </div>
     </li>
@@ -189,14 +189,32 @@ <h3>Comparison with the 2015 Mobile Accessibility Working Draft Note</h3>
 
   </section>
 
+  <section id="key-terms">
+    <h2>Key Terms</h2>
+<p>WCAG2Mobile defines key glossary terms to refine the broader scope of WCAG2ICT for Mobile Applications. It introduces terms that do not exist in WCAG2ICT or WCAG but are important to define for a Mobile Application context.</p>
+<p>“Content” and “user agent” are glossary terms from WCAG2ICT that need to be interpreted significantly differently when applied to Mobile Applications.</p>
+<p>The glossary terms “document” and “software” in WCAG2ICT are replaced with the defined terms “screen” and “view”. The glossary terms “set of web pages”, “set of documents” and “set of software programs” are replaced with the defined term “set of screens”.</p>
+<p>The term “accessibility services of platform software”, introduced by WCAG2ICT, has been modified to reflect its different use in Mobile Applications. Additionally, “closed functionality” has a different meaning in the context of Mobile Applications.</p>
+<p>The remaining glossary terms from WCAG2ICT and WCAG 2 are addressed in <a href="https://w3c.github.io/wcag2ict/#comments-on-definitions-in-wcag-2-glossary">WCAG2ICT: Comments on Definitions in WCAG 2 Glossary</a>.</p>
+<p>Terms defined and used in WCAG2Mobile are applicable only to the interpretation of the guidance in this document. The particular definitions should not be interpreted as having applicability to situations beyond the scope of WCAG2Mobile. Further information on usage of these terms follows.</p>
+<p>
+      <div class="note">
+        <p><strong>Work in Progress</strong>. See <a href="https://github.com/w3c/matf/issues?q=is%3Aissue%20state%3Aopen%20label%3Adefinition">Issues labeled as 'definition' on GitHub</a>.</p>
+
+      </div>
+    </p>
+
+  </section>
+
   <section id="comments">
     <h2>Comments by Principle, Guideline and Success Criterion</h2>
 <p>The sections that follow are organized according to the principles, guidelines and success criteria from WCAG 2.2. The text of each principle, guideline and success criterion from WCAG 2.2 is provided as quoted text. Following that, the WCAG2ICT guidance is provided as quoted text. Next, the WCAG2Mobile guidance itself is provided.</p>
-<div class="note" title="Work In Progress">
-  <p>
-    The document currently only includes guidance for success criteria. The guidance for principles and guidelines will be added at a later stage.
-  </p>
-</div>
+<p>
+      <div class="note">
+        <p><strong>Work in Progress</strong>. The document currently only includes guidance for success criteria. The guidance for principles and guidelines will be added at a later stage.</p>
+
+      </div>
+    </p>
 
 
 

matf.js

@@ -5,7 +5,7 @@ import markdownit from 'markdown-it';
 import ejs from 'ejs';
 import open from 'open';
 
-import { GithubPlugin } from './plugins/github.js';
+import { GitHubPlugin } from './plugins/github.js';
 import { NotePlugin } from './plugins/note.js';
 import { WcagPlugin } from './plugins/wcag.js';
 
@@ -16,7 +16,7 @@ const initMarkdown = async () => {
   console.log(`Initializing markdownit and custom plugins...`);
 
   return markdownit({ html: true })
-    .use(await GithubPlugin.init('https://github.com/w3c/matf'))
+    .use(await GitHubPlugin.init('https://github.com/w3c/matf'))
     .use(await NotePlugin.init())
     .use(await WcagPlugin.init('wcag', 'https://www.w3.org/TR/WCAG22/'))
     .use(await WcagPlugin.init('wcag2ict', 'https://www.w3.org/TR/wcag2ict-22/'));

plugins/github.js

@@ -1,10 +1,10 @@
 import { Plugin } from './plugin.js';
 
 /**
- * The GithubPlugin adds a new markdown tag to render GitHub issues.
+ * The GitHubPlugin adds a new markdown tag to render GitHub issues.
  * For example, the `[issue:71]` markdown will render issue #71 as a note with a link.
  */
-export class GithubPlugin extends Plugin {
+export class GitHubPlugin extends Plugin {
   constructor(url) {
     super('issue');
     this.url = url;
@@ -13,10 +13,10 @@ export class GithubPlugin extends Plugin {
   /**
    * Initializes the plugin with the specified GitHub repository URL.
    * @param {string} url - The GitHub repository URL (e.g., `https://github.com/w3c/matf`).
-   * @returns {Promise<{function}>} - An initialized `GithubPlugin` function.
+   * @returns {Promise<{function}>} - An initialized `GitHubPlugin` function.
    */
   static async init(url) {
-    return new GithubPlugin(url).plugin();
+    return new GitHubPlugin(url).plugin();
   }
 
   /**
@@ -40,7 +40,7 @@ export class GithubPlugin extends Plugin {
   }
 
   /**
-   * Renders the token as a Note with a link to the issue on Github.
+   * Renders the token as a Note with a link to the issue on GitHub.
    * @param {object} token - The token to render.
    * @returns {string} - The rendered HTML string.
    */

sections/comments.md

@@ -2,8 +2,4 @@
 
 The sections that follow are organized according to the principles, guidelines and success criteria from WCAG 2.2. The text of each principle, guideline and success criterion from WCAG 2.2 is provided as quoted text. Following that, the WCAG2ICT guidance is provided as quoted text. Next, the WCAG2Mobile guidance itself is provided.
 
-<div class="note" title="Work In Progress">
-  <p>
-    The document currently only includes guidance for success criteria. The guidance for principles and guidelines will be added at a later stage.
-  </p>
-</div>
+[note:**Work in Progress**. The document currently only includes guidance for success criteria. The guidance for principles and guidelines will be added at a later stage.]

sections/comparison.md

@@ -11,7 +11,7 @@ With this perspective in mind, the following list highlights where this current
   - platform software
   - virtual keyboard
 - New key terms introduced by WCAG2Mobile:
-  - [note:Work In Progress]
+  - [note:**Work In Progress**. See: [Key Terms section](#key-terms)]
 - Inclusion of all WCAG 2.2 Level A and AA success criteria and not just those specifically affected by mobile phone usage.
 
 The prior 2015 Mobile Working Draft Note included specific guidance on the following WCAG 2.0 success criteria for mobile, primarily for a mobile web context:

sections/keyterms.md

@@ -0,0 +1,15 @@
+## Key Terms
+
+WCAG2Mobile defines key glossary terms to refine the broader scope of WCAG2ICT for Mobile Applications. It introduces terms that do not exist in WCAG2ICT or WCAG but are important to define for a Mobile Application context.
+
+“Content” and “user agent” are glossary terms from WCAG2ICT that need to be interpreted significantly differently when applied to Mobile Applications.
+
+The glossary terms “document” and “software” in WCAG2ICT are replaced with the defined terms “screen” and “view”. The glossary terms “set of web pages”, “set of documents” and “set of software programs” are replaced with the defined term “set of screens”.
+
+The term “accessibility services of platform software”, introduced by WCAG2ICT, has been modified to reflect its different use in Mobile Applications. Additionally, “closed functionality” has a different meaning in the context of Mobile Applications.
+
+The remaining glossary terms from WCAG2ICT and WCAG 2 are addressed in [WCAG2ICT: Comments on Definitions in WCAG 2 Glossary](https://w3c.github.io/wcag2ict/#comments-on-definitions-in-wcag-2-glossary).
+
+Terms defined and used in WCAG2Mobile are applicable only to the interpretation of the guidance in this document. The particular definitions should not be interpreted as having applicability to situations beyond the scope of WCAG2Mobile. Further information on usage of these terms follows.
+
+[note:**Work in Progress**. See [Issues labeled as 'definition' on GitHub](https://github.com/w3c/matf/issues?q=is%3Aissue%20state%3Aopen%20label%3Adefinition).]