Merge pull request #13 from VODGroup/main

merge
VODGroup · Jan 28, 2024 · a92ea6d · a92ea6d
2 parents c121143 + 0d2b9d5
commit a92ea6d
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -8,8 +8,12 @@ Generally the project is dedicated to those who use the mentioned *toolkit* in t
 ## — How is it supposed to work?
 
 Currently our goal is to try out variable methods of documentation wrapping by implementing various **interactive solutions**, such as **step-by-step guides**, wide range of **media types** used and **[VoiceOver Designer](https://github.com/VODGroup/VoiceOverDesigner)** app prototype integration in order to find the most efficient *educational models*. 
+<img width="876" alt="Screenshot 2024-01-27 at 11 38 37 (2)" src="https://github.com/VODGroup/AccessibilityDocumentation/assets/94866528/3d27a208-0c3f-44db-a4f0-8ecf8691758e">
+
 
 The *interactivity* is implemented by heavy relying on **[DocC](https://developer.apple.com/documentation/docc), which is a native rich documentation solution for [Swift projects](https://www.swift.org/packages)**. It uses **[Markdown](https://apple.github.io/swift-markdown/documentation/markdown)** as its *formatting language*.
+<img width="876" alt="Screenshot 2024-01-27 at 11 47 07" src="https://github.com/VODGroup/AccessibilityDocumentation/assets/94866528/7eed36e2-20f7-4cbf-829f-d8cea5500376">
+
 
 Since it is only a *prototype*, having the resource hosted by **[GitHub Pages](https://pages.github.com)** seems to us a great option **to allow anyone to contribute to the project**. **GitHub Pages simply turns a GitHub repository into a *website*, which plays along *open-source development* fittingly**. 
 
@@ -23,6 +27,7 @@ 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**.
 
+
 ### Articles
 To study the concepts.
 - Accessibility Properties in Code: How to Use Them. A brief overview of **implenting accessibility in apps**.

diff --git a/.... AssistiveTechnologies/Switch Control.md → ...0. AssistiveTechnologies/SwitchControl.md b/.... AssistiveTechnologies/Switch Control.md → ...0. AssistiveTechnologies/SwitchControl.md
diff --git a/...0. AssistiveTechnologies/Voice Control.md → .../0. AssistiveTechnologies/VoiceControl.md b/...0. AssistiveTechnologies/Voice Control.md → .../0. AssistiveTechnologies/VoiceControl.md
diff --git a/...ssibilityDocumentation/Documentation.docc/Articles/1. Basic/ControlHierarchy.md b/...ssibilityDocumentation/Documentation.docc/Articles/1. Basic/ControlHierarchy.md
@@ -68,7 +68,7 @@ https://github.com/akaDuality/RotorHeaders
 
 ### Tutorial
 
-Read <doc:AdoptingCell> for example
+Read <doc:AdaptingCell> for example
 
 
 

diff --git a/...ssibilityDocumentation/Documentation.docc/Articles/1. Basic/DescribeElements.md b/...ssibilityDocumentation/Documentation.docc/Articles/1. Basic/DescribeElements.md
@@ -117,7 +117,7 @@ Probably, some users will enable hints via <doc:Rotor> when they use a new app a
 
 ### Tutorial
 
-Read <doc:AdoptingCell> for example
+Read <doc:AdaptingCell> for example
 
 ## Topics
 

diff --git a/...s/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/Navigation.md b/...s/AccessibilityDocumentation/Documentation.docc/Articles/1. Basic/Navigation.md
@@ -93,4 +93,4 @@ User can call "magic tap" gesture to perform main operation on the screen. Examp
 
 ## Topics
 - <doc:ControlHierarchy>
-- <doc:AdoptingCell>
+- <doc:AdaptingCell>
diff --git a/Sources/AccessibilityDocumentation/Documentation.docc/Getting Started.md b/Sources/AccessibilityDocumentation/Documentation.docc/Getting Started.md
@@ -9,8 +9,8 @@ Accessibility part of UIKit and SwiftUI frameworks helps developers to represent
 There are three main assistance for blind or motion limited users: 
 @Links(visualStyle: compactGrid) {
     - <doc:VoiceOver>
-    - <doc:Voice Control>
-    - <doc:Switch Control>
+    - <doc:VoiceControl>
+    - <doc:SwitchControl>
 }
 
 - **<doc:VoiceOver>** helps blind or low-visioned persons to use a phone by listening audio description of UI and command by different swipes and non-direct touches. Developer prepare text description of the element, iPhone will generate voice description from text. 
@@ -21,7 +21,7 @@ There are three main assistance for blind or motion limited users:
 
 ![Voice Control modes: with labels, enumerated elements or grid](VoiceControlOverview)
 
-- **<doc:Switch Control>** allows to connect external devices and link them to any command. As a result paralyzed people can control a phone by simple signals: finger movement, muscle stretches, etc. Also, a iPhone's camera can recognize facial expression or any sound like a command. In the end user moves focus on screen and pass command to focused element by submenu that is presented after selection.
+- **<doc:SwitchControl>** allows to connect external devices and link them to any command. As a result paralyzed people can control a phone by simple signals: finger movement, muscle stretches, etc. Also, a iPhone's camera can recognize facial expression or any sound like a command. In the end user moves focus on screen and pass command to focused element by submenu that is presented after selection.
 
 ![Switch Control modes: focus groups on elements, cross selection and submenu](SwitchControlOverview)
 
@@ -36,7 +36,7 @@ To prototype interaction on early stage of development you can use [VoiceOver De
 Step by step practice course.
 
 @Links(visualStyle: detailedGrid) {
-    - <doc:AdoptingCell>
+    - <doc:AdaptingCell>
     - <doc:AdjustableTutorial>
 }
 

diff --git a/.../Tutorials/1. Basic/AdoptingCell.tutorial → .../Tutorials/1. Basic/AdaptingCell.tutorial b/.../Tutorials/1. Basic/AdoptingCell.tutorial → .../Tutorials/1. Basic/AdaptingCell.tutorial
@@ -1,5 +1,5 @@
 @Tutorial(time: 10) {
-    @Intro(title: "Adopting Cell") {
+    @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 the cell. In other words, if there is a cell with pizza's description it is understandable 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. Such layout makes it adapt the cell's contents **wrong**. Let's take a look of what can be done to help our digital assistants navigate through the cognitive models we come up with,.
 

diff --git a/...cessibilityDocumentation/Documentation.docc/Tutorials/Tutorial Table of Contents.tutorial b/...cessibilityDocumentation/Documentation.docc/Tutorials/Tutorial Table of Contents.tutorial
@@ -14,12 +14,12 @@
 
 
     @Volume(name: "Getting Started") {        
-        @Chapter(name: "Adopting Cell") {
+        @Chapter(name: "Adapting Cell") {
             Simplifies navigation and control over a complex element for VoiceOver.
 
             @Image(source: "Chicken BBQ", alt: "Cell of Chicken BBQ with image, title, ingredients and price")
 
-            @TutorialReference(tutorial: "doc:AdoptingCell")
+            @TutorialReference(tutorial: "doc:AdaptingCell")
         }
 
         @Chapter(name: "Control Hierarchy") {
Original file line number	Diff line number	Diff line change
Expand Up		@@ -68,7 +68,7 @@ https://github.com/akaDuality/RotorHeaders

		### Tutorial

		Read <doc:AdoptingCell> for example
		Read <doc:AdaptingCell> for example



Expand Down