From 90ae4063fd137aedf5375cd0322ce8ede0ede479 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Sat, 26 Nov 2016 11:52:00 +0100 Subject: [PATCH 1/8] =?UTF-8?q?=F0=9F=8C=90=20Accessible=20Setup=20?= =?UTF-8?q?=E2=99=BF=EF=B8=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The MODX Advisory Board recommends, in an effort to make an accessible first impression, the setup process will support the option to set accessibility preferences during the installation process. 🔧🤘 --- proposed/a11y-setup.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 proposed/a11y-setup.md diff --git a/proposed/a11y-setup.md b/proposed/a11y-setup.md new file mode 100644 index 0000000..0dd3e7b --- /dev/null +++ b/proposed/a11y-setup.md @@ -0,0 +1,38 @@ +# 🌐 Accessible Setup ♿️ + +_Note: This recommendation is a DRAFT for consideration of the MODX Advisory Board._ + +The MODX Advisory Board recommends, in an effort to make an accessible first impression, the setup process will support the option to set accessibility preferences during the installation process. +🔧🤘 + +**Editor: JP de Vries** +**First published draft: Nov 26, 2016** + +## 🙏 Goals of Recommendation + + - To ensure that any accessibility preferences that may make the MODX Manager interface more accessible to users are accessible themselves during the installation setup process + - To allow Third Party Components to register preferences to the installer + +## 📚 Relevant Recommendations + + - [Bandwidth Considerations](https://github.com/modxcms/mab-recommendations/pull/4) + - [Accessibility Mandate](https://github.com/modxcms/mab-recommendations/pull/3) + - [Progressive Icons Proposal](https://github.com/modxcms/mab-recommendations/pull/1) + +## 🎯 Proof of Concepts + - [Markup.tips Settings](https://markup.tips/settings.html#focus) + - [MakeanIco Settings](http://makeanico.herokuapp.com/preferences) + +## 📝 Recommendation +📓 At modmore we hired [Janita Top](https://www.meetup.com/Groningen-Frontend-Devs/members/148145182/) for some accessibility consulting. One of the things that stuck with me from her presentation was not to be too quick to celebrate victory. You may not have received any feedback about inaccessibility because if a someone can't use the site, they can't leave feedback to begin with. +💡💥 + +_If a MODX user can not get to the System Settings page to update some settings or switch themes, that feature does not exist to them._ + +😃 Allowing users to set their preferences during the installation process will make for an accessible first impression of the MODX editing experience. Preferences like [contrast](https://markup.tips/settings.html#contrast), [font–size](https://markup.tips/settings.html#font-size), reduce animation, [font–family (choose a webfont)](https://markup.tips/settings.html#typeface), and even themes can be chosen during the installation process. + +⌛️ This recommendation should not increase the amount of time it takes to install MODX. For example, these options could be hidden behind a button or ``. + +📦 The core installation will ship with a default set of preferences configurable upon installation, but it is important that these preferences are not defined strictly by the core. Third Party Components (is that what we are calling Extras now?) should be able to register their own preferences that are accessible during installation. + +🛠 Preferences should be able to be set as System, User, and/or `localStorage` Settings. This will allow MODX to be tailored to just your device, just your user, or system wide. From 5a6e5156b6f6a70b0bd4087024fd8318d48d1089 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Thu, 18 May 2017 12:11:00 +0200 Subject: [PATCH 2/8] adding MODX Setup Proof of Concept --- proposed/a11y-setup.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/proposed/a11y-setup.md b/proposed/a11y-setup.md index 0dd3e7b..627d00f 100644 --- a/proposed/a11y-setup.md +++ b/proposed/a11y-setup.md @@ -20,6 +20,7 @@ The MODX Advisory Board recommends, in an effort to make an accessible first imp - [Progressive Icons Proposal](https://github.com/modxcms/mab-recommendations/pull/1) ## 🎯 Proof of Concepts + - [MODX Setup](https://github.com/jpdevries/modx-setup#demo) - [Markup.tips Settings](https://markup.tips/settings.html#focus) - [MakeanIco Settings](http://makeanico.herokuapp.com/preferences) @@ -36,3 +37,5 @@ _If a MODX user can not get to the System Settings page to update some settings 📦 The core installation will ship with a default set of preferences configurable upon installation, but it is important that these preferences are not defined strictly by the core. Third Party Components (is that what we are calling Extras now?) should be able to register their own preferences that are accessible during installation. 🛠 Preferences should be able to be set as System, User, and/or `localStorage` Settings. This will allow MODX to be tailored to just your device, just your user, or system wide. + +🎓 Someone who has a Masters Degree in Computer Science and just found out what MODX is 5 minutes ago, and is now trying to install it, is contextually a cognitively disabled MODX user. They don't know what MODX Extras are, let alone the right ones they need to install to get what they want done. It may take them days of trial and error and research to learn the MODX Extra ecosystem. The installation complete screen should allow users to specify what they will be building and automagically install the Extras they'll need. No longer will you need knowledge of what MODX Extras are what. You just tell MODX what you want to build. From e32aa14dd2dbd8c25dfc1e1c09ed97b7c099d941 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Mon, 22 May 2017 12:42:48 +0200 Subject: [PATCH 3/8] removing a11y preferences API it isn't that I don't like this idea, but I'm not sure it is necessary and it can be its own DRAFT one day if nedded --- proposed/a11y-setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/proposed/a11y-setup.md b/proposed/a11y-setup.md index 627d00f..45d86ef 100644 --- a/proposed/a11y-setup.md +++ b/proposed/a11y-setup.md @@ -11,7 +11,7 @@ The MODX Advisory Board recommends, in an effort to make an accessible first imp ## 🙏 Goals of Recommendation - To ensure that any accessibility preferences that may make the MODX Manager interface more accessible to users are accessible themselves during the installation setup process - - To allow Third Party Components to register preferences to the installer + - ~~To allow Third Party Components to register preferences to the installer~~ ## 📚 Relevant Recommendations @@ -34,7 +34,7 @@ _If a MODX user can not get to the System Settings page to update some settings ⌛️ This recommendation should not increase the amount of time it takes to install MODX. For example, these options could be hidden behind a button or ``. -📦 The core installation will ship with a default set of preferences configurable upon installation, but it is important that these preferences are not defined strictly by the core. Third Party Components (is that what we are calling Extras now?) should be able to register their own preferences that are accessible during installation. +📦 ~~The core installation will ship with a default set of preferences configurable upon installation, but it is important that these preferences are not defined strictly by the core. Third Party Components (is that what we are calling Extras now?) should be able to register their own preferences that are accessible during installation.~~ 🛠 Preferences should be able to be set as System, User, and/or `localStorage` Settings. This will allow MODX to be tailored to just your device, just your user, or system wide. From da99b5e216c73b407271163745826c9a210a85b6 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Mon, 22 May 2017 12:57:55 +0200 Subject: [PATCH 4/8] Update a11y-setup.md --- proposed/a11y-setup.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/proposed/a11y-setup.md b/proposed/a11y-setup.md index 45d86ef..d59ee3e 100644 --- a/proposed/a11y-setup.md +++ b/proposed/a11y-setup.md @@ -2,7 +2,7 @@ _Note: This recommendation is a DRAFT for consideration of the MODX Advisory Board._ -The MODX Advisory Board recommends, in an effort to make an accessible first impression, the setup process will support the option to set accessibility preferences during the installation process. +The MODX Advisory Board recommends, in an effort to make an accessible first impression, a new setup process will support the option to set accessibility preferences during the installation process. 🔧🤘 **Editor: JP de Vries** @@ -11,6 +11,7 @@ The MODX Advisory Board recommends, in an effort to make an accessible first imp ## 🙏 Goals of Recommendation - To ensure that any accessibility preferences that may make the MODX Manager interface more accessible to users are accessible themselves during the installation setup process + - To reimagine the setup process to be more end–user friendly (more accessible and less technical language) - ~~To allow Third Party Components to register preferences to the installer~~ ## 📚 Relevant Recommendations @@ -21,8 +22,7 @@ The MODX Advisory Board recommends, in an effort to make an accessible first imp ## 🎯 Proof of Concepts - [MODX Setup](https://github.com/jpdevries/modx-setup#demo) - - [Markup.tips Settings](https://markup.tips/settings.html#focus) - - [MakeanIco Settings](http://makeanico.herokuapp.com/preferences) + - [Screencast](https://vimeo.com/218397030) ## 📝 Recommendation 📓 At modmore we hired [Janita Top](https://www.meetup.com/Groningen-Frontend-Devs/members/148145182/) for some accessibility consulting. One of the things that stuck with me from her presentation was not to be too quick to celebrate victory. You may not have received any feedback about inaccessibility because if a someone can't use the site, they can't leave feedback to begin with. @@ -39,3 +39,5 @@ _If a MODX user can not get to the System Settings page to update some settings 🛠 Preferences should be able to be set as System, User, and/or `localStorage` Settings. This will allow MODX to be tailored to just your device, just your user, or system wide. 🎓 Someone who has a Masters Degree in Computer Science and just found out what MODX is 5 minutes ago, and is now trying to install it, is contextually a cognitively disabled MODX user. They don't know what MODX Extras are, let alone the right ones they need to install to get what they want done. It may take them days of trial and error and research to learn the MODX Extra ecosystem. The installation complete screen should allow users to specify what they will be building and automagically install the Extras they'll need. No longer will you need knowledge of what MODX Extras are what. You just tell MODX what you want to build. + +🚫 This recommendation does not include the "package wizard" as found in the [MODX Setup concept](https://github.com/jpdevries/modx-setup#demo). That will be its own recomendation. This recommendation also does not target a specific version of MODX. From 0711108cac86fd51f0c6bc6b090dabc675751216 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Mon, 22 May 2017 12:59:05 +0200 Subject: [PATCH 5/8] Update a11y-setup.md --- proposed/a11y-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposed/a11y-setup.md b/proposed/a11y-setup.md index d59ee3e..c2d3fd9 100644 --- a/proposed/a11y-setup.md +++ b/proposed/a11y-setup.md @@ -2,7 +2,7 @@ _Note: This recommendation is a DRAFT for consideration of the MODX Advisory Board._ -The MODX Advisory Board recommends, in an effort to make an accessible first impression, a new setup process will support the option to set accessibility preferences during the installation process. +The MODX Advisory Board recommends, in an effort to make an accessible first impression, a new more inclusive setup process will support the option to set accessibility preferences during the installation process. 🔧🤘 **Editor: JP de Vries** From 03ea62c75b5584a70ce6eb97a3dc148404529c09 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Mon, 19 Jun 2017 15:48:20 +0200 Subject: [PATCH 6/8] Update a11y-setup.md --- proposed/a11y-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposed/a11y-setup.md b/proposed/a11y-setup.md index c2d3fd9..3d5516a 100644 --- a/proposed/a11y-setup.md +++ b/proposed/a11y-setup.md @@ -2,7 +2,7 @@ _Note: This recommendation is a DRAFT for consideration of the MODX Advisory Board._ -The MODX Advisory Board recommends, in an effort to make an accessible first impression, a new more inclusive setup process will support the option to set accessibility preferences during the installation process. +The MODX Advisory Board recommends, in an effort to make an accessible first impression, a new more inclusive setup process will expose accessibility preferences during the installation process. 🔧🤘 **Editor: JP de Vries** From f0487290afb57168e9d626783feb912b2a9b8218 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Mon, 19 Jun 2017 15:52:41 +0200 Subject: [PATCH 7/8] Update a11y-setup.md --- proposed/a11y-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposed/a11y-setup.md b/proposed/a11y-setup.md index 3d5516a..31c6a85 100644 --- a/proposed/a11y-setup.md +++ b/proposed/a11y-setup.md @@ -36,7 +36,7 @@ _If a MODX user can not get to the System Settings page to update some settings 📦 ~~The core installation will ship with a default set of preferences configurable upon installation, but it is important that these preferences are not defined strictly by the core. Third Party Components (is that what we are calling Extras now?) should be able to register their own preferences that are accessible during installation.~~ -🛠 Preferences should be able to be set as System, User, and/or `localStorage` Settings. This will allow MODX to be tailored to just your device, just your user, or system wide. +🛠 ~~Preferences should be able to be set as System, User, and/or `localStorage` Settings. This will allow MODX to be tailored to just your device, just your user, or system wide.~~ 🎓 Someone who has a Masters Degree in Computer Science and just found out what MODX is 5 minutes ago, and is now trying to install it, is contextually a cognitively disabled MODX user. They don't know what MODX Extras are, let alone the right ones they need to install to get what they want done. It may take them days of trial and error and research to learn the MODX Extra ecosystem. The installation complete screen should allow users to specify what they will be building and automagically install the Extras they'll need. No longer will you need knowledge of what MODX Extras are what. You just tell MODX what you want to build. From b5a30458c232c7f5be6d9c78cd60261e3c68b839 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Thu, 29 Jun 2017 13:45:41 +0200 Subject: [PATCH 8/8] Update a11y-setup.md --- proposed/a11y-setup.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/proposed/a11y-setup.md b/proposed/a11y-setup.md index 31c6a85..03f1f2b 100644 --- a/proposed/a11y-setup.md +++ b/proposed/a11y-setup.md @@ -11,8 +11,7 @@ The MODX Advisory Board recommends, in an effort to make an accessible first imp ## 🙏 Goals of Recommendation - To ensure that any accessibility preferences that may make the MODX Manager interface more accessible to users are accessible themselves during the installation setup process - - To reimagine the setup process to be more end–user friendly (more accessible and less technical language) - - ~~To allow Third Party Components to register preferences to the installer~~ + - To reimagine the setup process to be more end–user friendly (more accessible and less technical language) ## 📚 Relevant Recommendations @@ -25,19 +24,12 @@ The MODX Advisory Board recommends, in an effort to make an accessible first imp - [Screencast](https://vimeo.com/218397030) ## 📝 Recommendation -📓 At modmore we hired [Janita Top](https://www.meetup.com/Groningen-Frontend-Devs/members/148145182/) for some accessibility consulting. One of the things that stuck with me from her presentation was not to be too quick to celebrate victory. You may not have received any feedback about inaccessibility because if a someone can't use the site, they can't leave feedback to begin with. -💡💥 +👤 If preferences to improve the accessibility of the MODX manager are managed through system settings, these preferences themselves might not be accessible to the user. Whether these preferences relate to contrast, font-size, reduced animations or fully optimised manager themes, if the user is unable to configure such options, those features do not exist to them. Therefore, accessibility preferences must also be configurable from an accessible setup. -_If a MODX user can not get to the System Settings page to update some settings or switch themes, that feature does not exist to them._ - -😃 Allowing users to set their preferences during the installation process will make for an accessible first impression of the MODX editing experience. Preferences like [contrast](https://markup.tips/settings.html#contrast), [font–size](https://markup.tips/settings.html#font-size), reduce animation, [font–family (choose a webfont)](https://markup.tips/settings.html#typeface), and even themes can be chosen during the installation process. +🎩 The most efficient user action is no action at all. The MODX setup intaller and default theme should "automagically" respond to relevant system level preferences such as high contrast mode, legibility preferences, and the presence of the `save-data` header. Users who are not familiar with system level preferences, or cannot access them, or for some reason choose to override them, benefit from also being able to manage these preference within MODX. ⌛️ This recommendation should not increase the amount of time it takes to install MODX. For example, these options could be hidden behind a button or ``. -📦 ~~The core installation will ship with a default set of preferences configurable upon installation, but it is important that these preferences are not defined strictly by the core. Third Party Components (is that what we are calling Extras now?) should be able to register their own preferences that are accessible during installation.~~ - -🛠 ~~Preferences should be able to be set as System, User, and/or `localStorage` Settings. This will allow MODX to be tailored to just your device, just your user, or system wide.~~ - -🎓 Someone who has a Masters Degree in Computer Science and just found out what MODX is 5 minutes ago, and is now trying to install it, is contextually a cognitively disabled MODX user. They don't know what MODX Extras are, let alone the right ones they need to install to get what they want done. It may take them days of trial and error and research to learn the MODX Extra ecosystem. The installation complete screen should allow users to specify what they will be building and automagically install the Extras they'll need. No longer will you need knowledge of what MODX Extras are what. You just tell MODX what you want to build. +🎓 Someone who has a Masters Degree in Computer Science and just found out what MODX is 5 minutes ago, and is now trying to install it, is contextually a cognitively disabled MODX user. They don't know what MODX Extras are, let alone the right ones they need to install to get what they want done. It may take them days of trial and error and research to learn the MODX Extra ecosystem. The installation complete screen should allow users to specify what they will be building and automatically install the Extras they'll need. No longer will you need knowledge of the MODX Extras ecosystem. You just tell MODX what you want to build. -🚫 This recommendation does not include the "package wizard" as found in the [MODX Setup concept](https://github.com/jpdevries/modx-setup#demo). That will be its own recomendation. This recommendation also does not target a specific version of MODX. +📆 This recommendation target the first non–ExtJS version of MODX.