Skip to content

Commit ce4ffd3

Browse files
author
Olivier Auverlot
committed
Documentation improved
1 parent 2570bda commit ce4ffd3

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

examples/official-site/sqlpage/migrations/68_login.sql

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,17 @@ INSERT INTO component(name, icon, description, introduced_in_version) VALUES
33
The login component is an authentication form with numerous customization options.
44
It offers the main functionalities for this type of form.
55
The user can enter their username and password.
6-
There are many optional attributes such as the use of icons on input fields, the insertion of a link to a page to reset the password, an option for the application to maintain the user''s session via a cookie.
6+
There are many optional attributes such as the use of icons on input fields, the insertion of a link to a page to reset the password, an option for the application to maintain the user''s identity via a cookie.
77
It is also possible to set the title of the form, display the company logo, or customize the appearance of the form submission button.
88
99
This component should be used in conjunction with other components such as [authentication](component.sql?component=authentication) and [cookie](component.sql?component=cookie).
1010
It does not implement any logic and simply collects the username and password to pass them to the code responsible for authentication.
1111
12+
A few things to know :
13+
- The form uses the POST method to transmit information to the destination page,
14+
- The user''s username and password are entered into fields with the names `username` and `password`,
15+
- To obtain the values of username and password, you must use the variables `:username` and `:password`,
16+
- To know if the user wants their identity to be remembered, you must read the value of the variable `:remember`.
1217
', '0.39.0');
1318

1419
INSERT INTO parameter(component, name, description, type, top_level, optional) SELECT 'login', * FROM (VALUES
@@ -22,7 +27,7 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S
2227
('image','The URL of an centered image displayed before the title.','URL',TRUE,TRUE),
2328
('forgot_password_text','A text for the link allowing the user to reset their password. If the text is empty, the link is not displayed.','TEXT',TRUE,TRUE),
2429
('forgot_password_link','The link to the page allowing the user to reset their password.','TEXT',TRUE,TRUE),
25-
('remember_me_text','A text for the option allowing the user to request the preservation of their work session. The name of the field is remember. If the text is empty, the option is not displayed.','TEXT',TRUE,TRUE),
30+
('remember_me_text','A text for the option allowing the user to request the preservation of their identity. If the text is empty, the option is not displayed.','TEXT',TRUE,TRUE),
2631
('footer','A text placed at the bottom of the authentication form.','TEXT',TRUE,TRUE),
2732
('footer_md','A markdown text placed at the bottom of the authentication form. Useful for creating links to other pages (creating a new account, contacting technical support, etc.).','TEXT',TRUE,TRUE),
2833
('validate','The text to display in the button at the bottom of the form that submits the values.','TEXT',TRUE,FALSE),

0 commit comments

Comments
 (0)