Skip to content

Commit 17dd4f9

Browse files
author
hleithner
committed
Release 4.3 Documentation
1 parent 3c6673b commit 17dd4f9

File tree

120 files changed

+5648
-7
lines changed

Some content is hidden

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

120 files changed

+5648
-7
lines changed

‎docusaurus.config.js‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ const config = {
2828
docs: {
2929
sidebarPath: require.resolve('./sidebars.js'),
3030
editUrl: 'https://github.com/joomla/manual/tree/main/',
31-
/*lastVersion: '4.3',*/
31+
lastVersion: '4.3',
3232
versions: {
3333
'current': {
34-
label: 'v4.3.x (upcoming)',
34+
label: '4.4 (upcoming)',
3535
banner: 'unreleased'
3636
},
37-
/*'4.3': {
38-
label: 'v4.3.x (latest)',
39-
}*/
37+
'4.3': {
38+
label: '4.3',
39+
}
4040
},
4141
/*onlyIncludeVersions: ['current', '4.3'], */
4242
},
@@ -93,6 +93,10 @@ const config = {
9393
className: 'dropdown-current-versions',
9494
value: '<b>Current releases</b>',
9595
},
96+
{
97+
label: '5.0 (upcoming)',
98+
href: 'http://pr-28.manual.joomlacode.org/docs/get-started/',
99+
},
96100
],
97101
dropdownItemsAfter: [
98102
{
@@ -105,8 +109,12 @@ const config = {
105109
value: '<b>Archived versions</b>',
106110
},
107111
{
112+
label: '3.x',
108113
href: 'https://docs.joomla.org/Category:Joomla!_3.0',
109-
label: '2.5.x',
114+
},
115+
{
116+
label: '2.5',
117+
href: 'https://docs.joomla.org/Category:Joomla!_2.5',
110118
},
111119
{
112120
type: 'html',

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "manual",
3-
"version": "0.0.0",
3+
"version": "4.3",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",

‎versioned_docs/version-4.3/about/documentation.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
This documentation
2+
==================
3+
:::caution TODO
4+
5+
This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
6+
7+
:::

‎versioned_docs/version-4.3/about/index.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
sidebar_position: 12
3+
---
4+
About
5+
=====
6+
:::caution TODO
7+
8+
This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
9+
10+
:::

‎versioned_docs/version-4.3/about/versioning.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Versioning the documentation
2+
============================
3+
4+
The documentation should reflect the current releases of Joomla!. For each minor version we will have a tagged version in the documentation and update the version dropdown in this documentation.
5+
6+
## Command to run
7+
When we release a new minor Joomla! version, the documentation will be frozen and the version will be tagged. Use
8+
9+
```bash npm2yarn
10+
npm run docusaurus docs:version 4.3.0
11+
```
12+
13+
to tag a version. The current state of the documentation will be copied to the ```versioned_docs``` folder and the ```versions.js``` is updated.
14+
15+
## Update the Versions dropdown
16+
In the ```docusaurus.config.js``` the key ```onlyIncludeVersions``` has to be updated to the latest stable version. Also the ```lastVersion``` has to be updated properly and the ```versions``` labels should be set.

‎versioned_docs/version-4.3/accessibility/atag.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
ATAG Conformance
5+
===========
6+
In this section we will explain the Authoring Tool Accessibility Guidelines, which level of conformance we are aiming for, and how to learn more about ATAG.
7+
8+
:::caution TODO
9+
10+
This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
11+
12+
:::

‎versioned_docs/version-4.3/accessibility/best-practices/empty-template.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
Page Template
2+
===========
3+
import Tabs from '@theme/Tabs';
4+
import TabItem from '@theme/TabItem';
5+
6+
:::tip
7+
This is an empty template, intended to be used as a starting point for adding new best practices pages. Try to keep it consistent with other pages and fill out all relevant sections; sections marked "optional" can be removed if not relevant.
8+
:::
9+
10+
## Overview
11+
12+
Definition / explanation of what this page is all about.
13+
14+
### Best Practices
15+
* Add best practices here.
16+
* etc
17+
18+
### Common Mistakes
19+
* Add common errors here.
20+
21+
## Who is affected?
22+
People using screen readers need ....
23+
24+
People with cognitive disabilities need ... etc.
25+
26+
Who is impacted most by the accessibility of this element?
27+
28+
## Testing for accessibility
29+
<Tabs>
30+
<TabItem value="screenreader" label="With a screenreader">
31+
32+
How does someone test that this is accessible with a screenreader?
33+
1. Use the screen reader to navigate to ...
34+
2. Make sure ...
35+
3. Make sure ...
36+
4. If ... then it passes. ✅
37+
5. If ... then it fails. ❌
38+
39+
</TabItem>
40+
<TabItem value="inspector" label="With web inspector">
41+
42+
How does someone test that this is accessible with web inspector?
43+
1. Right Click > Inspect ... on the page.
44+
2. Make sure ...
45+
3. Make sure ...
46+
4. If ... then it passes. ✅
47+
5. If ... then it fails. ❌
48+
6. If ... then it passes. ✅
49+
7. If ... then it fails. ❌
50+
51+
</TabItem>
52+
</Tabs>
53+
54+
## Relevant WCAG Success Criteria
55+
* Link to the WCAG Success Criteria here. For example:
56+
* [WCAG criteria 1.3.1 - Info and Relationships](https://www.w3.org/TR/WCAG22/#info-and-relationships)
57+
58+
## Relevant ATAG Guidelines (optional)
59+
* Link to the ATAG Guideline(s) here. For example:
60+
* [Guideline A.3.2: (For the authoring tool user interface) Provide authors with enough time.](https://www.w3.org/TR/ATAG20/#gl_a32)
61+

‎versioned_docs/version-4.3/accessibility/best-practices/index.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
Best Practices for Accessible Design
5+
===========
6+
In this section we will explain different aspects to designing with accessibility in mind.
7+
8+
Suggested sub-pages:
9+
1. Colours
10+
2. Fonts
11+
3. Images
12+
4. Focus Order
13+
5. (add more)
14+
15+
:::caution TODO
16+
17+
This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
18+
19+
:::

‎versioned_docs/version-4.3/accessibility/code-for-humans.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
You code for humans, not machines.
5+
===========
6+
In this section we will explain what accessibility is and why it matters. This should be evocative and informative; why should people care?
7+
8+
:::caution TODO
9+
10+
This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
11+
12+
:::

‎versioned_docs/version-4.3/accessibility/element-library/empty-template.md‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
Element Template
2+
===========
3+
import Tabs from '@theme/Tabs';
4+
import TabItem from '@theme/TabItem';
5+
6+
:::tip
7+
This is an empty template, intended to be used as a starting point for adding UI elements to the library. Try to keep it consistent with other elements and fill out all relevant sections; sections marked "optional" can be removed if not relevant.
8+
:::
9+
10+
## Overview
11+
12+
Definition / explanation of what this component is/how it works.
13+
14+
<Tabs>
15+
<TabItem value="front" label="Front End Screenshot">
16+
17+
Put front end/Cassiopeia screenshot here, if applicable. Don't forget alt text!
18+
19+
</TabItem>
20+
<TabItem value="back" label="Back End Screenshot">
21+
22+
Put back end/Atum screenshot here, if applicable. Don't forget alt text!
23+
24+
</TabItem>
25+
</Tabs>
26+
27+
## Usage
28+
### Requirements (optional)
29+
If this code only works in certain contexts or environments, add that here. For example:
30+
* PHP 8.0+
31+
* No IE Support
32+
33+
### Code Snippets
34+
35+
<Tabs>
36+
<TabItem value="front" label="Front End Usage">
37+
38+
:::info
39+
40+
Add notes about using this snippet in the front end, if applicable.
41+
42+
:::
43+
44+
```html title="Sample Front End Usage - ie, Cassiopia template"
45+
<!-- HTML Code Snippet Here -->
46+
```
47+
48+
</TabItem>
49+
<TabItem value="back" label="Back End Usage">
50+
51+
:::info
52+
53+
Add notes about using this snippet in the back end, if applicable.
54+
55+
:::
56+
57+
```html title="Sample Back End Usage - ie, Atum template"
58+
<!-- HTML Code Snippet Here -->
59+
```
60+
61+
</TabItem>
62+
</Tabs>
63+
64+
65+
66+
67+
### Best Practices
68+
* Add best practices here. For example, "Make sure you only use button elements when it will do an action, instead of navigating to a different page."
69+
* etc
70+
71+
### Common Mistakes
72+
* Add common errors here.
73+
74+
## Who is affected?
75+
People using screen readers need ....
76+
77+
People with cognitive disabilities need ... etc.
78+
79+
Who is impacted most by the accessibility of this element?
80+
81+
## Testing for accessibility
82+
<Tabs>
83+
<TabItem value="screenreader" label="With a screenreader">
84+
85+
How does someone test that this is accessible with a screenreader?
86+
1. Use the screen reader to navigate to ...
87+
2. Make sure ...
88+
3. Make sure ...
89+
4. If ... then it passes. ✅
90+
5. If ... then it fails. ❌
91+
92+
</TabItem>
93+
<TabItem value="inspector" label="With web inspector">
94+
95+
How does someone test that this is accessible with web inspector?
96+
1. Right Click > Inspect ... on the page.
97+
2. Make sure ...
98+
3. Make sure ...
99+
4. If ... then it passes. ✅
100+
5. If ... then it fails. ❌
101+
6. If ... then it passes. ✅
102+
7. If ... then it fails. ❌
103+
104+
</TabItem>
105+
</Tabs>
106+
107+
## Relevant WCAG Success Criteria
108+
* Link to the WCAG Success Criteria here. For example:
109+
* [WCAG criteria 1.3.1 - Info and Relationships](https://www.w3.org/TR/WCAG22/#info-and-relationships)
110+
111+
## Relevant ATAG Guidelines (optional)
112+
* Link to the ATAG Guideline(s) here. For example:
113+
* [Guideline A.3.2: (For the authoring tool user interface) Provide authors with enough time.](https://www.w3.org/TR/ATAG20/#gl_a32)
114+

0 commit comments

Comments
 (0)