From 34487dead919325bf2e5acb1bc4fb119d45dc4f5 Mon Sep 17 00:00:00 2001 From: estelle Date: Wed, 6 Mar 2024 22:49:43 -0800 Subject: [PATCH 01/15] New sidebar: accessibility --- kumascript/macros/A11yRef.ejs | 100 ++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 kumascript/macros/A11yRef.ejs diff --git a/kumascript/macros/A11yRef.ejs b/kumascript/macros/A11yRef.ejs new file mode 100644 index 000000000000..618c7cefa881 --- /dev/null +++ b/kumascript/macros/A11yRef.ejs @@ -0,0 +1,100 @@ +<% + +const text = mdn.localStringMap({ + 'en-US': { + "Accessibility" : "Accessibility", + "Guides" : "Guides", + "Information_for_Web_authors" : "Information for web authors", + "Accessibility:_What_users_can_to_to_browse_safely" : "User settings", + "An_overview_of_accessible_web_applications_and_widgets" : "Applications and widgets", + "Keyboard-navigable_JavaScript_widgets" : "Keyboard-navigable widgets", + "Mobile_accessibility_checklist" : "Mobile checklist", + "Understanding_WCAG" : "Understanding WCAG", + "Cognitive_accessibility" : "Cognitive accessibility", + "Accessibility_and_Spacial_Patterns" : "Spacial Patterns", + "Understanding_Colors_and_Luminance" : "Colors and Luminance", + "Seizure_disorders" : "Seizures and physical reactions", + "Resources" : "Resources", + "What_is_accessibility" : "What is accessibility?", + "HTML" : "HTML: A good basis for accessibility", + "CSS_and_JavaScript" : "CSS and JavaScript accessibility best practices", + "WAI-ARIA_basics" : "WAI-ARIA basics", + "Multimedia" : "Accessible multimedia", + "Mobile" : "Mobile accessibility", + "ARIA Guides" : "ARIA Guides", + "Annotations" : "Annotations", + "ARIA_Guides" : "Guides", + "ARIA_Live_Regions" : "Live regions", + "ARIA_Screen_Reader_Implementors_Guide" : "Screen reader implementors guide", + "ARIA_Techniques" : "Using ARIA", + "Multipart_labels" : "Multipart labels", + "How_to_file_ARIA-related_bugs" : "How to file bugs", + } +}); + + +const locale = env.locale; +const baseURL = `/${locale}/docs/Web/Accessibility/`; +const AriaURL = `/${locale}/docs/Web/Accessibility/ARIA/`; +const LearnURL = `/${locale}/docs/Learn/`; +const cssURL = `/${locale}/docs/Web/CSS/`; + +%> + + From 5c8e0683da1117effa62938b6b2096ce1f0b2377 Mon Sep 17 00:00:00 2001 From: Estelle Weyl Date: Thu, 7 Mar 2024 07:34:28 -0800 Subject: [PATCH 02/15] Apply sonkar's uggestions Co-authored-by: Onkar Ruikar <87750369+OnkarRuikar@users.noreply.github.com> --- kumascript/macros/A11yRef.ejs | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/kumascript/macros/A11yRef.ejs b/kumascript/macros/A11yRef.ejs index 618c7cefa881..dabffe23ba32 100644 --- a/kumascript/macros/A11yRef.ejs +++ b/kumascript/macros/A11yRef.ejs @@ -37,7 +37,6 @@ const locale = env.locale; const baseURL = `/${locale}/docs/Web/Accessibility/`; const AriaURL = `/${locale}/docs/Web/Accessibility/ARIA/`; const LearnURL = `/${locale}/docs/Learn/`; -const cssURL = `/${locale}/docs/Web/CSS/`; %> @@ -87,12 +86,12 @@ const cssURL = `/${locale}/docs/Web/CSS/`;
  • -
    ARIA States and properties +
    <%=text['ARIA States and properties']%> <%-await template("ListSubpagesForSidebar", ['/Web/Accessibility/ARIA/Attributes', true, true])%>
  • -
    ARIA Roles +
    <%=text['ARIA Roles']%> <%-await template("ListSubpagesForSidebar", ['/Web/Accessibility/ARIA/Roles', true, true])%>
  • From 368e8056873919f4cc51cbd126297b35f867b276 Mon Sep 17 00:00:00 2001 From: Estelle Weyl Date: Fri, 8 Mar 2024 17:12:21 -0800 Subject: [PATCH 03/15] Update kumascript/macros/A11yRef.ejs Co-authored-by: Onkar Ruikar <87750369+OnkarRuikar@users.noreply.github.com> --- kumascript/macros/A11yRef.ejs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/kumascript/macros/A11yRef.ejs b/kumascript/macros/A11yRef.ejs index dabffe23ba32..d6dbc5c08b70 100644 --- a/kumascript/macros/A11yRef.ejs +++ b/kumascript/macros/A11yRef.ejs @@ -29,6 +29,8 @@ const text = mdn.localStringMap({ "ARIA_Techniques" : "Using ARIA", "Multipart_labels" : "Multipart labels", "How_to_file_ARIA-related_bugs" : "How to file bugs", + "ARIA States and properties": "ARIA States and properties", + "ARIA Roles": "Area Roles" } }); From 2f2ec32133c3123ef2e31c00cd75f8c148ad12be Mon Sep 17 00:00:00 2001 From: Estelle Weyl Date: Tue, 12 Mar 2024 22:10:17 -0700 Subject: [PATCH 04/15] Apply suggestions from code review Co-authored-by: Claas Augner <495429+caugner@users.noreply.github.com> --- kumascript/macros/A11yRef.ejs | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/kumascript/macros/A11yRef.ejs b/kumascript/macros/A11yRef.ejs index d6dbc5c08b70..2bad08158724 100644 --- a/kumascript/macros/A11yRef.ejs +++ b/kumascript/macros/A11yRef.ejs @@ -1,19 +1,9 @@ <% -const text = mdn.localStringMap({ +const sections = mdn.localStringMap({ 'en-US': { "Accessibility" : "Accessibility", "Guides" : "Guides", - "Information_for_Web_authors" : "Information for web authors", - "Accessibility:_What_users_can_to_to_browse_safely" : "User settings", - "An_overview_of_accessible_web_applications_and_widgets" : "Applications and widgets", - "Keyboard-navigable_JavaScript_widgets" : "Keyboard-navigable widgets", - "Mobile_accessibility_checklist" : "Mobile checklist", - "Understanding_WCAG" : "Understanding WCAG", - "Cognitive_accessibility" : "Cognitive accessibility", - "Accessibility_and_Spacial_Patterns" : "Spacial Patterns", - "Understanding_Colors_and_Luminance" : "Colors and Luminance", - "Seizure_disorders" : "Seizures and physical reactions", "Resources" : "Resources", "What_is_accessibility" : "What is accessibility?", "HTML" : "HTML: A good basis for accessibility", @@ -48,7 +38,7 @@ const LearnURL = `/${locale}/docs/Learn/`;
  • <%=text["Guides"]%>
      -
    1. <%=text["Information_for_Web_authors"]%>
    2. +
    3. ${web.smartLink(`${baseURL}Information_for_Web_authors`)
    4. User settings
    5. <%=text["An_overview_of_accessible_web_applications_and_widgets"]%>
    6. Keyboard-navigable widgets
    7. From 41b3e561d49aa6041e7ba73ea6e23b8ab701646a Mon Sep 17 00:00:00 2001 From: Estelle Weyl Date: Sat, 23 Mar 2024 16:14:54 -0700 Subject: [PATCH 05/15] Rewrite a11yref.ejs --- kumascript/macros/A11yRef.ejs | 209 +++++++++++++++++++++++----------- 1 file changed, 143 insertions(+), 66 deletions(-) diff --git a/kumascript/macros/A11yRef.ejs b/kumascript/macros/A11yRef.ejs index 2bad08158724..ea6d8119d70c 100644 --- a/kumascript/macros/A11yRef.ejs +++ b/kumascript/macros/A11yRef.ejs @@ -1,9 +1,25 @@ <% -const sections = mdn.localStringMap({ - 'en-US': { +const locale = env.locale; +const sidebarURL = `/docs/Web/`; +const baseURL = `/${locale}/docs/Web/Accessibility/`; +const AriaURL = `/${locale}/docs/Web/Accessibility/ARIA/`; +const LearnURL = `/${locale}/docs/Learn/Accessibility/`; + +const l10nStrings = mdn.localStringMap({ + "en-US": { "Accessibility" : "Accessibility", "Guides" : "Guides", + "Information_for_Web_authors" : "Information for web authors", + "Accessibility:_What_users_can_to_to_browse_safely" : "User settings", + "An_overview_of_accessible_web_applications_and_widgets" : "Applications and widgets", + "Keyboard-navigable_JavaScript_widgets" : "Keyboard-navigable widgets", + "Mobile_accessibility_checklist" : "Mobile checklist", + "Understanding_WCAG" : "Understanding WCAG", + "Cognitive_accessibility" : "Cognitive accessibility", + "Accessibility_and_Spacial_Patterns" : "Spacial Patterns", + "Understanding_Colors_and_Luminance" : "Colors and Luminance", + "Seizure_disorders" : "Seizures and physical reactions", "Resources" : "Resources", "What_is_accessibility" : "What is accessibility?", "HTML" : "HTML: A good basis for accessibility", @@ -11,7 +27,8 @@ const sections = mdn.localStringMap({ "WAI-ARIA_basics" : "WAI-ARIA basics", "Multimedia" : "Accessible multimedia", "Mobile" : "Mobile accessibility", - "ARIA Guides" : "ARIA Guides", + "ARIA" : "ARIA", + "ARIA_guides" : "ARIA guides", "Annotations" : "Annotations", "ARIA_Guides" : "Guides", "ARIA_Live_Regions" : "Live regions", @@ -19,73 +36,133 @@ const sections = mdn.localStringMap({ "ARIA_Techniques" : "Using ARIA", "Multipart_labels" : "Multipart labels", "How_to_file_ARIA-related_bugs" : "How to file bugs", - "ARIA States and properties": "ARIA States and properties", - "ARIA Roles": "Area Roles" + "ARIA states and properties": "ARIA states and properties", + "ARIA roles": "ARIA roles", } }); +const sections = [ + { + name: "Accessibility", + link: "Accessibility", + subsections: [ + { + name: "Guides", + url: baseURL, + pages: [ + "Information_for_Web_authors", + "Accessibility:_What_users_can_to_to_browse_safely", + "An_overview_of_accessible_web_applications_and_widgets", + "Keyboard-navigable_JavaScript_widgets", + "Mobile_accessibility_checklist", + "Understanding_WCAG", + "Cognitive_accessibility", + "Accessibility_and_Spacial_Patterns", + "Understanding_Colors_and_Luminance", + "Seizure_disorders", + ] + }, + { + name: "Resources", + url: LearnURL, + pages: [ + "What_is_accessibility", + "HTML", + "CSS_and_JavaScript", + "WAI-ARIA_basics", + "Multimedia", + "Mobile", + ] + } + ] + }, + { + name: "ARIA", + link: "ARIA", + subsections: [ + { + name: "ARIA_guides", + url: AriaURL, + pages: [ + "Annotations", + "ARIA_Guides", + "ARIA_Live_Regions", + "ARIA_Screen_Reader_Implementors_Guide", + "ARIA_Techniques", + "Multipart_labels", + "How_to_file_ARIA-related_bugs", + ] + }, + { + name: "ARIA states and properties", + url: AriaURL, + subdirectory: "attributes", + }, + { + name: "ARIA roles", + url: AriaURL, + subdirectory: "roles", + } + ] + } +]; -const locale = env.locale; -const baseURL = `/${locale}/docs/Web/Accessibility/`; -const AriaURL = `/${locale}/docs/Web/Accessibility/ARIA/`; -const LearnURL = `/${locale}/docs/Learn/`; +async function getTitle(pageSlug, URL) { + let baseURL = URL? URL : baseURL; + let page = await wiki.getPage(`${baseURL}${pageSlug}`); + if (!page.title) { + page = await wiki.getPage(`/en-US${sidebarURL}${pageSlug}`); + } + return mdn.htmlEscape(page.title); +} + +async function renderSubsection(subsection) { + let output = `
    8. ${l10nStrings[subsection.name]}
        `; + if (subsection.pages) { + let URL = subsection.url; + for (const page of subsection.pages) { + const link = web.smartLink(`${URL}${page}`, null, await getTitle(page, URL)); + output += `
      1. ${link}
      2. `; + } + } else { + output += await renderDirectory(subsection); + } + output += "
    9. "; + return output; +} + + +async function renderDirectory(subsection) { + let directory = `${subsection.url}${subsection.subdirectory}`; + let output = await template("ListSubpagesForSidebar", [directory, true, true]); + return output; +} + + +async function renderSection(section) { + let output = `
    10. ${l10nStrings[section.name]}
    11. `; + + for (const subsection of section.subsections) { + output += await renderSubsection(subsection); + } + + return output; +} + +async function renderSidebar() { + let output = '"; + + return output; +} + +const output = await renderSidebar(); %> - +<%-output%> From 132c88e07a8b14940b7c5590c5b084511746ab6f Mon Sep 17 00:00:00 2001 From: Estelle Weyl Date: Sat, 23 Mar 2024 16:15:18 -0700 Subject: [PATCH 06/15] Rename A11yRef.ejs to accessibilitySidebar.ejs --- kumascript/macros/{A11yRef.ejs => accessibilitySidebar.ejs} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename kumascript/macros/{A11yRef.ejs => accessibilitySidebar.ejs} (100%) diff --git a/kumascript/macros/A11yRef.ejs b/kumascript/macros/accessibilitySidebar.ejs similarity index 100% rename from kumascript/macros/A11yRef.ejs rename to kumascript/macros/accessibilitySidebar.ejs From 8c133cdfab88b19e4339d5035dd0c185e849a6c5 Mon Sep 17 00:00:00 2001 From: Estelle Weyl Date: Mon, 25 Mar 2024 14:50:08 -0700 Subject: [PATCH 07/15] Update and rename accessibilitySidebar.ejs to AccessibilitySidebar.ejs --- ...tySidebar.ejs => AccessibilitySidebar.ejs} | 73 ++++++++----------- 1 file changed, 30 insertions(+), 43 deletions(-) rename kumascript/macros/{accessibilitySidebar.ejs => AccessibilitySidebar.ejs} (66%) diff --git a/kumascript/macros/accessibilitySidebar.ejs b/kumascript/macros/AccessibilitySidebar.ejs similarity index 66% rename from kumascript/macros/accessibilitySidebar.ejs rename to kumascript/macros/AccessibilitySidebar.ejs index ea6d8119d70c..4e867ff9e074 100644 --- a/kumascript/macros/accessibilitySidebar.ejs +++ b/kumascript/macros/AccessibilitySidebar.ejs @@ -2,9 +2,9 @@ const locale = env.locale; const sidebarURL = `/docs/Web/`; -const baseURL = `/${locale}/docs/Web/Accessibility/`; -const AriaURL = `/${locale}/docs/Web/Accessibility/ARIA/`; -const LearnURL = `/${locale}/docs/Learn/Accessibility/`; +const baseURL = `/${locale}/docs/`; +const ariaURL = `/${locale}/docs/Web/Accessibility/ARIA/`; +const learnURL = `/${locale}/docs/Learn/`; const l10nStrings = mdn.localStringMap({ "en-US": { @@ -20,13 +20,7 @@ const l10nStrings = mdn.localStringMap({ "Accessibility_and_Spacial_Patterns" : "Spacial Patterns", "Understanding_Colors_and_Luminance" : "Colors and Luminance", "Seizure_disorders" : "Seizures and physical reactions", - "Resources" : "Resources", - "What_is_accessibility" : "What is accessibility?", - "HTML" : "HTML: A good basis for accessibility", - "CSS_and_JavaScript" : "CSS and JavaScript accessibility best practices", - "WAI-ARIA_basics" : "WAI-ARIA basics", - "Multimedia" : "Accessible multimedia", - "Mobile" : "Mobile accessibility", + "Learn" : "Learn accessibility", "ARIA" : "ARIA", "ARIA_guides" : "ARIA guides", "Annotations" : "Annotations", @@ -50,30 +44,32 @@ const sections = [ name: "Guides", url: baseURL, pages: [ - "Information_for_Web_authors", - "Accessibility:_What_users_can_to_to_browse_safely", - "An_overview_of_accessible_web_applications_and_widgets", - "Keyboard-navigable_JavaScript_widgets", - "Mobile_accessibility_checklist", - "Understanding_WCAG", - "Cognitive_accessibility", - "Accessibility_and_Spacial_Patterns", - "Understanding_Colors_and_Luminance", - "Seizure_disorders", + "Web/Accessibility/Information_for_Web_authors", + "Web/Accessibility/Accessibility:_What_users_can_to_to_browse_safely", + "Web/Accessibility/An_overview_of_accessible_web_applications_and_widgets", + "Web/Accessibility/Keyboard-navigable_JavaScript_widgets", + "Web/Accessibility/Mobile_accessibility_checklist", + "Web/Accessibility/Understanding_WCAG", + "Web/Accessibility/Cognitive_accessibility", + "Web/Accessibility/Accessibility_and_Spacial_Patterns", + "Web/Accessibility/Understanding_Colors_and_Luminance", + "Web/Accessibility/Seizure_disorders", ] }, { - name: "Resources", - url: LearnURL, + name: "Learn", + url: learnURL, pages: [ - "What_is_accessibility", - "HTML", - "CSS_and_JavaScript", - "WAI-ARIA_basics", - "Multimedia", - "Mobile", + "Accessibility/", + "Accessibility/What_is_accessibility", + "Accessibility/HTML", + "Accessibility/CSS_and_JavaScript", + "Accessibility/WAI-ARIA_basics", + "Accessibility/Multimedia", + "Accessibility/Mobile", + "Accessibility/Accessibility_troubleshooting", ] - } + }, ] }, { @@ -82,7 +78,7 @@ const sections = [ subsections: [ { name: "ARIA_guides", - url: AriaURL, + url: ariaURL, pages: [ "Annotations", "ARIA_Guides", @@ -95,33 +91,24 @@ const sections = [ }, { name: "ARIA states and properties", - url: AriaURL, + url: ariaURL, subdirectory: "attributes", }, { name: "ARIA roles", - url: AriaURL, + url: ariaURL, subdirectory: "roles", } ] } ]; -async function getTitle(pageSlug, URL) { - let baseURL = URL? URL : baseURL; - let page = await wiki.getPage(`${baseURL}${pageSlug}`); - if (!page.title) { - page = await wiki.getPage(`/en-US${sidebarURL}${pageSlug}`); - } - return mdn.htmlEscape(page.title); -} - async function renderSubsection(subsection) { let output = `
    12. ${l10nStrings[subsection.name]}
        `; if (subsection.pages) { - let URL = subsection.url; + let url = subsection.url; for (const page of subsection.pages) { - const link = web.smartLink(`${URL}${page}`, null, await getTitle(page, URL)); + const link = web.smartLink(`${url}${page}`); output += `
      1. ${link}
      2. `; } } else { From 2cb835df30cc8c922ea7d04a3416f1160b5e6f2d Mon Sep 17 00:00:00 2001 From: Estelle Weyl Date: Tue, 26 Mar 2024 14:10:19 -0700 Subject: [PATCH 08/15] Add WCAG to sidebar --- kumascript/macros/AccessibilitySidebar.ejs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/kumascript/macros/AccessibilitySidebar.ejs b/kumascript/macros/AccessibilitySidebar.ejs index 4e867ff9e074..2f5afed7cf07 100644 --- a/kumascript/macros/AccessibilitySidebar.ejs +++ b/kumascript/macros/AccessibilitySidebar.ejs @@ -3,6 +3,7 @@ const locale = env.locale; const sidebarURL = `/docs/Web/`; const baseURL = `/${locale}/docs/`; +const accessibilityURL = `/${locale}/docs/Web/Accessibility/`; const ariaURL = `/${locale}/docs/Web/Accessibility/ARIA/`; const learnURL = `/${locale}/docs/Learn/`; @@ -32,6 +33,7 @@ const l10nStrings = mdn.localStringMap({ "How_to_file_ARIA-related_bugs" : "How to file bugs", "ARIA states and properties": "ARIA states and properties", "ARIA roles": "ARIA roles", + "WCAG": "WCAG", } }); @@ -70,6 +72,11 @@ const sections = [ "Accessibility/Accessibility_troubleshooting", ] }, + { + name: "WCAG", + url: accessibilityURL, + subdirectory: "Understanding_WCAG", + } ] }, { From acb3d010b48e257753b1f00545220d76487213f5 Mon Sep 17 00:00:00 2001 From: Claas Augner Date: Tue, 16 Apr 2024 21:53:34 +0200 Subject: [PATCH 09/15] refactor(macros/AccessibilitySidebar): use fully-qualified slugs --- kumascript/macros/AccessibilitySidebar.ejs | 54 +++++++++------------- 1 file changed, 22 insertions(+), 32 deletions(-) diff --git a/kumascript/macros/AccessibilitySidebar.ejs b/kumascript/macros/AccessibilitySidebar.ejs index 2f5afed7cf07..966e674a2c9b 100644 --- a/kumascript/macros/AccessibilitySidebar.ejs +++ b/kumascript/macros/AccessibilitySidebar.ejs @@ -3,9 +3,6 @@ const locale = env.locale; const sidebarURL = `/docs/Web/`; const baseURL = `/${locale}/docs/`; -const accessibilityURL = `/${locale}/docs/Web/Accessibility/`; -const ariaURL = `/${locale}/docs/Web/Accessibility/ARIA/`; -const learnURL = `/${locale}/docs/Learn/`; const l10nStrings = mdn.localStringMap({ "en-US": { @@ -40,11 +37,10 @@ const l10nStrings = mdn.localStringMap({ const sections = [ { name: "Accessibility", - link: "Accessibility", + link: "Web/Accessibility", subsections: [ { name: "Guides", - url: baseURL, pages: [ "Web/Accessibility/Information_for_Web_authors", "Web/Accessibility/Accessibility:_What_users_can_to_to_browse_safely", @@ -60,51 +56,46 @@ const sections = [ }, { name: "Learn", - url: learnURL, pages: [ - "Accessibility/", - "Accessibility/What_is_accessibility", - "Accessibility/HTML", - "Accessibility/CSS_and_JavaScript", - "Accessibility/WAI-ARIA_basics", - "Accessibility/Multimedia", - "Accessibility/Mobile", - "Accessibility/Accessibility_troubleshooting", + "Learn/Accessibility/", + "Learn/Accessibility/What_is_accessibility", + "Learn/Accessibility/HTML", + "Learn/Accessibility/CSS_and_JavaScript", + "Learn/Accessibility/WAI-ARIA_basics", + "Learn/Accessibility/Multimedia", + "Learn/Accessibility/Mobile", + "Learn/Accessibility/Accessibility_troubleshooting", ] }, { name: "WCAG", - url: accessibilityURL, - subdirectory: "Understanding_WCAG", + subdirectory: "Web/Accessibility/Understanding_WCAG", } ] }, { name: "ARIA", - link: "ARIA", + link: "Web/Accessibility/ARIA", subsections: [ { name: "ARIA_guides", - url: ariaURL, pages: [ - "Annotations", - "ARIA_Guides", - "ARIA_Live_Regions", - "ARIA_Screen_Reader_Implementors_Guide", - "ARIA_Techniques", - "Multipart_labels", - "How_to_file_ARIA-related_bugs", + "Web/Accessibility/ARIA/Annotations", + "Web/Accessibility/ARIA/ARIA_Guides", + "Web/Accessibility/ARIA/ARIA_Live_Regions", + "Web/Accessibility/ARIA/ARIA_Screen_Reader_Implementors_Guide", + "Web/Accessibility/ARIA/ARIA_Techniques", + "Web/Accessibility/ARIA/Multipart_labels", + "Web/Accessibility/ARIA/How_to_file_ARIA-related_bugs", ] }, { name: "ARIA states and properties", - url: ariaURL, - subdirectory: "attributes", + subdirectory: "Web/Accessibility/ARIA/attributes", }, { name: "ARIA roles", - url: ariaURL, - subdirectory: "roles", + subdirectory: "Web/Accessibility/ARIA/roles", } ] } @@ -113,9 +104,8 @@ const sections = [ async function renderSubsection(subsection) { let output = `
      3. ${l10nStrings[subsection.name]}
          `; if (subsection.pages) { - let url = subsection.url; for (const page of subsection.pages) { - const link = web.smartLink(`${url}${page}`); + const link = web.smartLink(`${baseURL}${page}`); output += `
        1. ${link}
        2. `; } } else { @@ -127,7 +117,7 @@ async function renderSubsection(subsection) { async function renderDirectory(subsection) { - let directory = `${subsection.url}${subsection.subdirectory}`; + let directory = `${baseURL}${subsection.subdirectory}`; let output = await template("ListSubpagesForSidebar", [directory, true, true]); return output; } From 25579fdbce8b605d2df0bd2763a3026f841fe937 Mon Sep 17 00:00:00 2001 From: Claas Augner Date: Tue, 16 Apr 2024 21:54:01 +0200 Subject: [PATCH 10/15] fix(macros/AccessibilitySidebar): use new li.section class --- kumascript/macros/AccessibilitySidebar.ejs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kumascript/macros/AccessibilitySidebar.ejs b/kumascript/macros/AccessibilitySidebar.ejs index 966e674a2c9b..fd6da98a396f 100644 --- a/kumascript/macros/AccessibilitySidebar.ejs +++ b/kumascript/macros/AccessibilitySidebar.ejs @@ -124,7 +124,7 @@ async function renderDirectory(subsection) { async function renderSection(section) { - let output = `
        3. ${l10nStrings[section.name]}
        4. `; + let output = `
        5. ${l10nStrings[section.name]}
        6. `; for (const subsection of section.subsections) { output += await renderSubsection(subsection); From 7d5da60036afab38ef5abf4f1db35383e1073e17 Mon Sep 17 00:00:00 2001 From: Claas Augner Date: Tue, 16 Apr 2024 21:55:27 +0200 Subject: [PATCH 11/15] chore(macros/AccessibilitySidebar): remove unused var --- kumascript/macros/AccessibilitySidebar.ejs | 1 - 1 file changed, 1 deletion(-) diff --git a/kumascript/macros/AccessibilitySidebar.ejs b/kumascript/macros/AccessibilitySidebar.ejs index fd6da98a396f..7933794ad00a 100644 --- a/kumascript/macros/AccessibilitySidebar.ejs +++ b/kumascript/macros/AccessibilitySidebar.ejs @@ -1,7 +1,6 @@ <% const locale = env.locale; -const sidebarURL = `/docs/Web/`; const baseURL = `/${locale}/docs/`; const l10nStrings = mdn.localStringMap({ From 666b52b7767797e8950bfa0691ab4bfe5e6ca6ea Mon Sep 17 00:00:00 2001 From: Claas Augner Date: Tue, 16 Apr 2024 21:57:42 +0200 Subject: [PATCH 12/15] chore(macros/AccessibilitySidebar): remove unused translations --- kumascript/macros/AccessibilitySidebar.ejs | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/kumascript/macros/AccessibilitySidebar.ejs b/kumascript/macros/AccessibilitySidebar.ejs index 7933794ad00a..02d39df6e6f4 100644 --- a/kumascript/macros/AccessibilitySidebar.ejs +++ b/kumascript/macros/AccessibilitySidebar.ejs @@ -7,26 +7,9 @@ const l10nStrings = mdn.localStringMap({ "en-US": { "Accessibility" : "Accessibility", "Guides" : "Guides", - "Information_for_Web_authors" : "Information for web authors", - "Accessibility:_What_users_can_to_to_browse_safely" : "User settings", - "An_overview_of_accessible_web_applications_and_widgets" : "Applications and widgets", - "Keyboard-navigable_JavaScript_widgets" : "Keyboard-navigable widgets", - "Mobile_accessibility_checklist" : "Mobile checklist", - "Understanding_WCAG" : "Understanding WCAG", - "Cognitive_accessibility" : "Cognitive accessibility", - "Accessibility_and_Spacial_Patterns" : "Spacial Patterns", - "Understanding_Colors_and_Luminance" : "Colors and Luminance", - "Seizure_disorders" : "Seizures and physical reactions", "Learn" : "Learn accessibility", "ARIA" : "ARIA", "ARIA_guides" : "ARIA guides", - "Annotations" : "Annotations", - "ARIA_Guides" : "Guides", - "ARIA_Live_Regions" : "Live regions", - "ARIA_Screen_Reader_Implementors_Guide" : "Screen reader implementors guide", - "ARIA_Techniques" : "Using ARIA", - "Multipart_labels" : "Multipart labels", - "How_to_file_ARIA-related_bugs" : "How to file bugs", "ARIA states and properties": "ARIA states and properties", "ARIA roles": "ARIA roles", "WCAG": "WCAG", From 2335c01ed7c9e0d8e92c7b1369f59fddcdf030de Mon Sep 17 00:00:00 2001 From: Claas Augner Date: Tue, 16 Apr 2024 22:01:11 +0200 Subject: [PATCH 13/15] refactor(macros/AccessibilitySidebar): rename subdirectory => directory --- kumascript/macros/AccessibilitySidebar.ejs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/kumascript/macros/AccessibilitySidebar.ejs b/kumascript/macros/AccessibilitySidebar.ejs index 02d39df6e6f4..08618f76a5c0 100644 --- a/kumascript/macros/AccessibilitySidebar.ejs +++ b/kumascript/macros/AccessibilitySidebar.ejs @@ -51,7 +51,7 @@ const sections = [ }, { name: "WCAG", - subdirectory: "Web/Accessibility/Understanding_WCAG", + directory: "Web/Accessibility/Understanding_WCAG", } ] }, @@ -73,11 +73,11 @@ const sections = [ }, { name: "ARIA states and properties", - subdirectory: "Web/Accessibility/ARIA/attributes", + directory: "Web/Accessibility/ARIA/attributes", }, { name: "ARIA roles", - subdirectory: "Web/Accessibility/ARIA/roles", + directory: "Web/Accessibility/ARIA/roles", } ] } @@ -99,7 +99,7 @@ async function renderSubsection(subsection) { async function renderDirectory(subsection) { - let directory = `${baseURL}${subsection.subdirectory}`; + let directory = `${baseURL}${subsection.directory}`; let output = await template("ListSubpagesForSidebar", [directory, true, true]); return output; } From d9ea09a51cec3a139de13695ce0a73506932eda4 Mon Sep 17 00:00:00 2001 From: Claas Augner Date: Tue, 16 Apr 2024 22:02:47 +0200 Subject: [PATCH 14/15] refactor(macros/AccessibilitySidebar): let -> const + new lines --- kumascript/macros/AccessibilitySidebar.ejs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/kumascript/macros/AccessibilitySidebar.ejs b/kumascript/macros/AccessibilitySidebar.ejs index 08618f76a5c0..006bf8c7be73 100644 --- a/kumascript/macros/AccessibilitySidebar.ejs +++ b/kumascript/macros/AccessibilitySidebar.ejs @@ -85,6 +85,7 @@ const sections = [ async function renderSubsection(subsection) { let output = `
        7. ${l10nStrings[subsection.name]}
            `; + if (subsection.pages) { for (const page of subsection.pages) { const link = web.smartLink(`${baseURL}${page}`); @@ -94,13 +95,15 @@ async function renderSubsection(subsection) { output += await renderDirectory(subsection); } output += "
        8. "; + return output; } async function renderDirectory(subsection) { - let directory = `${baseURL}${subsection.directory}`; - let output = await template("ListSubpagesForSidebar", [directory, true, true]); + const directory = `${baseURL}${subsection.directory}`; + const output = await template("ListSubpagesForSidebar", [directory, true, true]); + return output; } From 050221221371fbdcb1627d051c9f5c5121e79d84 Mon Sep 17 00:00:00 2001 From: Claas Augner Date: Tue, 16 Apr 2024 22:04:59 +0200 Subject: [PATCH 15/15] refactor(macros/AccessibilitySidebar): pass only directory to renderDirectory() --- kumascript/macros/AccessibilitySidebar.ejs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/kumascript/macros/AccessibilitySidebar.ejs b/kumascript/macros/AccessibilitySidebar.ejs index 006bf8c7be73..02b8967a9c57 100644 --- a/kumascript/macros/AccessibilitySidebar.ejs +++ b/kumascript/macros/AccessibilitySidebar.ejs @@ -92,7 +92,7 @@ async function renderSubsection(subsection) { output += `
        9. ${link}
        10. `; } } else { - output += await renderDirectory(subsection); + output += await renderDirectory(subsection.directory); } output += "
      4. "; @@ -100,9 +100,9 @@ async function renderSubsection(subsection) { } -async function renderDirectory(subsection) { - const directory = `${baseURL}${subsection.directory}`; - const output = await template("ListSubpagesForSidebar", [directory, true, true]); +async function renderDirectory(directory) { + const path = `${baseURL}${directory}`; + const output = await template("ListSubpagesForSidebar", [path, true, true]); return output; }