diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Design/Guidelines/Guidelines.tutorial b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Design/Guidelines/Guidelines.tutorial new file mode 100644 index 0000000..a6db784 --- /dev/null +++ b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Design/Guidelines/Guidelines.tutorial @@ -0,0 +1,29 @@ +@Tutorial(time: <#number#>) { + @Intro(title: "<#text#>") { + <#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/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Design/Privacy/Privacy.tutorial b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Design/Privacy/Privacy.tutorial new file mode 100644 index 0000000..a6db784 --- /dev/null +++ b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Design/Privacy/Privacy.tutorial @@ -0,0 +1,29 @@ +@Tutorial(time: <#number#>) { + @Intro(title: "<#text#>") { + <#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/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Design/Standarts/Standarts.tutorial b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Design/Standarts/Standarts.tutorial new file mode 100644 index 0000000..a6db784 --- /dev/null +++ b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Design/Standarts/Standarts.tutorial @@ -0,0 +1,29 @@ +@Tutorial(time: <#number#>) { + @Intro(title: "<#text#>") { + <#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/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Maintenance /Maintenance.tutorial b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Maintenance /Maintenance.tutorial deleted file mode 100644 index 302ff66..0000000 --- a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Maintenance /Maintenance.tutorial +++ /dev/null @@ -1,10 +0,0 @@ -@Article(time: 15) { - - @Comment { - https://www.deque.com/axe/developer-hub/ - } - - @Intro(title: "Accessibility Maintenance") { - If supported, any application grows in complexity even if there is no additional functionality added. - } -} diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Processes.tutorial b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Processes.tutorial index 8e50abc..7ba79e8 100644 --- a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Processes.tutorial +++ b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Processes.tutorial @@ -2,4 +2,15 @@ @Intro(title: "Integrating Accessibility Into Product Processes") { } + + + @ContentAndMedia { + ## Grassroot efforts + @Image(source: placeholder-image, alt: "") + } + + @ContentAndMedia { + ## Grassroot efforts + @Image(source: placeholder-image, alt: "") + } } diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Testing/Manual/Manual.tutorial b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Testing/Manual/Manual.tutorial new file mode 100644 index 0000000..a6db784 --- /dev/null +++ b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Enterprise/Testing/Manual/Manual.tutorial @@ -0,0 +1,29 @@ +@Tutorial(time: <#number#>) { + @Intro(title: "<#text#>") { + <#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/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/AdoptionGuide.tutorial b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/AdoptionGuide.tutorial index e295156..a1a9438 100644 --- a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/AdoptionGuide.tutorial +++ b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/AdoptionGuide.tutorial @@ -107,6 +107,11 @@ Get familiar with the ideas and **reasoning behind accessibility**. + @TutorialReference(tutorial: "doc:Processes") + @TutorialReference(tutorial: "doc:Guidelines") + @TutorialReference(tutorial: "doc:Standarts") + @TutorialReference(tutorial: "doc:Privacy") + @TutorialReference(tutorial: "doc:ErrorPrevention") @TutorialReference(tutorial: "doc:AccessibleDesign") @TutorialReference(tutorial: "doc:AccessibilityTree") @TutorialReference(tutorial: "doc:VoiceOverDesigner") @@ -124,7 +129,7 @@ @TutorialReference(tutorial: "doc:UnitTesting") @TutorialReference(tutorial: "doc:SnapshotTesting") @TutorialReference(tutorial: "doc:UITesting") - @TutorialReference(tutorial: "doc:Maintenance") + @TutorialReference(tutorial: "doc:Manual") @TutorialReference(tutorial: "doc:GuidedAccess") } diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/Basic/AccessibleUI.tutorial b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/AccessibleUI.tutorial similarity index 100% rename from Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/Basic/AccessibleUI.tutorial rename to Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/AccessibleUI.tutorial diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/Advanced/AccessibleUX.tutorial b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/AccessibleUX.tutorial similarity index 100% rename from Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/Advanced/AccessibleUX.tutorial rename to Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/AccessibleUX.tutorial diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/DigitalAccessibility/DigitalAccessibility.md b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/DigitalAccessibility/DigitalAccessibility.md new file mode 100644 index 0000000..669fe43 --- /dev/null +++ b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/DigitalAccessibility/DigitalAccessibility.md @@ -0,0 +1,54 @@ +# Digital Accessibility + +Enable people use your application with help of assistive technology + +@Metadata { + @PageColor(blue) + @TitleHeading("What Are We Even Talking About") + @PageImage( + purpose: icon, + source: "list", + alt: "") + @PageImage( + purpose: card, + source: "placeholder-image", + alt: "") + @CallToAction( + url: "https://www.apple.com/accessibility/", + purpose: link, + label: "General Knowledge") +} + + +## What is accessibility + +**Accessibility** is a property of *things* that measures its **approachability**. Most commonly the term is used to refer to those qualities of objects that make them accessible for people with special needs, for example, people with disabilities or users of assistive technology. + +### People with disabilities +Disability as a term is defined in relation to its model. Regardless of the focus of the model -- whether it is more medical or social -- disability is a reason of diversity of people's abilities in communicating, which consist of receiving input (perception) and providing output (interaction), with their environment. + +### Users of assistive technology +Assistive technology are those technological solutions that are aimed to ease the life of people by providing an equitable access to the life activities. + +### People with special needs +Nevertheless, people with disabilities and users of assistive technology are not the same. There is requirement to have a disability to use assistive technology, as well as a person with a disability may not use any of assistive technology. + +### -- So... for whom accessibility is then? +For everyone. Accessibility is a part of universal design whose purpose is not to exclude its potential users by their differences in abilities to perceive and interact with the designed object. + +### -- Ok. Just consider everyone. +No, it is impossible to include everyone. Users are essentially unknowable and it is a dangerous act to consider that anyone is able to make any predictions based on the expectations of users behaviour. But it is possible to not exclude anyone, both intentionally and unintentionally. By accessibility. + +### Accessibility best practices +To make something accessible it is required to use the established means in providing equitable access for as many people as possible based on what the humanity has learned about its diversity. + +### Assistive technology benefits accessibility +Assistive technology are functioning that way so their support explicitly benefits accessibility of the product. + +## iOS Accessibility Book + +### Accessibility of user interfaces +In this book we are going to work on accessibility of iOS application, which are programs ran on iOS devices. Computer programs is a well-discovered phenomenon and their accessibility is measured by approachability of their user interface -- space that includes every means of communication between the user and the machine. + +### Accessibility of iOS +Next, we are going to discuss accessibility of iOS and mobile devices that run this system. diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/Advanced/AccessibleControls/InterfaceInteractions.md b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/InterfaceInteractions.md similarity index 100% rename from Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/Advanced/AccessibleControls/InterfaceInteractions.md rename to Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/InterfaceInteractions.md diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/Advanced/AccessibleDescription/InterfacePerception.md b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/InterfacePerception.md similarity index 100% rename from Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/Advanced/AccessibleDescription/InterfacePerception.md rename to Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/InterfacePerception.md diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/MobileAccessibility.md b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/MobileAccessibility.md similarity index 100% rename from Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Integration/MobileAccessibility.md rename to Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/MobileAccessibility.md diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/iOSAccessibility.md b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/iOSAccessibility.md similarity index 100% rename from Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/iOSAccessibility.md rename to Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/Introduction/Theory/iOSAccessibility.md diff --git a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/iOSAccessibilityHandbook.md b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/iOSAccessibilityHandbook.md index 9caf392..79dd636 100644 --- a/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/iOSAccessibilityHandbook.md +++ b/Sources/iOSAccessibilityHandbook/iOSAccessibilityHandbook.docc/Pages/iOSAccessibilityHandbook.md @@ -22,7 +22,7 @@ Make your iOS application accessible for everyone ## Welcome to iOS Accessibility Handbook -[**iOS Accessibility Handbook**]() is an open-source **educational project** about making iOS applications *accessible*. Accessible application is such application that works with various *assistive technologies*, such as [**VoiceOver**](https://www.apple.com/accessibility/voiceover), [**Voice Control**](https://support.apple.com/en-us/HT210417) and [**Switch Control**](https://support.apple.com/en-us/HT201370), which enable **people with disabilities** to use the application. +[**iOS Accessibility Handbook**]() is an open-source **educational project** about making iOS applications *accessible*. **Accessible application** is such application that works with various *assistive technologies*, such as [**VoiceOver**](https://www.apple.com/accessibility/voiceover), [**Voice Control**](https://support.apple.com/en-us/HT210417) and [**Switch Control**](https://support.apple.com/en-us/HT201370), which enable **people with disabilities** to use the application. @Image(source: features-1, alt: "") @Image(source: features-2, alt: "") @@ -34,18 +34,20 @@ This handbook provides *extended documentation* of [**Accessibility Features**]( In other words, materials here cover **everything one could ever need to know about accessibility on iOS**. -### Target audience -The project is dedicated to help *developers*, *designers*, *testers*, *researchers* and *mere users* — in other words, to *everyone working with accessibility* on iOS. There is **no commercial underlayment** and the only reason the project exists is to popularise the topic and *share* relevant real-life experience of contributing *accessibility professionals*. - ### Featured @Links(visualStyle: detailedGrid) { - - } +### Target audience +The project is dedicated to help *developers*, *designers*, *testers*, *researchers* and *mere users* — in other words, to *everyone working with accessibility* on iOS. + +There is **no commercial underlayment** and the only reason the project exists is to popularise the topic and *share* relevant real-life experience of contributing *accessibility professionals*. + ## Book structure -The handbook is somewhat of a *complete course* of **how to make iOS applications accessible** regardless of the stage of its development. The material is split into conceptual *topics* and categorised by its relation to particular assistive technologies and field of implementation. +The handbook is somewhat of a *complete course* of **how to make iOS applications accessible**. The material is split into conceptual *topics* and categorised by its relation to particular assistive technologies and field of implementation. @Image(source: book-content, alt: "")