diff --git a/.gitignore b/.gitignore index b6e4761..b3845ca 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# MacOS +.DS_Store + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/a11y/docs/a11y_page_titles.md b/a11y/docs/a11y_page_titles.md new file mode 100644 index 0000000..0b1374e --- /dev/null +++ b/a11y/docs/a11y_page_titles.md @@ -0,0 +1,76 @@ +# a11y_page_titles + +Django management command that generates a markdown report comparing page titles across the OLH, Material, and Clean themes for a list of URLs. + +## Purpose +To assit with finding areas of non-compliance with [WCAG 2.4.2 Page Titled](https://www.w3.org/WAI/WCAG22/Understanding/page-titled) +> Web pages have titles that describe topic or purpose. + +"Describe" is subjective. This command cannot determine whether the title is descriptive. It is a helper command, to generate list of titles for a developer to review." A check is included as to whether all three themes have the same title, but this has no direct bearing on whether the title passes the requirement. Where the same title is expected across all three themes this provides a quick way to review the results. + +## What it does + +The command: + +1. Loads a list of URLs (from a JSON file) +2. Fetches each URL once per theme (olh, material, clean) via the Django test client +3. Extracts the `