Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Configure default upload locations, pagination limits, and more set
## Pagination limits

Default pagination limits for different sections of the back office can be defined through respective settings in
[`ezplatform_default_settings.yaml`](https://github.com/ibexa/admin-ui/blob/main/src/bundle/Resources/config/ezplatform_default_settings.yaml#L7).
[`ezplatform_default_settings.yaml`](https://github.com/ibexa/admin-ui/blob/5.0/src/bundle/Resources/config/ezplatform_default_settings.yaml#L7).

You can set the pagination limit for user settings under the `ibexa.system.<scope>.pagination_user` [configuration key](configuration.md#configuration-files):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ At this point you can go to the back office and check the results.
!!! note "Thumbnail mechanism "

This strategy overrides all generated thumbnails. You can specify a specific content type.
See the example [here](https://github.com/ibexa/user/blob/main/src/lib/Strategy/DefaultThumbnailStrategy.php)
See the example [here](https://github.com/ibexa/user/blob/5.0/src/lib/Strategy/DefaultThumbnailStrategy.php)


## Other fields as thumbnails
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To import CSS files only, use:

After you add new files, run `php bin/console cache:clear`.

For a full example of importing asset configuration, see [`ibexa.config.js`](https://github.com/ibexa/admin-ui/blob/main/src/bundle/Resources/encore/ibexa.config.js)
For a full example of importing asset configuration, see [`ibexa.config.js`](https://github.com/ibexa/admin-ui/blob/5.0/src/bundle/Resources/encore/ibexa.config.js)

To edit existing configuration entries, either in the bundle's `Resources/encore/` folder, or in the `encore` folder in the root folder of your project, create an `ibexa.config.manager.js` file:

Expand Down Expand Up @@ -74,7 +74,7 @@ module.exports = (ibexaConfig, ibexaConfigManager) => {

After you add new files, run `php bin/console cache:clear`.

For a full example of overriding configuration, see [`ibexa.config.manager.js`](https://github.com/ibexa/fieldtype-matrix/blob/main/src/bundle/Resources/encore/ibexa.config.manager.js).
For a full example of overriding configuration, see [`ibexa.config.manager.js`](https://github.com/ibexa/fieldtype-matrix/blob/5.0/src/bundle/Resources/encore/ibexa.config.manager.js).

To add a new configuration under your own namespace and with its own dependencies, create an `ibexa.webpack.custom.config.js` file that you create either in the bundle's `Resources/encore/` folder, or in the `encore` folder in the root directory of your project, for example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ You can also influence tab display (for example, order tabs, remove, or modify t

## Tab groups

You can create new tab groups by using the [`TabsComponent`](https://github.com/ibexa/admin-ui/blob/main/src/lib/Component/TabsComponent.php).
You can create new tab groups by using the [`TabsComponent`](https://github.com/ibexa/admin-ui/blob/5.0/src/lib/Component/TabsComponent.php).

To create a tab group, register it as a service:

Expand Down
2 changes: 1 addition & 1 deletion docs/administration/back_office/subitems_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Optionally, Sub-items module can take a following list of props:
- **items** _{Array}_ - list of location's sub-items
- **limit** _{Number}_ - items limit count
- **offset** _{Number}_ - items limit offset
- **labels** _{Object}_ - list of module labels, see [sub.items.module.js](https://github.com/ibexa/admin-ui/blob/main/src/bundle/ui-dev/src/modules/sub-items/sub.items.module.js) for details. Contains definitions for sub components:
- **labels** _{Object}_ - list of module labels, see [sub.items.module.js](https://github.com/ibexa/admin-ui/blob/5.0/src/bundle/ui-dev/src/modules/sub-items/sub.items.module.js) for details. Contains definitions for sub components:
- **subItems** _{Object}_ - list of sub-items module labels
- **tableView** _{Object}_ - list of table view component labels
- **tableViewItem** _{Object}_ - list of table item view component labels
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/project_organization/bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can also reuse the bundles you create in other projects or share them with t

Many [[= product_name =]] functionalities are provided through separate bundles included in the installation.
You can see the bundles that are automatically installed with [[= product_name =]] in the respective `composer.json` files.
For example, for [[= product_name_headless =]], see the [JSON file on GitHub](https://github.com/ibexa/headless/blob/master/composer.json).
For example, for [[= product_name_headless =]], see the [JSON file on GitHub](https://github.com/ibexa/headless/blob/5.0/composer.json).

## Working with bundles

Expand Down
4 changes: 2 additions & 2 deletions docs/api/graphql/graphql_custom_ft.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@

It's required for every implemented method, so that other mappers are called for the other field types.

The [`RelationFieldDefinitionMapper`](https://github.com/ibexa/graphql/blob/main/src/lib/Schema/Domain/Content/Mapper/FieldDefinition/RelationFieldDefinitionMapper.php) example:
The [`RelationFieldDefinitionMapper`](https://github.com/ibexa/graphql/blob/5.0/src/lib/Schema/Domain/Content/Mapper/FieldDefinition/RelationFieldDefinitionMapper.php) example:

```php hl_lines="14"
class RelationFieldDefinitionMapper extends DecoratingFieldDefinitionMapper implements FieldDefinitionMapper
Expand Down Expand Up @@ -172,4 +172,4 @@
- `location` is the content item's resolved location. For more information, see [Querying Locations](graphql_queries.md#querying-locations)
- `item` is the content together with its location `\Ibexa\GraphQL\Value\Item`

`RelationFieldValueBuilder` or `SelectionFieldValueBuilder` can be used as examples.
`RelationFieldValueBuilder` or `SelectionFieldValueBuilder` can be used as examples.

Check notice on line 175 in docs/api/graphql/graphql_custom_ft.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/graphql/graphql_custom_ft.md#L175

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/api/graphql/graphql_custom_ft.md", "range": {"start": {"line": 175, "column": 65}}}, "severity": "INFO"}
2 changes: 1 addition & 1 deletion docs/api/php_api/php_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ To create and modify repository values, use data structures, such as [`ContentSe

### Value info objects

Some complex value objects have an `Info` counterpart, for example [`ContentInfo`](https://github.com/ibexa/core/blob/main/src/contracts/Repository/Values/Content/ContentInfo.php) for [`Content`](https://github.com/ibexa/core/blob/main/src/contracts/Repository/Values/Content/Content.php).
Some complex value objects have an `Info` counterpart, for example [`ContentInfo`](https://github.com/ibexa/core/blob/5.0/src/contracts/Repository/Values/Content/ContentInfo.php) for [`Content`](https://github.com/ibexa/core/blob/5.0/src/contracts/Repository/Values/Content/Content.php).
These objects provide you with lower-level information.
For instance, `ContentInfo` contains `currentVersionNo` or `remoteId`, while `Content` enables you to retrieve fields, content type, or previous versions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ The RichText format enriches [DocBook](https://docbook.org/) with the following
!!! note "Unsupported DocBook elements"

Some DocBook elements aren't supported by RichText.
Refer to [`ezpublish.rng`](https://github.com/ibexa/fieldtype-richtext/blob/main/src/bundle/Resources/richtext/schemas/docbook/ezpublish.rng#L137) for a full list.
Refer to [`ezpublish.rng`](https://github.com/ibexa/fieldtype-richtext/blob/5.0/src/bundle/Resources/richtext/schemas/docbook/ezpublish.rng#L137) for a full list.

### Online Editor elements

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/field_types/field_type_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Default field is typically used by the [`Field` Sort Clause](field_sort_clause.m
## Register `Indexable` implementations

Implement `Ibexa\Contracts\Core\FieldType\Indexable` as an extra service and register this Service using the `ibexa.field_type.indexable` tag.
Example from [`indexable_fieldtypes.yaml`](https://github.com/ibexa/core/blob/main/src/lib/Resources/settings/indexable_fieldtypes.yml):
Example from [`indexable_fieldtypes.yaml`](https://github.com/ibexa/core/blob/5.0/src/lib/Resources/settings/indexable_fieldtypes.yml):

``` yaml
Ibexa\Core\FieldType\Keyword\SearchField:
Expand Down
8 changes: 4 additions & 4 deletions docs/content_management/field_types/field_type_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@

#### Registering a converter

The registration of a `Converter` currently works through the `$config` parameter of [`Ibexa\Core\Persistence\Legacy\Handler`](https://github.com/ibexa/core/blob/main/src/lib/Persistence/Legacy/Handler.php).
The registration of a `Converter` currently works through the `$config` parameter of [`Ibexa\Core\Persistence\Legacy\Handler`](https://github.com/ibexa/core/blob/5.0/src/lib/Persistence/Legacy/Handler.php).

Those converters also need to be correctly exposed as services and tagged with `ibexa.field_type.storage.legacy.converter`:

Expand All @@ -84,7 +84,7 @@

!!! tip

Converter configuration for built-in field types is located in [`ibexa/core/src/lib/Resources/settings/fieldtype_external_storages.yml`](https://github.com/ibexa/core/blob/main/src/lib/Resources/settings/fieldtype_external_storages.yml).
Converter configuration for built-in field types is located in [`ibexa/core/src/lib/Resources/settings/fieldtype_external_storages.yml`](https://github.com/ibexa/core/blob/5.0/src/lib/Resources/settings/fieldtype_external_storages.yml).

## Storing data externally

Expand Down Expand Up @@ -154,7 +154,7 @@

The configuration requires providing the `ibexa.field_type.storage.external.handler` tag, with the `alias` attribute being the *fieldTypeIdentifier*. You also have to inject the gateway in `arguments`, [see Gateway-based storage](#gateway-based-storage).

External storage configuration for basic field types is located in [`ibexa/core/src/lib/Resources/settings/fieldtype_external_storages.yml`](https://github.com/ibexa/core/blob/main/src/lib/Resources/settings/fieldtype_external_storages.yml).
External storage configuration for basic field types is located in [`ibexa/core/src/lib/Resources/settings/fieldtype_external_storages.yml`](https://github.com/ibexa/core/blob/5.0/src/lib/Resources/settings/fieldtype_external_storages.yml).

Check notice on line 157 in docs/content_management/field_types/field_type_storage.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/field_types/field_type_storage.md#L157

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/field_types/field_type_storage.md", "range": {"start": {"line": 157, "column": 54}}}, "severity": "INFO"}

Using gateway-based storage requires another service implementing `Ibexa\Core\FieldType\StorageGateway` to be injected into the [external storage handler](#storing-data-externally)).

Expand All @@ -176,7 +176,7 @@

!!! tip

Gateway configuration for built-in field types is located in [`core/src/lib/Resources/settings/storage_engines/`](https://github.com/ibexa/core/tree/main/src/lib/Resources/settings/storage_engines).
Gateway configuration for built-in field types is located in [`core/src/lib/Resources/settings/storage_engines/`](https://github.com/ibexa/core/tree/5.0/src/lib/Resources/settings/storage_engines).

## Storing field type settings externally

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/field_types/field_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Field types are responsible for:
To do so, you need to create a custom field type.

A custom field type must implement the **FieldType Service Provider Interfaces**
available in the [`Ibexa\Core\FieldType`](https://github.com/ibexa/core/tree/main/src/lib/FieldType) namespace.
available in the [`Ibexa\Core\FieldType`](https://github.com/ibexa/core/tree/5.0/src/lib/FieldType) namespace.

!!! note "Registration"

Expand Down
4 changes: 2 additions & 2 deletions docs/content_management/field_types/form_and_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ By convention, your block must be named `<fieldTypeIdentifier>_field`.

!!! tip

Template blocks for built-in field types are available in [`Core/Resources/views/content_fields.html.twig`](https://github.com/ibexa/core/blob/main/src/bundle/Core/Resources/views/content_fields.html.twig).
Template blocks for built-in field types are available in [`Core/Resources/views/content_fields.html.twig`](https://github.com/ibexa/core/blob/5.0/src/bundle/Core/Resources/views/content_fields.html.twig).

This template is also exposed as a part of Standard Design, so you can override it with the [design engine](design_engine.md).
To do so, place the template `themes/standard/content_fields.html.twig` in your `Resources/views` (assuming `ibexa_standard_design.override_kernel_templates` is set to true).
Expand All @@ -156,7 +156,7 @@ The block can receive the following variables:

For easier field type template development you can take advantage of all defined blocks by using the [`block()` function](https://twig.symfony.com/doc/3.x/functions/block.html).

You can for example use `simple_block_field`, `simple_inline_field` or `field_attributes` blocks provided in [`content_fields.html.twig`](https://github.com/ibexa/core/blob/main/src/bundle/Core/Resources/views/content_fields.html.twig#L486).
You can for example use `simple_block_field`, `simple_inline_field` or `field_attributes` blocks provided in [`content_fields.html.twig`](https://github.com/ibexa/core/blob/5.0/src/bundle/Core/Resources/views/content_fields.html.twig#L486).

!!! caution

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/field_types/type_and_value.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ This ensures that the initialization steps shared by all field types are execute

!!! tip

The configuration of built-in field types is located in [`core/src/lib/Resources/settings/fieldtypes.yml`](https://github.com/ibexa/core/blob/main/src/lib/Resources/settings/fieldtypes.yml).
The configuration of built-in field types is located in [`core/src/lib/Resources/settings/fieldtypes.yml`](https://github.com/ibexa/core/blob/5.0/src/lib/Resources/settings/fieldtypes.yml).

### Indexing

Expand Down
6 changes: 3 additions & 3 deletions docs/content_management/images/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
With a placeholder generator you can download or generate placeholder images for any missing image.
It proves useful when you're working on an existing database and are unable to download uploaded images to your local development environment, due to, for example, a large size of files.

If the original image cannot be resolved, the `PlaceholderAliasGenerator::getVariation` method generates a placeholder by delegating it to the implementation of the [PlaceholderProvider](https://github.com/ibexa/core/blob/main/src/bundle/Core/Imagine/PlaceholderProvider.php) interface, and saves it under the original path.
If the original image cannot be resolved, the `PlaceholderAliasGenerator::getVariation` method generates a placeholder by delegating it to the implementation of the [PlaceholderProvider](https://github.com/ibexa/core/blob/5.0/src/bundle/Core/Imagine/PlaceholderProvider.php) interface, and saves it under the original path.

Check notice on line 116 in docs/content_management/images/images.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/images/images.md#L116

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/images/images.md", "range": {"start": {"line": 116, "column": 30}}}, "severity": "INFO"}

In [[= product_name =]], there are two implementations of the `PlaceholderProvider` interface:

Expand All @@ -122,7 +122,7 @@

### GenericProvider

The [`GenericProvider`](https://github.com/ibexa/core/blob/main/src/bundle/Core/Imagine/PlaceholderProvider.php) package generates placeholders with basic information about the original image (see [example 1](#configuration-examples)).
The [`GenericProvider`](https://github.com/ibexa/core/blob/5.0/src/bundle/Core/Imagine/PlaceholderProvider.php) package generates placeholders with basic information about the original image (see [example 1](#configuration-examples)).

Check notice on line 125 in docs/content_management/images/images.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/images/images.md#L125

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "docs/content_management/images/images.md", "range": {"start": {"line": 125, "column": 7}}}, "severity": "INFO"}

![Placeholder image GenericProvider](placeholder_info.jpg "Example of a generic placeholder image")

Expand All @@ -139,7 +139,7 @@

### RemoteProvider

With the [`RemoteProvider`](https://github.com/ibexa/core/blob/main/src/bundle/Core/Imagine/PlaceholderProvider/RemoteProvider.php) you can download placeholders from:
With the [`RemoteProvider`](https://github.com/ibexa/core/blob/5.0/src/bundle/Core/Imagine/PlaceholderProvider/RemoteProvider.php) you can download placeholders from:

- remote sources, for example, <http://placekitten.com> (see [example 2](#configuration-examples))
- live version of a site (see [example 3](#configuration-examples))
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/rich_text/extend_online_editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ You can modify the order and visibility of buttons that are available in the Onl

For each button you can set `priority`, which defines the order of buttons in the toolbar.

For a full list of standard buttons, see the RichText module's [configuration file](https://github.com/ibexa/fieldtype-richtext/blob/main/src/bundle/Resources/config/prepend/ezpublish.yaml)
For a full list of standard buttons, see the RichText module's [configuration file](https://github.com/ibexa/fieldtype-richtext/blob/5.0/src/bundle/Resources/config/prepend/ezpublish.yaml)

## Add CKEditor plugins

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/url_management/url_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ ibexa:
| `separator` | Decides what separator is used. There are three types of separator available: dash, underscore and space. |
| `transformation_groups` | Contains the available patterns for URL generation. |

A transformation group consists of an array of commands (see [all available commands](https://github.com/ibexa/core/tree/main/src/lib/Resources/slug_converter/transformations)) and a [`cleanupText`](https://github.com/ibexa/core/blob/main/src/lib/Persistence/Legacy/Content/UrlAlias/SlugConverter.php#L286).
A transformation group consists of an array of commands (see [all available commands](https://github.com/ibexa/core/tree/5.0/src/lib/Resources/slug_converter/transformations)) and a [`cleanupText`](https://github.com/ibexa/core/blob/5.0/src/lib/Persistence/Legacy/Content/UrlAlias/SlugConverter.php#L286).

You can make use of pre-defined transformation groups.
You can also add your own, with your own set of commands.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/install_ibexa_dxp.md
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ Prepare a [virtual host configuration](https://en.wikipedia.org/wiki/Virtual_hos

=== "nginx"

You can use [this example vhost file](https://raw.githubusercontent.com/ibexa/post-install/main/resources/templates/nginx/vhost.template) and modify it to fit your project. You also need the `ibexa_params.d` files that should reside in a subdirectory below where the main file is, [as is shown here](https://github.com/ibexa/post-install/tree/main/resources/templates/nginx).
You can use [this example vhost file](https://raw.githubusercontent.com/ibexa/post-install/main/resources/templates/nginx/vhost.template) and modify it to fit your project. You also need the `ibexa_params.d` files that should reside in a subdirectory below where the main file is, [as is shown here](https://github.com/ibexa/post-install/tree/5.0/resources/templates/nginx).


Specify `/<your installation directory>/public` as the `root`, or ensure `BASEDIR` is set in the environment.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/install_with_ddev.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ ddev restart

#### Scripted procedure

Generate the virtual host with [`vhost.sh`](https://github.com/ibexa/docker/blob/main/scripts/vhost.sh):
Generate the virtual host with [`vhost.sh`](https://github.com/ibexa/docker/blob/5.0/scripts/vhost.sh):

```bash
curl -O https://raw.githubusercontent.com/ibexa/docker/main/scripts/vhost.sh
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ If you want to use Basic Auth with Fastly on [[= product_name_cloud =]], please

!!! note "Invalidating Varnish cache by using tokens"

In setups where the Varnish server IP can change (for example, on [[= product_name_cloud =]]), you can use token-based cache invalidation through [`ibexa_purge_acl`](https://github.com/ibexa/http-cache/blob/main/docs/varnish/vcl/varnish5.vcl#L174).
In setups where the Varnish server IP can change (for example, on [[= product_name_cloud =]]), you can use token-based cache invalidation through [`ibexa_purge_acl`](https://github.com/ibexa/http-cache/blob/5.0/docs/varnish/vcl/varnish5.vcl#L174).

In such situation, use strong, secure hash and make sure to keep the token secret.

Expand Down Expand Up @@ -195,7 +195,7 @@ If you created a custom Captcha block for your site by overriding the default fi
data-field-id="{{ field.id }}"
```

As a result, your file should be similar to [this example](https://github.com/ibexa/form-builder/blob/main/src/bundle/Resources/views/themes/standard/fields/captcha.html.twig).
As a result, your file should be similar to [this example](https://github.com/ibexa/form-builder/blob/5.0/src/bundle/Resources/views/themes/standard/fields/captcha.html.twig).

For more information about configuring Captcha fields, see [Captcha field](work_with_forms.md#captcha-field).

Expand Down
Loading
Loading