trustchain-oc1-orchestral
/
authentik
Archived
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(prompt.md): grammar and clarity

This commit is contained in:
tigattack 2020-06-18 18:34:40 +01:00 committed by GitHub
parent de00f9f41a
commit 703e67a060
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/flow/stages/prompt/prompt.md
View File

@ -6,20 +6,20 @@ This stage is used to show the user arbitrary prompts.
The prompt can be any of the following types: The prompt can be any of the following types:
| | | | Type | Description |
|----------|------------------------------------------------------------------| |----------|------------------------------------------------------------------|
| text | Arbitrary text, no client-side validation is done. | | text | Arbitrary text. No client-side validation is done. |
| email | E-Mail input, requires a valid E-Mail adress | | email | Email input. Requires a valid email adress. |
| password | Password Input | | password | Password input. |
| number | Number Input, any number is allowed | | number | Number input. Any number is allowed. |
| checkbox | Simple Checkbox | | checkbox | Simple checkbox. |
| hidden | Hidden Input field, allows for the pre-setting of default values | | hidden | Hidden input field. Allows for the pre-setting of default values.|
A Prompt has the following attributes: A prompt has the following attributes:
### `field_key` ### `field_key`
HTML name used for the prompt. This key is also used to later retrieve the data in expression policies: The HTML name used for the prompt. This key is also used to later retrieve the data in expression policies:
```jinja2 ```jinja2
{{ request.context.prompt_data.<field_key> }} {{ request.context.prompt_data.<field_key> }}
@ -27,16 +27,16 @@ HTML name used for the prompt. This key is also used to later retrieve the data
### `label` ### `label`
Label used to describe the Field. This might not be shown depending on the template selected. The label used to describe the field. Depending on the selected template, this may not be shown.
### `required` ### `required`
Flag that decides whether or not this field is required. A flag which decides whether or not this field is required.
### `placeholder` ### `placeholder`
Field placeholder, shown within the input field. This field is also used by the `hidden` type as the actual value. A field placeholder, shown within the input field. This field is also used by the `hidden` type as the actual value.
### `order` ### `order`
Numerical index of the prompt. This applies to all stages this prompt is a part of. The numerical index of the prompt. This applies to all stages which this prompt is a part of.