Skip to content

Commit 5e482c0

Browse files
committed
Rephrase, add some details
1 parent 6819db9 commit 5e482c0

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

proposed/form-admin-meta.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,51 @@
22

33
## 1. Summary
44

5-
Joomla uses forms based on XML and rendered with the help of the Form class.
5+
Joomla uses forms that are defined in XML and rendered using the Form class.
66

7-
While this is a flexible way and the forms can be changed with plugins, it is limited and in some way hard coded. Database constraints are implemented through business logic within the models and not on the database level.
8-
9-
This specification aims to define an extension of the form building process. After implementation it allows site builder the change the core forms. Adding and removing fields should be possible and core form building and custom fields are merged.
7+
Although this is a flexible way and the forms can be changed using plugins, it is limited and hard-coded in some ways.
8+
9+
This specification aims to define an extension to the form creation process. This form editor shall allow modifying
10+
forms, add or remove predefined fields and custom fields and change their order.
1011

1112
## 2. Why Bother?
1213

13-
Hard coded forms are not state of the art. Joomla! allows today a lot of flexibility but it is up to developers to implement. If we can change the way we are creating forms we would allow site builders to change Joomla that it fulfils the needs of clients better.
14+
Hard-coded forms are no longer state of the art. Joomla today offers a lot of flexibility, but it needs developers to
15+
implement changes. If we can change the way we create forms, we would allow website creators to adapt Joomla to better
16+
meet users' needs.
1417

1518
## 3. Scope
1619

17-
Planned feature for Joomla5.
18-
1920
### 3.1 Goals
2021

21-
Having a core component that allows configuration of forms and views. This includes custom fields and a migration from Joomla4.
22+
The goal is to provide a graphical user interface for creating and editing forms and views as a core component. Standard
23+
fields and user-defined fields are to be equally supported.
2224

23-
Respect versioning for custom fields.
25+
When saved, user-defined fields must be included in versioning, provided the underlying table supports versioning.
2426

25-
Creating a API for 3rd part components to use the functionality.
27+
The functionality shall also be available for extensions.
28+
29+
In the course of the
30+
implementation, [accessibility requirements and recommendations](https://accessibilitycluster.com/main-results/forms-editor)
31+
should be taken into account for the form renderer.
2632

2733
### 3.2 Non-Goals
2834

29-
Migration of 3rd part components to the new way of form rendering.
35+
It is not the goal of this component to force changes to 3rd party extensions.
3036

3137
## 4. Approaches
3238

39+
The component will consist of a Visual Editor and a Form Preprocessor. The preprocessor splits the form content so that
40+
the handler of the original form gets the data it expects and ensures the correct handling of the remaining form
41+
content.
42+
43+
Database constraints are implemented through business logic within the models and not at the database level. In the
44+
course of revising the database, this should be corrected if possible.
45+
3346
### 4.1 Chosen Approach
3447

35-
TBD
36-
3748
## 5. Design Decisions
3849

39-
None at this state
40-
4150
## 6. People
4251

4352
### 6.1 Editor(s)
@@ -46,7 +55,7 @@ None at this state
4655

4756
### 6.2 Sponsors
4857

49-
* N/A
58+
* Niels Braczek, <[email protected]>
5059

5160
### 6.3 Contributors
5261

0 commit comments

Comments
 (0)