-
Notifications
You must be signed in to change notification settings - Fork 81
IBX-8590: Reorganizing documentation in terms of Product Guides #2479
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
b5150d7
Fixes: new cards, mkdocs updated
julitafalcondusza 9827d75
Conflicts resolved while merging with master
julitafalcondusza d351c7d
Updates
julitafalcondusza 4198a34
New description, updates
julitafalcondusza dbac436
Typo fix
julitafalcondusza 6beca01
Fixes after rev
julitafalcondusza 01a59f1
Fixes after rev
julitafalcondusza 824fecc
Updates in the features table, fixes
julitafalcondusza 49999b7
Redirects fixed
julitafalcondusza 5ee1cb6
Fix
julitafalcondusza 3f3f337
Fix - docs removed from the redirect path
julitafalcondusza File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,18 @@ | ||
| --- | ||
| description: Form Builder enables creating dynamic forms to use in surveys, questionnaires, sign-up forms and others. | ||
| description: Forms are a type of content item that you can use to improve the functionality of your website. | ||
| edition: experience | ||
| page_type: landing_page | ||
julitafalcondusza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| --- | ||
|
|
||
| # Forms | ||
|
|
||
| You can build forms consisting of different fields in the Form Builder. | ||
| Forms are a type of content item that you can use to improve the functionality of your website. | ||
|
|
||
| !!! tip | ||
|
|
||
| To learn how to get, create, and delete form submissions by using the PHP API, | ||
| see [Form API](form_api.md). | ||
|
|
||
| [[% include 'snippets/forms_caution.md' %]] | ||
|
|
||
| ## Existing Form fields | ||
|
|
||
| ### Captcha field | ||
|
|
||
| The Captcha Form field is based on [Gregwar/CaptchaBundle](https://github.com/Gregwar/CaptchaBundle). | ||
|
|
||
|  | ||
|
|
||
| You can customize the field by adding configuration to `config/packages/gregwar_captcha.yaml` under `gregwar_captcha`: | ||
|
|
||
| ``` yaml | ||
| gregwar_captcha: | ||
| as_url: true | ||
| width: 150 | ||
| invalid_message: Code does not match, please retry. | ||
| reload: true | ||
| ``` | ||
|
|
||
| The example configuration above resizes the Captcha image (line 3), changes the error message (line 4), | ||
| and enables the user to reload the code (line 5). | ||
|
|
||
|  | ||
|
|
||
| For information about available options, see [Gregwar/CaptchaBundle's documentation](https://github.com/Gregwar/CaptchaBundle#options). | ||
|
|
||
| !!! note | ||
|
|
||
| If your installation uses Varnish to manage content cache, you must modify the configuration to avoid issues with the Captcha field. For more information, see [Ensure proper captcha behavior](reverse_proxy.md#ensure-proper-captcha-behavior). | ||
|
|
||
| ## Form submission purging | ||
|
|
||
| You can purge all submissions of a given form. | ||
| To do this, run the following command, where `form-id` stands for Content ID | ||
| of the form for which you want to purge data: | ||
|
|
||
| ```bash | ||
| php bin/console ibexa:form-builder:purge-form-submissions [options] [--] <form-id> | ||
| ``` | ||
|
|
||
| The following table lists some of the available options and their meaning: | ||
|
|
||
| | Switch | Option | Description | | ||
| |--------------|------------|------------| | ||
| | `-l` | `--language-code=LANGUAGE-CODE` | Passes a language code, for example, "eng-GB". | | ||
| | `-u` | `--user[=USER]` | Passes a repository username. By default it is "admin". | | ||
| | `-c` | `--batch-size[=BATCH-SIZE]` | Passes a number of URLs to check in a single iteration. Set it to avoid using too much memory. By default it is set to 50. | | ||
| | | `--siteaccess[=SITEACCESS]` | Passes a SiteAccess to use for operations. If not provided, the default SiteAccess is used. | | ||
|
|
||
| ## Form-uploaded files | ||
|
|
||
| You can use Forms to enable the user to upload files. | ||
| The default Location for files uploaded in this way is `/Media/Files/Form Uploads`. | ||
| You can change it with the following configuration: | ||
|
|
||
| ``` yaml | ||
| ibexa: | ||
| system: | ||
| default: | ||
| form_builder: | ||
| upload_location_id: 54 | ||
| ``` | ||
|
|
||
| This applies only if no specific Location is defined in the Form itself. | ||
| [[= cards([ | ||
| "content_management/forms/form_builder_guide", | ||
| "content_management/forms/work_with_forms", | ||
| "content_management/forms/form_api", | ||
| "content_management/forms/create_form_attribute", | ||
| "content_management/forms/create_custom_form_field", | ||
| "content_management/forms/customize_email_notifications" | ||
| ], columns=3) =]] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| --- | ||
| description: Form Builder enables creating dynamic forms to use in surveys, questionnaires, sign-up forms and others. | ||
julitafalcondusza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| edition: experience | ||
| --- | ||
|
|
||
| # Forms | ||
|
|
||
| You can build forms consisting of different fields in the Form Builder. | ||
julitafalcondusza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| !!! tip | ||
|
|
||
| To learn how to get, create, and delete form submissions by using the PHP API, | ||
| see [Form API](form_api.md). | ||
|
|
||
| [[% include 'snippets/forms_caution.md' %]] | ||
|
|
||
| ## Existing Form fields | ||
julitafalcondusza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Captcha field | ||
|
|
||
| The Captcha Form field is based on [Gregwar/CaptchaBundle](https://github.com/Gregwar/CaptchaBundle). | ||
julitafalcondusza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
| You can customize the field by adding configuration to `config/packages/gregwar_captcha.yaml` under `gregwar_captcha`: | ||
|
|
||
| ``` yaml | ||
| gregwar_captcha: | ||
| as_url: true | ||
| width: 150 | ||
| invalid_message: Code does not match, please retry. | ||
| reload: true | ||
| ``` | ||
| The example configuration above resizes the Captcha image (line 3), changes the error message (line 4), | ||
| and enables the user to reload the code (line 5). | ||
|  | ||
| For information about available options, see [Gregwar/CaptchaBundle's documentation](https://github.com/Gregwar/CaptchaBundle#options). | ||
| !!! note | ||
| If your installation uses Varnish to manage content cache, you must modify the configuration to avoid issues with the Captcha field. For more information, see [Ensure proper captcha behavior](reverse_proxy.md#ensure-proper-captcha-behavior). | ||
julitafalcondusza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Form submission purging | ||
| You can purge all submissions of a given form. | ||
| To do this, run the following command, where `form-id` stands for Content ID | ||
| of the form for which you want to purge data: | ||
|
|
||
| ```bash | ||
| php bin/console ibexa:form-builder:purge-form-submissions [options] [--] <form-id> | ||
| ``` | ||
|
|
||
| The following table lists some of the available options and their meaning: | ||
|
|
||
| | Switch | Option | Description | | ||
| |--------------|------------|------------| | ||
| | `-l` | `--language-code=LANGUAGE-CODE` | Passes a language code, for example, "eng-GB". | | ||
| | `-u` | `--user[=USER]` | Passes a repository username. By default it is "admin". | | ||
| | `-c` | `--batch-size[=BATCH-SIZE]` | Passes a number of URLs to check in a single iteration. Set it to avoid using too much memory. By default it is set to 50. | | ||
| | | `--siteaccess[=SITEACCESS]` | Passes a SiteAccess to use for operations. If not provided, the default SiteAccess is used. | | ||
julitafalcondusza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Form-uploaded files | ||
|
|
||
| You can use Forms to enable the user to upload files. | ||
| The default Location for files uploaded in this way is `/Media/Files/Form Uploads`. | ||
| You can change it with the following configuration: | ||
|
|
||
| ``` yaml | ||
| ibexa: | ||
| system: | ||
| default: | ||
| form_builder: | ||
| upload_location_id: 54 | ||
| ``` | ||
|
|
||
| This applies only if no specific Location is defined in the Form itself. | ||
julitafalcondusza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| description: RichText is a type of field that you add in any content item in Ibexa DXP and edit in Online Editor. | ||
| page_type: landing_page | ||
| --- | ||
|
|
||
| # RichText | ||
|
|
||
| RichText is a type of field that you add in any content item in Ibexa DXP and edit in Online Editor. | ||
|
|
||
| [[= cards([ | ||
| "content_management/rich_text/online_editor_guide", | ||
| "content_management/rich_text/extend_online_editor", | ||
| "content_management/rich_text/create_custom_richtext_block" | ||
| ], columns=3) =]] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.