Skip to content

Commit 654d990

Browse files
authored
Merge branch 'main' into deprecations-from-40613-feature-pr
2 parents caa3905 + 5f5d6b3 commit 654d990

File tree

461 files changed

+28959
-799
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

461 files changed

+28959
-799
lines changed

.drone.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ steps:
1010
commands:
1111
- npm install
1212
- npm run build
13+
- mv webserver/.htaccess build
1314

1415
- name: deployment
1516
image: joomlaprojects/docker-images:packager
@@ -47,6 +48,6 @@ steps:
4748

4849
---
4950
kind: signature
50-
hmac: 3d1303abd175ffda3aec141c6ea71d541f50f3c3e0752a68330fde5560386a58
51+
hmac: ae910acaafbf7e06bea4e33c509dbabe08e1edaba7f175d91db4a880030c7cc4
5152

5253
...
Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,45 @@
11
---
22
sidebar_position: 7
33
---
4+
45
Further Reading
5-
===========
6-
Additional accessibility resources can go here.
6+
===============
7+
8+
Additional accessibility resources to help you learn more about accessibility and how to make your website more accessible.
9+
10+
## General
11+
12+
- [UN Convention on the Rights of Persons with Disabilities](https://www.un.org/development/desa/disabilities/convention-on-the-rights-of-persons-with-disabilities/article-9-accessibility.html)
13+
- [Accessibility Fundamentals](https://www.w3.org/WAI/fundamentals)
14+
- [How to meet WCAG](https://www.w3.org/WAI/WCAG22/quickref/)
15+
- [Inclusive Design Principles](https://inclusivedesignprinciples.info/)
16+
- [Accessibility Myths](https://a11ymyths.com/)
17+
18+
## Blogs
19+
- [Sara Soueidan](https://www.sarasoueidan.com/blog/)
20+
- [Eric Eggert](https://yatil.net/blog)
21+
22+
## Alternative text for images
23+
- [Writing Alt Text for Data Visualization](https://medium.com/nightingale/writing-alt-text-for-data-visualization-2a218ef43f81)
24+
- [Write helpful Alt Text to describe images](https://accessibility.huit.harvard.edu/describe-content-images)
25+
- [How to Write Alt Text for Images: Best Practices & Examples](https://kdesign.co/blog/how-to-write-alt-text/)
26+
- [Are you making these five mistakes when writing alt text?](https://www.a11yproject.com/posts/are-you-making-these-five-mistakes-when-writing-alt-text/)
727

8-
:::caution TODO
28+
## Browser Tools
29+
- [Lighthouse (included Chrome)](https://developer.chrome.com/docs/lighthouse/)
30+
- [Wave](https://wave.webaim.org/)
31+
- [axe DevTools](https://www.deque.com/axe/devtools/)
32+
- [ANDI](https://www.ssa.gov/accessibility/andi/help/install.html)
33+
- [Landmarks](http://matatk.agrip.org.uk/landmarks/)
34+
- [IBM Equal Access Accessibility Checker](https://www.ibm.com/able/toolkit/tools/#develop)
935

10-
This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
36+
## Screenreader
37+
- [NDVA (Windows)](https://www.nvaccess.org/)
38+
- [VoiceOver (MacOS)](https://support.apple.com/de-at/guide/voiceover/welcome/mac)
39+
- [Setting up a screen reader testing environment on your computer](https://www.sarasoueidan.com/blog/testing-environment-setup/)
1140

12-
:::
41+
## Checklisten & Co.
42+
- [The A11y Project](https://www.a11yproject.com/checklist/)
43+
- [Webflow](https://webflow.com/accessibility/checklist)
44+
- [Deque University](https://dequeuniversity.com/checklists/web/)
45+
- [IAAP](https://www.accessibilityassociation.org/s/certification)
Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
---
22
sidebar_position: 6
33
---
4-
Reporting Errors
5-
===========
6-
How do people report accessibility issues in the CMS or template to us?
74

8-
:::caution TODO
5+
Reporting Errors
6+
================
97

10-
This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
8+
You can report accessibility issues in the CMS (using the standard Cassiopeia template) sending us an email to: [[email protected]](mailto:[email protected])
119

12-
:::
80.4 KB
Loading
137 KB
Loading
288 KB
Loading

docs/building-extensions/components/component-examples/ajaxdemo.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,15 @@ title: Ajax demo component
55
Ajaxdemo Component
66
==================
77

8-
This is an example component which you can download from [com_ajaxdemo](https://github.com/joomla/manual-examples/tree/main/component-ajaxdemo).
8+
This example component demonstrates the use of Ajax to interact with the server without requiring a page load. For further background see the General Concepts section on [Ajax and JsonResponse](../../../general-concepts/javascript/ajax.md).
99

10-
It demonstrates the use of Ajax within a Joomla component;
11-
for further background see the section [Ajax and JsonResponse](../../../general-concepts/javascript/ajax.md).
10+
The component can be easily adapted to demonstrate the use of [com_ajax](../../../general-concepts/javascript/com-ajax.md) for plugins and templates. Simply change `url` in media/js/divide.js to point to com_ajax instead of com_ajaxdemo and set the other required URL parameters.
1211

13-
It can be easily adapted to demonstrate the use of [com_ajax](../../../general-concepts/javascript/com-ajax.md) for plugins and templates;
14-
simply change the url in media/js/divide.js to point to com_ajax instead of com_ajaxdemo, and set the other required URL parameters.
12+
An installable ZIP file can be obtained via [DownGit](https://downgit.github.io/#/home?url=https://github.com/joomla/manual-examples/tree/main/component-ajaxdemo/com_ajaxdemo). After installation go to `<your domain>/index.php?option=com_ajaxdemo` to run it in your Joomla instance.
1513

16-
Once you have downloaded the source, zip up the com_ajaxdemo directory and install the component.
14+
The following screenshot shows the example form with some data added:
1715

18-
Then go to `<your domain>/index.php?option=com_ajaxdemo` to run it on your Joomla instance.
16+
![example form with added data](_assets/component-example-ajax.png)
1917

2018
The component displays a form to capture two numbers A and B, and a button to calculate A/B.
2119
The division is performed by an Ajax call to the server, and if B is zero then an exception is raised.

docs/building-extensions/components/component-examples/example-form-component.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,7 @@ title: Example Form Component
66
Example Form Component
77
======================
88

9-
This is an example component which you can download from [com_exampleform](https://github.com/joomla/manual-examples/tree/main/component-exampleform).
10-
11-
Once you have downloaded the source, zip up the com_exampleform directory and install the component.
12-
13-
Then go to `<your domain>/index.php?option=com_exampleform` to run it on your Joomla instance.
14-
15-
It is an MVC component which demonstrates the following:
9+
This example MVC component demonstrates the following aspects of form manipulation:
1610

1711
- using [Joomla Forms](../../../general-concepts/forms/how-forms-work.md) to capture data in a form
1812
- using several of the [standard form fields](../../../general-concepts/forms-fields/standard-fields/index.md)
@@ -21,9 +15,13 @@ It is an MVC component which demonstrates the following:
2115
- writing a [custom client-side validation rule](../../../general-concepts/forms/client-side-validation.md)
2216
- writing a [custom form filter](../../../general-concepts/forms-fields/standard-form-field-attributes.md#filter)
2317

24-
You can easily adapt it to experiment with other standard fields, simply by including the standard field in the form XML file.
18+
An installable ZIP file can be obtained via [DownGit](https://downgit.github.io/#/home?url=https://github.com/joomla/manual-examples/tree/main/component-exampleform/com_exampleform). After installation go to `<your domain>/index.php?option=com_exampleform` to run it in your Joomla instance.
19+
20+
The following screenshot shows the example form with some data added:
21+
22+
![example form with added data](_assets/component-example-form.png)
2523

26-
There are comments throughout the code to help you understand it, and brief summaries of the main source files are provided below.
24+
Brief summaries of the main source files are provided below. There are additional explanatory comments throughout the code.
2725

2826
## Administrator service provider
2927

@@ -125,9 +123,9 @@ Path: components/com_exampleform/src/View/ExampleformReturn/HtmlView.php
125123

126124
This simply has a function to accept the data from the Controller, which it stores locally.
127125

128-
## Site ExampleformReturn tmpl file
126+
## Site exampleformreturn tmpl file
129127

130-
Path: components/com_exampleform/tmpl/exampleformReturn/default.php
128+
Path: components/com_exampleform/tmpl/exampleformreturn/default.php
131129

132130
This simply outputs the raw and filtered data which was passed to the view.
133131

docs/building-extensions/components/component-examples/index.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,29 @@ title: Example Components
66
Component Examples
77
==================
88

9-
In this section you can find worked examples of components of various types.
9+
This section contains worked examples of components of various types. To obtain the examples source code to inspect or install you may clone the manual-examples repository or download an installable zip file for an individual example.
10+
11+
## To clone the repository
12+
13+
Navigate to a location on your development computer where you can keep multiple repositories. You might have a folder named `repos` or `git` or something else. In a terminal window use the following command:
14+
15+
```sh
16+
git clone https://github.com/joomla/manual-examples.git
17+
```
18+
19+
This takes no time at all and will give you a clone of the manual-examples repository that is very easy to inspect in an IDE. Here is an example screenshot of a clone open in VSCode:
20+
21+
![screenshot of manual examples folder in vscode](_assets/manual-examples-in-vscode.png)
22+
23+
To create an installable zip file, compress the subfolder containing the example code, such as the com_exampleform folder.
24+
25+
## To download an installable zip
26+
27+
1. Go to the [manual-examples repository](https://github.com/joomla/manual-examples) on GitHub.
28+
2. Select the example you wish to download, for example component-exampleform.
29+
3. Select the subfolder containing the example, com_exampleform.
30+
4. Copy the URL from the browser URL bar.
31+
5. Go to a download utility site such as [DownGit](https://downgit.github.io/#/home).
32+
6. Paste the URL copied in step 4 into the form.
33+
7. Select the Download button.
34+
8. Save the downloaded zip file. This can be installed in a Joomla instance or expanded to inspect with an IDE.

0 commit comments

Comments
 (0)