Skip to content
Merged
6 changes: 3 additions & 3 deletions docs/cdp/cdp_guide.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
description: The Ibexa CDP (Customer Data Platform) product guide provides a full description of its features as well as the benefits it brings to the client.
description: The Ibexa CDP product guide describes all the possibilities that the Customer Data Platform offers to help you build great customer experiences.
edition: experience
---

# [[= product_name_cdp =]] product guide
# Ibexa Customer Data Platform (CDP) product guide

## What is [[= product_name_cdp =]]

Expand Down Expand Up @@ -45,7 +45,7 @@ This approach helps you create a single customer view.

To create a personalized customer experience, you need to group your clients into specified audiences.
[[= product_name =]] comes with a ready solution - segment groups.
Segment group information is reused by various [[= product_name =]] functionalities, such as [Personalization](https://doc.ibexa.co/en/latest/personalization/personalization_brochure/) or content targeting.
Segment group information is reused by various [[= product_name =]] functionalities, such as [Personalization](personalization_guide.md) or content targeting.

You can [create a segment group](https://doc.ibexa.co/projects/userguide/en/latest/personalization/segment_management/) in the Back Office of [[= product_name =]]. It serves as a container for all segments data generated by [[= product_name_cdp =]].
When you create a segment group, you need to provide its name and identifier.
Expand Down
1 change: 1 addition & 0 deletions docs/content_management/content_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ page_type: landing_page
# Content management

[[= cards([
"content_management/content_management_guide",
"content_management/content_model",
"content_management/locations",
"content_management/field_types/field_type_reference/field_type_reference",
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/content_management_guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: The content management product guide provides a full description of its features as well as the benefits it brings to the client.
description: Read the content management product guide and learn how to create, modify, and display information to the target audience.
---

# Content management product guide
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ The Form Field Type stores a Form consisting of one or more form fields.



See [Forms](forms.md) for more information about working with Forms.
See [Forms](work_with_forms.md) for more information about working with Forms.
2 changes: 1 addition & 1 deletion docs/content_management/forms/form_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ edition: experience

## Form submissions

To manage form submissions created in the [Form Builder](forms.md), use `FormSubmissionServiceInterface`.
To manage form submissions created in the [Form Builder](form_builder_guide.md), use `FormSubmissionServiceInterface`.

### Getting form submissions

Expand Down
4 changes: 2 additions & 2 deletions docs/content_management/forms/form_builder_guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: The Form Builder product guide provides a full description of its features as well as the benefits it brings to the client.
description: See the Form Builder product guide and learn how to create various forms to increase the functionality of your website.
edition: experience
---

Expand Down Expand Up @@ -64,7 +64,7 @@ To learn more, see [Work with forms]([[= user_doc =]]/content_management/work_wi

### Forms management

[Form](forms.md) is one of available [content items]([[= user_doc =]]/content_management/content_items/) that you can find in the platform.
[Form](work_with_forms.md) is one of available [content items]([[= user_doc =]]/content_management/content_items/) that you can find in the platform.
You can work with it as with other regular items: create new one, edit existing one, move, etc.

You can manage all the existing forms. To do it, in a selected place of the content tree find your form and click on it.
Expand Down
83 changes: 11 additions & 72 deletions docs/content_management/forms/forms.md
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
---

# 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).

![Captcha field](extending_form_builder_captcha_default.png)

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).

![Custom captcha field](extending_form_builder_captcha_result.png)

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) =]]
79 changes: 79 additions & 0 deletions docs/content_management/forms/work_with_forms.md
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.
edition: experience
---

# Forms

You can build forms consisting of different fields in the Form Builder.

!!! 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).

![Captcha field](extending_form_builder_captcha_default.png)

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).
![Custom captcha field](extending_form_builder_captcha_result.png)
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.
2 changes: 1 addition & 1 deletion docs/content_management/pages/page_builder_guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: The Page Builder product guide provides a full description of its features as well as the benefits it brings to the client.
description: Read about the Page Builder - a powerful tool for creating and modifying pages in Ibexa DXP.
edition: experience
---

Expand Down
3 changes: 2 additions & 1 deletion docs/content_management/pages/pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ page_type: landing_page
Pages are block-based special types of content that editors can create and modify by using a visual drag-and-drop editor.

[[= cards([
"content_management/pages/page_builder_guide",
"content_management/pages/page_blocks",
"content_management/pages/page_block_attributes",
"content_management/pages/page_block_validators",
"content_management/pages/create_custom_page_block",
], columns=4) =]]
], columns=3) =]]
2 changes: 1 addition & 1 deletion docs/content_management/rich_text/online_editor_guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: The Online Editor product guide provides a full description of its features as well as the benefits it brings to the client.
description: Learn how to use the Online Editor, a tool that allows you to edit RichText Fields in any content item in Ibexa DXP.
---

# Online Editor product guide
Expand Down
14 changes: 14 additions & 0 deletions docs/content_management/rich_text/rich_text.md
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) =]]
Loading