From 4b18abd1f4809c2f4972c8e898654642a2601bab Mon Sep 17 00:00:00 2001 From: "C." Date: Mon, 29 Jan 2024 10:09:37 +0300 Subject: [PATCH 1/2] at to af --- README.md | 6 +++--- .../Articles/1. Basic/ControlHierarchy.md | 2 +- .../Articles/1. Basic/DescribeElements.md | 2 +- .../Documentation.docc/Getting Started.md | 2 +- .../Tutorials/1. Basic/AdaptingCell.tutorial | 4 ++-- .../Tutorials/2. Advanced/AdjustableTutorial.tutorial | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 411a785..755ad76 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,9 @@ Since it is only a *prototype*, having the resource hosted by **[GitHub Pages](h ## — What can I find in this repository specifically? ### Tutorials -To focus on the implementation of assistive technologies. -- **Real-life cases** in screens and scenarios involving usage of *assistive technologies*. -- **Step-by-step guides** how to apply **Accessibility Features**. +To focus on the applications of Accessibility Features. +- **Real-life cases** in screens and scenarios involving usage of assistive technology. +- **Step-by-step guides** how to adapt iOS applications. ### Articles diff --git a/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/ControlHierarchy.md b/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/ControlHierarchy.md index 225d385..8bd0266 100644 --- a/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/ControlHierarchy.md +++ b/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/ControlHierarchy.md @@ -2,7 +2,7 @@ ## Overview -Assistive technologies take description of elements to provide different way of communications. The core part of this process is providing information about hierarchy of elements, what element should be focusable and what should be hidden from focus. +**Accessibility Features** take description of elements to provide different way of communications. The core part of this process is providing information about hierarchy of elements, what element should be focusable and what should be hidden from focus. ### View hierarchy vs Accessibility Tree diff --git a/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/DescribeElements.md b/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/DescribeElements.md index 8e2e7f5..63e159f 100644 --- a/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/DescribeElements.md +++ b/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/DescribeElements.md @@ -1,6 +1,6 @@ # Describing Elements -In this article we're going to go over core *properties* that **describe *elements* for assistive technologies**. +In this article we're going to go over core *properties* that **describe *elements* for Accessibility Features**. Elements *description* is an essential part for the functioning of **VoiceOver**. This technology is aimed to ***tell* users what's happening on the screen**. diff --git a/Sources/AccessibilityDocumentation/Documentation.docc/Getting Started.md b/Sources/AccessibilityDocumentation/Documentation.docc/Getting Started.md index 0b5c0a5..27eb127 100644 --- a/Sources/AccessibilityDocumentation/Documentation.docc/Getting Started.md +++ b/Sources/AccessibilityDocumentation/Documentation.docc/Getting Started.md @@ -4,7 +4,7 @@ Accessibility part of UIKit and SwiftUI frameworks helps developers to represent ## Overview -### Assistive Technologies +### Accessibility Features There are three main assistance for blind or motion limited users: @Links(visualStyle: compactGrid) { diff --git a/Sources/AccessibilityDocumentation/Documentation.docc/Tutorials/1. Basic/AdaptingCell.tutorial b/Sources/AccessibilityDocumentation/Documentation.docc/Tutorials/1. Basic/AdaptingCell.tutorial index 545c2e3..fb82fdf 100644 --- a/Sources/AccessibilityDocumentation/Documentation.docc/Tutorials/1. Basic/AdaptingCell.tutorial +++ b/Sources/AccessibilityDocumentation/Documentation.docc/Tutorials/1. Basic/AdaptingCell.tutorial @@ -1,7 +1,7 @@ @Tutorial(time: 10) { @Intro(title: "Adapting Cell") { - To have *assistive technology* work as intented sometimes it is needed to **simplify complex cells** to such degree so there is no difference for accessibility features between *differentiated abstractions* that are stored in cells. + To have **Accessibility Features** work as intented sometimes it is needed to **simplify complex cells** to such degree so there is no difference for accessibility features between *differentiated abstractions* that are stored in cells. In other words, if there is a cell with pizza's description it is reasonable to distinguish data by its nature: have an image as an illustration, a title, a list of ingridients and a price - but it complicates the work for VoiceOver, Voice Control and Switch Control. @@ -13,7 +13,7 @@ @Section(title: "What Is Wrong With The «Normal» Layout") { @ContentAndMedia { - Even though the cell looks simple it is not enough — such layout would lead to several *accessibility issues*. Let's see **how exactly different assistive technology *struggle* with that**. + Even though the cell looks simple it is not enough — such layout would lead to several *accessibility issues*. Let's see **how exactly different Accessibility Features *struggle* with that**. @Image(source: "Chicken BBQ", alt: "Cell of Chicken BBQ containing an image, a title, ingredients and a price.") } diff --git a/Sources/AccessibilityDocumentation/Documentation.docc/Tutorials/2. Advanced/AdjustableTutorial.tutorial b/Sources/AccessibilityDocumentation/Documentation.docc/Tutorials/2. Advanced/AdjustableTutorial.tutorial index af50485..cb0afa8 100644 --- a/Sources/AccessibilityDocumentation/Documentation.docc/Tutorials/2. Advanced/AdjustableTutorial.tutorial +++ b/Sources/AccessibilityDocumentation/Documentation.docc/Tutorials/2. Advanced/AdjustableTutorial.tutorial @@ -59,7 +59,7 @@ @Assessments { @MultipleChoice { - What assistive technologies use adjustable trait? + What **Accessibility Features** use adjustable trait? @Choice(isCorrect: false) { Switch Control From be4419fc5802b2c3b46111d1caa4d95dc1a8cbdd Mon Sep 17 00:00:00 2001 From: "C." Date: Mon, 29 Jan 2024 10:44:34 +0300 Subject: [PATCH 2/2] fixes? --- .../AccessibilityDocumentation.xcscheme | 66 +++++++++++++++++++ .../Articles/1. Basic/DescribeElements.md | 10 +-- 2 files changed, 71 insertions(+), 5 deletions(-) create mode 100644 .swiftpm/xcode/xcshareddata/xcschemes/AccessibilityDocumentation.xcscheme diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/AccessibilityDocumentation.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/AccessibilityDocumentation.xcscheme new file mode 100644 index 0000000..2973901 --- /dev/null +++ b/.swiftpm/xcode/xcshareddata/xcschemes/AccessibilityDocumentation.xcscheme @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/DescribeElements.md b/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/DescribeElements.md index 63e159f..ee4d0a7 100644 --- a/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/DescribeElements.md +++ b/Sources/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/DescribeElements.md @@ -9,7 +9,7 @@ Nevertheless **Voice Control** and **Switch Control** also benefit from explicit To describe an element we can **specify three properties**: a *label*, a *value* and a *trait*. Let's get familiar with each of them. -## `accessibilityLabel` — Label +## accessibilityLabel — Label @Row { @Column(size: 1) { @@ -37,7 +37,7 @@ To describe an element we can **specify three properties**: a *label*, a *value* } } -## `accessibilityValue` — Value +## accessibilityValue — Value @Row { @Column(size: 2) { @@ -87,7 +87,9 @@ Another example is **Adjustable Elements**: this feature will change *only* the **If there is a *button* in the interface but it is not specified in its description — users *won't* be able to interact with this element using Accessibility Features**. > Note: If *Label* and *Value* are separated by a *comma*, *Trait* is separated from the other parts of the description by a *full stop*. + > Important: *Label* and *Value* are `String` properties, meanwhile *Trait* is **selected from a *limited* amount of options**. + > Important: **Don't mention *Trait* inside *Label* or *Value***. There is **no need to *double up* such facts for users: if the element is, for example, a *button*, they will know *everything* they need to know** depending on the **Accessible Feature** used. } @@ -104,11 +106,9 @@ Another example is **Adjustable Elements**: this feature will change *only* the -**Samples:** -## `accessibilityHint` — Hint -``Book/accessibilityHint`` +## ``Book/accessibilityHint`` — Hint **Hint** is another *optional* property that is used to **provide additional information about the element itself**. Property's *name* points at that: **we give a *hint* to the user about how to *treat* the element**. For example, «*tap twice to activate*».