Add structure to tutorials

VODGroup · Feb 10, 2024 · 5073a18 · 5073a18
1 parent 7ea326b
commit 5073a18
Show file tree

Hide file tree

Showing 24 changed files with 359 additions and 52 deletions.
diff --git a/...Handbook/iOSAccessibilityHandbook.docc/Pages/AdaptionTechniques/AdaptionStrategy.tutorial b/...Handbook/iOSAccessibilityHandbook.docc/Pages/AdaptionTechniques/AdaptionStrategy.tutorial
@@ -22,62 +22,37 @@
 
         @Image(source: placeholder-image.png, alt: "")
 
-        @Chapter(name: "Alternative Description") {
+        @Chapter(name: "Provide Description") {
             @Image(source: chapter-placeholder.png, alt: "")
 
             Accompany visuals with a verbose description so people who are unable to see can experience the content too.
 
             @TutorialReference(tutorial: "doc:AlternativeDescription")
-        }
-
-        @Chapter(name: "Colors And Shapes") {
-            @Image(source: chapter-placeholder.png, alt: "")
-
-            Follow specific guidelines to make your GUI easy to comprehend.
-
-            @TutorialReference(tutorial: "doc:ColorsAndShapes")
-        }
-
-        @Chapter(name: "Describe Elements") {
-            @Image(source: chapter-placeholder.png, alt: "")
 
             Provide a detailed description to everything so assistive technologies know how to deal with them.
 
-            @TutorialReference(tutorial: "doc:DescribeElements")
+            @TutorialReference(tutorial: "doc:Traits")
         }
 
-
-        @Chapter(name: "Adapt Cells") {
+        @Chapter(name: "Reduce Number of Controls") {
             @Image(source: chapter-placeholder.png, alt: "")
 
             Re-structure complex collections that way so it is easier to navigate between them.
 
             @TutorialReference(tutorial: "doc:AdaptCells")
+            @TutorialReference(tutorial: "doc:HideUselessControls")
         }
 
         @Chapter(name: "On-Screen Navigation") {
             @Image(source: chapter-placeholder.png, alt: "")
 
-            Adapt navigation within a screen for Accessibility Features.
-
-            @TutorialReference(tutorial: "doc:On-ScreenNavigation")
-        }
-
-        @Chapter(name: "Between-Screens Navigation") {
-            @Image(source: chapter-placeholder.png, alt: "")
-
-            See how navigation between screens can be implemented.
+            Adapt navigation within a screen for Accessibility Features and see how navigation between screens can be implemented.
 
+            @TutorialReference(tutorial: "doc:OnScreen-Navigation")
+            @TutorialReference(tutorial: "doc:Containers")
+            @TutorialReference(tutorial: "doc:FocusOrder")
             @TutorialReference(tutorial: "doc:Between-ScreensNavigation")
         }
-
-        @Chapter(name: "Charts") {
-            @Image(source: chapter-placeholder.png, alt: "")
-
-            Your application displays statistics and you are afraid that charts is an inaccessible case of representation? You will be surprised. 
-
-            @TutorialReference(tutorial: "doc:Charts")
-        }
     }
 
     @Volume(name: "Advanced Adaption Techniques") {
@@ -89,37 +64,47 @@
         @Chapter(name: "Vertical Swipes") {
             @Image(source: chapter-placeholder.png, alt: "")
 
-            Placeholder text here. I have no fucking idea what is this.
+            Horizontal swipes are used for navigation, but vertical swipes allows to control inner values of an element. Read about  <doc:aVerticalSwipes>
 
-            @TutorialReference(tutorial: "doc:VerticalSwipes")
+            @TutorialReference(tutorial: "doc:AdjustableElements")
+            @TutorialReference(tutorial: "doc:CustomActions")
+            @TutorialReference(tutorial: "doc:CustomDescription")
+            @TutorialReference(tutorial: "doc:Rotor")
+            @TutorialReference(tutorial: "doc:CustomRotor")
         }
-        
-        @Chapter(name: "Rotor") {
+
+        @Chapter(name: "Specific Properties") {
             @Image(source: chapter-placeholder.png, alt: "")
 
-            Rotor is the thing you turn with two fingers.
+            There are several options that is rare needed, but you can be interested in
 
-            @TutorialReference(tutorial: "doc:Rotor")
+            @TutorialReference(tutorial: "doc:SpecificProperties")
+            @TutorialReference(tutorial: "doc:Charts")
         }
 
-        @Chapter(name: "Adjustable Elements") {
+        @Chapter(name: "Text Input") {
             @Image(source: chapter-placeholder.png, alt: "")
 
-            Ugh...
+            There are several options that is rare needed, but you can be interested in
 
-            @TutorialReference(tutorial: "doc:AdjustableElements")
+            @TutorialReference(tutorial: "doc:HowTextInputWorks")
+            @TutorialReference(tutorial: "doc:HandleErrorsInTextField")
         }
+    }
+
+    @Volume(name: "Visual properties") {
 
-        @Chapter(name: "Specific Properties") {
+        @Chapter(name: "Colors And Shapes") {
             @Image(source: chapter-placeholder.png, alt: "")
 
-            No idea really.
+            Follow specific guidelines to make your GUI easy to comprehend.
 
-            @TutorialReference(tutorial: "doc:SpecificProperties")
+            @TutorialReference(tutorial: "doc:ColorsAndShapes")
+            @TutorialReference(tutorial: "doc:DynamicType")
         }
     }
 
-    @Volume(name: "What's Next?") {
+    @Volume(name: "Processes") {
 
         Additional resources expanding on the topic of Accessibility and its integration to design, development and production.
 
@@ -131,6 +116,7 @@
             How to design accessible apps.
 
             @TutorialReference(tutorial: "doc:AccessibleDesign")
+            @TutorialReference(tutorial: "doc:VoiceOverDesigner")
         }
 
         @Chapter(name: "Testing") {
@@ -139,6 +125,8 @@
             How to test accessible apps.
 
             @TutorialReference(tutorial: "doc:AccessibilityQA")
+            @TutorialReference(tutorial: "doc:UnitTesting")
+            @TutorialReference(tutorial: "doc:UITesting")
         }
 
         @Chapter(name: "Activism") {

diff --git a/...escribeElements/DescribeElements.tutorial → ...extInput/HandleErrorsInTextField.tutorial b/...escribeElements/DescribeElements.tutorial → ...extInput/HandleErrorsInTextField.tutorial
@@ -1,5 +1,5 @@
-@Tutorial(time: 15) {
-    @Intro(title: "🔒 Elements Described For Assistive Technology") {
+@Tutorial(time: 20) {
+    @Intro(title: "🔒 Handle Errors in Text Field") {
         <#text#>
 
         @Image(source: <#file#>, alt: "<#accessible description#>")

diff --git a/...ilityHandbook.docc/Pages/AdaptionTechniques/Advanced/TextInput/HowTextInputWorks.tutorial b/...ilityHandbook.docc/Pages/AdaptionTechniques/Advanced/TextInput/HowTextInputWorks.tutorial
@@ -0,0 +1,29 @@
+@Tutorial(time: 20) {
+    @Intro(title: "🔒 How Text Input Works") {
+        <#text#>
+
+        @Image(source: <#file#>, alt: "<#accessible description#>")
+    }
+
+    @Section(title: "<#text#>") {
+        @ContentAndMedia {
+            <#text#>
+
+            @Image(source: <#file#>, alt: "<#accessible description#>")
+        }
+
+        @Steps {
+            @Step {
+                <#text#>
+
+                @Image(source: <#file#>, alt: "<#accessible description#>")
+            }
+
+            @Step {
+                <#text#>
+
+                @Code(name: "<#display name#>", file: <#filename.swift#>)
+            }
+        }
+    }
+}
diff --git a/...lityHandbook.docc/Pages/AdaptionTechniques/Advanced/VerticalSwipes/CustomActions.tutorial b/...lityHandbook.docc/Pages/AdaptionTechniques/Advanced/VerticalSwipes/CustomActions.tutorial
@@ -0,0 +1,29 @@
+@Tutorial(time: 20) {
+    @Intro(title: "🔒 Custom Actions") {
+        <#text#>
+
+        @Image(source: <#file#>, alt: "<#accessible description#>")
+    }
+
+    @Section(title: "<#text#>") {
+        @ContentAndMedia {
+            <#text#>
+
+            @Image(source: <#file#>, alt: "<#accessible description#>")
+        }
+
+        @Steps {
+            @Step {
+                <#text#>
+
+                @Image(source: <#file#>, alt: "<#accessible description#>")
+            }
+
+            @Step {
+                <#text#>
+
+                @Code(name: "<#display name#>", file: <#filename.swift#>)
+            }
+        }
+    }
+}
diff --git a/...Handbook.docc/Pages/AdaptionTechniques/Advanced/VerticalSwipes/CustomDescription.tutorial b/...Handbook.docc/Pages/AdaptionTechniques/Advanced/VerticalSwipes/CustomDescription.tutorial
@@ -0,0 +1,29 @@
+@Tutorial(time: 20) {
+    @Intro(title: "🔒 Custom Description") {
+        <#text#>
+
+        @Image(source: <#file#>, alt: "<#accessible description#>")
+    }
+
+    @Section(title: "<#text#>") {
+        @ContentAndMedia {
+            <#text#>
+
+            @Image(source: <#file#>, alt: "<#accessible description#>")
+        }
+
+        @Steps {
+            @Step {
+                <#text#>
+
+                @Image(source: <#file#>, alt: "<#accessible description#>")
+            }
+
+            @Step {
+                <#text#>
+
+                @Code(name: "<#display name#>", file: <#filename.swift#>)
+            }
+        }
+    }
+}
diff --git a/...bilityHandbook.docc/Pages/AdaptionTechniques/Advanced/VerticalSwipes/CustomRotor.tutorial b/...bilityHandbook.docc/Pages/AdaptionTechniques/Advanced/VerticalSwipes/CustomRotor.tutorial
@@ -0,0 +1,29 @@
+@Tutorial(time: 20) {
+    @Intro(title: "🔒 Custom Actions With Rotor") {
+        <#text#>
+
+        @Image(source: <#file#>, alt: "<#accessible description#>")
+    }
+
+    @Section(title: "<#text#>") {
+        @ContentAndMedia {
+            <#text#>
+
+            @Image(source: <#file#>, alt: "<#accessible description#>")
+        }
+
+        @Steps {
+            @Step {
+                <#text#>
+
+                @Image(source: <#file#>, alt: "<#accessible description#>")
+            }
+
+            @Step {
+                <#text#>
+
+                @Code(name: "<#display name#>", file: <#filename.swift#>)
+            }
+        }
+    }
+}
diff --git a/...nTechniques/Advanced/Rotor/Rotor.tutorial → ...es/Advanced/VerticalSwipes/Rotor.tutorial b/...nTechniques/Advanced/Rotor/Rotor.tutorial → ...es/Advanced/VerticalSwipes/Rotor.tutorial
@@ -1,5 +1,5 @@
 @Tutorial(time: 30) {
-    @Intro(title: "🔒 Custom Actions With Rotor") {
+    @Intro(title: "🔒 Default Actions With Rotor") {
         <#text#>
 
         @Image(source: <#file#>, alt: "<#accessible description#>")

diff --git a/...ndbook.docc/Pages/AdaptionTechniques/Advanced/VerticalSwipes/aVerticalSwipes.md b/...ndbook.docc/Pages/AdaptionTechniques/Advanced/VerticalSwipes/aVerticalSwipes.md
@@ -1,10 +1,10 @@
-# Vertical Swipes
+# User scenarios for vertical swipes
 
 Vertical swipe have a lot of possible actions and all of them depends on focus'es context.
 
 ## Overview
 
-Previously we discussed how to add vertical swipe to any element at <doc:AdjustableElements> and <doc:AdjustableTutorial>. But vertical swipe is so easy to do and can have a lot of other actions. 
+Previously we discussed how to add vertical swipe to any element at <doc:AdjustableElements> and <doc:AdjustableElements>. But vertical swipe is so easy to do and can have a lot of other actions. 
 
 ### Custom action
 

diff --git a/...Handbook.docc/Pages/AdaptionTechniques/Essentials/AdaptCells/HideUselessControls.tutorial b/...Handbook.docc/Pages/AdaptionTechniques/Essentials/AdaptCells/HideUselessControls.tutorial
@@ -0,0 +1,29 @@
+@Tutorial(time: 10) {
+    @Intro(title: "🔒 Hide Useless controls") {
+        <#text#>
+
+        @Image(source: <#file#>, alt: "<#accessible description#>")
+    }
+
+    @Section(title: "<#text#>") {
+        @ContentAndMedia {
+            <#text#>
+
+            @Image(source: <#file#>, alt: "<#accessible description#>")
+        }
+
+        @Steps {
+            @Step {
+                <#text#>
+
+                @Image(source: <#file#>, alt: "<#accessible description#>")
+            }
+
+            @Step {
+                <#text#>
+
+                @Code(name: "<#display name#>", file: <#filename.swift#>)
+            }
+        }
+    }
+}
diff --git a/...ed/VerticalSwipes/VerticalSwipes.tutorial → ...sentials/DescribeElements/Traits.tutorial b/...ed/VerticalSwipes/VerticalSwipes.tutorial → ...sentials/DescribeElements/Traits.tutorial
@@ -1,5 +1,5 @@
 @Tutorial(time: 15) {
-    @Intro(title: "🔒 I Do Not Know Neither Does Mikhail Rubanov") {
+    @Intro(title: "🔒 Traits") {
         <#text#>
 
         @Image(source: <#file#>, alt: "<#accessible description#>")

diff --git a/...gation/Between-ScreensNavigation.tutorial → ...gation/Between-ScreensNavigation.tutorial b/...gation/Between-ScreensNavigation.tutorial → ...gation/Between-ScreensNavigation.tutorial
diff --git a/...ssibilityHandbook.docc/Pages/AdaptionTechniques/Essentials/Navigation/Containers.tutorial b/...ssibilityHandbook.docc/Pages/AdaptionTechniques/Essentials/Navigation/Containers.tutorial
@@ -0,0 +1,29 @@
+@Tutorial(time: 10) {
+    @Intro(title: "🔒 Containers") {
+        <#text#>
+
+        @Image(source: <#file#>, alt: "<#accessible description#>")
+    }
+
+    @Section(title: "<#text#>") {
+        @ContentAndMedia {
+            <#text#>
+
+            @Image(source: <#file#>, alt: "<#accessible description#>")
+        }
+
+        @Steps {
+            @Step {
+                <#text#>
+
+                @Image(source: <#file#>, alt: "<#accessible description#>")
+            }
+
+            @Step {
+                <#text#>
+
+                @Code(name: "<#display name#>", file: <#filename.swift#>)
+            }
+        }
+    }
+}
diff --git a/...ssibilityHandbook.docc/Pages/AdaptionTechniques/Essentials/Navigation/FocusOrder.tutorial b/...ssibilityHandbook.docc/Pages/AdaptionTechniques/Essentials/Navigation/FocusOrder.tutorial
@@ -0,0 +1,29 @@
+@Tutorial(time: 20) {
+    @Intro(title: "🔒 Focus Order") {
+        <#text#>
+
+        @Image(source: <#file#>, alt: "<#accessible description#>")
+    }
+
+    @Section(title: "<#text#>") {
+        @ContentAndMedia {
+            <#text#>
+
+            @Image(source: <#file#>, alt: "<#accessible description#>")
+        }
+
+        @Steps {
+            @Step {
+                <#text#>
+
+                @Image(source: <#file#>, alt: "<#accessible description#>")
+            }
+
+            @Step {
+                <#text#>
+
+                @Code(name: "<#display name#>", file: <#filename.swift#>)
+            }
+        }
+    }
+}
diff --git a/...enNavigation/OnScreen-Navigation.tutorial → ...s/Navigation/OnScreen-Navigation.tutorial b/...enNavigation/OnScreen-Navigation.tutorial → ...s/Navigation/OnScreen-Navigation.tutorial