diff --git a/docs/api/commerce_api/field_type_reference/field_type_reference.md b/docs/api/commerce_api/field_type_reference/field_type_reference.md index 8df54f0fb4..2cf2cd9a90 100644 --- a/docs/api/commerce_api/field_type_reference/field_type_reference.md +++ b/docs/api/commerce_api/field_type_reference/field_type_reference.md @@ -1,6 +1,6 @@ # Commerce Field Types -eZ Commerce uses special ecommerce-related Field Types: +[[= product_name_com =]] uses special ecommerce-related Field Types: - [sesselection](sesselection.md) - offers a selection using options from a YAML file - [sesexternaldata](sesexternaldata.md) diff --git a/docs/api/commerce_api/fields_for_ecommerce_data/fields_for_ecommerce_data.md b/docs/api/commerce_api/fields_for_ecommerce_data/fields_for_ecommerce_data.md index d21cea1489..d1db857795 100644 --- a/docs/api/commerce_api/fields_for_ecommerce_data/fields_for_ecommerce_data.md +++ b/docs/api/commerce_api/fields_for_ecommerce_data/fields_for_ecommerce_data.md @@ -1,6 +1,6 @@ # Fields for eCommerce data -eZ Commerce uses custom Fields to store eCommerce related data, for example for the catalog or basket. +[[= product_name_com =]] uses custom Fields to store eCommerce related data, for example for the catalog or basket. The shop provides a flexible way to store data using concrete instances of classes implementing `FieldInterface` and inheriting from the `AbstractField` class. Fields are used for fixed attributes of a product/catalog and for flexible attributes (property `dataMap` in [`CatalogElement`](../../../guide/catalog/catalog_api/catalog_element.md)). diff --git a/docs/api/commerce_api/helper_services/mailhelperservice.md b/docs/api/commerce_api/helper_services/mailhelperservice.md index 8e6f62403f..45d1b7678d 100644 --- a/docs/api/commerce_api/helper_services/mailhelperservice.md +++ b/docs/api/commerce_api/helper_services/mailhelperservice.md @@ -1,6 +1,6 @@ # MailHelperService -`MailHelperService` is used to create, render and send emails from eZ Commerce. +`MailHelperService` is used to create, render and send emails from [[= product_name_com =]]. ## Interface and implementations diff --git a/docs/api/commerce_rest_api.md b/docs/api/commerce_rest_api.md index 8fae42e26b..d9473592e5 100644 --- a/docs/api/commerce_rest_api.md +++ b/docs/api/commerce_rest_api.md @@ -1,6 +1,6 @@ # Commerce REST API -eZ Commerce extends the REST API of eZ Platform with the following features: +[[= product_name_com =]] extends the REST API of [[= product_name_oss =]] with the following features: ## Basket API diff --git a/docs/api/creating_content_with_binary_attachments_via_rest_api.md b/docs/api/creating_content_with_binary_attachments_via_rest_api.md index 5494179f49..f43d762100 100644 --- a/docs/api/creating_content_with_binary_attachments_via_rest_api.md +++ b/docs/api/creating_content_with_binary_attachments_via_rest_api.md @@ -10,7 +10,7 @@ As for the response, it's possible to use either JSON or XML in input. The following examples use JSON (and assume [HTTP Basic Auth](general_rest_usage.md#http-basic-authentication) is enabled). ``` php -// URL to eZ Platform installation +// URL to [[= product_name_oss =]] installation $base_url = "http://127.0.0.1"; // User credentials $username = "admin"; @@ -99,7 +99,7 @@ curl_close($curl); To publish the image use the following code: ``` php -// URL to eZ Platform installation +// URL to [[= product_name_oss =]] installation $base_url = "http://127.0.0.1"; // User credentials $username = "admin"; diff --git a/docs/api/creating_custom_rest_api_response.md b/docs/api/creating_custom_rest_api_response.md index 6bc3989c60..aac4125883 100644 --- a/docs/api/creating_custom_rest_api_response.md +++ b/docs/api/creating_custom_rest_api_response.md @@ -2,7 +2,7 @@ Customized REST API response can be used in many situations, both for headless and more traditional setups. REST responses can be enriched in a clean way and limit client-to-server round trips. -To do this you can take advantage of eZ Platform's [HATEOAS-based](https://en.wikipedia.org/wiki/HATEOAS) REST API and extend it with custom Content Types for your own needs. In this section you will add comments count to `eZ\Publish\API\Repository\Values\Content\VersionInfo` responses. +To do this you can take advantage of [[= product_name_oss =]]'s [HATEOAS-based](https://en.wikipedia.org/wiki/HATEOAS) REST API and extend it with custom Content Types for your own needs. In this section you will add comments count to `eZ\Publish\API\Repository\Values\Content\VersionInfo` responses. ## Implementation of dedicated Visitor @@ -246,7 +246,7 @@ Please note that you should set a proper `Accept` header value. For this example "value": [ { "_languageCode": "eng-GB", - "#text": "eZ Platform" + "#text": "Ibexa Platform" } ] }, diff --git a/docs/api/extending_the_rest_api.md b/docs/api/extending_the_rest_api.md index 4b223f6db1..6ec7b4dece 100644 --- a/docs/api/extending_the_rest_api.md +++ b/docs/api/extending_the_rest_api.md @@ -1,10 +1,10 @@ # Extending the REST API -The eZ Platform REST API comes with a framework that makes it easy to extend the API for your own needs. +The [[= product_name_oss =]] REST API comes with a framework that makes it easy to extend the API for your own needs. ## Requirements -REST routes are required to use the eZ Platform REST API prefix, `/api/ezp/v2`. You can create new resources below this prefix. +REST routes are required to use the [[= product_name_oss =]] REST API prefix, `/api/ezp/v2`. You can create new resources below this prefix. To do so, you will/may need to create: diff --git a/docs/api/field_type_api.md b/docs/api/field_type_api.md index bb5359ade7..5aa5c714b2 100644 --- a/docs/api/field_type_api.md +++ b/docs/api/field_type_api.md @@ -3,7 +3,7 @@ ## Basic information Field Types are the smallest building blocks of content. -eZ Platform comes with many [built-in Field Types](field_type_reference.md#available-field-types) that cover most common needs e.g. Text line, Email address, Author list, Content relation, Map location, Float, etc. +[[= product_name_oss =]] comes with many [built-in Field Types](field_type_reference.md#available-field-types) that cover most common needs e.g. Text line, Email address, Author list, Content relation, Map location, Float, etc. Field Types are responsible for: @@ -14,7 +14,7 @@ Field Types are responsible for: ## Custom data -eZ Platform can support custom data to be stored in the Fields of a Content item. +[[= product_name_oss =]] can support custom data to be stored in the Fields of a Content item. To do so, you need to create a custom Field Type. A custom Field Type must implement the **FieldType Service Provider Interfaces** @@ -25,7 +25,7 @@ available in the [`eZ\Publish\SPI\FieldType`](https://github.com/ezsystems/ezpla Remember that all your custom Field Types must be registered in `config/services.yml`. For more information see [Registration section](field_type_type_and_value.md#registration). -In order to provide custom functionality for a Field Type, the SPI interacts with multiple layers of the eZ Platform architecture: +In order to provide custom functionality for a Field Type, the SPI interacts with multiple layers of the [[= product_name_oss =]] architecture: ![Field Type Overview](img/field_type_overview.png) @@ -39,7 +39,7 @@ Below that, the Field Type must support the **Public API** implementation regard On the bottom level, a Field Type can additionally hook into the **Persistence SPI** in order to store data from a `FieldValue` in an external service. -Note that all non-standard eZ Platform database tables (e.g. `ezurl`) +Note that all non-standard [[= product_name_oss =]] database tables (e.g. `ezurl`) will be treated as [external storage](field_type_storage.md#external-storage). The following sequence diagrams visualize the process of creating and publishing new content across all layers, especially focused on the interaction with a Field Type. diff --git a/docs/api/field_type_reference.md b/docs/api/field_type_reference.md index 28a0ce1e22..e5a679aa12 100644 --- a/docs/api/field_type_reference.md +++ b/docs/api/field_type_reference.md @@ -2,13 +2,13 @@ A Field Type is the underlying building block of the content model. It consists of two entities: Field value and Field definition. Field value is determined by values entered into the Content Field. Field definition is provided by the Content Type, and holds any user defined rules used by Field Type to determine how a Field Value is validated, stored, retrieved, formatted and so on. -eZ Platform comes with a collection of Field Types that can be used to build powerful and complex content structures. In addition, it is possible to extend the system by creating custom types for special needs. +[[= product_name_oss =]] comes with a collection of Field Types that can be used to build powerful and complex content structures. In addition, it is possible to extend the system by creating custom types for special needs. !!! tip For general Field Type documentation, see [Field Type API](../api/field_type_api.md). -Custom Field Types have to be programmed in PHP. However, the built-in Field Types are usually sufficient enough for typical scenarios. The following table gives an overview of the supported Field Types that come with eZ Platform. +Custom Field Types have to be programmed in PHP. However, the built-in Field Types are usually sufficient enough for typical scenarios. The following table gives an overview of the supported Field Types that come with [[= product_name_oss =]]. ## Available Field Types @@ -37,7 +37,7 @@ Custom Field Types have to be programmed in PHP. However, the built-in Field Ty | [Rating](#rating-field-type) | **Deprecated** | N/A | N/A | | [Relation](#relation-field-type) | Validates and stores a relation to a Content item. | Yes, with both [`Field`](../guide/search/criteria_reference/field_criterion.md) and [`FieldRelation`](../guide/search/criteria_reference/fieldrelation_criterion.md) Criteria | Yes | | [RelationList](#relationlist-field-type) | Validates and stores a list of relations to Content items. | Yes, with [`FieldRelation` Criterion](../guide/search/criteria_reference/fieldrelation_criterion.md) | Yes | -| [RichText](#richtext-field-type) | Validates and stores structured rich text in DocBook xml format, and exposes it in several formats. Available via [eZ Platform RichTextBundle](https://github.com/ezsystems/ezplatform-richtext). | Yes[^1^](#1-note-on-legacy-search-engine) | Yes | +| [RichText](#richtext-field-type) | Validates and stores structured rich text in DocBook xml format, and exposes it in several formats. Available via [RichTextBundle](https://github.com/ezsystems/ezplatform-richtext). | Yes[^1^](#1-note-on-legacy-search-engine) | Yes | | [Selection](#selection-field-type) | Validates and stores a single selection or multiple choices from a list of options. | Yes[^1^](#1-note-on-legacy-search-engine) | Yes | | [TextBlock](#textblock-field-type) | Validates and stores a larger block of text. | Yes[^1^](#1-note-on-legacy-search-engine) | Yes | | [TextLine](#textline-field-type) | Validates and stores a single line of text. | Yes | Yes | @@ -57,7 +57,7 @@ Proper indexing of these Field Types is done with [Solr Search Bundle](../guide/ |FieldType|Description|Searchable|Editing support in Platform UI|Planned to be included in the future| |------|------|------|------|------| -| [XmlText](#xmltext-field-type)|Validates and stores multiple lines of formatted text using XML format.|Yes|Partial *(Raw XML editing)*|No *(has been superseded by [RichText](#richtext-field-type))*
The XmlText Field Type is not enabled by default in eZ Platform.| +| [XmlText](#xmltext-field-type)|Validates and stores multiple lines of formatted text using XML format.|Yes|Partial *(Raw XML editing)*|No *(has been superseded by [RichText](#richtext-field-type))*
The XmlText Field Type is not enabled by default in [[= product_name_oss =]].| ### Field Types provided by Community @@ -308,7 +308,7 @@ This Field Type maps an executable Repository query to a Field. |-----------|---------------|----------------| | `Content query` | `ezcontentquery` | `string` | -The Content query Field Type is available via the eZ Platform Query Field Type Bundle +The Content query Field Type is available via the Query Field Type Bundle provided by the [ezplatform-query-fieldtype](https://github.com/ezsystems/ezplatform-query-fieldtype) package. For information on the Field Type's usage, see [Query Field Type in controller documentation](../guide/controllers.md#query-field-type). @@ -342,7 +342,7 @@ When you set an array directly on a Content field you don't need to provide all #### Validation -This Field Type validates whether multiple countries are allowed by the Field definition, and whether the [Alpha2](https://www.iso.org/iso-3166-country-codes.html) is valid according to the countries configured in eZ Platform. +This Field Type validates whether multiple countries are allowed by the Field definition, and whether the [Alpha2](https://www.iso.org/iso-3166-country-codes.html) is valid according to the countries configured in [[= product_name_oss =]]. #### Settings @@ -790,7 +790,7 @@ $floatFieldCreateStruct->validatorConfiguration = [ This Field Type does not support settings. -!!! enterprise +!!! dxp ## Form Field Type @@ -1317,7 +1317,7 @@ This Field Type stores one or several comma-separated keywords as a string or ar |Type|Example| |------|------| |`string`|`"documentation"`| -|`string`|`"php, eZ Platform, html5"`| +|`string`|`"php, Ibexa Platform, html5"`| |`string[]`|`[ "Ibexa", "Enterprise", "User Experience Management" ]`| #### Value object @@ -1338,7 +1338,7 @@ use eZ\Publish\Core\FieldType\Keyword\Value; $keywordValue = new Value();   // Sets an array of keywords as a value -$keyword->value = [ "php", "css3", "html5", "eZ Platform" ]; +$keyword->value = [ "php", "css3", "html5", "Ibexa Platform" ]; ``` ##### Constructor @@ -1458,7 +1458,7 @@ This Field represents and handles a table of rows and columns of data. |----------|---------------|----------------| | `Matrix` | `ezmatrix` | `array` | -The Matrix Field Type is available via the eZ Platform Matrix Bundle +The Matrix Field Type is available via the Matrix Bundle provided by the [ezplatform-matrix-fieldtype](https://github.com/ezsystems/ezplatform-matrix-fieldtype) package. ### PHP API Field Type @@ -1793,7 +1793,7 @@ This Field Type is used as fallback for migration scenarios, and for testing pur ### Description -The Null Field Type serves as an aid when migrating from eZ Publish Platform and earlier legacy versions. It is a dummy for legacy Field Types that are not implemented in eZ Platform. +The Null Field Type serves as an aid when migrating from eZ Publish Platform and earlier legacy versions. It is a dummy for legacy Field Types that are not implemented in [[= product_name_oss =]]. Null Field Type will accept anything provided as a value and is usually combined with: - NullConverter: Makes it not store anything to the legacy storage engine (database), nor will it read any data. @@ -1822,13 +1822,13 @@ services: tags: [{name: ezplatform.field_type.indexable, alias: example}] ``` -!!! enterprise +!!! dxp ## Page Field Type Page Field Type represents a Page with a layout consisting of multiple zones. Each zone can in turn contain blocks. - Page Field Type is only used in the Page Content Type that is included in eZ Enterprise. + Page Field Type is only used in the Page Content Type that is included in [[= product_name_ee =]]. | Name | Internal name | Expected input | |----------------|-----------------|-----------------| @@ -2104,7 +2104,7 @@ $validators = [ ## RichText Field Type -The RichText Field Type is available via the eZ Platform RichText Field Type Bundle provided by the [ezplatform-richtext](https://github.com/ezsystems/ezplatform-richtext) package. +The RichText Field Type is available via the RichText Field Type Bundle provided by the [ezplatform-richtext](https://github.com/ezsystems/ezplatform-richtext) package. This Field Type validates and stores structured rich text, and exposes it in several formats. @@ -2130,7 +2130,7 @@ Currently supported input formats are described in the table below: |Name|Description| |------|------| -|eZ Platform's DocBook variant|Field Type's internal format| +|[[= product_name_oss =]]'s DocBook variant|Field Type's internal format| |XHTML5 editing format|Typically used with in-browser HTML editor| |Legacy eZXML format|Compatibility with legacy XML format, used by [XmlText Field Type](#xmltext-field-type)| @@ -2150,7 +2150,7 @@ Currently supported input formats are described in the table below: ###### Example of the Field Type's XHTML5 edit format -This format is used by eZ Platform's Online Editor. +This format is used by [[= product_name_oss =]]'s Online Editor. ``` xml @@ -2587,7 +2587,7 @@ This Field Type validates and stores information about a user. ## XmlText Field Type -The XmlText Field Type isn't officially supported by eZ Platform. It can be installed by requiring `ezsystems/ezplatform-xmltext-fieldtype`. PlatformUI does not support WYSIWYG editing of Fields of this type. +The XmlText Field Type isn't officially supported by [[= product_name_oss =]]. It can be installed by requiring `ezsystems/ezplatform-xmltext-fieldtype`. PlatformUI does not support WYSIWYG editing of Fields of this type. This Field Type validates and stores formatted text using the eZ Publish legacy format, eZXML.  diff --git a/docs/api/field_type_storage.md b/docs/api/field_type_storage.md index 6ce9153fc6..3a92401059 100644 --- a/docs/api/field_type_storage.md +++ b/docs/api/field_type_storage.md @@ -2,7 +2,7 @@ ## Storage conversion -If you want to store Field values in regular eZ Platform database tables, +If you want to store Field values in regular [[= product_name_oss =]] database tables, the `FieldValue` must be converted to the storage-specific format used by the Persistence SPI: `eZ\Publish\SPI\Persistence\Content\FieldValue`. After restoring a Field of the Field Type, you must reverse the conversion. @@ -19,7 +19,7 @@ The SPI `FieldValue` struct has properties which the Field Type can use: |Property|Description| |--------|-----------| |`$data`|The data to be stored in the database. This may be a scalar value, an associative array or a simple, serializable object.| -|`$externalData`|The arbitrary data stored in this field will not be touched by any of the eZ Platform components directly, but will be available for [Storing external data](#storing-external-data).| +|`$externalData`|The arbitrary data stored in this field will not be touched by any of the [[= product_name_oss =]] components directly, but will be available for [Storing external data](#storing-external-data).| |`$sortKey`|A value which can be used to sort content by this Field.| ### Legacy storage engine @@ -85,7 +85,7 @@ The tag has the following attribute: A Field Type may store arbitrary data in external data sources. External storage can be e.g. a web service, a file in the file system, another database -or even the eZ Platform database itself (in form of a non-standard table). +or even the [[= product_name_oss =]] database itself (in form of a non-standard table). In order to store data in external storage, the Field Type will interact with the Persistence SPI through the `eZ\Publish\SPI\FieldType\FieldStorage` interface. @@ -102,7 +102,7 @@ calls one of the following methods to also access the external data: |`getIndexData()`|Returns the actual index data for the provided `eZ\Publish\SPI\Persistence\Content\Field`. For more information, see [search service](field_type_search.md#search-field-values).| Each of the above methods (except `hasFieldData`) receives a `$context` array with information on the underlying storage and the environment. -To retrieve and store data in the eZ Platform data storage, +To retrieve and store data in the [[= product_name_oss =]] data storage, but outside of the normal structures (e.g. a custom table in an SQL database), use [Gateway-based storage](#gateway-based-storage) with properly injected Doctrine Connection. diff --git a/docs/api/field_type_type_and_value.md b/docs/api/field_type_type_and_value.md index f4dcd7be58..09cd794cfd 100644 --- a/docs/api/field_type_type_and_value.md +++ b/docs/api/field_type_type_and_value.md @@ -25,7 +25,7 @@ Since the Public API cannot know anything about these, their handling is delegat #### `getFieldTypeIdentifier()` Returns a unique identifier for the custom Field Type which is used to assign the type to a Field definition. -By convention it should be prefixed by a unique vendor shortcut (e.g. `ez` for eZ Platform). +By convention it should be prefixed by a unique vendor shortcut (e.g. `ibexa` for [[= product_name_oss =]]). #### `getSettingsSchema()` diff --git a/docs/api/general_rest_usage.md b/docs/api/general_rest_usage.md index c38b890a5f..812abd5366 100644 --- a/docs/api/general_rest_usage.md +++ b/docs/api/general_rest_usage.md @@ -276,7 +276,7 @@ X-Siteaccess: ezdemo_site_admin The REST API supports two authentication methods: - **Session-based authentication** for AJAX operations that lets you re-use the visitor's session to execute operations with their permissions. -- **Basic authentication** for writing cross-server procedures, when one remote application executes operations on one/several eZ Platform instances (remote publishing, maintenance, etc). +- **Basic authentication** for writing cross-server procedures, when one remote application executes operations on one/several [[= product_name_oss =]] instances (remote publishing, maintenance, etc). Session-based is the default authentication method as it is needed for UI. @@ -426,7 +426,7 @@ A few error codes apply to most resources (if they *are* applicable): |`405`|Method Not Allowed|Returned when the requested REST API resource does not support the HTTP verb that was used.| |`406`|Not Acceptable|Returned when an accept header sent with the requested is not supported.| |`500`|Internal Server Error|The server encountered an unexpected condition, usually an exception, which prevents it from fulfilling the request: database down, permissions or configuration error.| -|`501`|Not Implemented|Returned when the requested method has not yet been implemented. For eZ Platform, most of Users, User groups, Content items, Locations and Content Types have been implemented. Some of their methods, as well as other features, may return a 501.| +|`501`|Not Implemented|Returned when the requested method has not yet been implemented. For [[= product_name_oss =]], most of Users, User groups, Content items, Locations and Content Types have been implemented. Some of their methods, as well as other features, may return a 501.| #### Error handling in your REST implementation diff --git a/docs/api/graphql.md b/docs/api/graphql.md index 27432be2ed..f184e03db1 100644 --- a/docs/api/graphql.md +++ b/docs/api/graphql.md @@ -1,12 +1,12 @@ # GraphQL [GraphQL](https://graphql.org/) is a query language for the API. -The GraphQL implementation for eZ Platform is located in [`ezsystems/ezplatform-graphql`](https://github.com/ezsystems/ezplatform-graphql). +The GraphQL implementation for [[= product_name_oss =]] is located in [`ezsystems/ezplatform-graphql`](https://github.com/ezsystems/ezplatform-graphql). ## Setup Using GraphQL requires a domain schema. -The schema is generated automatically when installing eZ Platform. +The schema is generated automatically when installing [[= product_name_oss =]]. When you modify Content Types in your installation, you need to regenerate the schema: @@ -21,7 +21,7 @@ you can [query](graphql_queries.md) and [operate on](graphql_operations.md). ## Domain schema -GraphQL for eZ Platform is based on the Content Types, Content Type groups, and Content items +GraphQL for [[= product_name_oss =]] is based on the Content Types, Content Type groups, and Content items defined in the Repository. For each Content Type the schema exposes a singular and plural field, e.g. `article` and `articles`. @@ -40,7 +40,7 @@ You can also query Content Type and Content Type group information through the ` ### Repository schema -The repository schema, accessed through `_repository`, exposes the eZ Platform Repository +The repository schema, accessed through `_repository`, exposes the [[= product_name_oss =]] Repository in a manner similar to the [Public PHP API](public_php_api.md). The `_repository` field also enables you to query e.g. Object states configured for the Repository. @@ -56,7 +56,7 @@ This means you cannot use GraphQL with multiple repositories. ## Authentication -GraphQL for eZ Platform supports session-based authentication. +GraphQL for [[= product_name_oss =]] supports session-based authentication. You can get your session cookie by logging in through the interface or through a REST request. ## Usage diff --git a/docs/api/graphql_customization.md b/docs/api/graphql_customization.md index 5ca93b0ae0..7107ad235d 100644 --- a/docs/api/graphql_customization.md +++ b/docs/api/graphql_customization.md @@ -13,7 +13,7 @@ on [overblog/GraphQLBundle](https://github.com/overblog/GraphQLBundle). ### Configuration -You can include the eZ Platform schema in two ways: either through inheritance or composition. +You can include the [[= product_name_oss =]] schema in two ways: either through inheritance or composition. #### Inheritance @@ -32,7 +32,7 @@ Query: #### Composition -To use composition, define eZ Platform schema as a field in your custom schema. +To use composition, define [[= product_name_oss =]] schema as a field in your custom schema. For example, in `app/config/graphql/Query.types.yaml`: ``` yaml diff --git a/docs/api/making_cross_origin_http_requests.md b/docs/api/making_cross_origin_http_requests.md index 710c4f5866..a8c56cddca 100644 --- a/docs/api/making_cross_origin_http_requests.md +++ b/docs/api/making_cross_origin_http_requests.md @@ -1,6 +1,6 @@ # Making cross-origin HTTP requests -eZ Platform ships with [NelmioCorsBundle](https://github.com/nelmio/NelmioCorsBundle), +[[= product_name_oss =]] ships with [NelmioCorsBundle](https://github.com/nelmio/NelmioCorsBundle), an open-source Symfony bundle that provides support for [CORS (Cross-Origin Resource Sharing)](http://www.w3.org/TR/cors/). The REST API is pre-configured to respond to such requests, as long as you customize the allowed origins as explained below. @@ -36,9 +36,9 @@ nelmio_cors: allow_origin: [ 'http://example.com' ] ``` -#### Changing configuration of NelmioCorsBundle for eZ Platform REST +#### Changing configuration of NelmioCorsBundle for [[= product_name_oss =]] REST -The default configuration of NelmioCorsBundle for eZ Platform REST paths is set in the [nelmio_cors.yaml](https://github.com/ezsystems/ezplatform-rest/blob/master/src/bundle/Resources/config/nelmio_cors.yml) file. +The default configuration of NelmioCorsBundle for [[= product_name_oss =]] REST paths is set in the [nelmio_cors.yaml](https://github.com/ezsystems/ezplatform-rest/blob/master/src/bundle/Resources/config/nelmio_cors.yml) file. To adapt these settings to your own needs you have to overwrite them in the `nelmio_cors.yaml` file under the same configuration path, for instance: ```yaml diff --git a/docs/api/public_php_api.md b/docs/api/public_php_api.md index 0cd2d88ab9..662c765dd5 100644 --- a/docs/api/public_php_api.md +++ b/docs/api/public_php_api.md @@ -1,8 +1,8 @@ # Public PHP API -The Public PHP API enables you to interact with eZ Platform's Repository and content model from your PHP code. +The Public PHP API enables you to interact with [[= product_name_oss =]]'s Repository and content model from your PHP code. -You can use it to create, read, update, manage, and delete all objects available in eZ Platform, namely +You can use it to create, read, update, manage, and delete all objects available in [[= product_name_oss =]], namely content and related objects such as Sections, Locations, Content Types, languages, etc. The PHP API is built on top of a layered architecture, including a persistence SPI that abstracts storage. @@ -10,7 +10,7 @@ Using the API ensures that your code will be forward compatible with future rele !!! tip - For more information see a [presentation about eZ Platform API.](https://alongosz.github.io/ezconf2018-api/) + For more information see a [presentation about [[= product_name_oss =]] API.](https://alongosz.github.io/ezconf2018-api/) ## Using API services diff --git a/docs/api/public_php_api_browsing.md b/docs/api/public_php_api_browsing.md index 7a0995d4d5..3b6e3e80f8 100644 --- a/docs/api/public_php_api_browsing.md +++ b/docs/api/public_php_api_browsing.md @@ -314,7 +314,7 @@ the Content will also be loaded in bulk for the whole Location result set. To learn more about this functionality see [Lazy object properties.](https://github.com/ezsystems/ezpublish-kernel/blob/v8.0.0-beta5/doc/specifications/api/lazy_properties.md) -!!! enterprise +!!! dxp ## Comparing content versions diff --git a/docs/api/public_php_api_creating_content.md b/docs/api/public_php_api_creating_content.md index 814765557d..4f70bf80f8 100644 --- a/docs/api/public_php_api_creating_content.md +++ b/docs/api/public_php_api_creating_content.md @@ -82,7 +82,7 @@ based on the input file. ### Creating content with RichText -The RichText Field accepts values in eZ Platform's variant of the [Docbook](https://github.com/docbook/wiki/wiki) format. +The RichText Field accepts values in [[= product_name_oss =]]'s variant of the [Docbook](https://github.com/docbook/wiki/wiki) format. You can see more information about this format in [Field Types reference](field_type_reference.md#example-of-the-field-types-internal-format). For example, to add a simple RichText paragraph, provide the following as input: diff --git a/docs/api/public_php_api_managing_content.md b/docs/api/public_php_api_managing_content.md index 8a9e586273..b522b9daf8 100644 --- a/docs/api/public_php_api_managing_content.md +++ b/docs/api/public_php_api_managing_content.md @@ -202,7 +202,7 @@ $this->contentTypeService->updateContentTypeDraft($copyDraft, $copyUpdateStruct) $this->contentTypeService->publishContentTypeDraft($copyDraft); ``` -!!! enterprise +!!! dxp ## Calendar events diff --git a/docs/api/public_php_api_managing_repository.md b/docs/api/public_php_api_managing_repository.md index fa99dabd00..079945643b 100644 --- a/docs/api/public_php_api_managing_repository.md +++ b/docs/api/public_php_api_managing_repository.md @@ -125,7 +125,7 @@ $objectState = $this->objectStateService->loadObjectState($objectStateId); $this->objectStateService->setContentState($contentInfo, $objectStateGroup, $objectState); ``` -!!! enterprise +!!! dxp ## Workflow diff --git a/docs/api/public_php_api_search.md b/docs/api/public_php_api_search.md index 4d03dafb85..6f21943a3c 100644 --- a/docs/api/public_php_api_search.md +++ b/docs/api/public_php_api_search.md @@ -13,7 +13,7 @@ The service should be [injected into the constructor of your command or controll !!! tip "SearchService in the Back Office" - `SearchService` is also used in the Back Office of eZ Platform, + `SearchService` is also used in the Back Office of [[= product_name_oss =]], in components such as Universal Discovery Widget or Sub-items List. ### Performing a search @@ -283,7 +283,7 @@ class CustomController extends Controller ### Paginating search results -To paginate search results, it is recommended to use the [Pagerfanta library](https://github.com/whiteoctober/Pagerfanta) and [eZ Platform's adapters for it.](https://github.com/ezsystems/ezplatform-kernel/tree/v1.0.0/eZ/Publish/Core/Pagination/Pagerfanta) +To paginate search results, it is recommended to use the [Pagerfanta library](https://github.com/whiteoctober/Pagerfanta) and [[[= product_name_oss =]]'s adapters for it.](https://github.com/ezsystems/ezplatform-kernel/tree/v1.0.0/eZ/Publish/Core/Pagination/Pagerfanta) ``` php //... diff --git a/docs/api/rest_api_guide.md b/docs/api/rest_api_guide.md index 0f55ffb756..64acd5e7f3 100644 --- a/docs/api/rest_api_guide.md +++ b/docs/api/rest_api_guide.md @@ -1,6 +1,6 @@ # REST API Guide -The REST API v2 introduced in eZ Platform allows you to interact with an eZ Platform installation using the HTTP protocol, following a [REST](http://en.wikipedia.org/wiki/Representational_state_transfer) interaction model. +The REST API v2 introduced in [[= product_name_oss =]] allows you to interact with an [[= product_name_oss =]] installation using the HTTP protocol, following a [REST](http://en.wikipedia.org/wiki/Representational_state_transfer) interaction model. ## REST API reference @@ -9,7 +9,7 @@ REST API resources and endpoints. !!! tip - For more information see a [presentation about eZ Platform APIs](https://alongosz.github.io/ezconf2018-api/). + For more information see a [presentation about [[= product_name_oss =]] APIs](https://alongosz.github.io/ezconf2018-api/). ## Accessing the REST API @@ -17,7 +17,7 @@ The REST API is available at the URI `/api/ezp/v2` . HTTPS is available as long ## Basics -REST (REpresentational State Transfer) is a web services architecture that follows the HTTP Protocol very closely. The eZ Platform REST API supports both [JSON](http://www.json.org/) and [XML](http://www.w3.org/XML/) in terms of format. +REST (REpresentational State Transfer) is a web services architecture that follows the HTTP Protocol very closely. The [[= product_name_oss =]] REST API supports both [JSON](http://www.json.org/) and [XML](http://www.w3.org/XML/) in terms of format. ### Resources @@ -59,7 +59,7 @@ Responses returned by the API will also use custom headers to indicate informati ### Installation -No special preparations are necessary to use the REST API. As long as your eZ Platform is correctly configured, the REST API is available on your site using the URI `/api/ezp/v2/`. If you have installed eZ Platform in a subfolder, prepend the path with this subfolder: `http://example.com/sub/folder/ezpublish/api/ezp/v2/`. +No special preparations are necessary to use the REST API. As long as your [[= product_name_oss =]] is correctly configured, the REST API is available on your site using the URI `/api/ezp/v2/`. If you have installed [[= product_name_oss =]] in a subfolder, prepend the path with this subfolder: `http://example.com/sub/folder/ezpublish/api/ezp/v2/`. !!! note @@ -118,7 +118,7 @@ request.send(); ``` -In order to test it, just save this code to some test.html file in the web folder of your eZ Platform installation. If you use the rewrite rules, don't forget to allow this file to be served directly. +In order to test it, just save this code to some test.html file in the web folder of your [[= product_name_oss =]] installation. If you use the rewrite rules, don't forget to allow this file to be served directly. If necessary, substitute `59` with the Content item ID of an item from your database. You will get the ContentInfo for item 59 in JSON encoding. diff --git a/docs/community_resources/code.md b/docs/community_resources/code.md index f8561d9566..0707dc0715 100644 --- a/docs/community_resources/code.md +++ b/docs/community_resources/code.md @@ -7,7 +7,7 @@ All the rules to follow can be found in [Contribute to documentation](documentat Once you are done with describing your idea, focus on the main part - sharing the actual solution. eZ uses a regular git workflow, so if you are familiar with the concept, the whole procedure should be pretty straightforward. -eZ Platform is divided into meta-repositories. +[[= product_name_oss =]] is divided into meta-repositories. The core of our system is [`ezplatform-kernel`](https://github.com/ezsystems/ezplatform-kernel) containing an advanced Content Model and aiming to provide additional features for the MVC layer (Symfony). On the other hand, e.g. `ezplatform-admin-ui` is strictly dedicated to the Admin Panel purposes. @@ -19,7 +19,7 @@ Now you need to determine which version of the package your changes should targe If you plan to fix something in your current project, check `composer.json` for the version of the package and pick proper branch. For example: you added a `try { } catch () {}` statement fixing an annoying error in `ezplatform-admin-ui` -and you are using eZ Platform 2.5. You should aim for branch `1.5` then, as version `1.5.0` is used. +and you are using version 2.5. You should aim for branch `1.5` then, as version `1.5.0` is used. Now you can follow the same procedure as in [Contributing through git](documentation/#contributing-through-git). diff --git a/docs/community_resources/contributing.md b/docs/community_resources/contributing.md index 9ca7d9cce7..89e47e3291 100644 --- a/docs/community_resources/contributing.md +++ b/docs/community_resources/contributing.md @@ -2,15 +2,15 @@ Are you ready to become a part of the eZ Community? There are several ways in which you can contribute, from spotting and reporting bugs to committing to the documentation to discussing innovative uses on Slack to coding new bundles. -If you're looking to contribute code, whether in form of corrections or separate bundles with features, the open-source nature of eZ Platform lets you do this without any fuss using GitHub. Take a look at our [Development guidelines](development_guidelines.md) to get started. +If you're looking to contribute code, whether in form of corrections or separate bundles with features, the open-source nature of [[= product_name_oss =]] lets you do this without any fuss using GitHub. Take a look at our [Development guidelines](development_guidelines.md) to get started. - [Report and follow issues](report_follow_issues.md) if you'd just like to let us know of a bug you've encountered - [Contribute code](code.md) if you've fixed a bug or implemented improvement/feature -- [Contribute translations](translations.md) if you'd like to add a translation of eZ Platform interface +- [Contribute translations](translations.md) if you'd like to add a translation of [[= product_name_oss =]] interface - [Contribute to documentation](documentation.md) if you've noticed any improvement needed in the documentation -- Visit [Community website](http://share.ez.no) or the [eZ Community Slack team](https://ezcommunity.slack.com/) if what you're looking for is simply discussing the way you use eZ Platform +- Visit [Community website](http://share.ez.no) or the [eZ Community Slack team](https://ezcommunity.slack.com/) if what you're looking for is simply discussing the way you use [[= product_name_oss =]]   diff --git a/docs/community_resources/development_guidelines.md b/docs/community_resources/development_guidelines.md index 3a8acb8f03..f7e13aa19f 100644 --- a/docs/community_resources/development_guidelines.md +++ b/docs/community_resources/development_guidelines.md @@ -1,12 +1,12 @@ # Development guidelines -These are the development/coding guidelines for eZ Platform kernel, they are the same if you intend to write Bundles, hack on eZ Platform itself or create new functionality for or on top of eZ Platform. +These are the development/coding guidelines for [[= product_name_oss =]] kernel, they are the same if you intend to write Bundles, hack on [[= product_name_oss =]] itself or create new functionality for or on top of [[= product_name_oss =]]. -Like most development guidelines these aims to improve security, maintainability, performance and readability of our software. They follow industry standards but sometimes extend them to cater specifically to our needs for eZ Platform ecosystem. The next sections will cover all relevant technologies from a high level point of view. +Like most development guidelines these aims to improve security, maintainability, performance and readability of our software. They follow industry standards but sometimes extend them to cater specifically to our needs for [[= product_name_oss =]] ecosystem. The next sections will cover all relevant technologies from a high level point of view. ## HTTP -eZ Platform is a web software that is reached via HTTP in most cases, out of the box in eZ Platform kernel this is specifically: web (usually HTML) or REST. +[[= product_name_oss =]] is a web software that is reached via HTTP in most cases, out of the box in [[= product_name_oss =]] kernel this is specifically: web (usually HTML) or REST. We aim to follow the [latest](http://trac.tools.ietf.org/wg/httpbis/trac/wiki#HTTP1.1Deliverables) stable HTTP specification, and industry best practice: @@ -57,13 +57,13 @@ For now see the living [REST v2 specification](https://doc.ezplatform.com/rest-a ## UI -eZ Platform is often used as a web content management software, so we always strive to use the HTML/CSS/EcmaScript specifications correctly, and keep new releases up to date on new revisions of those. We furthermore always try to make sure our software gracefully degrades making sure it is useful even on older or less capable web clients (browsers), the industry terms for this approach are: +[[= product_name_oss =]] is often used as a web content management software, so we always strive to use the HTML/CSS/EcmaScript specifications correctly, and keep new releases up to date on new revisions of those. We furthermore always try to make sure our software gracefully degrades making sure it is useful even on older or less capable web clients (browsers), the industry terms for this approach are: - [Progressive enhancement](http://en.wikipedia.org/wiki/Progressive_enhancement "Progressive enhancement") - [Unobtrusive JavaScript](http://en.wikipedia.org/wiki/Unobtrusive_JavaScript) - [Responsive Design](http://en.wikipedia.org/wiki/Responsive_Web_Design "Responsive Web Design") -All these terms in general recommends aiming for the minimum standard first, and enhance with additional features/styling if the client is capable of doing so. In essence this allows eZ Platform to be "Mobile first" if the design allows for it, which is recommended. But eZ Platform should always also be fully capable of having different sets of web presentations for different devices using one or several sets of SiteAccess matching rules for the domain, port or URI, so any kind of device detection can be used together with eZ Platform, making it fully possible to write for instance [WAP](http://en.wikipedia.org/wiki/Wireless_Application_Protocol) based websites and interfaces on top of eZ Platform. +All these terms in general recommends aiming for the minimum standard first, and enhance with additional features/styling if the client is capable of doing so. In essence this allows [[= product_name_oss =]] to be "Mobile first" if the design allows for it, which is recommended. But [[= product_name_oss =]] should always also be fully capable of having different sets of web presentations for different devices using one or several sets of SiteAccess matching rules for the domain, port or URI, so any kind of device detection can be used together with [[= product_name_oss =]], making it fully possible to write for instance [WAP](http://en.wikipedia.org/wiki/Wireless_Application_Protocol) based websites and interfaces on top of [[= product_name_oss =]]. ### WEB Forms/Ajax @@ -84,7 +84,7 @@ Admin operations that can have a severe impact on the web applications should re ### Public API -The [Public PHP API](../api/public_php_api) provided in eZ Platform is in most cases in charge of checking permissions to data for you, but some API's are not documented to throw `UnauthorizedException`, which means that it is the consumer of the API's who is responsible for checking permissions. +The [Public PHP API](../api/public_php_api) provided in [[= product_name_oss =]] is in most cases in charge of checking permissions to data for you, but some API's are not documented to throw `UnauthorizedException`, which means that it is the consumer of the API's who is responsible for checking permissions. The following example shows how this is done in the case of loading users: diff --git a/docs/community_resources/documentation.md b/docs/community_resources/documentation.md index 25bdf360cb..6e158a819d 100644 --- a/docs/community_resources/documentation.md +++ b/docs/community_resources/documentation.md @@ -4,7 +4,7 @@ While we are doing our best to make sure our documentation fulfills all your nee ## How to contribute to documentation -This documentation is written on GitHub and generated into a static site. It is organized in branches. Each branch is a version of documentation (which in turn corresponds to a version of eZ Platform). +This documentation is written on GitHub and generated into a static site. It is organized in branches. Each branch is a version of documentation (which in turn corresponds to a version of [[= product_name_oss =]]). If you are familiar with the git workflow, you will find it easy to contribute. Please create a Pull Request for any, even the smallest change you want to suggest. diff --git a/docs/community_resources/installing-on-mac-os-and-windows.md b/docs/community_resources/installing-on-mac-os-and-windows.md index 2d8652eaf2..d527af6fe1 100644 --- a/docs/community_resources/installing-on-mac-os-and-windows.md +++ b/docs/community_resources/installing-on-mac-os-and-windows.md @@ -1,17 +1,17 @@ -# Install eZ Platform on macOS or Windows +# Install [[= product_name_oss =]] on macOS or Windows -This page explains how to install eZ Platform on macOS or Windows. +This page explains how to install [[= product_name_oss =]] on macOS or Windows. !!! caution This procedure is **for development purposes only**. - Installing eZ Platform for production purposes is supported only on Linux. + Installing [[= product_name_oss =]] for production purposes is supported only on Linux. - If you want to use eZ Platform in the production environment, see [Installing eZ Platform](../getting_started/install_ez_platform.md). + If you want to use [[= product_name_oss =]] in the production environment, see [Installing [[= product_name_oss =]]](../getting_started/install_ez_platform.md). ### Prepare work environment -To install eZ Platform, you need a stack with MySQL and PHP. +To install [[= product_name_oss =]], you need a stack with MySQL and PHP. Additionally, you need [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/lang/en/docs/install/) for asset management. If you want to use a web server, you need to install it as well: @@ -71,9 +71,9 @@ The instructions below assumes you are using Apache. Download and run [Composer-Setup.exe](https://getcomposer.org/Composer-Setup.exe) - it will install the latest Composer version. -## Download eZ Platform +## Download [[= product_name_oss =]] -Download and extract an archive into the location where you want your project root directory to be from [ezplatform.com](https://ezplatform.com/#download-option) (for open-source version) or from the [Support portal](https://support.ez.no/Downloads) (for eZ Enterprise), or clone the [GitHub repository](https://github.com/ezsystems/ezplatform): +Download and extract an archive into the location where you want your project root directory to be from [ezplatform.com](https://ezplatform.com/#download-option) (for open-source version) or from the [Support portal](https://support.ez.no/Downloads) (for [[= product_name_ee =]]), or clone the [GitHub repository](https://github.com/ezsystems/ezplatform): ``` bash git clone https://github.com/ezsystems/ezplatform . @@ -84,7 +84,7 @@ git clone https://github.com/ezsystems/ezplatform . You can use any other folder name for your project in place of `ezplatform`. Set its location as your project root directory in your virtual host configuration. -To install Composer dependencies, from the folder into which you downloaded eZ Platform, run: +To install Composer dependencies, from the folder into which you downloaded [[= product_name_oss =]], run: ``` bash composer install @@ -135,11 +135,11 @@ To manually create a database, ensure that you [changed the installation paramet php ./bin/console doctrine:database:create ``` -## Install eZ Platform +## Install [[= product_name_oss =]] Before executing the following command, ensure that the user set during `composer install` has sufficient permissions. -Install eZ Platform by running: +Install [[= product_name_oss =]] by running: ``` bash composer ezplatform-install @@ -152,7 +152,7 @@ composer ezplatform-install ## Set up virtual host -To set up virtual host, use the template provided with eZ Platform: `/doc/apache2/vhost.template`. +To set up virtual host, use the template provided with [[= product_name_oss =]]: `/doc/apache2/vhost.template`. Copy the virtual host template under the name `.conf` into your Apache directory: diff --git a/docs/community_resources/package_structure.md b/docs/community_resources/package_structure.md index 5a1ac09752..10a6ae0170 100644 --- a/docs/community_resources/package_structure.md +++ b/docs/community_resources/package_structure.md @@ -9,7 +9,7 @@ The following conventions apply to contributions to Ibexa core code, not to thir ## Root PHP namespace -Define eZ Platform by Ibexa core PHP code in a namespace with the following prefix: +Define [[= product_name_oss =]] core PHP code in a namespace with the following prefix: ```php namespace Ibexa\Platform; diff --git a/docs/community_resources/release_process.md b/docs/community_resources/release_process.md index aa16000e10..16ce6e3b14 100644 --- a/docs/community_resources/release_process.md +++ b/docs/community_resources/release_process.md @@ -1,27 +1,27 @@ -# eZ Platform release process and roadmap +# [[= product_name_oss =]] release process and roadmap ## Release process -eZ Platform has two distributions: +[[= product_name_oss =]] has three distributions: -- eZ Platform is an open source Content Management System (CMS) developed by Ibexa together with the open source community. eZ Platform's code base is available on GitHub under the GPLv2 license. eZ Platform comes with no commercial support and maintenance services. It is supported by the community on public channels. -- eZ Platform Enterprise Edition (EE) is commercial software available under eZ Business User License (BUL) to eZ Enterprise subscribers. It is comprised of eZ Platform Open Source edition, additional enterprise support and maintenance services, as well as additional features which are not available in the open source software. +- [[= product_name_oss =]] is an open source Content Management System (CMS) developed by Ibexa together with the open source community. [[= product_name_oss =]]'s code base is available on GitHub under the GPLv2 license. [[= product_name_oss =]] comes with no commercial support and maintenance services. It is supported by the community on public channels. +- [[= product_name_ee =]] is commercial software available under eZ Business User License (BUL) to [[= product_name_ee =]] subscribers. It is comprised of [[= product_name_oss =]], additional enterprise support and maintenance services, as well as additional features which are not available in the open source software. -We manage the release of eZ Platform using an agile iterative process and a continuous software development model, which is why we provide two kinds of eZ Platform releases: +We manage the release of [[= product_name_oss =]] using an agile iterative process and a continuous software development model, which is why we provide two kinds of [[= product_name_oss =]] releases: -- Long Term Support releases (LTS) which are supported by Ibexa for a long period of time (see [support lifecycle below](#support-lifecycle)), for eZ Enterprise subscribers. -- Fast Track releases (FT) give access to the latest features and are supported for a short period of time. They are maintained only until the next FT release is introduced. These are supported for both the open source community and eZ Enterprise subscribers. +- Long Term Support releases (LTS) which are supported by Ibexa for a long period of time (see [support lifecycle below](#support-lifecycle)), for [[= product_name_ee =]] subscribers. +- Fast Track releases (FT) give access to the latest features and are supported for a short period of time. They are maintained only until the next FT release is introduced. These are supported for both the open source community and [[= product_name_ee =]] subscribers. FT releases are tailored for those who want to stay up-to-date with newest functionalities, while LTS releases are suitable for highly stable enterprise rollouts. -We usually release eZ Platform four times a year following the seasons (winter, spring, summer and fall). This usually includes one LTS release and three FT releases. +We usually release [[= product_name_oss =]] four times a year following the seasons (winter, spring, summer and fall). This usually includes one LTS release and three FT releases. ## Versioning conventions -Both eZ Platform editions use [semantic versioning](http://semver.org/). +Both [[= product_name_oss =]] editions use [semantic versioning](http://semver.org/). -The version number of eZ Platform and all its internal components follows the semantic versioning conventions: vX.Y.Z. +The version number of [[= product_name_oss =]] and all its internal components follows the semantic versioning conventions: vX.Y.Z. - Changes to X indicate breaking changes. They usually concern mostly internal things, but developers should check in our change logs if they need to adjust their code to continue using the API or features. If there are larger breaks (like the new Back Office in v2), this is announced well in advance of the upcoming release. - Y represents new features and functionalities. @@ -29,8 +29,8 @@ The version number of eZ Platform and all its internal components follows the se Distribution files of our two editions are as follows: -- for eZ Platform: ezplatform-vX.Y.Z.tgz -- for eZ Platform Enterprise: ezplatformenterprise-vX.Y.Z.tgz +- for [[= product_name_oss =]]: ezplatform-vX.Y.Z.tgz +- for [[= product_name_ee =]]: ezplatformenterprise-vX.Y.Z.tgz ## Support lifecycle @@ -40,7 +40,7 @@ This means there is need for software maintenance services to provide bug fixes As our products constantly provide new features and possibilities, our documentation and user forums may not always be able to provide an answer to all questions that may arise. That is why our support and consulting professional services teams are available to assist -as part of an eZ Enterprise subscription or as part of a specific statement of work. +as part of an [[= product_name_ee =]] subscription or as part of a specific statement of work. [Contact our Sales team](https://ez.no/Forms/Request-a-Consultation) for more information. Over time, existing product versions mature and new versions become the center of attention for customers looking for the latest features. diff --git a/docs/community_resources/report_follow_issues.md b/docs/community_resources/report_follow_issues.md index 4d8949beea..92ef22dc09 100644 --- a/docs/community_resources/report_follow_issues.md +++ b/docs/community_resources/report_follow_issues.md @@ -36,7 +36,7 @@ This way you can get and provide feedback during the issue's life. You are also ## How to report an issue -!!! enterprise "Issues in eZ Platform Enterprise Edition" +!!! dxp "Issues in [[= product_name_ee =]]" If you have an Enterprise subscription, report your issues through the [support portal](https://support.ez.no) instead of JIRA. This ensures the issue can be quickly prioritized according to its impact. diff --git a/docs/community_resources/resources.md b/docs/community_resources/resources.md index bd09d5743a..f686f0e6d3 100644 --- a/docs/community_resources/resources.md +++ b/docs/community_resources/resources.md @@ -2,17 +2,17 @@ ### Let's Connect! -In the course of its development eZ Platform has been deeply rooted in its community. This remains true, with many invaluable contributions by dedicated community members who play a key role in the continuous development of eZ Platform.  +In the course of its development [[= product_name_oss =]] has been deeply rooted in its community. This remains true, with many invaluable contributions by dedicated community members who play a key role in the continuous development of [[= product_name_oss =]].  eZ partners, customers, independent developers, designers, and digital content enthusiasts can contribute to important web projects, influence the [eZ roadmap](https://doc.ez.no/display/MAIN/eZ+Platform+Release+Process+and+Roadmap), and ensure the platform stays on top of market trends and organizations' needs. -This section provides information about the benefits you can draw from the community and about how you can contribute to eZ Platform's development yourself. +This section provides information about the benefits you can draw from the community and about how you can contribute to [[= product_name_oss =]]'s development yourself. - ** - The Developer Hub**, - the best place to start for all things eZ Platform! + the best place to start for all things [[= product_name_oss =]]! - Downloads - Developer Blog -- **[eZ Community Slack team](http://ez-community-on-slack.herokuapp.com/)**, the place to discuss eZ Platform with Community members, developers, and other like-minded individuals. +- **[eZ Community Slack team](http://ez-community-on-slack.herokuapp.com/)**, the place to discuss [[= product_name_oss =]] with Community members, developers, and other like-minded individuals. - **[ibexa.co](http://ibexa.co) - The corporate website for Ibexa**, here you can find overviews of the products, contact information, and a wealth of additional [resources](http://ez.no/Resources/) such as use cases, webinars and e-books. - [eZ Blog](http://ez.no/Blog) - Current insights from the eZ world. diff --git a/docs/community_resources/support_maintenance_faq.md b/docs/community_resources/support_maintenance_faq.md index dd7784a596..d73e8a0979 100644 --- a/docs/community_resources/support_maintenance_faq.md +++ b/docs/community_resources/support_maintenance_faq.md @@ -5,7 +5,7 @@ as well as references to important parts of the documentation and tools useful f #### What information should I specify when creating a Customer Support ticket? -When reporting a problem to Customer Support the most important information is the version of eZ Platform which is used in the project. +When reporting a problem to Customer Support the most important information is the version of [[= product_name_oss =]] which is used in the project. The best way to specify it is to provide the list of currently installed packages by running: ``` bash @@ -24,7 +24,7 @@ related to the code which generates the problem. #### What are the recommended ways to increase my project's performance? -The most important clues around increasing overall performance of your eZ Platform-based project can be found in [the Performance documentation page](../guide/performance.md). +The most important clues around increasing overall performance of your [[= product_name_oss =]]-based project can be found in [the Performance documentation page](../guide/performance.md). #### How can I translate my Back Office? @@ -34,7 +34,7 @@ Once you have language packages installed, you can switch the language of the Ba If you do not have a language defined in the browser, it will be selected based on the `parameters.locale_fallback` parameter located in `config/packages/ezplatform.yaml`. -To read more about language managing in eZ Platform, see the following doc pages: +To read more about language managing in [[= product_name_oss =]], see the following doc pages: - [Back Office languages](../guide/internationalization/#back-office-languages) - [Multi-language SiteAccesses and corresponding translations](../guide/multi_language_siteaccesses.md) @@ -107,7 +107,7 @@ You can also place it in `config/landing_page_blocks.yaml`, which should be impo - { resource: ../landing_page_blocks.yaml } ``` -#### How can I implement authentication in an eZ Platform-based project? +#### How can I implement authentication in an [[= product_name_oss =]]-based project? The best approach is to use Symfony authentication. Check [development security](../guide/security.md) page for more detailed instructions. diff --git a/docs/community_resources/translations.md b/docs/community_resources/translations.md index 6ecbe513d3..30d3797714 100644 --- a/docs/community_resources/translations.md +++ b/docs/community_resources/translations.md @@ -1,6 +1,6 @@ # Contribute translations -If you'd like to see eZ Platform in your language, you can contribute to the translations. +If you'd like to see [[= product_name_oss =]] in your language, you can contribute to the translations. [`ezplatform-i18n`](https://github.com/ezsystems/ezplatform-i18n) contains the XLIFF files providing translations. You can use an XLIFF editor of your choice to contribute strings in your language. @@ -30,11 +30,11 @@ Right-click your browser's bookmark bar, and create a new bookmark as shown in t **URL**: `javascript:function hasInContextCookie(){ return document.cookie.match(/^(.*;)?\s*ez_in_context_translation\s*=\s*[^;]+(.*)?$/);}(function () { document.cookie = hasInContextCookie() ? document.cookie = 'ez_in_context_translation=;expires=Mon, 05 Jul 2000 00:00:00 GMT;path=/;': document.cookie='ez_in_context_translation=1;path=/;'; location.reload()})()` -Enter Back Office. While on the page clicking this bookmark will turn on and off in-context translation for eZ Platform interface. +Enter Back Office. While on the page clicking this bookmark will turn on and off in-context translation for [[= product_name_oss =]] interface. ### Using console -To enable in-context translation you need to create Crowdin account and join [eZ Platform project](https://crowdin.com/project/ezplatform). To start translating access (eZ Platform credentials: admin / publish). Select `Inspect` or `Inspect Element` from context menu. In Console tab type: `document.cookie='ez_in_context_translation=1;path=/;'; location.reload();`. Page will reload and you will be able to choose a language to which you want to translate eZ Platform. +To enable in-context translation you need to create Crowdin account and join [[[= product_name_oss =]] project](https://crowdin.com/project/ezplatform). To start translating access ([[= product_name_oss =]] credentials: admin / publish). Select `Inspect` or `Inspect Element` from context menu. In Console tab type: `document.cookie='ez_in_context_translation=1;path=/;'; location.reload();`. Page will reload and you will be able to choose a language to which you want to translate [[= product_name_oss =]]. Strings in the interface that can be translated will be outlined in red (untranslated), blue (translated) or green (approved). When moving over them, an edit button will show up on the top left corner of the outline. Click on it, and edit the string in the window that shows up. @@ -42,13 +42,13 @@ Strings in the interface that can be translated will be outlined in red (untrans #### Troubleshooting -Make sure you clear your browser's cache in addition to eZ Platform's. Some of the translation resources use aggressive HTTP cache. +Make sure you clear your browser's cache in addition to [[= product_name_oss =]]'s. Some of the translation resources use aggressive HTTP cache. ## Translating outside in-context -If you prefer not to use in-context, simply visit [eZ Platform's Crowdin page](https://crowdin.com/project/ezplatform), choose a language and you will see a list of files containing strings. Here you can suggest your translations. +If you prefer not to use in-context, simply visit [[[= product_name_oss =]]'s Crowdin page](https://crowdin.com/project/ezplatform), choose a language and you will see a list of files containing strings. Here you can suggest your translations. -If the language you want to translate to is not available, you can ask for it to be added in the [Crowdin discussion forum for eZ Platform](https://crowdin.com/project/ezplatform/discussions). +If the language you want to translate to is not available, you can ask for it to be added in the [Crowdin discussion forum for [[= product_name_oss =]]](https://crowdin.com/project/ezplatform/discussions). ## Install new translation package @@ -70,7 +70,7 @@ For example, if you want to translate your application into French, you just hav and then clear the cache. -Now you can reload your eZ Platform administration page which will be translated in French (if your browser is configured to fr\_FR.) +Now you can reload your [[= product_name_oss =]] administration page which will be translated in French (if your browser is configured to fr\_FR.) ## Full translation workflow diff --git a/docs/css/custom.css b/docs/css/custom.css index 9931b9efea..c199b88085 100644 --- a/docs/css/custom.css +++ b/docs/css/custom.css @@ -221,8 +221,9 @@ html .md-footer-meta.md-typeset a { border: .4rem solid; } -/* Enterprise */ +/* DXP */ +.admonition.dxp .admonition-title, .admonition.enterprise .admonition-title { padding-left: 1.2rem; } @@ -231,6 +232,7 @@ html .md-footer-meta.md-typeset a { padding-left: 3.8rem; } +.admonition.dxp, .admonition.dxp>.admonition-title, .admonition.enterprise, .admonition.enterprise>.admonition-title { border-color: var(--enterprise-border); background-color: #ffffff; @@ -258,7 +260,8 @@ html .md-footer-meta.md-typeset a { } .md-typeset .admonition.note>.admonition-title:before, .md-typeset .admonition.tip>.admonition-title:before, -.md-typeset .admonition.caution>.admonition-title:before, .md-typeset .admonition.enterprise>.admonition-title:before, +.md-typeset .admonition.caution>.admonition-title:before, .md-typeset .admonition.dxp>.admonition-title:before, +.md-typeset .admonition.enterprise>.admonition-title:before, .md-typeset details.note>summary:before, .md-typeset details.tip>summary:before, .md-typeset details.caution>summary:before { content: ""; } @@ -276,7 +279,8 @@ html .md-footer-meta.md-typeset a { } .md-typeset .admonition.note>.admonition-title, .md-typeset .admonition.tip>.admonition-title, -.md-typeset .admonition.caution>.admonition-title, .md-typeset .admonition.enterprise>.admonition-title, +.md-typeset .admonition.caution>.admonition-title, .md-typeset .admonition.dxp>.admonition-title, +.md-typeset .admonition.enterprise>.admonition-title, .md-typeset details.tip>summary, .md-typeset details.note>summary, .md-typeset details.caution>summary { background-repeat: no-repeat; background-size: 24px; @@ -288,7 +292,8 @@ html .md-footer-meta.md-typeset a { /* General admonitions */ .md-typeset .admonition.caution>.admonition-title, .md-typeset .admonition.note>.admonition-title, -.md-typeset .admonition.tip>.admonition-title, .md-typeset .admonition.enterprise>.admonition-title, +.md-typeset .admonition.tip>.admonition-title, .md-typeset .admonition.dxp>.admonition-title, +.md-typeset .admonition.enterprise>.admonition-title, .md-typeset details.tip, .md-typeset details.tip>summary, .md-typeset details.note, .md-typeset details.note>summary { background-color: #ffffff; diff --git a/docs/extending/creating_custom_dropdowns.md b/docs/extending/creating_custom_dropdowns.md index a262c51ad7..78c0f93699 100644 --- a/docs/extending/creating_custom_dropdowns.md +++ b/docs/extending/creating_custom_dropdowns.md @@ -1,6 +1,6 @@ # Creating custom drop-downs -In eZ Platform, you can implement custom drop-downs anywhere in the Back Office. +In [[= product_name_oss =]], you can implement custom drop-downs anywhere in the Back Office. Follow the steps below to learn how to integrate this component to fit it to your project needs. ## Prepare custom dropdown structure diff --git a/docs/extending/custom_fieldtype_comparison.md b/docs/extending/custom_fieldtype_comparison.md index 0e5fa78e2b..b08fbb2ca7 100644 --- a/docs/extending/custom_fieldtype_comparison.md +++ b/docs/extending/custom_fieldtype_comparison.md @@ -1,6 +1,6 @@ # Creating custom version comparison of Field Types -!!! enterprise +!!! dxp In the Back Office, you can compare the contents of Fields. Comparing is possible only between two versions of the same Field that are in the same language. diff --git a/docs/extending/custom_icons.md b/docs/extending/custom_icons.md index e245f28349..1244c31aef 100644 --- a/docs/extending/custom_icons.md +++ b/docs/extending/custom_icons.md @@ -2,8 +2,8 @@ ## Custom Content Type icons -To add custom icons for existing Content Types or custom Content Types in eZ Platform, follow the instructions below. -For more information on icons used in eZ Platform, see [the Icons section](../guidelines/resources/icons.md). +To add custom icons for existing Content Types or custom Content Types in [[= product_name_oss =]], follow the instructions below. +For more information on icons used in [[= product_name_oss =]], see [the Icons section](../guidelines/resources/icons.md). ### Configuration @@ -66,4 +66,4 @@ return ( ) -``` \ No newline at end of file +``` diff --git a/docs/extending/customizing_calendar.md b/docs/extending/customizing_calendar.md index b6bd14854d..e84adc7f20 100644 --- a/docs/extending/customizing_calendar.md +++ b/docs/extending/customizing_calendar.md @@ -1,6 +1,6 @@ # Customizing Calendar widget -!!! enterprise +!!! dxp By default, the Calendar widget enables you to display all scheduled events and perform basic actions on them. You can also configure it to display your custom event types or display them from [custom sources](#configuring-event-sources). diff --git a/docs/extending/drag_and_drop.md b/docs/extending/drag_and_drop.md index 83c2bc1cea..8459d3d691 100644 --- a/docs/extending/drag_and_drop.md +++ b/docs/extending/drag_and_drop.md @@ -1,6 +1,6 @@ # Creating drag and drop interface -In eZ Platform, you can create a generic interface for drag and drop interactions reusable in many places. +In [[= product_name_oss =]], you can create a generic interface for drag and drop interactions reusable in many places. First, prepare the HTML code structure that will be placed in a Twig template in the following way: diff --git a/docs/extending/extending_form_builder.md b/docs/extending/extending_form_builder.md index d6788637aa..1e1b498991 100644 --- a/docs/extending/extending_form_builder.md +++ b/docs/extending/extending_form_builder.md @@ -1,6 +1,6 @@ # Extending Form Builder -!!! enterprise +!!! dxp ## Existing Form fields diff --git a/docs/extending/extending_multifile_upload.md b/docs/extending/extending_multifile_upload.md index 2954e1ade7..3acd872d17 100644 --- a/docs/extending/extending_multifile_upload.md +++ b/docs/extending/extending_multifile_upload.md @@ -1,6 +1,6 @@ # Extending Multi-file Upload -The Multi-file Upload module is meant to be used as a part of editorial interface of eZ Platform. +The Multi-file Upload module is meant to be used as a part of editorial interface of [[= product_name_oss =]]. It provides an interface to publish content based on dropped files while uploading them in the interface. !!! caution diff --git a/docs/extending/extending_online_editor.md b/docs/extending/extending_online_editor.md index 4a53e0707d..8a78eea175 100644 --- a/docs/extending/extending_online_editor.md +++ b/docs/extending/extending_online_editor.md @@ -2,7 +2,7 @@ The Online Editor is based on [Alloy Editor](https://alloyeditor.com/). Refer to [Alloy Editor documentation](https://alloyeditor.com/docs/develop/) to learn how to extend the Online Editor with new elements. -To learn how to extend the eZ Platform Back Office follow [Extending Admin UI tutorial](../../tutorials/extending_admin_ui/extending_admin_ui). +To learn how to extend the [[= product_name_oss =]] Back Office follow [Extending Admin UI tutorial](../../tutorials/extending_admin_ui/extending_admin_ui). !!! note @@ -136,7 +136,7 @@ You can only use inline custom tags in the `text` toolbar. #### Link tag You can also configure a custom tag with a `link` attribute that offers a basic UI with text input. -It is useful when migrating from eZ Publish to eZ Platform. +It is useful when migrating from eZ Publish to [[= product_name_oss =]]. The configuration in `app/config/custom_tags.yml` is: diff --git a/docs/extending/extending_page.md b/docs/extending/extending_page.md index 114470d3a4..2c51f2200e 100644 --- a/docs/extending/extending_page.md +++ b/docs/extending/extending_page.md @@ -1,6 +1,6 @@ # Creating custom Page blocks -!!! enterprise +!!! dxp To create an Example Page block, use the following YAML configuration in an application or a bundle, under the `ezplatform_page_fieldtype` key, e.g. in `config/packages/ezplatform_page_fieldtype.yaml`: @@ -365,7 +365,7 @@ Some blocks can have slightly more complex configuration. An example is the Collection block, which requires an `options` key. This key defines which Content Types can be added to it. - See [this example from the eZ Enterprise Demo](https://github.com/ezsystems/ezplatform-ee-demo/blob/master/config/packages/default_layouts.yml#L186): + See [this example from the Demo](https://github.com/ezsystems/ezplatform-ee-demo/blob/master/config/packages/default_layouts.yml#L186): ``` yaml blocks: diff --git a/docs/extending/extending_subitems_list.md b/docs/extending/extending_subitems_list.md index 06f737adbe..cc5c43598d 100644 --- a/docs/extending/extending_subitems_list.md +++ b/docs/extending/extending_subitems_list.md @@ -1,6 +1,6 @@ # Extending Sub-items List -The Sub-items List module is meant to be used as a part of the editorial interface of eZ Platform. +The Sub-items List module is meant to be used as a part of the editorial interface of [[= product_name_oss =]]. It provides an interface for listing the sub-items of any Location. !!! caution diff --git a/docs/extending/extending_udw.md b/docs/extending/extending_udw.md index 2afddf7403..59e775fd24 100644 --- a/docs/extending/extending_udw.md +++ b/docs/extending/extending_udw.md @@ -99,7 +99,7 @@ General configuration for tabs e.g. browse, search, bookmarks etc. UDW configuration is SiteAccess-aware. For each defined SiteAccess, you need to be able to use the same configuration tree in order to define SiteAccess-specific config. These settings need to be mapped to SiteAccess-aware internal parameters that you can retrieve via the ConfigResolver. -For more information on ConfigResolver, see [eZ Platform dynamic configuration basics](../guide/config_dynamic.md#configresolver). +For more information on ConfigResolver, see [[[= product_name_oss =]] dynamic configuration basics](../guide/config_dynamic.md#configresolver). ### Example configuration diff --git a/docs/extending/extending_workflow.md b/docs/extending/extending_workflow.md index a1b82278fa..5ebcda0491 100644 --- a/docs/extending/extending_workflow.md +++ b/docs/extending/extending_workflow.md @@ -1,6 +1,6 @@ # Extending Workflow -!!! enterprise +!!! dxp ## Adding custom actions diff --git a/docs/extending/online_editor_button.md b/docs/extending/online_editor_button.md index 9c90fe0cb1..a594bd10e2 100644 --- a/docs/extending/online_editor_button.md +++ b/docs/extending/online_editor_button.md @@ -77,7 +77,7 @@ eZConfigManager.add({ ## Adding the button to configuration -Finally, add the button to your eZ Platform configuration: +Finally, add the button to your [[= product_name_oss =]] configuration: ``` yaml ezplatform: diff --git a/docs/extending/online_editor_plugin.md b/docs/extending/online_editor_plugin.md index 9224c2304b..cc9cddb2cc 100644 --- a/docs/extending/online_editor_plugin.md +++ b/docs/extending/online_editor_plugin.md @@ -103,7 +103,7 @@ This file loads the plugin and button files when loading Online Editor. ## Adding the plugin to configuration -Finally, add the plugin and its button to your eZ Platform configuration: +Finally, add the plugin and its button to your [[= product_name_oss =]] configuration: ``` yaml ezplatform: diff --git a/docs/extending/richtext_block.md b/docs/extending/richtext_block.md index 86f90d7fd8..8935c6e361 100644 --- a/docs/extending/richtext_block.md +++ b/docs/extending/richtext_block.md @@ -1,6 +1,6 @@ # Creating custom RichText blocks -!!! enterprise +!!! dxp To create a RichText [custom Page block](extending_page.md), you need to define its layout, provide templates, add a subscriber and register it as a service. diff --git a/docs/getting_started/bundles_starter_pack.md b/docs/getting_started/bundles_starter_pack.md index fb448c636b..1f6d278175 100644 --- a/docs/getting_started/bundles_starter_pack.md +++ b/docs/getting_started/bundles_starter_pack.md @@ -1,16 +1,16 @@ # Bundles starter pack -eZ Platform follows the [Symfony 5 bundle system](http://symfony.com/doc/5.0/book/bundles.html). +[[= product_name_oss =]] follows the [Symfony 5 bundle system](http://symfony.com/doc/5.0/book/bundles.html). Clean installation comes with set of built-in packages which you can preview in [composer.json](https://github.com/ezsystems/ezplatform/blob/v3.0.0/composer.json). -For more information about eZ Platform bundle structure, see [Bundle section](../guide/bundles.md) in our Guide. +For more information about [[= product_name_oss =]] bundle structure, see [Bundle section](../guide/bundles.md) in our Guide. ## External packages If basic bundles do not give you enough flexibility or functionalities, you can extend your project with external packages. They provide additional ways of customizing your installation, and can help you with content management, further development, integrations, security, social engagement, and system management. -You can easily browse the external bundles and download them from [eZ Platform Packages](https://ezplatform.com/packages). +You can easily browse the external bundles and download them from [[[= product_name_oss =]] Packages](https://ezplatform.com/packages). Refer to their respective pages for instructions on how to install them. ## Contributors @@ -18,12 +18,3 @@ Refer to their respective pages for instructions on how to install them. |Bundle|Description| |------|-----------| |[RepositoryProfilerBundle](https://github.com/ezsystems/RepositoryProfilerBundle)| profiles Platform API/SPI and sets up scenarios to be able to continuously test to keep track of performance regressions of repository and underlying storage engines| - -## Educational - -These bundles are not necessarily something you would install, but they are useful for learning process: - -|Bundle|Description| -|------|-----------| -|[ezplatform-com](https://github.com/ezsystems/ezplatform-com)|the Ibexa Developer Hub for the Open Source PHP CMS eZ Platform (example site)| -|[ezplatform-ee-demo](https://github.com/ezsystems/ezplatform-ee-demo)|fork of the "ezplatform-ee" meta repository, contains changes necessary to enable eZ Platform Enterprise Edition Demo. Not recommended for a clean install for new projects, but great for observation and learning (example site)| diff --git a/docs/getting_started/first_steps.md b/docs/getting_started/first_steps.md index e9671854c5..aa09d82c04 100644 --- a/docs/getting_started/first_steps.md +++ b/docs/getting_started/first_steps.md @@ -1,12 +1,12 @@ # First steps -This page lists first steps you can take after installing eZ Platform. +This page lists first steps you can take after installing [[= product_name_oss =]]. These are most common actions you may need to take in a new installation. !!! tip "Beginner tutorial" To go through a full tutorial that leads from a clean installation to creating a full site, - see [Building a bicycle route tracker in eZ Platform](../tutorials/platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md). + see [Building a bicycle route tracker in [[= product_name_oss =]]](../tutorials/platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md). ## Remove welcome page diff --git a/docs/getting_started/install_ez_enterprise.md b/docs/getting_started/install_ez_enterprise.md deleted file mode 100644 index 00fe9eae49..0000000000 --- a/docs/getting_started/install_ez_enterprise.md +++ /dev/null @@ -1,129 +0,0 @@ -# Install eZ Enterprise - -This page describes how to gain access to commercial packages and security releases -when installing eZ Platform Enterprise Edition and eZ Commerce. -They are available via [updates.ez.no](https://updates.ez.no). - -!!! enterprise - - To install eZ Enterprise, start with the procedure described in [Install eZ Platform](install_ez_platform.md). - Because you do not have access to the Enterprise GitHub repositories, - you need to [download an archive](install_ez_platform.md#a-download-ez-platform) from the Support Portal, or follow instructions below in order to use `composer create-project`. - - When dealing with software from updates.ez.no, you need to take care of [channels](#select-correct-updatesezno-channels) and [authentication](#set-up-authentication-tokens): - - ## Select correct updates.ez.no channel(s) - - The following channels are available: - - - Trial (limited access to try for up to 120 days): - - [ttl](https://updates.ez.no/ttl/) eZ Platform Enterprise Trial packages - - [ttl_com](https://updates.ez.no/ttl_com/) eZ Commerce Trial packages - - Enterprise Business User License (requires valid subscription): - - [bul](https://updates.ez.no/bul/) available with an eZ Platform Enterprise subscription - - [bul_com](https://updates.ez.no/bul_com/) available with an eZ Commerce subscription - - Once you have set up authentication below, the links above give you access to see the available packages and releases. - - ## Set up authentication tokens - - eZ Enterprise subscribers have access to commercial packages at [updates.ez.no/bul/](https://updates.ez.no/bul/). - The site is password-protected. You will need to set up authentication tokens to get access to it. - - Log in to your service portal on [support.ez.no](https://support.ez.no), go to your **Service Portal**, and look for the following on the **Maintenance and Support agreement details** screen: - - ![Authentication token](img/Using_Composer_Auth_token.png) - - 1. Select **Create token** (this requires the **Portal administrator** access level). - 2. Fill in a label describing the use of the token. This will allow you to revoke access later. - 3. Save the password, **you will not get access to it again**! - - !!! tip "Save authentication token in `auth.json` to avoid repeatedly typing it" - - Composer will ask to do this for you on updates. - If you decline, you can create an `auth.json` file manually in one of the following ways: - - - A: Store your credentials in the project directory (for security reasons do not check it in to git): - - ``` bash - composer config http-basic.updates.ez.no - ``` - - - B: If you only have one project on the machine/server/vm, and want to install globally in [`COMPOSER_HOME`](https://getcomposer.org/doc/03-cli.md#composer-home) directory for machine-wide use: - - ``` bash - composer config --global http-basic.updates.ez.no - ``` - - !!! note "eZ Platform Cloud" - - If you are using Platform.sh, you can set the token as an environment variable. - - When you do, make sure the **Visible during runtime** box in Platform.sh configuration is unchecked. - This will ensure that the token is not exposed. - - ![Setting token to be invisible during runtime](img/psh_addvariable.png) - - After this, when running Composer to get updates, you will be asked for a username and password. Use: - - - as username – your Installation key found on the **Maintenance and Support agreement details** page in the service portal - - as password – the token password you retrieved in step 3. - - !!! note "Authentication token validation delay" - - You can encounter some delay between creating the token and being able to use it in Composer. It might take up to 15 minutes. - - !!! note "Support agreement expiry" - - If your Support agreement expires, your authentication token(s) will no longer work. - They will become active again if the agreement is renewed, but this process may take up to 24 hours. - _(If the agreement is renewed before the expiry date, there will be no disruption of service.)_ - - ## Create project - - In order to install a new project using `composer create-project` to get latest version of eZ Enterprise, - you'll need to tell Composer which token to use before the project folder is created in the first place. - This can be done in the following way: - - ``` bash - COMPOSER_AUTH='{"http-basic":{"updates.ez.no":{"username":"","password":""}}}' composer create-project --keep-vcs --repository=https://updates.ez.no/bul/ ezsystems/ezplatform-ee my-new-ee-project - ``` - - !!! tip "Usage of authentication token with `composer create-project`" - - If you have several projects set up on your machine, - they should all use different tokens set in `auth.json` file in project directory. - - !!! note "Moving from trial" - - If you started with a trial installation, you should [adjust the channel(s)](#edit-composerjson) you use in order to get software under [BUL license instead of a TTL license](https://ez.no/About-our-Software/Licenses-and-agreements/). - - ## Edit composer.json - - Edit `composer.json` in your project root and change the URL defined in the `repositories` section to point to the `bul*` URLs listed above. - Once that is done, you can execute `composer update` to get packages with the correct license. - - !!! note - - You can now refer back to [Installing eZ Platform](install_ez_platform.md#change-installation-parameters) for finishing steps of the installation process. - - ## Enable Date-based Publisher - - To enable delayed publishing of Content using the Date-based Publisher, you need to set up cron to run the command `bin/console ezplatform:scheduled:run` periodically. - - For example, to check for publishing every minute, add the following script: - - `echo '* * * * * cd [path-to-ezplatform]; php bin/console ezplatform:cron:run --quiet --env=prod' > ezp_cron.txt` - - For 5-minute intervals: - - `echo '*/5 * * * * cd [path-to-ezplatform]; php bin/console ezplatform:cron:run --quiet --env=prod' > ezp_cron.txt` - - Next, append the new cron to user's crontab without destroying existing crons. - Assuming the web server user data is `www-data`: - - `crontab -u www-data -l|cat - ezp_cron.txt | crontab -u www-data -` - - Finally, remove the temporary file: - - `rm ezp_cron.txt` diff --git a/docs/getting_started/install_ez_platform.md b/docs/getting_started/install_ez_platform.md index 77e78015fd..e4680c2c7e 100644 --- a/docs/getting_started/install_ez_platform.md +++ b/docs/getting_started/install_ez_platform.md @@ -1,15 +1,15 @@ -# Install eZ Platform +# Install [[= product_name_oss =]] !!! note Installation for production is only supported on Linux. - To install eZ Platform for development on macOS or Windows, + To install [[= product_name_oss =]] for development on macOS or Windows, see [Install on macOS or Windows](../community_resources/installing-on-mac-os-and-windows.md). ## Prepare the work environment -To install eZ Platform you need a stack with your operating system, MySQL and PHP. +To install [[= product_name_oss =]] you need a stack with your operating system, MySQL and PHP. You can install it by following your favorite tutorial, for example: [Install LAMP stack on Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-install-linux-apache-mysql-php-lamp-stack-ubuntu-18-04). @@ -50,13 +50,13 @@ composer -V If you do so, you must replace `composer` with `php -d memory_limit=-1 composer.phar` in all commands below. -## Get eZ Platform +## Get [[= product_name_oss =]] -!!! enterprise "Enterprise and Commerce" +!!! dxp "[[= product_name_ee =]] and [[= product_name_com =]]" ### Set up authentication tokens - Enterprise and Commerce subscribers have access to commercial packages at [updates.ez.no/bul/](https://updates.ez.no/bul/). + [[= product_name_ee =]] and [[= product_name_com =]] subscribers have access to commercial packages at [updates.ez.no/bul/](https://updates.ez.no/bul/). The site is password-protected. You must set up authentication tokens to access the site. @@ -111,7 +111,7 @@ composer -V ## Create project -There are two ways to get an instance of eZ Platform. +There are two ways to get an instance of [[= product_name_oss =]]. The result is the same, so you can use the way you prefer: - [Download or clone](#a-download-or-clone) @@ -119,7 +119,7 @@ The result is the same, so you can use the way you prefer: ### A. Download or clone -=== "eZ Platform" +=== "[[= product_name_oss =]]" You can either: @@ -134,7 +134,7 @@ The result is the same, so you can use the way you prefer: Check out a tag (e.g. `git checkout v1.13.4`) that you want to use in a project. Use branches (e.g. `master` or `1.13`) only when contributing. -=== "Enterprise and Commerce" +=== "[[= product_name_ee =]] and [[= product_name_com =]]" Download an archive from the [Support portal](https://support.ez.no/Downloads). @@ -150,7 +150,7 @@ Composer looks inside the `composer.json` file and installs all packages require ### B. Create a project with Composer -=== "eZ Platform" +=== "[[= product_name_oss =]]" To use Composer to instantly create a project in the current folder with all the dependencies, run the following command: @@ -158,9 +158,9 @@ Composer looks inside the `composer.json` file and installs all packages require composer create-project --keep-vcs ezsystems/ezplatform . ``` -=== "Enterprise" +=== "[[= product_name_ee =]]" - To install a new project with the `composer create-project` command to get the latest version of eZ Enterprise, + To install a new project with the `composer create-project` command to get the latest version of [[= product_name_ee =]], you must first inform the Composer, which token to use before the project folder is created. To do this, select the correct updates.ez.no channel. The following channels are available: @@ -181,9 +181,9 @@ Composer looks inside the `composer.json` file and installs all packages require If you started with a trial installation and want to use the software under the [BUL license instead of a TTL license](https://ibexa.co/About-our-Software/Licenses-and-agreements/), you must change the channel setting that you have just made. -=== "Commerce" +=== "[[= product_name_com =]]" - To install a new project with the `composer create-project` command to get the latest version of eZ Commerce, + To install a new project with the `composer create-project` command to get the latest version of [[= product_name_com =]], you must first inform the Composer, which token to use before the project folder is created. To do this, select the correct updates.ez.no channel. The following channels are available: @@ -260,9 +260,9 @@ The configuration requires providing the following parameters: If you want an installation with PostgreSQL instead of MySQL, refer to [Using PostgreSQL](../guide/databases.md#using-postgresql). -!!! enterprise "Commerce" +!!! dxp "[[= product_name_com =]]" - ## Install and configure Solr for Commerce + ## Install and configure Solr for [[= product_name_com =]] Search in the shop front end requires Solr as search engine. To install it, run the included script: @@ -282,9 +282,9 @@ The configuration requires providing the following parameters: SEARCH_ENGINE=solr ``` -## Install eZ Platform +## Install [[= product_name_oss =]] -Install eZ Platform and create a database with: +Install [[= product_name_oss =]] and create a database with: ``` bash composer ezplatform-install @@ -294,7 +294,7 @@ Before executing the command make sure that the database user has sufficient per If Composer asks for your token, you must log in to your GitHub account and generate a new token (edit your profile and go to **Developer settings** > **Personal access tokens** > **Generate new token** with default settings). -This operation is performed only once, when you install eZ Platform for the first time. +This operation is performed only once, when you install [[= product_name_oss =]] for the first time. ## Use PHPs built-in server @@ -314,7 +314,7 @@ symfony serve ## Prepare the installation for production -To use eZ Platform with an HTTP server, you need to [set up directory permissions](#set-up-permissions) and [prepare a virtual host](#set-up-virtual-host). +To use [[= product_name_oss =]] with an HTTP server, you need to [set up directory permissions](#set-up-permissions) and [prepare a virtual host](#set-up-virtual-host). ### Set up permissions @@ -382,13 +382,13 @@ You should see the welcome page. !!! tip "eZ Launchpad for quick deployment" - To get your eZ Platform installation up and running quickly, + To get your [[= product_name_oss =]] installation up and running quickly, use the Docker-based [eZ Launchpad](https://ezsystems.github.io/launchpad/), which takes care of the whole setup for you. - eZ Launchpad is supported by the eZ Community. + eZ Launchpad is supported by the Ibexa Community. ## Post-installation steps -!!! enterprise +!!! dxp ### Enable Date-based Publisher @@ -411,15 +411,15 @@ You should see the welcome page. `rm ezp_cron.txt` -!!! enterprise +!!! dxp ### Enable the Link manager To make use of the [Link Manager](../guide/url_management.md), you must [set up cron](../guide/url_management.md#enable-automatic-url-validation). -!!! enterprise "Commerce" +!!! dxp "[[= product_name_com =]]" #### JMS payment secret - To provide the `JMS_PAYMENT_SECRET` secret for the Commerce payment system, run `./vendor/defuse/php-encryption/bin/generate-defuse-key` + To provide the `JMS_PAYMENT_SECRET` secret for the [[= product_name_com =]] payment system, run `./vendor/defuse/php-encryption/bin/generate-defuse-key` and use the generated secret. diff --git a/docs/getting_started/requirements.md b/docs/getting_started/requirements.md index a41f57c7e7..7632a8bf84 100644 --- a/docs/getting_started/requirements.md +++ b/docs/getting_started/requirements.md @@ -29,7 +29,7 @@ These setups are tested by QA and are generally recommended setups. For security |------|------| |Search|Solr 7.7LTS *or* Elasticsearch 7.7 (excluding eZ Commerce), using Oracle Java/Open JDK 8 or higher | |Graphic Handler|GraphicsMagick or ImageMagick or GD| -|[Clustering](../guide/clustering.md)|Linux NFS *or* S3/EFS *(for IO, aka binary files stored in content repository, not supported with legacy)*
Redis 5.0 or higher *(separate instances for session & cache, both using a `volatile-*` [eviction policy](https://redis.io/topics/lru-cache), session instance configured for persistance)* *or* [Memcached](https://memcached.org/) 1.5 or higher
[Varnish](http://varnish-cache.org/) 6.0LTS with [varnish-modules](https://github.com/varnish/varnish-modules/blob/master/README.rst) *or* [Fastly](https://www.fastly.com/) using [the bundle provided with eZ Platform Enterprise Edition](../guide/http_cache.md#serving-varnish-through-fastly) *(for HttpCache)*| +|[Clustering](../guide/clustering.md)|Linux NFS *or* S3/EFS *(for IO, aka binary files stored in content repository, not supported with legacy)*
Redis 5.0 or higher *(separate instances for session & cache, both using a `volatile-*` [eviction policy](https://redis.io/topics/lru-cache), session instance configured for persistance)* *or* [Memcached](https://memcached.org/) 1.5 or higher
[Varnish](http://varnish-cache.org/) 6.0LTS with [varnish-modules](https://github.com/varnish/varnish-modules/blob/master/README.rst) *or* [Fastly](https://www.fastly.com/) using [the bundle provided with [[= product_name_ee =]]](../guide/http_cache.md#serving-varnish-through-fastly) *(for HttpCache)*| |Filesystem|Linux ext4 / XFS| |Package manager|Composer (recent stable version)| |Asset manager|`Node.js` 10.15.3 LTS
`yarn` 1.15.2 or higher| @@ -60,7 +60,7 @@ For security and performance we generally recommend (unless otherwise noted) usi - IO: NFS or S3 - HttpCache, using one of: - [Varnish](http://varnish-cache.org/) 6.0LTS with [varnish-modules](https://github.com/varnish/varnish-modules/blob/master/README.rst) - - [Fastly](https://www.fastly.com/) using [the bundle provided with eZ Platform Enterprise Edition](../guide/http_cache.md#serving-varnish-through-fastly) + - [Fastly](https://www.fastly.com/) using [the bundle provided with [[= product_name_ee =]]](../guide/http_cache.md#serving-varnish-through-fastly) - PHP extensions/modules - curl @@ -126,17 +126,17 @@ Please note that the user interface might not look or behave exactly the same ac ### Cloud hosting with eZ Platform Cloud and Platform.sh - In general, eZ Platform Cloud supports all features and services of [Platform.sh](https://platform.sh/hosting/php/ez) that are compatible and supported by the eZ Platform version you use. + In general, eZ Platform Cloud supports all features and services of [Platform.sh](https://platform.sh/hosting/php/ez) that are compatible and supported by the [[= product_name_oss =]] version you use. For example: - - Platform.sh provides Redis support for versions 3.2, 4.0 and 5.0. eZ Platform supports Redis version 4.0 or higher, and recommends 5.0. As a result, Redis is supported on eZ Platform Cloud in versions 4.0 and 5.0, but 5.0 is recommended. + - Platform.sh provides Redis support for versions 3.2, 4.0 and 5.0. [[= product_name_oss =]] supports Redis version 4.0 or higher, and recommends 5.0. As a result, Redis is supported on eZ Platform Cloud in versions 4.0 and 5.0, but 5.0 is recommended. - Features or services supported by eZ Platform but not covered by Platform.sh may be possible by means of a [custom integration](#custom-integrations). + Features or services supported by [[= product_name_oss =]] but not covered by Platform.sh may be possible by means of a [custom integration](#custom-integrations). ### eZ Platform Cloud Setup support matrix - All eZ Platform features are supported in accordance with the example above. For example: As Legacy Bridge is not supported with v3, it is not supported on eZ Platform Cloud either. + All [[= product_name_oss =]] features are supported in accordance with the example above. For example: As Legacy Bridge is not supported with v3, it is not supported on eZ Platform Cloud either. !!! note @@ -151,20 +151,20 @@ Please note that the user interface might not look or behave exactly the same ac ### Supported eZ Platform Cloud setup - Because of the large range of possible configurations of eZ Platform, there are many possibilities beyond what is provided in the default recommended configuration. + Because of the large range of possible configurations of [[= product_name_oss =]], there are many possibilities beyond what is provided in the default recommended configuration. Make sure to set aside time and budget for: - Verifying your requirements and ensuring they are supported by Platform.sh - Additional time for adaptation and configuration work, and testing by your development team - - Additional consulting/onboarding time with Platform.sh, Ibexa technical services, and/or one of the many partners with prior experience using Platform.sh with eZ Platform + - Additional consulting/onboarding time with Platform.sh, Ibexa technical services, and/or one of the many partners with prior experience using Platform.sh with [[= product_name_oss =]] The cost and effort of this is not included in eZ Platform Cloud subscription and will vary depending on the project. ### Custom integrations - Features supported by eZ Platform, but not natively by Platform.sh, can in many cases be used by means of custom integrations with external services. + Features supported by [[= product_name_oss =]], but not natively by Platform.sh, can in many cases be used by means of custom integrations with external services. - For example, you can create an integration with S3 by means of setting up your own S3 bucket and configuring the relevant parts of eZ Platform. + For example, you can create an integration with S3 by means of setting up your own S3 bucket and configuring the relevant parts of [[= product_name_oss =]]. We recommend giving the development team working on the project access to the bucket to ensure work is done in a DevOps way without depending on external teams when changes are needed. diff --git a/docs/getting_started/troubleshooting.md b/docs/getting_started/troubleshooting.md index 0ea9775590..9ccab804c4 100644 --- a/docs/getting_started/troubleshooting.md +++ b/docs/getting_started/troubleshooting.md @@ -1,6 +1,6 @@ # Troubleshooting -This page lists potential problems that you may encounter while installing, configuring, and running eZ Platform. +This page lists potential problems that you may encounter while installing, configuring, and running [[= product_name_oss =]]. ## Initial installation options @@ -9,7 +9,7 @@ you can do it in the `.env` file. ## Enable swap on systems with limited RAM -If you have problems installing eZ Platform on a system with limited RAM (for example 1GB or 2GB), enable swap. +If you have problems installing [[= product_name_oss =]] on a system with limited RAM (for example 1GB or 2GB), enable swap. It allows your operating system to use the hard disk to supplement RAM when it runs out. With swap enables you will be able to successfully run `php -d memory_limit=-1 bin/console ezplatform:install --env prod ezplatform-clean`. diff --git a/docs/guide/admin_panel.md b/docs/guide/admin_panel.md index 88deed4210..b003f7cffa 100644 --- a/docs/guide/admin_panel.md +++ b/docs/guide/admin_panel.md @@ -42,7 +42,7 @@ Section ID numbers are not recycled. If a Section is removed, its ID number will ## Users -Users in eZ Platform are treated the same way as [Content Types](#content-types). +Users in [[= product_name_oss =]] are treated the same way as [Content Types](#content-types). They are organized in groups such as *Guests*, *Editors*, *Anonymous*, which makes it easier to manage them and their permissions. All User Groups and Users can be accessed in the Admin panel by selecting Users. @@ -112,17 +112,17 @@ To allow the User to enter the Back Office interface and view all content, you n These Policies will be necessary for all other cases below that require access to the content structure. -!!! enterprise +!!! dxp #### Create content without publishing - This option can be used together with eZ Enterprise's content review options. + This option can be used together with [[= product_name_ee =]]'s content review options. Using the following Policies, the User is able to create content, but can't publish it; instead, they must send it for review to another User with proper permissions (for example, senior editor, proofreader, etc.). - `content/create` - `content/edit` - Note that without eZ Enterprise this setup should not be used, as it will not allow the User to continue working with their content. + Note that without [[= product_name_ee =]] this setup should not be used, as it will not allow the User to continue working with their content. #### Create and publish content @@ -192,7 +192,7 @@ Note that when a Policy has more than one Limitation, all of them have to apply, For example, a `Location` Limitation on Location `1/2` and `Subtree of Location` Limitation on `1/2/55` cannot work together, because no Location can satisfy both those requirements at the same time. If you want to combine more than one Limitation with the *or* relation, not *and*, you can split your Policy in two, each with one of these Limitations. -!!! enterprise +!!! dxp #### Editorial workflows @@ -213,7 +213,7 @@ For more examples, see [Permissions use cases](permissions/#use-cases). ## Languages -eZ Platform offers the ability to create multiple translations of your website. +[[= product_name_oss =]] offers the ability to create multiple translations of your website. Which version is shown to a visitor depends on the way your installation is set up. A new language version for the website can be added in the Admin Panel in the Languages tab. Every new language must have a name and a language code, written in the `xxx-XX` format, for example `eng-GB` etc. @@ -257,7 +257,7 @@ You can assign states to content in the Back Office in the Content item's Detail ![Assigning an Object state to a Content item](img/assigning_an_object_state.png "Assigning an Object state to a Content item") -By default, eZ Platform contains one Object state group: **Lock**, with states **Locked** and **Not locked**. +By default, [[= product_name_oss =]] contains one Object state group: **Lock**, with states **Locked** and **Not locked**. ![**Lock** Object state](img/object_state_lock.png "Lock Object state") diff --git a/docs/guide/architecture.md b/docs/guide/architecture.md index b3f37d38a2..c757763b25 100644 --- a/docs/guide/architecture.md +++ b/docs/guide/architecture.md @@ -2,23 +2,23 @@ eZ architecture is based on the philosophy to **use APIs** that will be maintained in the long term. This **makes upgrades easier and provides lossless couplings** between all parts of the architecture, at the same time improving the migration capabilities of the system. -The structure of an eZ Platform app is based on the Symfony framework +The structure of an [[= product_name_oss =]] app is based on the Symfony framework but content management functions rely on the Public API. -Other applications integrate with eZ Platform via REST API, which also relies on the Public API. +Other applications integrate with [[= product_name_oss =]] via REST API, which also relies on the Public API. ![Architecture](img/ez_platform_architecture.png "Architecture") -The architecture of eZ Platform is layered and uses clearly defined APIs between the layers. +The architecture of [[= product_name_oss =]] is layered and uses clearly defined APIs between the layers. |Layer|Description| |-----|-----------| -|[Admin UI](config_back_office.md)|Admin UI contains all the necessary parts to run the eZ Platform Back Office interface.| +|[Admin UI](config_back_office.md)|Admin UI contains all the necessary parts to run the [[= product_name_oss =]] Back Office interface.| |[HTTP Cache](http_cache.md)|Symfony HTTP cache is used to manage content "view" cache with an expiration model. In addition it is extended by using FOSHttpCache to add several advanced features.| |[eZ Controllers](controllers.md)|Controllers created by you to read information from a Request object, create and return a Response objects.| |[Twig templates](twig_functions_reference.md)|Set of custom and built-in Twig templates. User interfaces are developed using the Twig template engine and query the Public API directly.| -|[REST API v2](../api/rest_api_guide.md)|The REST API v2 enables you to interact with an eZ Platform installation using the HTTP protocol, following a REST interaction model.| -|[GraphQL](../api/graphql.md)|GraphQL for eZ Platform exposes the domain model using the Repository, based on Content Type groups, Content Types and Field definitions.| -|[Public API](../api/public_php_api.md)|Public API exposes the Repository which enables you to create, read, update, manage and delete all objects available in eZ Platform.| +|[REST API v2](../api/rest_api_guide.md)|The REST API v2 enables you to interact with an [[= product_name_oss =]] installation using the HTTP protocol, following a REST interaction model.| +|[GraphQL](../api/graphql.md)|GraphQL for [[= product_name_oss =]] exposes the domain model using the Repository, based on Content Type groups, Content Types and Field definitions.| +|[Public API](../api/public_php_api.md)|Public API exposes the Repository which enables you to create, read, update, manage and delete all objects available in [[= product_name_oss =]].| |Business Logic|The business logic is defined in the kernel. This business logic is exposed to applications via an API. It is used to organize development of the user interface layer.| |[SPI](repository.md#spi)|Service Provider Interface which defines contracts for implementing various parts of the system, including persistence layer (`SPI\Persistence`), custom Field Types, custom Limitations, etc.| |[Persistence cache](persistence_cache.md)|The implementation of SPI\Persistence that decorates the main backend implementation.| diff --git a/docs/guide/back_office_translations.md b/docs/guide/back_office_translations.md index 0d233efc0c..f09f7ee31e 100644 --- a/docs/guide/back_office_translations.md +++ b/docs/guide/back_office_translations.md @@ -12,7 +12,7 @@ For example, if you want to translate your application into French, run: and then clear the cache. -Now you can reload your eZ Platform Back Office. +Now you can reload your [[= product_name_oss =]] Back Office. If your browser language is set to French, the Back Office will be displayed in French. !!! tip "Checking browser language" diff --git a/docs/guide/backup.md b/docs/guide/backup.md index 77a8aa2e16..b354311f1f 100644 --- a/docs/guide/backup.md +++ b/docs/guide/backup.md @@ -1,12 +1,12 @@ # Backup -You should always make sure that your solution is properly backed up. The following example shows you how to do this on a Linux-UNIX-based system where eZ Platform is using a MySQL database called "example". You should shut down Platform if it's running before making a backup or an upgrade. +You should always make sure that your solution is properly backed up. The following example shows you how to do this on a Linux-UNIX-based system where [[= product_name_oss =]] is using a MySQL database called "example". You should shut down Platform if it's running before making a backup or an upgrade. !!! note "Externally stored assets" If you store assets in any external service or localization, you should back them up before proceeding. -1\. Navigate into the eZ Platform directory: +1\. Navigate into the [[= product_name_oss =]] directory: ``` cd /path/to/ezplatform diff --git a/docs/guide/basket/basket.md b/docs/guide/basket/basket.md index 9bde987c1b..71c5c47ecf 100644 --- a/docs/guide/basket/basket.md +++ b/docs/guide/basket/basket.md @@ -2,7 +2,7 @@ ![](../img/basket_1.jpg) -eZ Commerce provides a flexible basket system. A basket is identified by: +[[= product_name_com =]] provides a flexible basket system. A basket is identified by: - session ID (if the user is not logged in) - user ID (if the user is logged in) @@ -85,7 +85,7 @@ The basket contains a flag that controls if a recalculation has to be done (time ## Merging of baskets -After the user logs in, eZ Commerce merges the products from the existing basket (filled as an anonymous user) and a basket which is already stored for the given user ID. +After the user logs in, [[= product_name_com =]] merges the products from the existing basket (filled as an anonymous user) and a basket which is already stored for the given user ID. If an SKU is already present in a basket, a new line is created in the user's basket. diff --git a/docs/guide/basket/basket_api/basket_events/basket_eventlistener_in_the_standard.md b/docs/guide/basket/basket_api/basket_events/basket_eventlistener_in_the_standard.md index fea1527e95..aaa69e2366 100644 --- a/docs/guide/basket/basket_api/basket_events/basket_eventlistener_in_the_standard.md +++ b/docs/guide/basket/basket_api/basket_events/basket_eventlistener_in_the_standard.md @@ -1,6 +1,6 @@ # Basket - Eventlistener in the standard -eZ Commerce offers two standard event listeners. +[[= product_name_com =]] offers two standard event listeners. ## StandardBasketListener diff --git a/docs/guide/basket/basket_api/basket_events/basket_events.md b/docs/guide/basket/basket_api/basket_events/basket_events.md index d5c27b3916..83c40b245a 100644 --- a/docs/guide/basket/basket_api/basket_events/basket_events.md +++ b/docs/guide/basket/basket_api/basket_events/basket_events.md @@ -9,7 +9,7 @@ They can be used for example to: - perform a detailed check if the stock is still available - check if the minimum quantity has to be checked. For an example, see [Product quantity validation](../../basket_features/product_quantity_validation.md) -Some [standard Eventlisteners](basket_eventlistener_in_the_standard.md) in eZ Commerce will take care that e.g. a basket preview cache is updated correctly. +Some [standard Eventlisteners](basket_eventlistener_in_the_standard.md) in [[= product_name_com =]] will take care that e.g. a basket preview cache is updated correctly. ## BasketLine Events diff --git a/docs/guide/basket/basket_ui/adding_products_to_the_basket.md b/docs/guide/basket/basket_ui/adding_products_to_the_basket.md index 91218a4a8f..16ef4c7f12 100644 --- a/docs/guide/basket/basket_ui/adding_products_to_the_basket.md +++ b/docs/guide/basket/basket_ui/adding_products_to_the_basket.md @@ -6,8 +6,8 @@ To successfully add products to the basket you need to provide the required para |Fixed parameters|Required|Value|Description| |--- |--- |--- |--- | -|ses_basket[0][quantity]|YES||The quantity to be ordered. If empty the eZ Commerce will use 1 instead, as long as the parameter ses_basket[0][ses_ignore_quantity] is not set.| -|ses_basket[0][ses_ignore_quantity]||1|If set, eZ Commerce will not use 1 instead of empty quantity.| +|ses_basket[0][quantity]|YES||The quantity to be ordered. If empty the [[= product_name_com =]] will use 1 instead, as long as the parameter ses_basket[0][ses_ignore_quantity] is not set.| +|ses_basket[0][ses_ignore_quantity]||1|If set, [[= product_name_com =]] will not use 1 instead of empty quantity.| |ses_basket[0][sku]|YES||The SKU to be ordered. A valid `CatalogElement` must exist for the given SKU.| |ses_basket[0][isVariant]|YES FOR VARIANTS|isVariant|Should be set if product is a variant.| |ses_basket[0][ses_variant_code]|YES FOR VARIANTS||Variant code of the ordered variant.| diff --git a/docs/guide/basket/basket_ui/basket_ui.md b/docs/guide/basket/basket_ui/basket_ui.md index 599a8b3765..f61e26ba9f 100644 --- a/docs/guide/basket/basket_ui/basket_ui.md +++ b/docs/guide/basket/basket_ui/basket_ui.md @@ -14,7 +14,7 @@ ## Display the content of a basket -The basket can be displayed using a standard controller of eZ Commerce (`/basket/show`). +The basket can be displayed using a standard controller of [[= product_name_com =]] (`/basket/show`). The controller provides a variable basket containing the content of the current basket. You can access all basket attributes from a template: diff --git a/docs/guide/breadcrumbs/breadcrumbs.md b/docs/guide/breadcrumbs/breadcrumbs.md index 3ff6244383..231debeea8 100644 --- a/docs/guide/breadcrumbs/breadcrumbs.md +++ b/docs/guide/breadcrumbs/breadcrumbs.md @@ -1,6 +1,6 @@ # Breadcrumbs -eZ Commerce automatically generates breadcrumbs for every part of the shop, including the catalog, +[[= product_name_com =]] automatically generates breadcrumbs for every part of the shop, including the catalog, internal shop routes (e.g. my profile, search), Content items and forms. ![](../img/breadcrumbs_1.png) diff --git a/docs/guide/bundles.md b/docs/guide/bundles.md index 9c5ab718a3..af972a50c1 100644 --- a/docs/guide/bundles.md +++ b/docs/guide/bundles.md @@ -1,16 +1,16 @@ # Bundles -A bundle in Symfony (and eZ Platform) is a separate part of your application that implements a feature. +A bundle in Symfony (and [[= product_name_oss =]]) is a separate part of your application that implements a feature. You can create bundles yourself or make use of available open-source bundles. You can also reuse the bundles you create in other projects or share them with the community. -Many eZ Platform functionalities are provided through separate bundles included in the installation. -You can see the bundles that are automatically installed with eZ Platform in [composer.json](https://github.com/ezsystems/ezplatform/blob/3.0/composer.json). +Many [[= product_name_oss =]] functionalities are provided through separate bundles included in the installation. +You can see the bundles that are automatically installed with [[= product_name_oss =]] in [composer.json](https://github.com/ezsystems/ezplatform/blob/3.0/composer.json). ## Working with bundles -All bundles containing built-in eZ Platform functionalities are installed automatically. -Additionally, you can install community-developed bundles from [eZ Platform Packages.](https://ezplatform.com/packages) +All bundles containing built-in [[= product_name_oss =]] functionalities are installed automatically. +Additionally, you can install community-developed bundles from [[[= product_name_oss =]] Packages.](https://ezplatform.com/packages) To learn how to create your own bundles, see [Symfony documentation on bundles.](https://symfony.com/doc/5.0/bundles.html) @@ -27,39 +27,39 @@ see the [How to Remove a Bundle](http://symfony.com/doc/5.0/bundles/remove.html) ## Built-in bundles -The following tables give an overview of the main eZ Platform bundles. +The following tables give an overview of the main [[= product_name_oss =]] bundles. ### Core bundles |Bundle|Description| |---------|-----------| -|[ezplatform-kernel](https://github.com/ezsystems/ezplatform-kernel)|contains the core of the whole eZ Platform application e.g. EzPublishCoreBundle| +|[ezplatform-kernel](https://github.com/ezsystems/ezplatform-kernel)|contains the core of the whole [[= product_name_oss =]] application e.g. EzPublishCoreBundle| |[ezplatform-content-forms](https://github.com/ezsystems/ezplatform-content-forms)|provides form-based integration for the Symfony Forms into Content and User objects in kernel| -|[ezplatform-solr-search-engine](https://github.com/ezsystems/ezplatform-solr-search-engine)|[Solr-powered](http://lucene.apache.org/solr/) search handler for eZ Platform| +|[ezplatform-solr-search-engine](https://github.com/ezsystems/ezplatform-solr-search-engine)|[Solr-powered](http://lucene.apache.org/solr/) search handler for [[= product_name_oss =]]| |[ez-support-tools](https://github.com/ezsystems/ez-support-tools)|provides functionality for system information| -|[ezplatform-http-cache](https://github.com/ezsystems/ezplatform-http-cache)|HTTP cache handling for eZ Platform, using multi tagging (incl Varnish xkey)| -|[ezplatform-admin-ui](https://github.com/ezsystems/ezplatform-admin-ui)|contains Back Office interface for eZ Platform v2+| +|[ezplatform-http-cache](https://github.com/ezsystems/ezplatform-http-cache)|HTTP cache handling for [[= product_name_oss =]], using multi tagging (incl Varnish xkey)| +|[ezplatform-admin-ui](https://github.com/ezsystems/ezplatform-admin-ui)|contains Back Office interface for [[= product_name_oss =]] v2+| |[ezplatform-admin-ui-assets](https://github.com/ezsystems/ezplatform-admin-ui-assets)|contains assets for AdminUI| -|[ezplatform-design-engine](https://github.com/ezsystems/ezplatform-design-engine)|design fallback system for eZ Platform similar to legacy design fallback system| +|[ezplatform-design-engine](https://github.com/ezsystems/ezplatform-design-engine)|design fallback system for [[= product_name_oss =]] similar to legacy design fallback system| |[ezplatform-standard-design](https://github.com/ezsystems/ezplatform-standard-design)|defines standard Design and Theme to be handled by ezplatform-design-engine| -|[ezplatform-cron](https://github.com/ezsystems/ezplatform-cron)|exposes cron/cron package for use in eZ Platform (or just plain Symfony) via a simple command `ezplatform:cron:run`| -|[ezplatform-graphql](https://github.com/ezsystems/ezplatform-graphql)|defines GraphQL server for eZ Platform| -|[ezplatform-matrix-fieldtype](https://github.com/ezsystems/ezplatform-matrix-fieldtype)|dedicated to Matrix Field Type for eZ Platform, it replaces previous version found on `ezcommunity/EzMatrixFieldTypeBundle`| +|[ezplatform-cron](https://github.com/ezsystems/ezplatform-cron)|exposes cron/cron package for use in [[= product_name_oss =]] (or just plain Symfony) via a simple command `ezplatform:cron:run`| +|[ezplatform-graphql](https://github.com/ezsystems/ezplatform-graphql)|defines GraphQL server for [[= product_name_oss =]]| +|[ezplatform-matrix-fieldtype](https://github.com/ezsystems/ezplatform-matrix-fieldtype)|dedicated to Matrix Field Type for [[= product_name_oss =]], it replaces previous version found on `ezcommunity/EzMatrixFieldTypeBundle`| |[ezplatform-query-fieldtype](https://github.com/ezsystems/ezplatform-query-fieldtype)|Field Type that lists Content items based by querying the Repository| |[ezplatform-rest](https://github.com/ezsystems/ezplatform-rest)|contains REST API| |[ezplatform-richtext](https://github.com/ezsystems/ezplatform-richtext)|Field Type for supporting rich formatted text stored in a structured XML format| -|[ezplatform-user](https://github.com/ezsystems/ezplatform-user)|dedicated to eZ Platform User management.| +|[ezplatform-user](https://github.com/ezsystems/ezplatform-user)|dedicated to [[= product_name_oss =]] User management.| |[BehatBundle](https://github.com/ezsystems/BehatBundle)|common reusable sentence implementations and other common needs for Behat testing in bundles/projects| -!!! Enterprise +!!! dxp |Bundle|Description| |---------|-----------| - |date-based-publisher|provides the date based publishing functionality for eZ Platform Enterprise Edition| + |date-based-publisher|provides the date based publishing functionality for [[= product_name_ee =]]| |ezplatform-workflow|implementation of a collaboration feature that lets you send content draft to any user for a review or rewriting| |ezplatform-page-fieldtype|Page handling Field Type| - |ezplatform-page-builder|contains eZ Platform Page editor| - |ezplatform-ee-installer|provides `ezplatform:install` Symfony console command which is the installer for eZ Platform Enterprise Edition v2| + |ezplatform-page-builder|contains [[= product_name_ee =]] Page editor| + |ezplatform-ee-installer|provides `ezplatform:install` Symfony console command which is the installer for [[= product_name_ee =]] v2| |ezplatform-http-cache-fastly|extends ezplatform-http-cache to support Fastly, for use on Platform.sh PE or standalone| |ezplatform-calendar|extends the Back Office by adding the calendar tab with the calendar widget| |ezplatform-version-comparison|allows comparing between two versions of the same Field| @@ -75,7 +75,7 @@ The following tables give an overview of the main eZ Platform bundles. |[ezplatform-multi-file-upload](https://github.com/ezsystems/ezplatform-multi-file-upload)|allows uploading multiple files as new content items at once| |[ezplatform-demo-assets](https://github.com/ezsystems/ezplatform-demo-assets)|contains binary install data for ezsystems/ezplatform-demo| -!!! Enterprise +!!! dxp |Bundle|Description| |---------|-----------| @@ -85,15 +85,13 @@ The following tables give an overview of the main eZ Platform bundles. |Bundle|Description| |------|-----------| -|[ezplatform-com](https://github.com/ezsystems/ezplatform-com)|the Ibexa Developer Hub for the Open Source PHP CMS eZ Platform (example site)| -|[ezplatform-ee-demo](https://github.com/ezsystems/ezplatform-ee-demo)|fork of the "ezplatform-ee" meta repository, contains changes necessary to enable eZ Platform Enterprise Edition Demo. Not recommended for a clean install for new projects, but great for observation and learning (example site)| -|[ezplatform-ee-beginner-tutorial](https://github.com/ezsystems/ezplatform-ee-beginner-tutorial)|resources used in the eZ Platform Enterprise Edition Beginner Tutorial| +|[ezplatform-com](https://github.com/ezsystems/ezplatform-com)|the Ibexa Developer Hub for [[= product_name_oss =]] (example site)| +|[ezplatform-ee-beginner-tutorial](https://github.com/ezsystems/ezplatform-ee-beginner-tutorial)|resources used in the [[= product_name_ee =]] Beginner Tutorial| |[docker-php](https://github.com/ezsystems/docker-php)|contains PHP docker image example| ### Documentation - additional resources |Repository|Description| |------|-----------| -|[developer-documentation](https://github.com/ezsystems/developer-documentation)|source for the developer documentation for eZ Platform, an open source CMS based on the Symfony Full Stack Framework in PHP. https://doc.ezplatform.com| -|[user-documentation](https://github.com/ezsystems/user-documentation)|source for the user documentation for eZ Platform, an open source CMS based on the Symfony Full Stack Framework in PHP| -|[ezpersonalization-documentation](https://github.com/ezsystems/ezservices-documentation)|source for the eZ Personalization documentation for eZ Platform, an open source CMS based on the Symfony Full Stack Framework in PHP| +|[developer-documentation](https://github.com/ezsystems/developer-documentation)|source for the developer documentation for [[= product_name_oss =]], an open source CMS based on the Symfony Full Stack Framework in PHP. https://doc.ezplatform.com| +|[user-documentation](https://github.com/ezsystems/user-documentation)|source for the user documentation for [[= product_name_oss =]], an open source CMS based on the Symfony Full Stack Framework in PHP| diff --git a/docs/guide/cache/basketpreview_cache_and_user_specific_data.md b/docs/guide/cache/basketpreview_cache_and_user_specific_data.md index 3a7471a08e..70c2605393 100644 --- a/docs/guide/cache/basketpreview_cache_and_user_specific_data.md +++ b/docs/guide/cache/basketpreview_cache_and_user_specific_data.md @@ -1,6 +1,6 @@ # Basketpreview cache and user-specific data -eZ Commerce uses a lot of dynamic data which has to be displayed in the shop: +[[= product_name_com =]] uses a lot of dynamic data which has to be displayed in the shop: - basket preview shows the number of products and a list of products - the name of the customer @@ -56,7 +56,7 @@ The alias `mydata` is used as a key in the modules section. ### Working with HTML fragments Each service implementing `SessionDataInterface` can return HTML fragments. -The keys should use the ID of a container inside your site. eZ Commerce automatically replaces this container with the indicated HTML. +The keys should use the ID of a container inside your site. [[= product_name_com =]] automatically replaces this container with the indicated HTML. Example for providing the data in a service: diff --git a/docs/guide/cache/cache.md b/docs/guide/cache/cache.md index 6cb52b546d..76b49531ff 100644 --- a/docs/guide/cache/cache.md +++ b/docs/guide/cache/cache.md @@ -1,6 +1,6 @@ # Cache -eZ Commerce uses different caches, including HTTP cache, which can greatly increase shop performance. +[[= product_name_com =]] uses different caches, including HTTP cache, which can greatly increase shop performance. Dynamic parts of the shop such as basket preview or prices are displayed using dynamic caching features such as ESI or JavaScript. This ensures that only small parts of a page have to be generated in real time. @@ -24,7 +24,7 @@ Caching strategies are defined in configuration, see: [HTTP caching](content_cac ## Usage of cache tags -eZ Commerce uses cache tags to tag and purge content. +[[= product_name_com =]] uses cache tags to tag and purge content. |Tag|Used for|Purged| |--- |--- |--- | diff --git a/docs/guide/cache/content_cache_refresh/http_caching.md b/docs/guide/cache/content_cache_refresh/http_caching.md index 40a9c8421a..f64eb2ccb7 100644 --- a/docs/guide/cache/content_cache_refresh/http_caching.md +++ b/docs/guide/cache/content_cache_refresh/http_caching.md @@ -126,7 +126,7 @@ Example: php bin/console silversolutions:http-cache:purge 1056 222 --env="prod" ``` -### Purging using eZ Platform service +### Purging using [[= product_name_oss =]] service If you programmatically updated product data, basket or some other cached content, you need to update caches to show users current information. diff --git a/docs/guide/catalog/catalog_api/routing_system.md b/docs/guide/catalog/catalog_api/routing_system.md index dc888ccc9a..a44798649f 100644 --- a/docs/guide/catalog/catalog_api/routing_system.md +++ b/docs/guide/catalog/catalog_api/routing_system.md @@ -1,6 +1,6 @@ # Routing system -eZ Commerce uses its own routing/URL matching solution to avoid conflicting with the eZ Platform routing system +[[= product_name_com =]] uses its own routing/URL matching solution to avoid conflicting with the [[= product_name_oss =]] routing system and to enable using Platform API in commerce routes. !!! note diff --git a/docs/guide/catalog/product_variants/product_variants.md b/docs/guide/catalog/product_variants/product_variants.md index 9b7c0920d0..ca0ec5c80a 100644 --- a/docs/guide/catalog/product_variants/product_variants.md +++ b/docs/guide/catalog/product_variants/product_variants.md @@ -162,7 +162,7 @@ In this case the product is identified by the SKU and the `variantCode`: `SKU_AN These "variants" can be grouped by a PIM system or a special field in the ERP system. In this case, the `variantCode` from the catalog is the actual SKU that is sent to the ERP: `SKU_ONLY` -eZ Commerce supports both methods. +[[= product_name_com =]] supports both methods. To select a method, use the following configuration: ``` yaml diff --git a/docs/guide/checkout/checkout.md b/docs/guide/checkout/checkout.md index 60cadd576a..1c9a03bc02 100644 --- a/docs/guide/checkout/checkout.md +++ b/docs/guide/checkout/checkout.md @@ -1,6 +1,6 @@ # Checkout -eZ Commerce provides one-page checkout with a varying number of steps. +[[= product_name_com =]] provides one-page checkout with a varying number of steps. If a user is not logged in, they see two more steps: one with a login form and a second one for the invoice address. Customers who already have a customer number is forwarded to step 3. diff --git a/docs/guide/checkout/checkout_features/rma_process.md b/docs/guide/checkout/checkout_features/rma_process.md index dda21b9858..f3cde1947e 100644 --- a/docs/guide/checkout/checkout_features/rma_process.md +++ b/docs/guide/checkout/checkout_features/rma_process.md @@ -1,6 +1,6 @@ # RMA process -eZ Commerce offers a simple RMA (return merchandise authorization) process. +[[= product_name_com =]] offers a simple RMA (return merchandise authorization) process. The goal is to inform the user about the cancellation policies and give them the possible to return their goods - online as well. The cancellation process validates the input and sends an email to the shop administrator. @@ -46,7 +46,7 @@ parameters: ## Online RMA form -eZ Commerce also offers an online RMA form. +[[= product_name_com =]] also offers an online RMA form. After a user submits the form, an email is sent to the admin by using [SendRmaEmailDataProcessor](../../forms/form_api/dataprocessors.md#sendrmaemaildataprocessor). The email recipient has to generate a delivery note with a return number and send it to the customer. diff --git a/docs/guide/clustering.md b/docs/guide/clustering.md index 350b0b0d9b..2f3d093084 100644 --- a/docs/guide/clustering.md +++ b/docs/guide/clustering.md @@ -1,10 +1,10 @@ # Clustering -Clustering in eZ Platform refers to setting up your installation with several web servers for handling more load and/or for failover. +Clustering in [[= product_name_oss =]] refers to setting up your installation with several web servers for handling more load and/or for failover. ## Server setup overview -This diagram illustrates how clustering in eZ Platform is typically set up. +This diagram illustrates how clustering in [[= product_name_oss =]] is typically set up. The parts illustrate the different roles needed for a successful cluster setup. ![Server setup for clustering](img/server_setup.png) @@ -26,9 +26,9 @@ It is also recommended to use: - [Solr](search/solr.md) for better search and performance - a CDN for improved performance and faster ping time worldwide - - in eZ Platform Enterprise Edition you can use Fastly, which has native support as HTTP cache and CDN. + - in [[= product_name_ee =]] you can use Fastly, which has native support as HTTP cache and CDN. - active/passive database for failover -- more recent versions of PHP and MySQL/MariaDB within [what is supported](../getting_started/requirements.md) for your eZ Platform version to get more performance out of each server. Numbers might vary so make sure to test this when upgrading. +- more recent versions of PHP and MySQL/MariaDB within [what is supported](../getting_started/requirements.md) for your [[= product_name_oss =]] version to get more performance out of each server. Numbers might vary so make sure to test this when upgrading. ### Shared persistence cache @@ -48,11 +48,11 @@ To avoid concurrent access to session data from front-end nodes, if possible you Session locking is available with `php-memcached`, and with `php-redis` (v4.2.0 and higher). -On eZ Platform Cloud (and Platform.sh) Redis is preferred and supported. +On Ibexa Cloud (and Platform.sh) Redis is preferred and supported. ### Shared binary files -eZ Platform supports multi-server setups by means of [custom IO handlers](file_management.md#the-dfs-cluster-handler). +[[= product_name_oss =]] supports multi-server setups by means of [custom IO handlers](file_management.md#the-dfs-cluster-handler). They make sure that files are correctly synchronized among the multiple clients using the data. ## DFS IO handler @@ -64,7 +64,7 @@ It will use a database to manipulate metadata, making up for the potential incon You need to configure both metadata and binarydata handlers. -eZ Platform ships with a custom local adapter (`ibexa.platform.io.nfs.adapter.site_access_aware`), +[[= product_name_oss =]] ships with a custom local adapter (`ibexa.platform.io.nfs.adapter.site_access_aware`), which decorates the Flysystem local adapter to enable support for SiteAccess-aware settings. If an NFS path relies on SiteAccess-aware dynamic parameters, you must use the custom local adapter instead of the Flysystem local adapter. @@ -124,7 +124,7 @@ manually importing its schema definition: ``` !!! note - On eZ Platform Cloud (and Platform.sh) a separate DFS database is supported for MySQL only. + On Ibexa Cloud (and Platform.sh) a separate DFS database is supported for MySQL only. This example uses Doctrine connection named `dfs`: @@ -157,7 +157,7 @@ oneup_flysystem: custom: service: ibexa.platform.io.nfs.adapter.site_access_aware -# define the eZ Platform handlers +# define the Ibexa handlers ez_io: binarydata_handlers: nfs: @@ -215,7 +215,7 @@ You can read more about that on [Binary files URL handling](file_management.md#u ### Web server rewrite rules -The default eZ Platform rewrite rules will let image requests be served directly from disk. +The default [[= product_name_oss =]] rewrite rules will let image requests be served directly from disk. In a cluster setup, files matching `^/var/([^/]+/)?storage/images(-versioned)?/.*` have to be passed through `/public/index.php` instead. In any case, this specific rewrite rule must be placed before the ones that "ignore" image files and just let the web server serve the files directly. diff --git a/docs/guide/clustering_aws_s3.md b/docs/guide/clustering_aws_s3.md index ba8eae3cc4..e3f048b666 100644 --- a/docs/guide/clustering_aws_s3.md +++ b/docs/guide/clustering_aws_s3.md @@ -28,10 +28,10 @@ The secret key cannot be retrieved again after the key has been created, so don' Make sure that your bucket is [configured as Public](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/block-public-access-bucket.html) to avoid facing 403 errors, as the current S3 handler is meant to store files publicly so they can be served directly from S3. -## Set up eZ Platform for AWS S3 +## Set up [[= product_name_oss =]] for AWS S3 -In your eZ Platform root directory, run `php composer.phar require league/flysystem-aws-s3-v3`. -In your eZ Platform configuration, e.g. `config/packages/ezplatform.yaml`, set up the AWS S3 client: +In your [[= product_name_oss =]] root directory, run `php composer.phar require league/flysystem-aws-s3-v3`. +In your [[= product_name_oss =]] configuration, e.g. `config/packages/ezplatform.yaml`, set up the AWS S3 client: ``` yaml services: @@ -45,7 +45,7 @@ services: secret: abc123... # Your AWS secret key ``` -In the same eZ Platform configuration, set up the Flysystem adapter that uses the S3 client: +In the same [[= product_name_oss =]] configuration, set up the Flysystem adapter that uses the S3 client: ``` yaml oneup_flysystem: @@ -75,7 +75,7 @@ ez_io: For example, you could configure one called `gcloud_storage` for a third-party (community-supported) [Google Cloud Storage adapter](https://github.com/thephpleague/flysystem#community-supported). -In your eZ Platform system settings, e.g. `config/packages/ezplatform.yaml`, enable the binary data handler: +In your [[= product_name_oss =]] system settings, e.g. `config/packages/ezplatform.yaml`, enable the binary data handler: ``` yaml ezplatform: diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index 68988eb510..e1f12acd90 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -1,6 +1,6 @@ # Configuration -eZ Platform configuration is delivered using a number of dedicated configuration files. +[[= product_name_oss =]] configuration is delivered using a number of dedicated configuration files. It contains everything from selecting the content Repository to SiteAccesses to language settings. ### Configuration format @@ -34,7 +34,7 @@ These files contain additional settings and point to the general (not environmen Configuration is tightly related to the service container. To fully understand it, you need to be familiar with [Symfony's service container](service_container.md) and [its configuration](https://symfony.com/doc/5.0/service_container.html#service-parameters). -Basic configuration handling in eZ Platform is similar to what is commonly possible with Symfony. +Basic configuration handling in [[= product_name_oss =]] is similar to what is commonly possible with Symfony. You can define key/value pairs in your configuration files. Internally and by convention, keys follow a **dot syntax**, where the different segments follow your configuration hierarchy. diff --git a/docs/guide/content_management.md b/docs/guide/content_management.md index b3d2eea3d0..e632c78ce0 100644 --- a/docs/guide/content_management.md +++ b/docs/guide/content_management.md @@ -73,7 +73,7 @@ which can be viewed by selecting the **Users** tab in the Admin Panel. The default ID number of the **Users** Location is 5, but it can be [modified via configuration](config_repository.md#top-level-locations). It contains a User Group Content item. -!!! enterprise +!!! dxp #### Forms diff --git a/docs/guide/content_model.md b/docs/guide/content_model.md index 4086b0ec23..41de547c47 100644 --- a/docs/guide/content_model.md +++ b/docs/guide/content_model.md @@ -2,13 +2,13 @@ ## Content model overview -The content structure in eZ Platform is based on Content items. +The content structure in [[= product_name_oss =]] is based on Content items. A Content item represents a single piece of content: an article, a blog post, an image, a product, etc. Each Content item is an instance of a Content Type. !!! tip - An introduction to the content model for non-developer users is available in [eZ Platform user documentation](https://doc.ezplatform.com/projects/userguide/en/latest/content_model/). + An introduction to the content model for non-developer users is available in [[[= product_name_oss =]] user documentation](https://doc.ezplatform.com/projects/userguide/en/latest/content_model/). ## Content items diff --git a/docs/guide/content_rendering.md b/docs/guide/content_rendering.md index af4e6463b1..33181f1719 100644 --- a/docs/guide/content_rendering.md +++ b/docs/guide/content_rendering.md @@ -2,7 +2,7 @@ ## The ViewController -eZ Platform comes with a native controller to display your content, known as the **`ViewController`**. It is called each time you try to reach a Content item from its **URL alias** (human-readable, translatable URI generated for any content based on URL patterns defined per Content Type). It is able to render any content created in the admin interface or via the [Public API Guide](../api/public_php_api.md). +[[= product_name_oss =]] comes with a native controller to display your content, known as the **`ViewController`**. It is called each time you try to reach a Content item from its **URL alias** (human-readable, translatable URI generated for any content based on URL patterns defined per Content Type). It is able to render any content created in the admin interface or via the [Public API Guide](../api/public_php_api.md). It can also be called straight by its direct URI:  @@ -283,7 +283,7 @@ class MyViewProvider implements ViewProvider ## Events -This section presents the events that are triggered by eZ Platform. +This section presents the events that are triggered by [[= product_name_oss =]]. ### eZ Publish Core @@ -297,7 +297,7 @@ This section presents the events that are triggered by eZ Platform. ### Twig Helper -eZ Platform comes with a Twig helper as a [global variable](http://symfony.com/doc/5.0/cookbook/templating/global_variables.html) named `ezplatform`. +[[= product_name_oss =]] comes with a Twig helper as a [global variable](http://symfony.com/doc/5.0/cookbook/templating/global_variables.html) named `ezplatform`. This helper is accessible from all Twig templates and allows you to easily retrieve useful information. diff --git a/docs/guide/controllers.md b/docs/guide/controllers.md index 270f955793..6bfbed54a0 100644 --- a/docs/guide/controllers.md +++ b/docs/guide/controllers.md @@ -506,7 +506,7 @@ A `QueryType` service is registered automatically when `autoconfigure: true` is !!! tip - In the default eZ Platform installation services are autoconfigured by default for the `App` namespace, + In the default [[= product_name_oss =]] installation services are autoconfigured by default for the `App` namespace, so no additional registration is required. Otherwise, you can register your QueryType with a service tag: diff --git a/docs/guide/customers/customers.md b/docs/guide/customers/customers.md index ae31f9ecde..735cc7e827 100644 --- a/docs/guide/customers/customers.md +++ b/docs/guide/customers/customers.md @@ -1,7 +1,7 @@ # Customers Customers are stored as User Content items in the database. -eZ Commerce uses the following features that are connected to users: +[[= product_name_com =]] uses the following features that are connected to users: - Roles and Policies - extensible User model @@ -10,9 +10,9 @@ eZ Commerce uses the following features that are connected to users: - activation of accounts - session handling -In addition, eZ Commerce supports multiple user accounts with the same email address (e.g. for a multi-shop setup). +In addition, [[= product_name_com =]] supports multiple user accounts with the same email address (e.g. for a multi-shop setup). -eZ Commerce adds the following new Fields to the User Content Type that are required for the shop: +[[= product_name_com =]] adds the following new Fields to the User Content Type that are required for the shop: - first name, last name - salutation @@ -79,7 +79,7 @@ E-Mail address: {{ ses.profile.sesUser.email }} An example would be a CLI tool, or processes that happen in background, like sending out the order if a customer paid via a payment service provider. -eZ Commerce uses the UBL standard to model customer data. The most important type is the Party which describes an address. +[[= product_name_com =]] uses the UBL standard to model customer data. The most important type is the Party which describes an address. For each user, the following information is stored. If the user has a customer number, the following information is updated from the ERP after login: diff --git a/docs/guide/customers/customers_api/customer_profile_data_components/customer_profile_data_services.md b/docs/guide/customers/customers_api/customer_profile_data_components/customer_profile_data_services.md index 7a7e414f92..c937d05d2d 100644 --- a/docs/guide/customers/customers_api/customer_profile_data_components/customer_profile_data_services.md +++ b/docs/guide/customers/customers_api/customer_profile_data_components/customer_profile_data_services.md @@ -19,7 +19,7 @@ It also uses the content model as source for account data and target for fallbac ## DeprecatedCustomerMappingService `DeprecatedCustomerMappingService` (`Silversolutions\Bundle\EshopBundle\Services\CustomerProfileData\DeprecatedCustomerMappingService`) -is the concrete customer profile data service which implements the deprecated `AbstracCustomerService` to use with eZ Commerce components, +is the concrete customer profile data service which implements the deprecated `AbstracCustomerService` to use with [[= product_name_com =]] components, which depend on the deprecated model. ## Using customer profile data services in source code diff --git a/docs/guide/customers/customers_templating.md b/docs/guide/customers/customers_templating.md index 03639b1359..7d6f952150 100644 --- a/docs/guide/customers/customers_templating.md +++ b/docs/guide/customers/customers_templating.md @@ -1,13 +1,13 @@ # Customers templating -eZ Commerce provides a global Twig variable `ses` which is available in all templates. +[[= product_name_com =]] provides a global Twig variable `ses` which is available in all templates. The variable provides the `profile` method which contains information about the current customer. -If the user has a customer number, eZ Commerce automatically fetches customer information from the ERP. +If the user has a customer number, [[= product_name_com =]] automatically fetches customer information from the ERP. The data is stored in the session and is provided by the variable `ses.profile`. Subsequent calls do not initiate a new request to the ERP because the data from the ERP is cached and handled by the Symfony session handlers. -eZ Commerce provides a standard template for displaying customer data: +[[= product_name_com =]] provides a standard template for displaying customer data: `SilversolutionsEshopBundle/Resources/views/details.html.twig`. ## Getting customer profile data diff --git a/docs/guide/customers/vat_handling.md b/docs/guide/customers/vat_handling.md index 03cbacf819..ccbc3b776e 100644 --- a/docs/guide/customers/vat_handling.md +++ b/docs/guide/customers/vat_handling.md @@ -1,6 +1,6 @@ # VAT handling -The VAT handling for customers inside eZ Commerce is controlled by: +The VAT handling for customers inside [[= product_name_com =]] is controlled by: - The ERP system - The settings from the User Content item diff --git a/docs/guide/data_providers/data_providers.md b/docs/guide/data_providers/data_providers.md index 05897c713a..a7980cc7f6 100644 --- a/docs/guide/data_providers/data_providers.md +++ b/docs/guide/data_providers/data_providers.md @@ -19,7 +19,7 @@ The command takes the following options: |Option|Notes| |--- |--- | |`--new-root-node`|Default value is `56` for content model data provider, `2` for eContent| -|`--location-id`|Default value is `56`. This is the Location ID of the "Product catalog" Content item in eZ Platform. If you are using another Location ID, change this parameter| +|`--location-id`|Default value is `56`. This is the Location ID of the "Product catalog" Content item in [[= product_name_oss =]]. If you are using another Location ID, change this parameter| ``` bash # switch to eContent diff --git a/docs/guide/databases.md b/docs/guide/databases.md index 213dbbd5f0..80b90a5426 100644 --- a/docs/guide/databases.md +++ b/docs/guide/databases.md @@ -2,7 +2,7 @@ ## Using PostgreSQL -eZ Platform uses MySQL by default, but you can also choose to install it with PostgreSQL. +[[= product_name_oss =]] uses MySQL by default, but you can also choose to install it with PostgreSQL. ### Requirements diff --git a/docs/guide/design_engine.md b/docs/guide/design_engine.md index c3588989db..dc2264afba 100644 --- a/docs/guide/design_engine.md +++ b/docs/guide/design_engine.md @@ -215,7 +215,7 @@ The default fallback order is: In addition to the convention described above, it is also possible to add arbitrary Twig template directories to a theme from configuration. This can be useful when you want to define templates from third-party bundles -as part of one of your themes, or when upgrading your application in order to use eZ Platform design engine, +as part of one of your themes, or when upgrading your application in order to use [[= product_name_oss =]] design engine, when your existing templates are not yet following the convention. ```yaml diff --git a/docs/guide/devops.md b/docs/guide/devops.md index c724391ee8..e662d806a1 100644 --- a/docs/guide/devops.md +++ b/docs/guide/devops.md @@ -27,9 +27,9 @@ For a [cluster](clustering.md) setup, the content cache ([HTTP cache](http_cache ## Web Debug Toolbar -When running eZ Platform in the `dev` environment you have access to the standard Symfony Web Debug Toolbar. It is extended with some eZ Platform-specific information: +When running [[= product_name_oss =]] in the `dev` environment you have access to the standard Symfony Web Debug Toolbar. It is extended with some [[= product_name_oss =]]-specific information: -![eZ Platform info in Web Debug Toolbar](img/web_debug_toolbar.png "eZ Platform info in Web Debug Toolbar") +![[[= product_name_oss =]] info in Web Debug Toolbar](img/web_debug_toolbar.png "[[= product_name_oss =]] info in Web Debug Toolbar") #### SPI (persistence) @@ -41,7 +41,7 @@ Here you can see the name of the current SiteAccess and how it was matched. For ## Logging and debug configuration -Logging in eZ Platform consists of two parts. +Logging in [[= product_name_oss =]] consists of two parts. One are several debug systems that integrate with Symfony developer toolbar to give you detailed information about what is going on. The other is the standard [PSR-3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md) logger, as provided by Symfony using [Monolog](https://github.com/Seldaek/monolog). @@ -65,7 +65,7 @@ parameters: ### Error logging and rotation -eZ Platform uses the [Monolog](https://github.com/Seldaek/monolog) component to log errors, and it has a `RotatingFileHandler` that allows for file rotation. +[[= product_name_oss =]] uses the [Monolog](https://github.com/Seldaek/monolog) component to log errors, and it has a `RotatingFileHandler` that allows for file rotation. According to [their documentation](https://seldaek.github.io/monolog/doc/02-handlers-formatters-processors.html#log-to-files-and-syslog), it "logs records to a file and creates one logfile per day. It will also delete files older than `$maxFiles`". diff --git a/docs/guide/econtent/econtent.md b/docs/guide/econtent/econtent.md index 744ff1471d..ccda0a710e 100644 --- a/docs/guide/econtent/econtent.md +++ b/docs/guide/econtent/econtent.md @@ -16,12 +16,12 @@ Main advantages of using eContent as the data provider: ## Content model vs. eContent data provider -eZ Commerce uses an almost generic way to access the catalog. +[[= product_name_com =]] uses an almost generic way to access the catalog. The catalog can be stored in the content model or in eContent. If eContent is used, there are a few restrictions that have to be considered: -- A product cannot be embedded by using the standard embed feature. eZ Commerce offers an alternative feature which enables embedding products in RichtText Fields. +- A product cannot be embedded by using the standard embed feature. [[= product_name_com =]] offers an alternative feature which enables embedding products in RichtText Fields. - eContent products are not visible in the Back Office. It depends on the requirements of the customer to decide which provider should be used. The following table compares the main features: diff --git a/docs/guide/econtent/econtent_api.md b/docs/guide/econtent/econtent_api.md index d23ecb0afd..094516dd00 100644 --- a/docs/guide/econtent/econtent_api.md +++ b/docs/guide/econtent/econtent_api.md @@ -2,7 +2,7 @@ eContent provides a flexible way to define project-specific attributes for products and categories (and other product-related types of data). -eZ Commerce requires that some of the attributes use predefined identifiers. +[[= product_name_com =]] requires that some of the attributes use predefined identifiers. ## Categories diff --git a/docs/guide/econtent/econtent_configuration.md b/docs/guide/econtent/econtent_configuration.md index 256c0d23d0..b1c1f817ac 100644 --- a/docs/guide/econtent/econtent_configuration.md +++ b/docs/guide/econtent/econtent_configuration.md @@ -238,7 +238,7 @@ silver_econtent.default.mapping.product: This definition is used by this plugin: `SisoNavEcontentImporterPlugin` -It defines the prefix of the field name that Fields from eZ Platform have in eContent. +It defines the prefix of the field name that Fields from [[= product_name_oss =]] have in eContent. ``` yaml silver_econtent.default.ez_datatype_attribute_prefix: ezdata_ diff --git a/docs/guide/econtent/econtent_features/econtent_database_model.md b/docs/guide/econtent/econtent_features/econtent_database_model.md index 6e68829a8f..049ba246fc 100644 --- a/docs/guide/econtent/econtent_features/econtent_database_model.md +++ b/docs/guide/econtent/econtent_features/econtent_database_model.md @@ -17,7 +17,7 @@ For more information, see [eContent staging system](staging_system.md). !!! note - eZ Commerce uses Doctrine entities to create these tables. + [[= product_name_com =]] uses Doctrine entities to create these tables. It is impossible to create indexes for the table `sve_object_attributes` for the `data_text` attribute with Doctrine. You must create the indexes manually every time you run `php bin/console doctrine:schema:update --force` @@ -26,7 +26,7 @@ For more information, see [eContent staging system](staging_system.md). The table `sve_object` contains one entry for each product group, product, etc. You can arrange data in a tree structure by using the field `parent_id`, which is the Location ID of the parent. -Location IDs start from 2 due to compatibility with the eZ Platform data structure. +Location IDs start from 2 due to compatibility with the [[= product_name_oss =]] data structure. This table contains several other pieces of information in addition to Content Type ID and Location ID, for example: diff --git a/docs/guide/econtent/econtent_features/indexing_econtent_data/indexing_econtent_data.md b/docs/guide/econtent/econtent_features/indexing_econtent_data/indexing_econtent_data.md index acdf92805d..547422ac23 100644 --- a/docs/guide/econtent/econtent_features/indexing_econtent_data/indexing_econtent_data.md +++ b/docs/guide/econtent/econtent_features/indexing_econtent_data/indexing_econtent_data.md @@ -1,6 +1,6 @@ # Indexing eContent data -If eZ Commerce is configured to use eContent as data provider, the following things have to be taken into consideration when indexing. +If [[= product_name_com =]] is configured to use eContent as data provider, the following things have to be taken into consideration when indexing. ## Default indexing diff --git a/docs/guide/econtent/econtent_features/indexing_econtent_data/solr_cores_for_econtent.md b/docs/guide/econtent/econtent_features/indexing_econtent_data/solr_cores_for_econtent.md index 7ba3bb6927..417366e337 100644 --- a/docs/guide/econtent/econtent_features/indexing_econtent_data/solr_cores_for_econtent.md +++ b/docs/guide/econtent/econtent_features/indexing_econtent_data/solr_cores_for_econtent.md @@ -7,7 +7,7 @@ After the processes are finished, the temporary cores are swapped with the produ ## Adapt configuration for two Solr eContent cores -The standard configuration for eZ Commerce supports two Solr eContent cores by default (see `app/config/ezcommerce_advanced.yml`). +The standard configuration for [[= product_name_com =]] supports two Solr eContent cores by default (see `app/config/ezcommerce_advanced.yml`). In `ezpublish/config/config.yml`: @@ -62,7 +62,7 @@ parameters: ## Manual changes in Solr -eZ Commerce comes with an bash script which installs the Solr engine and adapts the configuration for Solr: +[[= product_name_com =]] comes with an bash script which installs the Solr engine and adapts the configuration for Solr: ``` bash bash ./install-solr.sh 8983 diff --git a/docs/guide/econtent/econtent_features/staging_system.md b/docs/guide/econtent/econtent_features/staging_system.md index 5ac33efdba..914e437183 100644 --- a/docs/guide/econtent/econtent_features/staging_system.md +++ b/docs/guide/econtent/econtent_features/staging_system.md @@ -2,7 +2,7 @@ eContent supports a staging area. The product catalog can exist either as a live version which is used for the customer, or a staging (temporary) version, which can be used for staging and importing purposes. -eZ Commerce offers tools to switch between the production and staging versions. +[[= product_name_com =]] offers tools to switch between the production and staging versions. ## Best practice diff --git a/docs/guide/environments.md b/docs/guide/environments.md index 1a499d0692..e9a5fef4dc 100644 --- a/docs/guide/environments.md +++ b/docs/guide/environments.md @@ -1,6 +1,6 @@ # Environments -Environment configuration is provided by Symfony. eZ Platform additionally enables you to specify environments in virtual host configuration. +Environment configuration is provided by Symfony. [[= product_name_oss =]] additionally enables you to specify environments in virtual host configuration. You can configure several environments, such as production, development or staging. You can have different configuration sets for each of them. !!! tip diff --git a/docs/guide/erp_integration/connecting_shop_to_erp.md b/docs/guide/erp_integration/connecting_shop_to_erp.md index 21916acffc..a2c59206d6 100644 --- a/docs/guide/erp_integration/connecting_shop_to_erp.md +++ b/docs/guide/erp_integration/connecting_shop_to_erp.md @@ -1,6 +1,6 @@ # Connecting shop to ERP -eZ Commerce can use both webservices/SOAP and REST transfer protocols to connect to ERP. +[[= product_name_com =]] can use both webservices/SOAP and REST transfer protocols to connect to ERP. You can extend the transport layer if you need an additional protocol or way to access the ERP/CRM. @@ -9,7 +9,7 @@ which already comes with prepared interfaces for those ERP systems. There are other options besides using the Web.Connector: -- If the ERP offers a webservice/REST interface, you can connect eZ Commerce directly with the ERP. +- If the ERP offers a webservice/REST interface, you can connect [[= product_name_com =]] directly with the ERP. - You can use an enterprise service bus (ESB). ![](../img/web_connector.png) @@ -200,7 +200,7 @@ silver_erp.config.messages: mapping_identifier: "selectcustomer" ``` -If `mapping_identifier` is defined, eZ Commerce uses a mapping (XSLT based). +If `mapping_identifier` is defined, [[= product_name_com =]] uses a mapping (XSLT based). The Web.Connector performs mapping for each message according to the following configuration: diff --git a/docs/guide/erp_integration/erp_communication/erp_communication.md b/docs/guide/erp_integration/erp_communication/erp_communication.md index 3da1ace485..d5b280671c 100644 --- a/docs/guide/erp_integration/erp_communication/erp_communication.md +++ b/docs/guide/erp_integration/erp_communication/erp_communication.md @@ -1,6 +1,6 @@ # ERP communication -eZ Commerce uses the logic of an ERP system in different situations: +[[= product_name_com =]] uses the logic of an ERP system in different situations: - During login process, to get customer data - In product detail page (configurable), to get prices and stock infos diff --git a/docs/guide/erp_integration/erp_communication/erp_components/erp_component_messages/erp_message_class_generator.md b/docs/guide/erp_integration/erp_communication/erp_components/erp_component_messages/erp_message_class_generator.md index 0a974d1911..a44cac1c89 100644 --- a/docs/guide/erp_integration/erp_communication/erp_components/erp_component_messages/erp_message_class_generator.md +++ b/docs/guide/erp_integration/erp_communication/erp_components/erp_component_messages/erp_message_class_generator.md @@ -51,7 +51,7 @@ The value represents a space-separated list of child element names that are supp The names of the types should be prefixed with either `ses:` or `cust:` -- `ses:` type classes are stored in the eZ Commerce path. XML definition files are always read from the eZ Commerce path. +- `ses:` type classes are stored in the [[= product_name_com =]] path. XML definition files are always read from the [[= product_name_com =]] path. - `cust:` type classes are stored in the defined target directory. XML definition files are always read from the source path. For each type an XML file must be stored in the `src` folder which defines the reusable datatype which is named .xml diff --git a/docs/guide/erp_integration/erp_communication/erp_components/erp_component_messages/erp_message_instantiation.md b/docs/guide/erp_integration/erp_communication/erp_components/erp_component_messages/erp_message_instantiation.md index eeeb9f51a8..32e687b08e 100644 --- a/docs/guide/erp_integration/erp_communication/erp_components/erp_component_messages/erp_message_instantiation.md +++ b/docs/guide/erp_integration/erp_communication/erp_components/erp_component_messages/erp_message_instantiation.md @@ -3,7 +3,7 @@ Message creation uses the mechanics of the [Symfony event dispatcher system.](https://symfony.com/doc/3.4/components/event_dispatcher.html) When a new message is required, a specific service delivers a message object of specific type (e.g. `calculate_sales_order`). -eZ Commerce then dispatches an `InquireMessageEvent` event within that service, +[[= product_name_com =]] then dispatches an `InquireMessageEvent` event within that service, containing the requested message type and a reference to an `AbstractMessage` object. Specific listeners which can create messages can register/subscribe to that event and check if they can create that type of message. In Symfony you can register new listeners for events as services via configuration. diff --git a/docs/guide/erp_integration/erp_communication/erp_components/erp_components.md b/docs/guide/erp_integration/erp_communication/erp_components/erp_components.md index 6a8ba68e5c..617047073e 100644 --- a/docs/guide/erp_integration/erp_communication/erp_components/erp_components.md +++ b/docs/guide/erp_integration/erp_communication/erp_components/erp_components.md @@ -12,7 +12,7 @@ Although this is also a Symfony service, it does not mean that all Symfony servi It includes an event-observer pattern which provides a hook into the message creation and data feeding. - Transport - The transport component is responsible for the serialization and network communication to the remote system. - Mapping - The mapping API is used to transform a specific message format into another. -This may be necessary if the remote system expects a different data structure than the one which is used in the eZ Commerce. +This may be necessary if the remote system expects a different data structure than the one which is used in the [[= product_name_com =]]. The general process looks like this: diff --git a/docs/guide/erp_integration/erp_communication/erp_configuration/adapt_the_mappings_for_erp_functions/adapt_the_mappings_for_erp_functions.md b/docs/guide/erp_integration/erp_communication/erp_configuration/adapt_the_mappings_for_erp_functions/adapt_the_mappings_for_erp_functions.md index 6f80ea59e7..885816db5f 100644 --- a/docs/guide/erp_integration/erp_communication/erp_configuration/adapt_the_mappings_for_erp_functions/adapt_the_mappings_for_erp_functions.md +++ b/docs/guide/erp_integration/erp_communication/erp_configuration/adapt_the_mappings_for_erp_functions/adapt_the_mappings_for_erp_functions.md @@ -1,8 +1,8 @@ # Adapt the mappings for ERP functions -eZ Commerce uses a flexible way to map the request and response between the shop and the ERP system. +[[= product_name_com =]] uses a flexible way to map the request and response between the shop and the ERP system. -By default eZ Commerce comes with a prepared mapping stored in the vendor bundle. +By default [[= product_name_com =]] comes with a prepared mapping stored in the vendor bundle. The mappings can be extended in your project bundles. Your bundle has to be registered as a mapping bundle: diff --git a/docs/guide/erp_integration/erp_communication/erp_logging.md b/docs/guide/erp_integration/erp_communication/erp_logging.md index cb21cbf4c7..d8fdd69964 100644 --- a/docs/guide/erp_integration/erp_communication/erp_logging.md +++ b/docs/guide/erp_integration/erp_communication/erp_logging.md @@ -3,7 +3,7 @@ All communication (request- and response messages) that is performed by the [ERP transport](erp_components/erp_component_transport.md) is recorded by the `siso_erp.logger`. It is a special service of the class `Monolog/Logger`. -To learn more about logging in eZ Commerce in general, see [Logging](../../../guide/logging/logging.md). +To learn more about logging in [[= product_name_com =]] in general, see [Logging](../../../guide/logging/logging.md). ## Adding a log entry @@ -170,7 +170,7 @@ CREATE TABLE `ses_log_erp` ( ## Logging architecture: measuring points -During communication between the eZ Commerce and ERP, messages pass several instances of processing. +During communication between the [[= product_name_com =]] and ERP, messages pass several instances of processing. In order to reconstruct how a message is processed, [the transport layer](erp_components/erp_component_transport.md) writes a message's content multiple times into the log - once for every important process step. These points in time of writing a message into the log are called measuring points. diff --git a/docs/guide/erp_integration/erp_communication/guides/creating_a_new_erp_message/create_project_specific_message.md b/docs/guide/erp_integration/erp_communication/guides/creating_a_new_erp_message/create_project_specific_message.md index 4671596152..e62a14cd9d 100644 --- a/docs/guide/erp_integration/erp_communication/guides/creating_a_new_erp_message/create_project_specific_message.md +++ b/docs/guide/erp_integration/erp_communication/guides/creating_a_new_erp_message/create_project_specific_message.md @@ -144,7 +144,7 @@ php bin/console silversolutions:generatemessages --message selectModifiedData -- There should be a symlink to the mapping in `app/Resources`: `xsl` - project symlink for the specific project - always has a higher priority - `xslbase` - standard symlink for eZ Commerce as a default + `xslbase` - standard symlink for [[= product_name_com =]] as a default ``` bash cd app/Resources diff --git a/docs/guide/erp_integration/erp_communication/guides/creating_a_new_erp_message/create_standard_message.md b/docs/guide/erp_integration/erp_communication/guides/creating_a_new_erp_message/create_standard_message.md index 445cf03349..62886ea2e9 100644 --- a/docs/guide/erp_integration/erp_communication/guides/creating_a_new_erp_message/create_standard_message.md +++ b/docs/guide/erp_integration/erp_communication/guides/creating_a_new_erp_message/create_standard_message.md @@ -286,7 +286,7 @@ instead of overriding the .xml and re-generating of the messages. There should be a symlink to the mapping in `app/Resources`: `xsl` - project symlink for the specific project - always has a higher priority - `xslbase` - standard symlink for eZ Commerce as a default + `xslbase` - standard symlink for [[= product_name_com =]] as a default ``` bash cd app/Resources diff --git a/docs/guide/erp_integration/erp_integration.md b/docs/guide/erp_integration/erp_integration.md index 97ddd695af..25901dee4d 100644 --- a/docs/guide/erp_integration/erp_integration.md +++ b/docs/guide/erp_integration/erp_integration.md @@ -1,6 +1,6 @@ # ERP integration -eZ Commerce can communicate with ERP systems. It uses the data and logic already provided by ERP. +[[= product_name_com =]] can communicate with ERP systems. It uses the data and logic already provided by ERP. This ensures that the shop is always up to date. The complex logic and processes already implemented in the ERP can be reused. @@ -18,14 +18,14 @@ If your ERP supports webservices directly, see [Configuration for webservice-bas ### Adapting the mapping -eZ Commerce uses the UBL ([Universal Business Language](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=ubl)) standard to model business data. +[[= product_name_com =]] uses the UBL ([Universal Business Language](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=ubl)) standard to model business data. ERP systems usually use vendor-specific structures and attribute names. An XSLT-based mapping feature enables adapting the mapping between these formats. See [Adapt the mappings for ERP functions](erp_communication/erp_configuration\adapt_the_mappings_for_erp_functions/adapt_the_mappings_for_erp_functions.md) for more details. ### Monitoring the ERP connection -The Back Office provides a monitoring service which enables checking all messages exchanged between ERP and eZ Commerce. +The Back Office provides a monitoring service which enables checking all messages exchanged between ERP and [[= product_name_com =]]. After selecting a date range and a measuring point (recommended: "Request data before and after mapping" and "Response data before and after mapping"), you get more details about the request sent to the ERP system and the applied mapping. @@ -38,21 +38,21 @@ you get more details about the request sent to the ERP system and the applied ma ## Supported ERP systems -eZ Commerce offers out-of-the-box interfaces and connectors for: +[[= product_name_com =]] offers out-of-the-box interfaces and connectors for: - Microsoft Dynamics NAV - Microsoft Dynamics AX - SAP -Since eZ Commerce offers an open interface using standards (REST, Webservices and a standard XML Format UBL), +Since [[= product_name_com =]] offers an open interface using standards (REST, Webservices and a standard XML Format UBL), you can adapt other ERP systems as well. -To be connected to eZ Commerce, an ERP system must be open (offer e.g. a REST or webservice interface) +To be connected to [[= product_name_com =]], an ERP system must be open (offer e.g. a REST or webservice interface) and must offer the supported functions. ### Supported processes with ERP integration -eZ Commerce and the ERP system exchange the following data. +[[= product_name_com =]] and the ERP system exchange the following data. The details of data exchange depend on the project-specific configuration, because in complex configurations other systems might provide data as well (for example a PIM system). diff --git a/docs/guide/file_management.md b/docs/guide/file_management.md index ada2521896..d2f197e612 100644 --- a/docs/guide/file_management.md +++ b/docs/guide/file_management.md @@ -2,7 +2,7 @@ ## Handling binary files -eZ Platform supports multiple binary file handling mechanisms by means of an `IOHandler` interface. This feature is used by the [BinaryFile](../api/field_type_reference.md#binaryfile-field-type), [Media](../api/field_type_reference.md#media-field-type) and [Image](../api/field_type_reference.md#image-field-type) Field Types. +[[= product_name_oss =]] supports multiple binary file handling mechanisms by means of an `IOHandler` interface. This feature is used by the [BinaryFile](../api/field_type_reference.md#binaryfile-field-type), [Media](../api/field_type_reference.md#media-field-type) and [Image](../api/field_type_reference.md#image-field-type) Field Types. ### Native IO handler @@ -84,7 +84,7 @@ Default values are 0644 for files and 0755 for directories. [league/flysystem](http://flysystem.thephpleague.com/) (along with [FlysystemBundle](https://github.com/1up-lab/OneupFlysystemBundle/)) is an abstract file handling library. -eZ Platform uses it as the default way to read and write content in form of binary files. Flysystem can use the `local` filesystem (this is the default and officially supported configuration), but is also able to read/write to `sftp`, `zip` or cloud filesystems (`azure`, `rackspace`, `S3`). +[[= product_name_oss =]] uses it as the default way to read and write content in form of binary files. Flysystem can use the `local` filesystem (this is the default and officially supported configuration), but is also able to read/write to `sftp`, `zip` or cloud filesystems (`azure`, `rackspace`, `S3`). #### Handler options diff --git a/docs/guide/forms/form_api/dataprocessors.md b/docs/guide/forms/form_api/dataprocessors.md index 004197d57a..e4534df34d 100644 --- a/docs/guide/forms/form_api/dataprocessors.md +++ b/docs/guide/forms/form_api/dataprocessors.md @@ -69,7 +69,7 @@ The data processor sets the following fields in the User Content item: - `ses_hastopay_vat` - `ses_display_vat` -eZ Commerce provides a standard event for this handler which adds a prefix to the login name of the user. +[[= product_name_com =]] provides a standard event for this handler which adds a prefix to the login name of the user. The prefix can be defined in the configuration key `data_processor_ez_user_login_prefix`. ``` xml diff --git a/docs/guide/forms/form_api/form_api.md b/docs/guide/forms/form_api/form_api.md index 998317940a..2d08a83255 100644 --- a/docs/guide/forms/form_api/form_api.md +++ b/docs/guide/forms/form_api/form_api.md @@ -17,7 +17,7 @@ Every `dataProcessor` can set an additional error message that is displayed for ## Form validators Besides standard [Symfony validators,](http://symfony.com/doc/3.4/validation.html) -eZ Commerce offers additional validators. +[[= product_name_com =]] offers additional validators. ### ZIP validator diff --git a/docs/guide/forms/forms.md b/docs/guide/forms/forms.md index 701ca2302e..4c59f9aec7 100644 --- a/docs/guide/forms/forms.md +++ b/docs/guide/forms/forms.md @@ -1,6 +1,6 @@ # Forms -eZ Commerce offers a unified way of handling all one-page forms. +[[= product_name_com =]] offers a unified way of handling all one-page forms. One-page forms have several common criteria: @@ -8,7 +8,7 @@ One-page forms have several common criteria: - After submitting some processes are executed in the backend. - After server response the user sees a confirmation page with a success or error message. -eZ Commerce uses [Symfony forms](http://symfony.com/doc/3.4/forms.html) as a part of the solution. +[[= product_name_com =]] uses [Symfony forms](http://symfony.com/doc/3.4/forms.html) as a part of the solution. You can pre-fill the form with default values when it is loaded for the first time. The process that pre-fills the form is called a [pre-data processor](form_api/predataprocessors.md). diff --git a/docs/guide/http_cache.md b/docs/guide/http_cache.md index 4eb33b0b9d..5a0079277d 100644 --- a/docs/guide/http_cache.md +++ b/docs/guide/http_cache.md @@ -1,13 +1,13 @@ # HTTP cache -eZ Platform provides highly advanced caching features needed for its own content views, taking advantage +[[= product_name_oss =]] provides highly advanced caching features needed for its own content views, taking advantage of sophisticated techniques to make Varnish and Fastly act as the view cache for the system. This and other features -allow eZ Platform to be scaled up to serve high traffic websites and applications. +allow [[= product_name_oss =]] to be scaled up to serve high traffic websites and applications. This is handled by the [ezplatform-http-cache](https://github.com/ezsystems/ezplatform-http-cache) bundle, which extends [friendsofsymfony/http-cache-bundle](https://foshttpcachebundle.readthedocs.io/en/2.8.0/), a Symfony community bundle that in turn extends [Symfony HTTP cache](http://symfony.com/doc/5.1/http_cache.html). -For content view responses coming from eZ Platform itself, this means: +For content view responses coming from [[= product_name_oss =]] itself, this means: - Cache is **[content-aware](#content-aware-http-cache)**, always kept up-to-date by invalidating using cache tags. - Cache is **[context-aware](#context-aware-http-cache)**, to cache request for logged in users by varying on user _rights_. @@ -50,7 +50,7 @@ To avoid this, installation ships with configuration to match those specific sit fos_http_cache: cache_control: rules: - # Make sure cacheable (fresh) responses from eZ Platform which are errors/redirects get lower TTL than default_ttl + # Make sure cacheable (fresh) responses from Ibexa Platform which are errors/redirects get lower TTL than default_ttl - match: match_response: 'response.isFresh() && ( response.isServerError() || response.isClientError() || response.isRedirect() )' @@ -114,7 +114,7 @@ have to wait for backend and not be able to deliver cached pages directly. ## Using Varnish or Fastly -As eZ Platform is built on top of Symfony, it uses standard HTTP cache headers. +As [[= product_name_oss =]] is built on top of Symfony, it uses standard HTTP cache headers. By default, the Symfony reverse proxy, written in PHP, is used to handle cache. But it can be easily replaced with reverse proxies like Varnish or CDN like Fastly. This is highly recommended as they provide far better performance and more advance features like grace handling, configurable logic through VCL and much more. @@ -135,14 +135,14 @@ For setup to work properly with your installation, you'll need to adapt one of t When you extend [FOSHttpCacheBundle](https://foshttpcachebundle.readthedocs.io/en/2.8.0/), you can also adapt your VCL further with [FOSHttpCache documentation](http://foshttpcache.readthedocs.org/en/latest/varnish-configuration.html) in order to use additional features. -### Configure eZ Platform +### Configure [[= product_name_oss =]] -Configuring eZ Platform for Varnish or Fastly involves a few steps, starting with configuring proxy. +Configuring [[= product_name_oss =]] for Varnish or Fastly involves a few steps, starting with configuring proxy. #### Configuring Symfony Front Controller In a pure Symfony installation you would normally adapt Front Controller (`web/app.php`) [in order to configure Symfony to work behind a Load Balancer or a Reverse Proxy](https://symfony.com/doc/5.1/deployment/proxies.html), -however in eZ Platform you can cover most use cases by setting supported environment variables using: +however in [[= product_name_oss =]] you can cover most use cases by setting supported environment variables using: - `APP_HTTP_CACHE`: To enable (`"1"`) or disable (`"0"`) use of Symfony HttpCache reverse proxy - *Must* be disabled when using Varnish or Fastly. @@ -165,12 +165,12 @@ however in eZ Platform you can cover most use cases by setting supported environ and that there is no other way to configure it. -See [Examples for configuring eZ Platform](#Examples-for-configuring-eZ-Platform) for how these variables can be set. +See [Examples for configuring [[= product_name_oss =]]](#Examples-for-configuring-Ibexa-Platform) for how these variables can be set. #### Update YML configuration -Secondly, you need to tell eZ Platform to use an HTTP-based purge client (specifically the FosHttpCache Varnish purge client), +Secondly, you need to tell [[= product_name_oss =]] to use an HTTP-based purge client (specifically the FosHttpCache Varnish purge client), and specify the URL Varnish can be reached on (in `config/packages/ezplatform.yaml`): @@ -201,12 +201,12 @@ ezplatform: !!! note "Invalidating Varnish cache using tokens" - In setups where the Varnish server IP can change (for example on platform.sh/eZ Platform Cloud), + In setups where the Varnish server IP can change (for example on platform.sh/Ibexa Cloud), you can use token-based cache invalidation via [ez_purge_acl.](https://github.com/ezsystems/ezplatform-http-cache/blob/v2.1.0/docs/varnish/vcl/varnish5.vcl#L174) In such a case use a strong, secure hash and make sure to keep the token secret. -!!! enterprise +!!! dxp #### Ensure proper Captcha behavior @@ -247,7 +247,7 @@ ezplatform: #### Using Fastly as HttpCache proxy - [Fastly](https://www.fastly.com/) delivers Varnish as a CDN service and is supported with eZ Platform Enterprise. + [Fastly](https://www.fastly.com/) delivers Varnish as a CDN service and is supported with [[= product_name_ee =]]. See, [Fastly documentation](https://docs.fastly.com/guides/basic-concepts/how-fastlys-cdn-service-works) to learn how it works. ##### Configuring Fastly in YML @@ -298,7 +298,7 @@ ezplatform: instructions on how to generate a Fastly API token. The token needs `purge_select` and `purge_all` scope. -#### Examples for configuring eZ Platform +#### Examples for configuring [[= product_name_oss =]] Below you will find the most common examples for configuring the system completely by environment variables. @@ -384,7 +384,7 @@ concurrent requests for the same page to the backend, the following happens when - If cache is still within grace period, first and subsequent requests for the content is served from cache, and doesn't wait for the asynchronous lookup to finish - The backend lookup finishes and refreshes the cache so any subsequent requests gets a fresh cache -By default, eZ Platform always "Soft Purges" content on reverse proxies that support it (Varnish and Fastly), with +By default, [[= product_name_oss =]] always "Soft Purges" content on reverse proxies that support it (Varnish and Fastly), with the following logic in the out-of-the-box VCL: - Cache is within grace @@ -405,7 +405,7 @@ Serving grace is not always allowed by default because: ## Context-aware HTTP cache -eZ Platform allows caching request made by logged in users, it is called (user) context aware cache. +[[= product_name_oss =]] allows caching request made by logged in users, it is called (user) context aware cache. It means that HttpCache is unique per user permissions (roles and limitations), there are variations of cache shared only among users that have the exact same permissions. So if a user is browsing a list of children Locations, @@ -433,7 +433,7 @@ hash lookup itself is cached by the cache proxy as well as described below. ##### User Context Hash caching -Example of response sent to reverse proxy from `/_fos_user_context_hash` with [eZ Platform's default config](#default-options-for-foshttpcachebundle-defined-in-ez-platform): +Example of response sent to reverse proxy from `/_fos_user_context_hash` with [[[= product_name_oss =]]'s default config](#default-options-for-foshttpcachebundle-defined-in-ez-platform): ``` HTTP/1.1 200 OK @@ -466,9 +466,9 @@ It also varies on `Authorization` to cover any possible basic auth headers in ca Only known workaround would be to make it SiteAccess aware, and have custom VCL logic tied to your SiteAccess matching with Varnish/Fastly, in order to send SiteAccess prefix as URI. -##### Default options for FOSHttpCacheBundle defined in eZ Platform +##### Default options for FOSHttpCacheBundle defined in [[= product_name_oss =]] -The following configuration is defined in eZ Platform by default for FOSHttpCacheBundle. +The following configuration is defined in [[= product_name_oss =]] by default for FOSHttpCacheBundle. Typically, you should not override these settings unless you know what you are doing. ``` yaml @@ -489,7 +489,7 @@ fos_http_cache: #### How to Personalize Responses -Here are some generic recommendations on how to approach personalized content with eZ Platform / Symfony: +Here are some generic recommendations on how to approach personalized content with [[= product_name_oss =]] / Symfony: 1\. ESI + Vary by Cookie: @@ -530,8 +530,8 @@ Example: Refer to [FOSHttpCacheBundle documentation on how user context hashes are generated](https://foshttpcachebundle.readthedocs.io/en/2.8.0/features/user-context.html#generating-hashes). -eZ Platform implements a custom context provider in order to make user context hash reflect the current User's permissions -and Limitations, this is needed given eZ Platform's more complex permission model compared to Symfony's. +[[= product_name_oss =]] implements a custom context provider in order to make user context hash reflect the current User's permissions +and Limitations, this is needed given [[= product_name_oss =]]'s more complex permission model compared to Symfony's. You can technically extend the user context hash by [implementing your own custom context provider(s)](https://foshttpcachebundle.readthedocs.io/en/2.8.0/reference/configuration/user-context.html#custom-context-providers), however **this is strongly discouraged** as it will mean you'll increase amount of cache variations stored in Proxy for every single cache item, lowering cache hit ratio and increasing memory use. @@ -608,7 +608,7 @@ To avoid overloading any application code, you will take advantage of Symfony's ## Content-aware HTTP cache -HTTP cache in eZ Platform is "aware" of which content or entity it is connected to, this awareness is accomplished +HTTP cache in [[= product_name_oss =]] is "aware" of which content or entity it is connected to, this awareness is accomplished by means of "cache tagging". All supported reverse proxies are content-aware. !!! note "Tag header is stripped in production for security reasons" @@ -639,7 +639,7 @@ when someone requests them. !!! note "Automatically repository prefixing of cache tags" - As eZ Platform support multi repository (multi database) setups that can have overlapping ID's. It's shared + As [[= product_name_oss =]] support multi repository (multi database) setups that can have overlapping ID's. It's shared HTTP cache systems need to distinguish tags relevant to the different content repositories. This is why in multi repository setup you'll see cache tags such as `1p2`. Where `1` represents the index among diff --git a/docs/guide/images.md b/docs/guide/images.md index 6199f26f0e..10ef79cfea 100644 --- a/docs/guide/images.md +++ b/docs/guide/images.md @@ -56,7 +56,7 @@ The following parameters are set for each variation: ### Built-in image variations -A few basic image variations are included by default in eZ Platform in the `default_settings.yaml` config file: +A few basic image variations are included by default in [[= product_name_oss =]] in the `default_settings.yaml` config file: ``` yaml ezsettings.default.image_variations: @@ -103,7 +103,7 @@ Please refer to [post-processor documentation in LiipImagineBundle](http://symfo ## Configuration examples -### Scaling with an eZ Platform filter +### Scaling with an [[= product_name_oss =]] filter This configuration defines a `medium` image variation that is scaled to a width of 700 px. @@ -123,7 +123,7 @@ ezplatform: This configuration adds a limit to the image quality using a liip filter. -You can use both an eZ Platform and a liip filter for the same image variation, in this case `medium`. +You can use both an [[= product_name_oss =]] and a liip filter for the same image variation, in this case `medium`. ``` yaml ezplatform: @@ -186,7 +186,7 @@ The first example will clear the image files for the `large` variation. The sec !!! caution "Code injection in image EXIF" - EXIF metadata of an image may contain e.g. HTML, JavaScript, or PHP code. eZ Platform is itself does not parse EXIF metadata, but third-party bundles need to be secured against this eventuality. Images should be treated like any other user-submitted data - make sure the metadata is properly escaped before use. + EXIF metadata of an image may contain e.g. HTML, JavaScript, or PHP code. [[= product_name_oss =]] is itself does not parse EXIF metadata, but third-party bundles need to be secured against this eventuality. Images should be treated like any other user-submitted data - make sure the metadata is properly escaped before use. ### Resolving image URLs @@ -221,7 +221,7 @@ LiipImagineBundle supports additional settings, it is possible to combine filter ### Discarded filters -The following filters exist in the Imagine library but are not used in eZ Platform due to incompatibility: +The following filters exist in the Imagine library but are not used in [[= product_name_oss =]] due to incompatibility: - `flatten`. Obsolete, images are automatically flattened. - `bordercolor` @@ -239,7 +239,7 @@ Placeholder generator enables you to download or use generated image placeholder `PlaceholderAliasGenerator::getVariation` method generates placeholder (by delegating it to the implementation of `PlaceholderProvider` interface) if original image cannot be resolved and saves it under the original path. -In eZ Platform there are two implementations of `PlaceholderProvider` interface: +In [[= product_name_oss =]] there are two implementations of `PlaceholderProvider` interface: - [GenericProvider](#genericprovider) - [RemoteProvider](#remoteprovider) diff --git a/docs/guide/internationalization.md b/docs/guide/internationalization.md index 6e53470d14..fd8157e7ab 100644 --- a/docs/guide/internationalization.md +++ b/docs/guide/internationalization.md @@ -2,7 +2,7 @@ ## Language versions -eZ Platform offers the ability to create multiple language versions (translations) of a Content item. +[[= product_name_oss =]] offers the ability to create multiple language versions (translations) of a Content item. Translations are created per version of the item, so each version of the content can have a different set of translations. A version always has at least one translation which by default is the *initial/main* translation. Further versions can be added, but only for languages that have previously been [added to the global translation list](#adding-available-languages), that is a list of all languages available in the system. The maximum number of languages in the system is 62. @@ -28,7 +28,7 @@ yarn encore Language versions consist of translated values of the Content item's Fields. In the Content Type definition every Field is set to be Translatable or not. -eZ Platform does not decide by itself which Fields can be translated and which cannot. For some Field values the need for a translation can be obvious, for example for the body of an article. In other cases, for instance images without text, integer numbers or e-mail addresses, translation is usually unnecessary. Despite that, eZ Platform gives you the possibility to mark any Field as translatable regardless of its Field Type. It is only your decision to exclude the translation possibility for those Fields where it makes no sense. +[[= product_name_oss =]] does not decide by itself which Fields can be translated and which cannot. For some Field values the need for a translation can be obvious, for example for the body of an article. In other cases, for instance images without text, integer numbers or e-mail addresses, translation is usually unnecessary. Despite that, [[= product_name_oss =]] gives you the possibility to mark any Field as translatable regardless of its Field Type. It is only your decision to exclude the translation possibility for those Fields where it makes no sense. When a Field is not flagged as Translatable, its value will be copied from the initial/main translation when a new language version is created. This copied value cannot be modified. When a Field is Translatable, you will have to enter its value in a new language version manually. diff --git a/docs/guide/limitation_reference.md b/docs/guide/limitation_reference.md index df550f7465..54aec33417 100644 --- a/docs/guide/limitation_reference.md +++ b/docs/guide/limitation_reference.md @@ -112,7 +112,7 @@ This Limitation combined with `ContentType` Limitation allows you to define busi |------|------|------| |``|``|All valid Content Type IDs can be set as value(s)| -!!! enterprise +!!! dxp ## Field Group Limitation diff --git a/docs/guide/logging/logging.md b/docs/guide/logging/logging.md index 28a5003a11..ca8a47d110 100644 --- a/docs/guide/logging/logging.md +++ b/docs/guide/logging/logging.md @@ -1,6 +1,6 @@ # Logging -eZ Commerce uses [Monolog](https://github.com/Seldaek/monolog) to log the most important information. +[[= product_name_com =]] uses [Monolog](https://github.com/Seldaek/monolog) to log the most important information. The default implementation writes standard shop-related information into a single log file. Emails and ERP communication are written into the database to make it easier to process them for administrative (HTML) presentation. @@ -8,7 +8,7 @@ Emails and ERP communication are written into the database to make it easier to Some logs can contain personal information which can be affected by the GDPR regulations. -By default, eZ Commerce does not log the User ID for logging search query: +By default, [[= product_name_com =]] does not log the User ID for logging search query: ``` yaml siso_core.default.gdpr.store_user_id_in_logs: false diff --git a/docs/guide/logging/logging_api.md b/docs/guide/logging/logging_api.md index 6e5be4cd37..914466b387 100644 --- a/docs/guide/logging/logging_api.md +++ b/docs/guide/logging/logging_api.md @@ -1,6 +1,6 @@ # Logging API -Logging in eZ Commerce is based on Monolog. There is no separate logging API definition. +Logging in [[= product_name_com =]] is based on Monolog. There is no separate logging API definition. For the purpose of persisting logs within a database, the Monolog API implementation has been extended by Doctrine-based classes and an interface. diff --git a/docs/guide/login_and_registration/forgot_change_password.md b/docs/guide/login_and_registration/forgot_change_password.md index ca44b417af..f8e30f4b04 100644 --- a/docs/guide/login_and_registration/forgot_change_password.md +++ b/docs/guide/login_and_registration/forgot_change_password.md @@ -78,7 +78,7 @@ siso_core.default.forget_password_token_valid: 1 hour ``` The shop allows registrations of more than one account with the same email address. -This is useful when eZ Commerce runs a B2B and a B2C shop in one installation. +This is useful when [[= product_name_com =]] runs a B2B and a B2C shop in one installation. ## Change password diff --git a/docs/guide/login_and_registration/login_and_registration.md b/docs/guide/login_and_registration/login_and_registration.md index d4ae5f734a..3111ee8cc7 100644 --- a/docs/guide/login_and_registration/login_and_registration.md +++ b/docs/guide/login_and_registration/login_and_registration.md @@ -1,8 +1,8 @@ # Login and registration -eZ Commerce uses eZ Platform's user management functionality. Users are located in the "Users" Section. +[[= product_name_com =]] uses [[= product_name_oss =]]'s user management functionality. Users are located in the "Users" Section. -eZ Commerce extends the user management with the following attributes: +[[= product_name_com =]] extends the user management with the following attributes: - Customer profile data - Customer number @@ -30,14 +30,14 @@ When a user logs in: - The shop checks if the user has a contact number - The contact data from the ERP is fetched and stored in Customer profile data as well. -When the data is stored in the ERP, the shop takes care of the versions created by eZ Platform. -eZ Platform limits the number of versions created per Content item. +When the data is stored in the ERP, the shop takes care of the versions created by [[= product_name_oss =]]. +[[= product_name_oss =]] limits the number of versions created per Content item. The shop uses a setting to limit the number of versions (`silver_tools.default.versions_count: 10`) and removes the archived versions. If the number of versions to be removed exceeds 20, only 20 versions are removed to ensure the login process does not take too much time (and lead to a timeout). ## Login -eZ Commerce provides a flexible login functionality. A user can log in to the shop with a username or email and a password. +[[= product_name_com =]] provides a flexible login functionality. A user can log in to the shop with a username or email and a password. Additionally, you can add a field "customer number", which is required for logging into the customer center. The methods `retrieveUser()` and `checkAuthentication()` of `AuthenticationProvider` are overriden to provide the login functionality. @@ -50,7 +50,7 @@ The search looks in subfolders such as business, private or editors. ## Registration options -eZ Commerce provides different options for users to register in the shop. +[[= product_name_com =]] provides different options for users to register in the shop. There are different registration forms for different target groups, such as private or business customers. diff --git a/docs/guide/login_and_registration/login_and_registration_cookbook.md b/docs/guide/login_and_registration/login_and_registration_cookbook.md index b09f10e9cb..d051df279f 100644 --- a/docs/guide/login_and_registration/login_and_registration_cookbook.md +++ b/docs/guide/login_and_registration/login_and_registration_cookbook.md @@ -1,6 +1,6 @@ # Login and registration cookbook -eZ Commerce is able to check credentials not only specified by username and password, +[[= product_name_com =]] is able to check credentials not only specified by username and password, but also using customer number (which could be taken from ERP system). ## Services diff --git a/docs/guide/multi_language_siteaccesses.md b/docs/guide/multi_language_siteaccesses.md index b02ad7357f..b710b86ea3 100644 --- a/docs/guide/multi_language_siteaccesses.md +++ b/docs/guide/multi_language_siteaccesses.md @@ -123,7 +123,7 @@ You should now be able to reload your site in the `en` and `fr` SiteAccess. ## Replace the `site` SiteAccess -eZ Platform ships with a pre-configured SiteAccess named `site`. +[[= product_name_oss =]] ships with a pre-configured SiteAccess named `site`. As you have now successfully introduced two new SiteAccesses, remove the `site` SiteAccess as it is no longer required. It was not possible to remove `site` before, as you first needed to give the appropriate permissions to the new SiteAccesses (`en` and `fr`), without which your site would not have loaded correctly. @@ -148,4 +148,4 @@ siteaccess: Clear the cache by running: `php bin/console cache:clear`. -Now you should be able to load your eZ Platform site using the `en` and `fr` SiteAccess to display content in English and French. +Now you should be able to load your [[= product_name_oss =]] site using the `en` and `fr` SiteAccess to display content in English and French. diff --git a/docs/guide/multisite.md b/docs/guide/multisite.md index 6d74b695fb..4ad0bdd328 100644 --- a/docs/guide/multisite.md +++ b/docs/guide/multisite.md @@ -2,7 +2,7 @@ ## Introduction -You can serve multiple different sites using one eZ Platform instance and database. +You can serve multiple different sites using one [[= product_name_oss =]] instance and database. Each site will have its own content root, at a lower level than the default one (Location ID 2). You can use one global back office for all sites, or a separate back office for each site. @@ -52,7 +52,7 @@ In the example above, the Media and Images folders will be accessible using thei ## Configuration example -To see how multisite can be used, let's look at an example of two sites using the same eZ Platform instance: a general company site and a site for a specific event. +To see how multisite can be used, let's look at an example of two sites using the same [[= product_name_oss =]] instance: a general company site and a site for a specific event. Separate SiteAccesses are set up for the two sites: ``` yaml @@ -142,7 +142,7 @@ To configure multisite with multiple Repositories, [configure the repositories]( ## Different designs for multiple sites -eZ Platform does not apply a [Legacy template fallback](https://doc.ez.no/display/EZP/Legacy+template+fallback) like eZ Publish did. +[[= product_name_oss =]] does not apply a [Legacy template fallback](https://doc.ez.no/display/EZP/Legacy+template+fallback) like eZ Publish did. You can, however, have different designs in your multisite installation if you organize the view configuration with the use of SiteAccesses. Looking back at the [previous example](#configuration-example), you can apply different designs to the two sites, but use some common templates. diff --git a/docs/guide/newsletter/newsletter.md b/docs/guide/newsletter/newsletter.md index 63e7d974e4..5f846ebec9 100644 --- a/docs/guide/newsletter/newsletter.md +++ b/docs/guide/newsletter/newsletter.md @@ -1,13 +1,13 @@ # Newsletter -eZ Commerce offers a newsletter interface. This allows the user to subscribe to newsletters +[[= product_name_com =]] offers a newsletter interface. This allows the user to subscribe to newsletters and see the newsletter status or update newsletter details information in their profile. There is no specific newsletter provider connection configured out of the box. The standard offers only processes, templates, routes, configurations and an interface which can be used for newsletter integration. A newsletter provider service with specific API implementation of this provider has to be implemented separately. -## Newsletter features in eZ Commerce +## Newsletter features in [[= product_name_com =]] - Double-opt-in process when a user subscribes to the newsletter - User can subscribe from the newsletter box diff --git a/docs/guide/newsletter/newsletter_interface.md b/docs/guide/newsletter/newsletter_interface.md index 19e9f87010..66367bbc7b 100644 --- a/docs/guide/newsletter/newsletter_interface.md +++ b/docs/guide/newsletter/newsletter_interface.md @@ -1,6 +1,6 @@ # Newsletter interface -eZ Commerce provides a common interface for newsletter providers: `Siso\Bundle\NewsletterBundle\Api\NewsletterInterface`. If another newsletter provider is used, the following methods have to be implemented. +[[= product_name_com =]] provides a common interface for newsletter providers: `Siso\Bundle\NewsletterBundle\Api\NewsletterInterface`. If another newsletter provider is used, the following methods have to be implemented. ## subscribeNewsletter/unsubscribeNewsletter diff --git a/docs/guide/order_history/order_history_features/orderhistory_local_orders.md b/docs/guide/order_history/order_history_features/orderhistory_local_orders.md index bff9e36de8..1767bcf5a7 100644 --- a/docs/guide/order_history/order_history_features/orderhistory_local_orders.md +++ b/docs/guide/order_history/order_history_features/orderhistory_local_orders.md @@ -14,7 +14,7 @@ siso_order_history.default.use_local_documents: false The feature uses event listeners, so the standard logic does not change if this value is set to false. -eZ Commerce offers an event listener which uses the `ConfigurationEvents::READ_CONFIGURATION` event. +[[= product_name_com =]] offers an event listener which uses the `ConfigurationEvents::READ_CONFIGURATION` event. This listener is disabled by default, so you need to activate it in your project: ``` yaml diff --git a/docs/guide/order_history/orderhistory_configuration.md b/docs/guide/order_history/orderhistory_configuration.md index e7612ed559..9d0940779b 100644 --- a/docs/guide/order_history/orderhistory_configuration.md +++ b/docs/guide/order_history/orderhistory_configuration.md @@ -4,7 +4,7 @@ Order history uses semantic configuration, so it only exposes parameters that ar However it is possible to [override this configuration per SiteAccess](overriding_semantic_configuration.md). When an event is thrown, before the configuration is used, you can implement a listener that changes this configuration. -eZ Commerce uses this event to display [local orders](order_history_features/orderhistory_local_orders.md). +[[= product_name_com =]] uses this event to display [local orders](order_history_features/orderhistory_local_orders.md). See the [Overriding semantic configuration](overriding_semantic_configuration.md) to find out how to implement a new configuration listener. ``` yaml diff --git a/docs/guide/page.md b/docs/guide/page.md index dde8392d16..074535e518 100644 --- a/docs/guide/page.md +++ b/docs/guide/page.md @@ -1,6 +1,6 @@ # Pages in the shop -eZ Commerce adds the following blocks to the Page Builder: +[[= product_name_com =]] adds the following blocks to the Page Builder: - Last viewed items - list of products recently viewed by the current user - Bestsellers - list of bestsellers for a given product category diff --git a/docs/guide/page_rendering.md b/docs/guide/page_rendering.md index 1502807a35..8fd5172708 100644 --- a/docs/guide/page_rendering.md +++ b/docs/guide/page_rendering.md @@ -1,6 +1,6 @@ # Page rendering -!!! enterprise +!!! dxp ### Page layouts diff --git a/docs/guide/payment/payment.md b/docs/guide/payment/payment.md index 7cf07c2994..76df4b5ce1 100644 --- a/docs/guide/payment/payment.md +++ b/docs/guide/payment/payment.md @@ -1,13 +1,13 @@ # Payment -Payments in eZ Commerce depends on the [JMSPaymentCoreBundle.](http://jmsyst.com/bundles/JMSPaymentCoreBundle) +Payments in [[= product_name_com =]] depends on the [JMSPaymentCoreBundle.](http://jmsyst.com/bundles/JMSPaymentCoreBundle) !!! note If `JMSPaymentCoreBundle` is not installed due to composer dependencies, [installed it manually.](http://jmsyst.com/bundles/JMSPaymentCoreBundle/master/installation) -The eZ Commerce supports the following payment providers out of the box: +The [[= product_name_com =]] supports the following payment providers out of the box: |Payment provider|Code used in Basket| |--- |--- | diff --git a/docs/guide/payment/payment_api.md b/docs/guide/payment/payment_api.md index e8d0072cac..85b2590ed2 100644 --- a/docs/guide/payment/payment_api.md +++ b/docs/guide/payment/payment_api.md @@ -87,7 +87,7 @@ and the related payment instruction for further processing in the returning URL It is impossible to configure the URLs via the Symfony container, as the basket ID is determined dynamically. This interface is used to provide an adaptable way to integrate the various data fields which can be used by the different payment plugins for storing e.g. URL information. -You must implement this interface for every payment plugin that should be available in the eZ Commerce, +You must implement this interface for every payment plugin that should be available in the [[= product_name_com =]], if more than the standard fields like amount, are necessary for the payment process. The interface defines a single method, `createExtendedDataForOrder($orderReference)`, diff --git a/docs/guide/performance.md b/docs/guide/performance.md index 69bf709a98..54dba51318 100644 --- a/docs/guide/performance.md +++ b/docs/guide/performance.md @@ -1,6 +1,6 @@ # Performance -eZ Platform can be set up to run efficiently on almost any modern configuration. +[[= product_name_oss =]] can be set up to run efficiently on almost any modern configuration. What follows is a list of recommendation that will make your installation perform better. !!! note @@ -26,7 +26,7 @@ In production setups: - Always use reverse proxy, and if possible use Varnish. - Compared to the built-in Symfony Proxy in PHP Varnish is much faster and is able to queue up requests for the same fresh/invalidated resource. - With [ezplatform-http-cache](https://github.com/ezsystems/ezplatform-http-cache) support for xkey and grace Varnish provides more stable performance in read/write scenarios. -- Set up eZ Platform in [cluster mode](clustering.md) if you need to handle bigger spikes of traffic than a single server can manage. +- Set up [[= product_name_oss =]] in [cluster mode](clustering.md) if you need to handle bigger spikes of traffic than a single server can manage. - See [recommendation for Memcached/Redis](#memcachedredis) and [Search](#search) below. !!! note diff --git a/docs/guide/permissions.md b/docs/guide/permissions.md index 04d3eecd90..e37657150e 100644 --- a/docs/guide/permissions.md +++ b/docs/guide/permissions.md @@ -63,13 +63,13 @@ This also lets the user copy and move content, as well as add new Locations to a #### Create content without publishing -This option can be used together with eZ Enterprise's content review options. +This option can be used together with [[= product_name_ee =]]'s content review options. Using the following Policies, the User is able to create content, but can't publish it; instead, they must send it for review to another User with proper permissions (for example, senior editor, proofreader, etc.). - `content/create` - `content/edit` -Note that without eZ Enterprise this setup should not be used, as it will not allow the User to continue working with their content. +Note that without [[= product_name_ee =]] this setup should not be used, as it will not allow the User to continue working with their content. #### Restrict editing to part of the tree @@ -168,7 +168,7 @@ Additional Policies are needed for each section of the Admin. Users are treated like other content, so to create and modify them the User needs to have the same permissions as for managing other Content items. -!!! enterprise +!!! dxp #### Editorial workflows @@ -195,7 +195,7 @@ Users are treated like other content, so to create and modify them the User need |   | `view_embed` | view content embedded in another Content item (even when the User is not allowed to view it as an individual Content item) | |   | `create` | create new content. Note: even without this Policy the User is able to enter edit mode, but cannot finalize work with the Content item. | |   | `edit` | edit existing content | -|   | `publish` | publish content. Without this Policy, the User can only save drafts or send them for review (in eZ Enterprise) | +|   | `publish` | publish content. Without this Policy, the User can only save drafts or send them for review (in [[= product_name_ee =]]) | |   | `manage_locations` | remove Locations and send content to Trash | |   | `hide` | hide and reveal content Locations | |   | `reverserelatedlist` | see all content that a Content item relates to (even when the User is not allowed to view it as an individual Content items) | diff --git a/docs/guide/persistence_cache.md b/docs/guide/persistence_cache.md index 9bdeac853b..0e0c81b974 100644 --- a/docs/guide/persistence_cache.md +++ b/docs/guide/persistence_cache.md @@ -13,8 +13,8 @@ For details on how to reuse this Cache service in your own custom code, see belo ## Transparent cache -With the persistence cache, just like with the HTTP cache, eZ Platform tries to follow principles of transparent caching. -This can shortly be described as a cache which is invisible to the end user (admin/editors) of eZ Platform where content +With the persistence cache, just like with the HTTP cache, [[= product_name_oss =]] tries to follow principles of transparent caching. +This can shortly be described as a cache which is invisible to the end user (admin/editors) of [[= product_name_oss =]] where content is always returned *fresh*. In other words, there should be no need to manually clear the cache like it was frequently the case with eZ Publish 4.x. This is possible thanks to an interface that follows CRUD (Create Read Update Delete) operations per domain. @@ -46,7 +46,7 @@ To see where and how to contribute additional caches, refer to the [source code] Current implementation uses Symfony cache. It technically supports the following cache backends: [APCu, Array, Chain, Doctrine, Filesystem, Memcached, PDO & Doctrine DBAL, Php Array, Proxy, Redis](https://symfony.com/doc/5.0/components/cache/cache_pools.html#creating-cache-pools). - eZ Platform officially supports only using Filesystem for single server and Redis or Memcached for clustered setups. + [[= product_name_oss =]] officially supports only using Filesystem for single server and Redis or Memcached for clustered setups. Use of Memcached or Redis as shared cache back end is a requirement for use in clustering setup. For an overview of this feature, see [Clustering](clustering.md). @@ -157,9 +157,9 @@ Depending on the number of lookups and latency to cache server this might affect Out of the box in `config/packages/cache_pool/cache.redis.yaml` you'll find a default example that can be used. -!!! note "eZ Platform Cloud" +!!! note "Ibexa Cloud" - For eZ Platform Cloud/Platform.sh: This is automatically configured in `app/config/env/platformsh.php` if you have enabled Redis as `rediscache` Platform.sh service. + For Ibexa Cloud/Platform.sh: This is automatically configured in `app/config/env/platformsh.php` if you have enabled Redis as `rediscache` Platform.sh service. For anything else, you can enable it with environment variables detected automatically by `app/config/env/generic.php`. For instance, if you set the following environment variables `export CACHE_POOL="cache.redis" CACHE_DSN="secret@example.com:1234/13"`, it will result in config like this: @@ -206,9 +206,9 @@ Several cloud providers have managed services that are easier to set up, handle - [Azure Redis Cache](https://azure.microsoft.com/en-us/services/cache/) - [Google Cloud Memorystore](https://cloud.google.com/memorystore/) -###### eZ Platform Cloud / Platform.sh usage +###### Ibexa Cloud / Platform.sh usage -!!! note "eZ Platform Cloud" +!!! note "Ibexa Cloud" If you use Platform.sh Enterprise you can benefit from the Redis Sentinel across three nodes for great fault tolerance. Platform.sh Professional and lower versions offer Redis in single instance mode only. @@ -235,9 +235,9 @@ There is one Memcached adapter available out of the box. Out of the box in `config/packages/cache_pool/cache.memcached.yaml` you'll find a default example that can be used. -!!! note "eZ Platform Cloud" +!!! note "Ibexa Cloud" - For eZ Platform Cloud/Platform.sh: This is automatically configured in `config/env/platformsh.php` if you have enabled Memcached as `cache` Platform.sh service. + For Ibexa Cloud/Platform.sh: This is automatically configured in `config/env/platformsh.php` if you have enabled Memcached as `cache` Platform.sh service. For anything else, you can enable it with environment variables detected automatically by `config/env/generic.php`. For instance, if you set the following environment variables `export CACHE_POOL="cache.memcached" CACHE_DSN="user:pass@localhost?weight=33"`, it will result in config like this: @@ -282,7 +282,7 @@ See `config/default_parameters.yaml` and `config/cache_pool/cache.memcached.yaml ## Using Cache Service Using the internal cache service allows you to use an interface and without caring whether the system is configured to place the cache in Memcached or on File system. -And as eZ Platform requires that instances use a cluster-aware cache in Cluster setup, you can safely assume your cache is shared *(and invalidated)* across all web servers. +And as [[= product_name_oss =]] requires that instances use a cluster-aware cache in Cluster setup, you can safely assume your cache is shared *(and invalidated)* across all web servers. !!! note diff --git a/docs/guide/personalization/recommendation_client.md b/docs/guide/personalization/recommendation_client.md index a6f56e4d9b..d9ca838de9 100644 --- a/docs/guide/personalization/recommendation_client.md +++ b/docs/guide/personalization/recommendation_client.md @@ -1,6 +1,6 @@ # Recommendation -[`ezrecommendation-client`](https://github.com/ezsystems/ezrecommendation-client) adds a personalization solution to eZ Platform. +[`ezrecommendation-client`](https://github.com/ezsystems/ezrecommendation-client) adds a personalization solution to [[= product_name_oss =]]. It enables you to track the way visitors use your website and recommends content based on their behavior. You can also use the personalized search (content suggestions) @@ -14,13 +14,13 @@ and personalized newsletter features (embedding personalized content in your new ## Installation [`ezrecommendation-client`](https://github.com/ezsystems/ezrecommendation-client) -is provided in a separate package and is not included in eZ Platform by default. +is provided in a separate package and is not included in [[= product_name_oss =]] by default. To use it, you need to install the package: ### 1. Install and enable the bundle -Run `composer require` from your eZ Platform installation root: +Run `composer require` from your [[= product_name_oss =]] installation root: ``` bash composer require --no-update ezsystems/ezrecommendation-client @@ -54,7 +54,7 @@ Register an account (customerID) with your eZ Sales manager. !!! tip - If you want to use the Recommendation engine with the open source version of eZ Platform, + If you want to use the Recommendation engine with the open source version of [[= product_name_oss =]], send an email to support@yoochoose.com. ### 4. Allow public HTTP(S) access @@ -63,7 +63,7 @@ Allow public HTTP(S) access to the recommendation bundle API (`/api/ !!! note "IP whitelisting" - The Recommendation engine servers need to access the API of an eZ Platform installation + The Recommendation engine servers need to access the API of an [[= product_name_oss =]] installation in order to continuously sync content. If it's not possible to allow public access, the following IP addresses can be used for whitelisting on, for example, a firewall. @@ -92,7 +92,7 @@ security: Create a User with the name of the customerID and a password which is the license key in your local security provider. This User must have access granted on the URLs provided by the bundle API (see above). -In order to tell the recommender to use this User and password to request resources on the eZ Platform instance, +In order to tell the recommender to use this User and password to request resources on the [[= product_name_oss =]] instance, you can configure this as follows (an example file is available in the bundle under `Resources/config/default_settings.yml`): ``` yaml @@ -125,7 +125,7 @@ Tracking Content Types is required for displaying recommendations. You define Content Types to track in the local `app/config/config.yml` file. The content will then be initially exported by a script. -After this, it will be kept in sync with the Personalization Solution every time a change occurs in the eZ Platform Back Office. +After this, it will be kept in sync with the Personalization Solution every time a change occurs in the [[= product_name_oss =]] Back Office. The bundle's configuration is SiteAccess-aware. This is an example of the settings (in `config.yaml`): @@ -424,7 +424,7 @@ Make sure that the content ID is at least 2 characters long (for example, `&q=73 ### Subsequent content exports -The Recommendation engine is automatically kept in sync with the content in eZ Platform. +The Recommendation engine is automatically kept in sync with the content in [[= product_name_oss =]]. Every time an editor creates, updates or deletes content in the Back Office (1), a notification is sent to https://admin.yoochoose.net (2). diff --git a/docs/guide/pricing/price_engine.md b/docs/guide/pricing/price_engine.md index fb25d4cfee..34f324484b 100644 --- a/docs/guide/pricing/price_engine.md +++ b/docs/guide/pricing/price_engine.md @@ -2,7 +2,7 @@ The price engine is responsible for calculating prices in the shop. It can, for example, calculate prices based on imported prices and rules, -and use the business logic of the ERP system which is connected to the eZ Commerce. +and use the business logic of the ERP system which is connected to the [[= product_name_com =]]. It can combine the logic of an ERP system and a local price provider to get the best compromise between real-time data and shop performance. @@ -33,7 +33,7 @@ since the ERP systems usually provide this information in the price request. |Provider|Logic|Note| |--- |--- |--- | -|Local price provider|A simple provider which gets the price from the product itself|Do not use this provider for eZ Commerce. Use ShopPriceEngine instead| +|Local price provider|A simple provider which gets the price from the product itself|Do not use this provider for [[= product_name_com =]]. Use ShopPriceEngine instead| |Shop price provider|A more sophisticated price provider. Offers currency and customer group support|| |Remote price engine|Gets prices from the ERP|| diff --git a/docs/guide/pricing/price_engine_api/price_engine_services/chainpriceservice/price_providers/localpriceprovider.md b/docs/guide/pricing/price_engine_api/price_engine_services/chainpriceservice/price_providers/localpriceprovider.md index f608da5a8c..8d01052653 100644 --- a/docs/guide/pricing/price_engine_api/price_engine_services/chainpriceservice/price_providers/localpriceprovider.md +++ b/docs/guide/pricing/price_engine_api/price_engine_services/chainpriceservice/price_providers/localpriceprovider.md @@ -1,6 +1,6 @@ # LocalPriceProvider -The local price provider can calculate prices based on product data imported to eZ Commerce. +The local price provider can calculate prices based on product data imported to [[= product_name_com =]]. It uses the information provided by the catalog element. The Local price provider supports the following price models: diff --git a/docs/guide/product_comparison/product_comparison.md b/docs/guide/product_comparison/product_comparison.md index 708e126ce7..7d0c80672e 100644 --- a/docs/guide/product_comparison/product_comparison.md +++ b/docs/guide/product_comparison/product_comparison.md @@ -1,6 +1,6 @@ # Product comparison -eZ Commerce offers the option to compare products on a single page. +[[= product_name_com =]] offers the option to compare products on a single page. Customers can save products on their own comparison lists. Comparison lists are divided per kind of product (separately for, e.g. sofas, tables, etc.). diff --git a/docs/guide/project_organization.md b/docs/guide/project_organization.md index 372df61d1f..59e3d3357e 100644 --- a/docs/guide/project_organization.md +++ b/docs/guide/project_organization.md @@ -1,8 +1,8 @@ # Project organization -eZ Platform is a Symfony application and follows the project structure used by Symfony. +[[= product_name_oss =]] is a Symfony application and follows the project structure used by Symfony. -You can see an example of organizing a simple project in the [companion repository](https://github.com/ezsystems/ezplatform-ee-beginner-tutorial/tree/v3-master) for the [eZ Enterprise Beginner tutorial](../tutorials/enterprise_beginner/ez_enterprise_beginner_tutorial_-_its_a_dogs_world.md). +You can see an example of organizing a simple project in the [companion repository](https://github.com/ezsystems/ezplatform-ee-beginner-tutorial/tree/v3-master) for the [[[= product_name_ee =]] Beginner tutorial](../tutorials/enterprise_beginner/ez_enterprise_beginner_tutorial_-_its_a_dogs_world.md). ## PHP code @@ -35,7 +35,7 @@ All project assets are accessible through the `assets` path. ### Importing assets from a bundle -eZ Platform uses [Webpack Encore](https://symfony.com/doc/5.0/frontend.html#webpack-encore) for asset management. +[[= product_name_oss =]] uses [Webpack Encore](https://symfony.com/doc/5.0/frontend.html#webpack-encore) for asset management. #### Configuration from a bundle diff --git a/docs/guide/quick_order/quick_order_api.md b/docs/guide/quick_order/quick_order_api.md index ee676f3d3a..1ffb4db7e4 100644 --- a/docs/guide/quick_order/quick_order_api.md +++ b/docs/guide/quick_order/quick_order_api.md @@ -40,7 +40,7 @@ siso_solr.default.search.auto_suggest_fields: ``` The `ses_variant_\*` fields are additional fields indexed in the Solr. -The standard shop is able to index the variant fields stored in eZ Platform Matrix Field. +The standard shop is able to index the variant fields stored in Matrix Field. For projects which extend the product's Content Type with new fields, the indexer has to be extended as well: diff --git a/docs/guide/repository.md b/docs/guide/repository.md index e6484013d9..f3f478a1e8 100644 --- a/docs/guide/repository.md +++ b/docs/guide/repository.md @@ -38,7 +38,7 @@ You should always check full list of changes for each release in corresponding r ## SPI -eZ Platform SPI is a Service Provider Interface which defines contracts for implementing various parts of the system, including: +[[= product_name_oss =]] SPI is a Service Provider Interface which defines contracts for implementing various parts of the system, including: - persistence layer (`SPI\Persistence`) - custom Field Types diff --git a/docs/guide/retrieving_root_location.md b/docs/guide/retrieving_root_location.md index 2ef2a6d92d..41b15b6c6e 100644 --- a/docs/guide/retrieving_root_location.md +++ b/docs/guide/retrieving_root_location.md @@ -3,7 +3,7 @@ The root Location can be a starting point for API queries, or even links to home page. By default, the root Location ID is `2`, but the best practice is to retrieve it dynamically. -This is because eZ Platform can be used for [multisite development](multisite.md) and the root Location can vary. +This is because [[= product_name_oss =]] can be used for [multisite development](multisite.md) and the root Location can vary. The Location can also be changed by configuration. ### Retrieving root Location ID diff --git a/docs/guide/search/elastic.md b/docs/guide/search/elastic.md index c1a43816c6..b3a5322f3c 100644 --- a/docs/guide/search/elastic.md +++ b/docs/guide/search/elastic.md @@ -1,6 +1,6 @@ # Elasticsearch search engine -!!! enterprise +!!! dxp Elasticsearch is an open-source, distributed, Java-based search engine that responds to queries in real-time and is easily scalable in reaction to changing processing needs. @@ -18,7 +18,7 @@ !!! note - eZ Platform supports Elasticsearch in version 7.7. + [[= product_name_ee =]] supports Elasticsearch in version 7.7. ## Step 2: Verify that the Elasticsearch instance is up @@ -57,7 +57,7 @@ ## Step 4: Configure the search engine - eZ Platform comes pre-configured to work with an Elasticsearch cluster that uses default settings, and you can use this initial setup for testing purposes. + [[= product_name_ee =]] comes pre-configured to work with an Elasticsearch cluster that uses default settings, and you can use this initial setup for testing purposes. However, to effectively search through actual data, you must provide specific settings. All configuration is made in the `/config/packages/ezplatform_elastic_search_engine.yaml` file. @@ -66,7 +66,7 @@ All the settings, their order and meaning, correspond to the settings that are described in the Elasticsearch documentation. - First, decide how eZ Platform connects to Elasticsearch and configure other connection settings. + First, decide how [[= product_name_ee =]] connects to Elasticsearch and configure other connection settings. For more information, see [Configuring connections](#configuring-connections). Then, define a field type mappings template that instructs Elasticsearch to interpret eZ @@ -118,7 +118,7 @@ !!! tip "A default connection" If you define more than one connection, for example, to create a separate connection for - each repository, you must select the one that eZ Platform should use with the following setting: + each repository, you must select the one that [[= product_name_ee =]] should use with the following setting: ``` yaml ez_platform_elastic_search_engine: @@ -245,7 +245,7 @@ ##### Number of retries - The `retries` setting configures the number of attempts that eZ Platform makes to connect + The `retries` setting configures the number of attempts that [[= product_name_ee =]] makes to connect to the nodes of the cluster before it throws an exception. By default, `null` is used, which means that the number of retries equals to the number of nodes in the cluster. @@ -255,7 +255,7 @@ retries: null ``` - Depending on the connection pool that you select, eZ Platform's reaction to reaching the maximum + Depending on the connection pool that you select, [[= product_name_ee =]]'s reaction to reaching the maximum number of retries might differ. For more information, see [Set retries](https://www.elastic.co/guide/en/elasticsearch/client/php-api/7.x/configuration.html#_set_retries). @@ -266,7 +266,7 @@ With Elasticsearch Cloud you do not have to build or manage your own Elasticsearch cluster. Also, you do all the configuration and administration in a graphical user interface. - To connect to a cloud solution with eZ Platform, you must set the `elastic_cloud_id` parameter by + To connect to a cloud solution with [[= product_name_ee =]], you must set the `elastic_cloud_id` parameter by providing an alphanumerical ID string that you obtain from the cloud's user interface, for example: ``` yaml @@ -292,7 +292,7 @@ #### Configuring basic authentication - If your Elasticsearch server is protected by HTTP authentication, you must provide eZ Platform with the credentials. + If your Elasticsearch server is protected by HTTP authentication, you must provide [[= product_name_ee =]] with the credentials. When using basic authentication, you must pass the following parameters: ``` yaml @@ -319,7 +319,7 @@ #### Configuring API key authentication If your Elasticsearch cluster is protected by API keys, you must provide the key and secret in authentication configuration to - connect eZ Platform with the cluster. With API key authentication you can define different + connect [[= product_name_ee =]] with the cluster. With API key authentication you can define different authorization levels, such as [`create_index`, `index`, etc.](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-privileges.html#privileges-list-indices). Such approach proves useful if the cluster is available to the public. @@ -425,8 +425,8 @@ ### Configuring field type mapping templates - Before you can re-index the eZ Platform data, so that Elasticsearch can search through its contents, you must define an index template. - Templates instruct Elasticsearch to recognize eZ Platform Fields as specific data types, based on, for example, a field name. + Before you can re-index the [[= product_name_ee =]] data, so that Elasticsearch can search through its contents, you must define an index template. + Templates instruct Elasticsearch to recognize [[= product_name_ee =]] Fields as specific data types, based on, for example, a field name. They help you prevent Elasticsearch from using the dynamic field mapping feature to create type mappings automatically. You can create several field type mapping templates for each index, for example, to define settings that are specific for different languages. When you establish a relationship between a field mapping template and a connection, you can apply several templates, too. @@ -456,7 +456,7 @@ `___` - By default, repository name is set to `default`, however, in the context of an eZ Platform instance, + By default, repository name is set to `default`, however, in the context of an [[= product_name_ee =]] instance, there can be [several repositories with different names](https://doc.ezplatform.com/en/latest/guide/config_repository/#defining-custom-connection). Document type can be either `content` or `location`. In a language code, hyphens are replaced with underscores, and all characters must be lowercase. @@ -504,7 +504,7 @@ For more information about mappings, see [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/mapping.html). When you create a custom index template, with settings for your own field and document - types, make sure that it contains mappings for all searchable fields that are available in eZ Platform. + types, make sure that it contains mappings for all searchable fields that are available in [[= product_name_ee =]]. For an example of default configuration with a list of searchable fields, see [Default configuration](https://github.com/ezsystems/ezplatform-elastic-search-engine/blob/v1.0.0/src/bundle/Resources/config/default-config.yaml). #### Fine-tuning the search results diff --git a/docs/guide/search/extend_elasticsearch.md b/docs/guide/search/extend_elasticsearch.md index 9e0c4015f3..1b9b08b2a5 100644 --- a/docs/guide/search/extend_elasticsearch.md +++ b/docs/guide/search/extend_elasticsearch.md @@ -1,6 +1,6 @@ # Elasticsearch extensibility -!!! enterprise +!!! dxp ## Indexing custom data diff --git a/docs/guide/search/search.md b/docs/guide/search/search.md index 4579987955..8de3ef4643 100644 --- a/docs/guide/search/search.md +++ b/docs/guide/search/search.md @@ -1,12 +1,12 @@ # Search -eZ Platform exposes a very powerful [Search API](../../api/public_php_api_search.md), allowing both full-text search and querying the content Repository using several built-in Search Criteria and Sort Clauses. These are supported across different search engines, allowing you to plug in another search engine without changing your code. +[[= product_name_oss =]] exposes a very powerful [Search API](../../api/public_php_api_search.md), allowing both full-text search and querying the content Repository using several built-in Search Criteria and Sort Clauses. These are supported across different search engines, allowing you to plug in another search engine without changing your code. -Currently, the following search engines exist in their own eZ Platform Bundles: +Currently, the following search engines exist in their own [[= product_name_oss =]] Bundles: 1. [Legacy search engine](search_engines.md#legacy-search-engine-bundle), a database-powered search engine for basic needs. 1. [Solr](solr.md), an integration providing better overall performance, much better scalability and support for more advanced search capabilities. -1. [Elasticsearch](elastic.md), available for eZ Enterprise customers, a document-oriented engine providing even better performance and scalability. +1. [Elasticsearch](elastic.md), available for [[= product_name_ee =]] customers, a document-oriented engine providing even better performance and scalability. ### Feature comparison @@ -27,7 +27,7 @@ amount of data with Legacy Search Engine (SQL), use Solr for this. ## Search Criteria and Sort Clauses Search Criteria and Sort Clauses are value object classes used for building a search query, to define filter criteria and ordering of the result set. -eZ Platform provides a number of standard Search Criteria and Sort Clauses that you can use out of the box and that should cover the majority of use cases. +[[= product_name_oss =]] provides a number of standard Search Criteria and Sort Clauses that you can use out of the box and that should cover the majority of use cases. For an example of how to use and combine Criteria and Sort Clauses, refer to [Searching in PHP API](../../api/public_php_api_search.md). @@ -74,7 +74,7 @@ Arguments: ## Custom Criteria and Sort Clauses -Sometimes you will find that standard Search Criteria and Sort Clauses provided with eZ Platform are not sufficient for your needs. Most often this will be the case if you have a custom Field Type using external storage which cannot be searched using the standard Field Criterion. +Sometimes you will find that standard Search Criteria and Sort Clauses provided with [[= product_name_oss =]] are not sufficient for your needs. Most often this will be the case if you have a custom Field Type using external storage which cannot be searched using the standard Field Criterion. !!!note diff --git a/docs/guide/search/shop_search/extending_search/indexing_file_content.md b/docs/guide/search/shop_search/extending_search/indexing_file_content.md index db8f52b7ef..94f3d41b27 100644 --- a/docs/guide/search/shop_search/extending_search/indexing_file_content.md +++ b/docs/guide/search/shop_search/extending_search/indexing_file_content.md @@ -2,7 +2,7 @@ Indexing the content of files stored in the content model uses an additional component called Apache Tika. -Apache Tika has two available modes: Server Mode and App Mode. eZ Commerce uses Apache Tika in App mode. +Apache Tika has two available modes: Server Mode and App Mode. [[= product_name_com =]] uses Apache Tika in App mode. You can specify which MIME types are indexed in configuration. If you need additional file types to be indexed, add them to this configuration, for example: diff --git a/docs/guide/search/solr.md b/docs/guide/search/solr.md index 94021167d4..26fedfd6a4 100644 --- a/docs/guide/search/solr.md +++ b/docs/guide/search/solr.md @@ -1,6 +1,6 @@ # Solr search engine -[ezplatform-solr-search-engine](https://github.com/ezsystems/ezplatform-solr-search-engine) aims to be a transparent drop-in replacement for the SQL-based Legacy search engine powering eZ Platform Search API by default. When you enable Solr and re-index your content, all your existing Search queries using `SearchService` will be powered by Solr automatically. This allows you to scale up your eZ Platform installation and be able to continue development locally against SQL engine, and have a test infrastructure, Staging and Prod powered by Solr. This removes considerable load from your database. See [further information on the architecture of eZ Platform](../architecture.md). +[ezplatform-solr-search-engine](https://github.com/ezsystems/ezplatform-solr-search-engine) aims to be a transparent drop-in replacement for the SQL-based Legacy search engine powering [[= product_name_oss =]] Search API by default. When you enable Solr and re-index your content, all your existing Search queries using `SearchService` will be powered by Solr automatically. This allows you to scale up your [[= product_name_oss =]] installation and be able to continue development locally against SQL engine, and have a test infrastructure, Staging and Prod powered by Solr. This removes considerable load from your database. See [further information on the architecture of [[= product_name_oss =]]](../architecture.md). ## How to set up Solr search engine @@ -82,9 +82,9 @@ This setting is **required** if you want to see the changes after publish. It is #### Generating configuration The command line tool `bin/generate-solr-config.sh` generates Solr 7 configuration automatically. -It can be used for deploying to eZ Platform Cloud (Platform.sh) and on-premise installs. +It can be used for deploying to Ibexa Cloud (Platform.sh) and on-premise installs. -Execute the script from the eZ Platform root directory for further information: +Execute the script from the [[= product_name_oss =]] root directory for further information: ``` bash ./vendor/ezsystems/ezplatform-solr-search-engine/bin/generate-solr-config.sh --help @@ -102,7 +102,7 @@ The Solr Search Engine Bundle can be configured in many ways. The config further #### Single-core example (default) -Out of the box in eZ Platform the following is enabled for a simple setup: +Out of the box in [[= product_name_oss =]] the following is enabled for a simple setup: ``` yaml ez_search_engine_solr: @@ -458,7 +458,7 @@ This may be needed when you want to find the content with full-text search, or t To do this effectively, you first need to understand how the data is indexed with the Solr search engine. Solr uses [documents](https://lucene.apache.org/solr/guide/7_7/overview-of-documents-fields-and-schema-design.html#how-solr-sees-the-world) as a unit of data that is indexed. Documents are indexed per translation, as content blocks. A block is a nested document structure. -When used in eZ Platform, a parent document represents content, and Locations are indexed as child documents of the Content item. +When used in [[= product_name_oss =]], a parent document represents content, and Locations are indexed as child documents of the Content item. To avoid duplication, full-text data is indexed on the Content document only. Knowing this, you have the option to index additional data on: - all block documents (meaning content and its Locations, all translations) diff --git a/docs/guide/security.md b/docs/guide/security.md index ab273f4bc5..8d3cdff42e 100644 --- a/docs/guide/security.md +++ b/docs/guide/security.md @@ -2,11 +2,11 @@ !!! tip - See [Permissions](permissions.md) for information about the permissions system in eZ Platform. + See [Permissions](permissions.md) for information about the permissions system in [[= product_name_oss =]]. ## Symfony authentication -To use Symfony authentication with eZ Platform, use the following configuration (in `config/packages/security.yaml`): +To use Symfony authentication with [[= product_name_oss =]], use the following configuration (in `config/packages/security.yaml`): ``` yaml security: @@ -101,7 +101,7 @@ See [Authenticating a user with multiple user provider](user_management/user_man By default, only the Administrator has the permissions to use the package system. It follows that the Administrator role, and any others granted packaging permissions, can only be held by users who already have access to the server, and/or can be trusted not to exploit this access. - As a consequence eZ Publish legacy should not be used in the type of shared hosting installation where Administrators are not supposed to have access to the underlying operating system, or to other eZ Publish installations on the same server. The package system is an old part of eZ Publish legacy, and it was not designed for that kind of installation. Currently this is not considered best practice anyway - setups using e.g. Docker and Platform.sh allow you to completely separate installations from each other. This is a better way to keep things secure than relying on PHP scripts being read-only even for administrators. (The package system does not exist in eZ Platform and will not be added there, since extensions are not used there.) + As a consequence eZ Publish legacy should not be used in the type of shared hosting installation where Administrators are not supposed to have access to the underlying operating system, or to other eZ Publish installations on the same server. The package system is an old part of eZ Publish legacy, and it was not designed for that kind of installation. Currently this is not considered best practice anyway - setups using e.g. Docker and Platform.sh allow you to completely separate installations from each other. This is a better way to keep things secure than relying on PHP scripts being read-only even for administrators. (The package system does not exist in [[= product_name_oss =]] and will not be added there, since extensions are not used there.) In summary: diff --git a/docs/guide/service_container.md b/docs/guide/service_container.md index bc694bad84..79d60b444c 100644 --- a/docs/guide/service_container.md +++ b/docs/guide/service_container.md @@ -11,7 +11,7 @@ This is where the service container comes into play. The role of a service conta Each time you need a service, you may ask the service container for it. It will either build the service with the configuration you provided, or give you an existing instance if it is already available. -eZ Platform uses the [Symfony service container](http://symfony.com/doc/5.0/service_container.html). +[[= product_name_oss =]] uses the [Symfony service container](http://symfony.com/doc/5.0/service_container.html). !!! tip @@ -28,7 +28,7 @@ For instance, if you want to register a [Twig extension](http://twig.sensiolabs. you need to create the PHP class and declare it as a service in the DIC configuration with the `twig.extension` tag (see the [Symfony cookbook entry](http://symfony.com/doc/5.0/templating/twig_extension.html) for a full example). -eZ Platform exposes several features this way (see the [list of core service tags](#core-and-api)). +[[= product_name_oss =]] exposes several features this way (see the [list of core service tags](#core-and-api)). This is for example the case with Field Types. You will find all service tags exposed by Symfony in [its reference documentation](http://symfony.com/doc/5.0/reference/dic_tags.html). diff --git a/docs/guide/sessions.md b/docs/guide/sessions.md index f865bc8bcc..b1b6fcd9bb 100644 --- a/docs/guide/sessions.md +++ b/docs/guide/sessions.md @@ -1,7 +1,7 @@ # Sessions Sessions are handled by the Symfony framework, specifically API and underlying session handlers provided by the HttpFoundation component. -It is further enhanced in eZ Platform with support for SiteAccess-aware session cookie configuration. +It is further enhanced in [[= product_name_oss =]] with support for SiteAccess-aware session cookie configuration. !!! note @@ -20,7 +20,7 @@ These options include: - `cookie_secure` - `cookie_httponly` -However, in eZ Platform you can set up several sites within one Symfony application, +However, in [[= product_name_oss =]] you can set up several sites within one Symfony application, so you can also define session configuration per SiteAccess and SiteAccess group level. ### Session options per SiteAccess @@ -52,7 +52,7 @@ Symfony can be configured to use custom handlers, or just fall back to what is ### Default configuration -eZ Platform adapts Symfony's defaults to make sure its session save path is always taken into account: +[[= product_name_oss =]] adapts Symfony's defaults to make sure its session save path is always taken into account: ``` yaml # Default session configuration @@ -77,7 +77,7 @@ See [shared sessions in the clustering guide](clustering.md#shared-sessions). ##### Handling sessions with Memcached -To set up eZ Platform using [Memcached](https://pecl.php.net/package/memcached) you need to: +To set up [[= product_name_oss =]] using [Memcached](https://pecl.php.net/package/memcached) you need to: - [Configure the session save handler settings in `php.ini`](http://php.net/manual/en/memcached.sessions.php) - Set `%ezplatform.session.handler_id%` to `~` (null) in `config/packages/ezplatform.yaml` @@ -102,7 +102,7 @@ session locking. ##### Handling sessions with Redis -To set up eZ Platform using the [Redis](https://pecl.php.net/package/redis) you need to: +To set up [[= product_name_oss =]] using the [Redis](https://pecl.php.net/package/redis) you need to: - [Configure the session save handler settings in `php.ini`](https://github.com/phpredis/phpredis/#php-session-handler) - Set `%ezplatform.session.handler_id%` to `~` _(null)_ in `config/packages/ezplatform.yaml` @@ -112,9 +112,9 @@ Alternatively if you have needs to configure Redis servers dynamically: - Set `%ezplatform.session.handler_id%` (or `SESSION_HANDLER_ID` env var) to `ezplatform.core.session.handler.native_redis` - Set `%ezplatform.session.save_path%` (or `SESSION_SAVE_PATH` env var) to [save_path config for Redis](https://github.com/phpredis/phpredis/#php-session-handler) -!!! note "eZ Platform Cloud" +!!! note "Ibexa Cloud" - For eZ Platform Cloud (and Platform.sh), this is already configured in `config/env/platformsh.php` based on `.platform.yaml` config. + For Ibexa Cloud (and Platform.sh), this is already configured in `config/env/platformsh.php` based on `.platform.yaml` config. If you are on `php-redis` v4.2.0 and higher, you can optionally tweak [`php-redis` settings](https://github.com/phpredis/phpredis#session-locking) for session locking. @@ -133,7 +133,7 @@ If you want to make sure sessions survive Redis or server restarts, consider usi For setups where database is preferred for storing sessions, you may use Symfony's PdoSessionHandler, although it is not currently recommended from performance perspective. -Below is a configuration example for eZ Platform. Refer to the [Symfony Cookbook](http://symfony.com/doc/5.0/doctrine/pdo_session_storage.html) for full documentation. +Below is a configuration example for [[= product_name_oss =]]. Refer to the [Symfony Cookbook](http://symfony.com/doc/5.0/doctrine/pdo_session_storage.html) for full documentation. ``` yaml framework: diff --git a/docs/guide/shop_configuration/advanced_configuration.md b/docs/guide/shop_configuration/advanced_configuration.md index 03e95ade7b..83142c8601 100644 --- a/docs/guide/shop_configuration/advanced_configuration.md +++ b/docs/guide/shop_configuration/advanced_configuration.md @@ -16,7 +16,7 @@ stash: ## Settings for Users -eZ Commerce uses specific User groups where new Users are placed. +[[= product_name_com =]] uses specific User groups where new Users are placed. You can configure the Location IDs of these User groups in the following way: ``` yaml @@ -27,7 +27,7 @@ siso_core.default.user_group_location.private: 106 ## Supported country list -This configuration controls which countries will be offered in eZ Commerce (e.g. in registration forms or in the checkout). +This configuration controls which countries will be offered in [[= product_name_com =]] (e.g. in registration forms or in the checkout). ``` yaml siso_tools.default.countries: ['DE','US','NO'] diff --git a/docs/guide/shop_configuration/configure_erp_connection.md b/docs/guide/shop_configuration/configure_erp_connection.md index e5effcf666..d152f2ce01 100644 --- a/docs/guide/shop_configuration/configure_erp_connection.md +++ b/docs/guide/shop_configuration/configure_erp_connection.md @@ -1,6 +1,6 @@ # Configure ERP connection -By default eZ Commerce uses the `TsoWebconnectorLayer` which enables the shop to communicate with a Microsoft Dynamics NAV System. +By default [[= product_name_com =]] uses the `TsoWebconnectorLayer` which enables the shop to communicate with a Microsoft Dynamics NAV System. ## Requirements diff --git a/docs/guide/shop_configuration/session_handling.md b/docs/guide/shop_configuration/session_handling.md index 8ece1aa007..765b58e5e6 100644 --- a/docs/guide/shop_configuration/session_handling.md +++ b/docs/guide/shop_configuration/session_handling.md @@ -18,7 +18,7 @@ CREATE TABLE session ## Set up name for SiteAccesses -It is very important to set a session name. Otherwise eZ Platform will generate a unique name per SiteAccess. +It is very important to set a session name. Otherwise [[= product_name_oss =]] will generate a unique name per SiteAccess. This can cause issues - for example if you switch the language/SiteAccess, users cannot share a basket and login across SiteAccesses. ``` yaml diff --git a/docs/guide/shop_configuration/shop_configuration.md b/docs/guide/shop_configuration/shop_configuration.md index a3bf88250d..b15dee0762 100644 --- a/docs/guide/shop_configuration/shop_configuration.md +++ b/docs/guide/shop_configuration/shop_configuration.md @@ -5,7 +5,7 @@ For more information about the HTTP server configuration, see [the installation guide](../../getting_started/install_ez_platform.md#prepare-installation-for-production). -eZ Commerce requires one more rule in order to display images. The following examples show the settings for Apache: +[[= product_name_com =]] requires one more rule in order to display images. The following examples show the settings for Apache: ``` RewriteRule ^/var/assets/.* - [L] @@ -138,7 +138,7 @@ siso_paypal_api.password: 'paypal api password' siso_paypal_api.signature: 'paypal-api-signature' ``` -## Changing the logo for eZ Commerce +## Changing the logo for [[= product_name_com =]] If you want to change the logo in the Back Office, provide a link to the assets located in the `web/*` folder: diff --git a/docs/guide/shop_features/catalog.md b/docs/guide/shop_features/catalog.md index 307862db6a..4d85265245 100644 --- a/docs/guide/shop_features/catalog.md +++ b/docs/guide/shop_features/catalog.md @@ -1,6 +1,6 @@ # Catalog -eZ Commerce generates the shop catalog automatically from the products and content in the installation or an ERP/PIM system. +[[= product_name_com =]] generates the shop catalog automatically from the products and content in the installation or an ERP/PIM system. The source of products depends on the data provider you have configured. @@ -40,6 +40,6 @@ to learn how to change the data provider. ![product catalog](img/product_catalog_2.png) -A category represents a product group. eZ Commerce enables showing a product category page using different layouts (by default sub-categories only, products only or both on the entry page of a category). In the Back Office you can also configure if bestsellers of the group should be displayed. +A category represents a product group. [[= product_name_com =]] enables showing a product category page using different layouts (by default sub-categories only, products only or both on the entry page of a category). In the Back Office you can also configure if bestsellers of the group should be displayed. ![both](img/catalog_categories_and_products.png) diff --git a/docs/guide/shop_features/content_management.md b/docs/guide/shop_features/content_management.md index 1aa1fb8a1d..62812c38cf 100644 --- a/docs/guide/shop_features/content_management.md +++ b/docs/guide/shop_features/content_management.md @@ -2,7 +2,7 @@ ## Product -eZ Commerce offers a built-in Product Content Type. +[[= product_name_com =]] offers a built-in Product Content Type. Any content of this type can be automatically used for all shop functionalities, such as adding to basket, price calculation and ordering, diff --git a/docs/guide/shop_features/erp_integration.md b/docs/guide/shop_features/erp_integration.md index ab8afd26e5..bd052a58c2 100644 --- a/docs/guide/shop_features/erp_integration.md +++ b/docs/guide/shop_features/erp_integration.md @@ -1,6 +1,6 @@ # ERP integration -eZ Commerce can be connected to ERP systems. Out of the box it offers Web.Connectors for SAP, Microsoft Dynamics NAV and AX. +[[= product_name_com =]] can be connected to ERP systems. Out of the box it offers Web.Connectors for SAP, Microsoft Dynamics NAV and AX. The product provides an open interface which can be adapted to other ERP systems as well. Existing ERP customers can automatically create an account in the shop without waiting for confirmation from the administrator. @@ -13,7 +13,7 @@ The shop requests orders, delivery notes, invoices and credit memos from the ERP ## Stock information -eZ Commerce requests real-time stock information from the ERP +[[= product_name_com =]] requests real-time stock information from the ERP and notifies the customer if the stock is lower than the required quantity. It is possible to display the real stock as a numeric value as well. @@ -29,7 +29,7 @@ A fallback price provider (e.g. using imported prices) can be configured. It is ## ERP fallback -eZ Commerce supports fallback scenarios for the most important processes in case the connection to the ERP is not available: +[[= product_name_com =]] supports fallback scenarios for the most important processes in case the connection to the ERP is not available: - Caching latest customer data after login. - Fallback price engine. The customer is informed if the prices and stock are not up to date. diff --git a/docs/guide/shop_features/payment_and_shipping.md b/docs/guide/shop_features/payment_and_shipping.md index c10c4521bd..f67d903892 100644 --- a/docs/guide/shop_features/payment_and_shipping.md +++ b/docs/guide/shop_features/payment_and_shipping.md @@ -1,6 +1,6 @@ # Payment and shipping -eZ Commerce offers the following payment methods: +[[= product_name_com =]] offers the following payment methods: - invoice - PayPal Express @@ -13,7 +13,7 @@ The payment and shipping methods can be enabled or disabled per SiteAccess. ## Shipping costs -eZ Commerce offers a flexible way to define shipping costs, if they are not set in the ERP system. +[[= product_name_com =]] offers a flexible way to define shipping costs, if they are not set in the ERP system. Shipping costs can be set up per: diff --git a/docs/guide/shop_features/pricing.md b/docs/guide/shop_features/pricing.md index 11056ea747..f043974ed6 100644 --- a/docs/guide/shop_features/pricing.md +++ b/docs/guide/shop_features/pricing.md @@ -13,7 +13,7 @@ The currency is configured per country in the [configuration settings](../shop_c If a product has a price for a currency this price is displayed in the shop. -If there is no price set in a shop for the given currency, eZ Commerce offers two options that can be set in the shop configuration: +If there is no price set in a shop for the given currency, [[= product_name_com =]] offers two options that can be set in the shop configuration: - Calculate the price for the requested currency using the base price defined in the product (using the base currency setup for the installation) and an exchange rate defined in the configuration - Display an error in the frontend that no price is available diff --git a/docs/guide/shop_features/search.md b/docs/guide/shop_features/search.md index 81cf7ac55d..55b88ec537 100644 --- a/docs/guide/shop_features/search.md +++ b/docs/guide/shop_features/search.md @@ -1,6 +1,6 @@ # Search -eZ Commerce uses Solr to index products together with content. +[[= product_name_com =]] uses Solr to index products together with content. ![Search](img/search_1.png) diff --git a/docs/guide/shop_features/shop_features.md b/docs/guide/shop_features/shop_features.md index aca2319781..3387f7a78d 100644 --- a/docs/guide/shop_features/shop_features.md +++ b/docs/guide/shop_features/shop_features.md @@ -53,7 +53,7 @@ The customer can order the same products again: ## GDPR compliance -eZ Commerce offers tools to set up a shop that is compliant with GDPR (General Data Protection Regulation): +[[= product_name_com =]] offers tools to set up a shop that is compliant with GDPR (General Data Protection Regulation): - Prepared articles with dummy text for T&C, data privacy and cancellation policy - Important legal documents (e.g. T&C or data privacy) can be linked using permanent URLs diff --git a/docs/guide/shop_features/user_management.md b/docs/guide/shop_features/user_management.md index ac8fd52b57..ea450c320f 100644 --- a/docs/guide/shop_features/user_management.md +++ b/docs/guide/shop_features/user_management.md @@ -1,6 +1,6 @@ # User management -eZ Commerce by default adds the Shop users User Group, containing subgroups Business customers and Private customers. +[[= product_name_com =]] by default adds the Shop users User Group, containing subgroups Business customers and Private customers. These groups are assigned Roles that allow them to use the shop as customers. @@ -16,7 +16,7 @@ The built-in Roles than allow using the shop are: - Ecommerce checkout - Ecommerce registered users -eZ Commerce adds [special shop-related Policies](../user_management/access_control.md#ez-commerce-policies). +[[= product_name_com =]] adds [special shop-related Policies](../user_management/access_control.md#ez-commerce-policies). ## User registration @@ -30,7 +30,7 @@ A newly registered account is not active by default. The shop owner or administr ### Existing customers -Customers who are set up in the connected ERP can activate their eZ Commerce accounts themselves by entering their customer number and one invoice number. +Customers who are set up in the connected ERP can activate their [[= product_name_com =]] accounts themselves by entering their customer number and one invoice number. The data is sent to the ERP. If the data in ERP and the entered data match, the customer gets access to the shop immediately. A User Content item is created automatically with the customer number from the ERP. diff --git a/docs/guide/shop_templates/design_engine.md b/docs/guide/shop_templates/design_engine.md index 86634555df..4efa4c1071 100644 --- a/docs/guide/shop_templates/design_engine.md +++ b/docs/guide/shop_templates/design_engine.md @@ -3,9 +3,9 @@ !!! tip See [Design engine](../design_engine.md) for more information - about using the design engine in eZ Platform. + about using the design engine in [[= product_name_oss =]]. -eZ Commerce comes with the configured `base_design` and `base_theme` which use the existing standard templates used with the template resolver. +[[= product_name_com =]] comes with the configured `base_design` and `base_theme` which use the existing standard templates used with the template resolver. ## SiteAccess configuration @@ -31,7 +31,7 @@ admin_group: ## Activation -If the template resolver of eZ Commerce is disabled (standard), the design engine of eZ Platform is automatically activated: +If the template resolver of [[= product_name_com =]] is disabled (standard), the design engine of [[= product_name_oss =]] is automatically activated: ``` yaml siso_tools.default.template_resolver.enabled: false @@ -39,7 +39,7 @@ siso_tools.default.template_resolver.enabled: false ## Template theme paths -All eZ Commerce bundles contain an `ez_design.yml` file which is used to define the `templates_theme_path` to the templates. +All [[= product_name_com =]] bundles contain an `ez_design.yml` file which is used to define the `templates_theme_path` to the templates. Without the template theme path, the templates are not recognized by the design engine: ``` yaml diff --git a/docs/guide/shop_templates/shop_templates.md b/docs/guide/shop_templates/shop_templates.md index 81433eda61..7ea6ccfa35 100644 --- a/docs/guide/shop_templates/shop_templates.md +++ b/docs/guide/shop_templates/shop_templates.md @@ -1,10 +1,10 @@ # Shop templates -eZ Commerce offers additional Twig functions and filters you can use in templates. +[[= product_name_com =]] offers additional Twig functions and filters you can use in templates. ## Template resolver -eZ Commerce comes with a [template resolver](template_resolver.md) system which enables overriding templates on a SiteAccess and design base. +[[= product_name_com =]] comes with a [template resolver](template_resolver.md) system which enables overriding templates on a SiteAccess and design base. ## Design engine diff --git a/docs/guide/shop_templates/template_resolver.md b/docs/guide/shop_templates/template_resolver.md index f8612df48c..24bbee919c 100644 --- a/docs/guide/shop_templates/template_resolver.md +++ b/docs/guide/shop_templates/template_resolver.md @@ -15,7 +15,7 @@ An override is activated by a template resolver configuration. You can configure ## Overriding templates In this example you have a project with a bundle `src/Client/Bundle/WebsiteBundle`, a SiteAccess `website_de_de` -and you want to override eZ Commerce bundle templates. +and you want to override [[= product_name_com =]] bundle templates. ### Step 1. Change `config_{env}.yml` or `parameters.yml` @@ -42,7 +42,7 @@ parameters: ### Step 2. Create new templates -To override templates, you have to reflect the structure of eZ Commerce vendor bundles, e.g.: +To override templates, you have to reflect the structure of [[= product_name_com =]] vendor bundles, e.g.: | | | | ----------------- | --- | diff --git a/docs/guide/shop_templates/twig_extension.md b/docs/guide/shop_templates/twig_extension.md index fa65afbf18..5b22853a6b 100644 --- a/docs/guide/shop_templates/twig_extension.md +++ b/docs/guide/shop_templates/twig_extension.md @@ -1,6 +1,6 @@ # Twig extension -eZ Commerce offers the following Twig functions and filter for use in templates: +[[= product_name_com =]] offers the following Twig functions and filter for use in templates: ## Functions diff --git a/docs/guide/site_factory.md b/docs/guide/site_factory.md index 43cb86f0a0..dc818ad498 100644 --- a/docs/guide/site_factory.md +++ b/docs/guide/site_factory.md @@ -1,6 +1,6 @@ # Site Factory -!!! enterprise +!!! dxp Site Factory is a site management User Interface, integrated with Admin UI. It enables you to configure sites without editing: @@ -165,14 +165,14 @@ ezsettings.default.site_factory.sites_location_id: 2 ``` - To change it to e.g. eZ Platform, go to `config/packages/ezplatform_site_factory.yaml`, and add the following parameter: + To change it to e.g. [[= product_name_oss =]], go to `config/packages/ezplatform_site_factory.yaml`, and add the following parameter: ``` yaml parameters: ezsettings.default.site_factory.sites_location_id: 42 ``` - Now, all new directories will be created under eZ Platform. + Now, all new directories will be created under [[= product_name_oss =]]. ### Provide access diff --git a/docs/guide/siteaccess.md b/docs/guide/siteaccess.md index 03af37e440..2a15bc7d5b 100644 --- a/docs/guide/siteaccess.md +++ b/docs/guide/siteaccess.md @@ -2,7 +2,7 @@ ## Introduction -eZ Platform enables you to maintain multiple sites in one installation using a feature called **SiteAccesses**. +[[= product_name_oss =]] enables you to maintain multiple sites in one installation using a feature called **SiteAccesses**. In short, a SiteAccess is a set of configuration settings that is used when you reach the site through a specific address. When the user visits the site, the system analyzes the URI and compares it to rules specified in the configuration. If it finds a set of fitting rules, this SiteAccess is used. @@ -23,13 +23,13 @@ Typical uses of a SiteAccess are: - different language versions of the same site identified by a uri part; one SiteAccess for one language - two different versions of a website: one SiteAccess with a public interface for visitors and one with a restricted interface for administrators -!!! enterprise +!!! dxp If you need to change between SiteAccesses in Site mode, do not use any functions in the page itself (for example, a language switcher). This may cause unexpected errors. Instead, switch between SiteAccesses using the SiteAccess bar above the page. #### `admin` SiteAccess -The back-office UI of eZ Platform is housed in a predefined `admin` SiteAccess in `admin_group`. +The back-office UI of [[= product_name_oss =]] is housed in a predefined `admin` SiteAccess in `admin_group`. If you have a multisite setup with a separate back-office interface for each site, you need to create your own admin SiteAccesses and add them to this group. In cases where the sites are on separate databases they will need their own [repository](configuration.md#configuration-examples) (including their own storage and search connection), var dir, [cache pool](persistence_cache.md#persistence-cache-configuration), and ideally also separate Varnish/Fastly config for each site individually. @@ -55,7 +55,7 @@ Collects SiteAccesses into groups that can be used later for configuration. The rule or set of rules by which SiteAccesses are matched. See [SiteAccess matching](siteaccess_matching.md) for more information. -!!! enterprise +!!! dxp ### SiteAccess selection in Page Builder @@ -186,7 +186,7 @@ ezplatform: Note that you should avoid defining a setting twice within the same scope, as this will cause a [silent failure](https://github.com/symfony/symfony/issues/11538). -This mechanism is not limited to eZ Platform internal settings (the `ezsettings` namespace) and is applicable for specific needs (bundle-related, project-related, etc.). +This mechanism is not limited to [[= product_name_oss =]] internal settings (the `ezsettings` namespace) and is applicable for specific needs (bundle-related, project-related, etc.). Always prefer semantic configuration especially for internal eZ settings. Manually editing internal eZ settings is possible, but at your own risk, as unexpected behavior can occur. @@ -262,7 +262,7 @@ The SiteAccess router has been added a `matchByName()` method to reflect this ad #### Navigating between SiteAccesses - limitations -There are two known limitations to moving between SiteAccesses in eZ Enterprise's Pages: +There are two known limitations to moving between SiteAccesses in [[= product_name_ee =]]'s Pages: 1. On a Page you can encounter a 404 error when clicking a relative link which points to a different SiteAccess (if the Content item being previewed does not exist in the previously used SiteAccess). This is because detecting SiteAccesses when navigating in preview is not functional yet. This is a known limitation that is awaiting resolution. @@ -328,7 +328,7 @@ The [Symfony Config component](https://symfony.com/doc/5.0/components/config.htm This configuration is validated by rules you define, e.g. validating type (string, array, integer, boolean, etc.). Usually, once validated and processed, this semantic configuration is then mapped to internal *key/value* parameters stored in the `ServiceContainer`. -eZ Platform uses this for its core configuration, but adds another configuration level, the **SiteAccess**. +[[= product_name_oss =]] uses this for its core configuration, but adds another configuration level, the **SiteAccess**. For each defined SiteAccess, you need to be able to use the same configuration tree in order to define SiteAccess-specific config. These settings then need to be mapped to SiteAccess-aware internal parameters that you can retrieve via the `ConfigResolver`. @@ -338,9 +338,9 @@ For this, internal keys need to follow the format `...user_settings.templates.update Symfony provides native support for [multiple user providers](https://symfony.com/doc/5.0/security/multiple_user_providers.html). This makes it easy to integrate any kind of login handlers, including SSO and existing third party bundles (e.g. [FR3DLdapBundle](https://github.com/Maks3w/FR3DLdapBundle), [HWIOauthBundle](https://github.com/hwi/HWIOAuthBundle), [FOSUserBundle](https://github.com/FriendsOfSymfony/FOSUserBundle), [BeSimpleSsoAuthBundle](http://github.com/BeSimple/BeSimpleSsoAuthBundle), etc.). -However, to be able to use *external* user providers with eZ Platform, a valid Platform user needs to be injected into the Repository. +However, to be able to use *external* user providers with [[= product_name_oss =]], a valid Platform user needs to be injected into the Repository. This is mainly for the kernel to be able to manage content-related permissions (but not limited to this). Depending on your context, you will either want to create a Platform User, return an existing User, or even always use a generic User. -Whenever an *external* user is matched (i.e. one that does not come from Platform repository, like coming from LDAP), eZ Platform kernel initiates an `MVCEvents::INTERACTIVE_LOGIN` event. +Whenever an *external* user is matched (i.e. one that does not come from Platform repository, like coming from LDAP), [[= product_name_oss =]] kernel initiates an `MVCEvents::INTERACTIVE_LOGIN` event. Every service listening to this event receives an `eZ\Publish\Core\MVC\Symfony\Event\InteractiveLoginEvent` object which contains the original security token (that holds the matched user) and the request. Then, it is up to the listener to retrieve a Platform User from the Repository and to assign it back to the event object. This user will be injected into the repository and used for the rest of the request. -If no eZ Platform User is returned, the Anonymous User will be used. +If no [[= product_name_oss =]] User is returned, the Anonymous User will be used. ### User exposed and security token When an *external* user is matched, a different token will be injected into the security context, the `InteractiveLoginToken`. -This token holds a `UserWrapped` instance which contains the originally matched User and the *API user* (the one from the eZ Platform Repository). +This token holds a `UserWrapped` instance which contains the originally matched User and the *API user* (the one from the [[= product_name_oss =]] Repository). Note that the *API user* is mainly used for permission checks against the repository and thus stays *under the hood*. @@ -399,7 +399,7 @@ services: - { name: kernel.event_subscriber }  ``` -Do not mix `MVCEvents::INTERACTIVE_LOGIN` event (specific to eZ Platform) and `SecurityEvents::INTERACTIVE_LOGIN` event (fired by Symfony security component). +Do not mix `MVCEvents::INTERACTIVE_LOGIN` event (specific to [[= product_name_oss =]]) and `SecurityEvents::INTERACTIVE_LOGIN` event (fired by Symfony security component). ``` php loa ## eZ Platform v2.4.2 -!!! enterprise +!!! dxp ### Update eZ Enterprise v2.4 to v2.4.2 diff --git a/docs/releases/ez_platform_v2.5.md b/docs/releases/ez_platform_v2.5.md index 8befd73bdf..3534a82af6 100644 --- a/docs/releases/ez_platform_v2.5.md +++ b/docs/releases/ez_platform_v2.5.md @@ -61,7 +61,7 @@ bin/console ezplatform:migrate:legacy_matrix The new [ezplatform-user](https://github.com/ezsystems/ezplatform-user) bundle now centralizes all features related to user management, such as user accounts, registering, changing passwords, etc. -!!! enterprise +!!! dxp ### Workflow improvements diff --git a/docs/releases/ez_platform_v3.0.md b/docs/releases/ez_platform_v3.0.md index e536566b5f..5b30855669 100644 --- a/docs/releases/ez_platform_v3.0.md +++ b/docs/releases/ez_platform_v3.0.md @@ -41,7 +41,7 @@ For details, see [Bundles](../guide/bundles.md). ## New features -!!! enterprise +!!! dxp ### Site Factory diff --git a/docs/releases/ez_platform_v3.1.md b/docs/releases/ez_platform_v3.1.md index 8277ee1ff8..62963b8282 100644 --- a/docs/releases/ez_platform_v3.1.md +++ b/docs/releases/ez_platform_v3.1.md @@ -18,7 +18,7 @@ Refer to [eZ Commerce documentation](https://doc.ezplatform.com/projects/ezcomme This release of eZ Platform introduces the following new features: -!!! enterprise +!!! dxp ### Site Factory diff --git a/docs/tutorials/enterprise_beginner/1_get_a_starter_website.md b/docs/tutorials/enterprise_beginner/1_get_a_starter_website.md index d9ffad85f7..27eb6fb8b6 100644 --- a/docs/tutorials/enterprise_beginner/1_get_a_starter_website.md +++ b/docs/tutorials/enterprise_beginner/1_get_a_starter_website.md @@ -6,11 +6,11 @@ To set up the starter website, you need to follow these steps: -## Get a clean eZ Enterprise installation +## Get a clean [[= product_name_ee =]] installation -To begin the tutorial, you need a clean installation of eZ Platform Enterprise Edition. +To begin the tutorial, you need a clean installation of [[= product_name_ee =]]. -Get it by following the [Install eZ Platform](../../getting_started/install_ez_platform.md) guide. +Get it by following the [Install [[= product_name_oss =]]](../../getting_started/install_ez_platform.md) guide. ## Create Content Types @@ -55,7 +55,7 @@ Edit it to remove the Image Field that has a Content Relation (ezobjectrelation) !!! tip - For an introduction on how to use templates in eZ Platform, take a look at the [Building a Bicycle Route Tracker in eZ Platform tutorial](../platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md) + For an introduction on how to use templates in [[= product_name_oss =]], take a look at the [Building a Bicycle Route Tracker in [[= product_name_oss =]] tutorial](../platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md) First, delete the `config/packages/ezplatform_welcome_page.yaml` file to remove the welcome page. @@ -110,7 +110,7 @@ Next, create a few Content items of proper Content Types in each of these folder - 3 Dog Breeds - 3 Tips -Finally, remove the "eZ Platform" folder. You will not need it for this tutorial. +Finally, remove the "Ibexa Platform" folder. You will not need it for this tutorial. ### Add images diff --git a/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md b/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md index 2b8b036e8d..857d3ae4ea 100644 --- a/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md +++ b/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md @@ -35,7 +35,7 @@ Remove the Tag block. Hover over it and select the trash icon from the menu. Switch to editing Page Fields and change the Title of the page to "Home". The design for the website you are making needs a layout with two zones: a main column and a narrower sidebar. -eZ Enterprise provides only a one-zone default layout, so you need to create a new one. +[[= product_name_ee =]] provides only a one-zone default layout, so you need to create a new one. Preparing a new layout requires three things: diff --git a/docs/tutorials/enterprise_beginner/ez_enterprise_beginner_tutorial_-_its_a_dogs_world.md b/docs/tutorials/enterprise_beginner/ez_enterprise_beginner_tutorial_-_its_a_dogs_world.md index aaff24fc83..1141c366db 100644 --- a/docs/tutorials/enterprise_beginner/ez_enterprise_beginner_tutorial_-_its_a_dogs_world.md +++ b/docs/tutorials/enterprise_beginner/ez_enterprise_beginner_tutorial_-_its_a_dogs_world.md @@ -1,12 +1,12 @@ -# eZ Enterprise Beginner Tutorial - It's a Dog's World +# [[= product_name_ee =]] Beginner Tutorial - It's a Dog's World -This tutorial is a step-by-step guide to building a website with eZ Platform Enterprise Edition. +This tutorial is a step-by-step guide to building a website with [[= product_name_ee =]]. It focuses on creating a front page using a feature called **Page Builder**.  ### Intended audience -This tutorial is intended for users who have basic knowledge of eZ Platform. -Ideally, you should be familiar with the concepts covered in the [Building a Bicycle Route Tracker in eZ Platform tutorial](../platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md). +This tutorial is intended for users who have basic knowledge of [[= product_name_oss =]]. +Ideally, you should be familiar with the concepts covered in the [Building a Bicycle Route Tracker in [[= product_name_oss =]] tutorial](../platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md). ### Learning outcomes diff --git a/docs/tutorials/extending_admin_ui/4_adding_a_custom_tag.md b/docs/tutorials/extending_admin_ui/4_adding_a_custom_tag.md index 76137bc92b..67b1983a94 100644 --- a/docs/tutorials/extending_admin_ui/4_adding_a_custom_tag.md +++ b/docs/tutorials/extending_admin_ui/4_adding_a_custom_tag.md @@ -1,6 +1,6 @@ # Step 4 - Creating a custom tag -eZ Platform's RichText Field contains some built-in elements you can use, such as an image or a table. +The RichText Field contains some built-in elements you can use, such as an image or a table. You can also add custom tags that will enable you to add additional elements to RichText Fields. In this step you will add a custom tag, which will enable you to create a special note box called a Factbox. diff --git a/docs/tutorials/extending_admin_ui/extending_admin_ui.md b/docs/tutorials/extending_admin_ui/extending_admin_ui.md index 3e0c9d3420..da52991f60 100644 --- a/docs/tutorials/extending_admin_ui/extending_admin_ui.md +++ b/docs/tutorials/extending_admin_ui/extending_admin_ui.md @@ -2,7 +2,7 @@ ## Introduction -This tutorial aims at providing a step-by-step guide on how to extend the eZ Platform Back Office provided by [the eZ Platform Admin UI bundle](https://github.com/ezsystems/ezplatform-admin-ui).  +This tutorial aims at providing a step-by-step guide on how to extend the [[= product_name_oss =]] Back Office provided by [the [[= product_name_oss =]] Admin UI bundle](https://github.com/ezsystems/ezplatform-admin-ui).  You will learn to extend a few points of the Back Office: @@ -13,7 +13,7 @@ You will learn to extend a few points of the Back Office: To follow this tutorial you need to: -- be comfortable with eZ Platform's content model (Content, Location, Content Type, etc.) +- be comfortable with [[= product_name_oss =]]'s content model (Content, Location, Content Type, etc.) - have basic to intermediate level in PHP - have a basic knowledge of Symfony's concepts (such as Controllers and routing) diff --git a/docs/tutorials/generic_field_type/1_implement_the_point2d_value_class.md b/docs/tutorials/generic_field_type/1_implement_the_point2d_value_class.md index 24d568bded..d8d5ef483f 100644 --- a/docs/tutorials/generic_field_type/1_implement_the_point2d_value_class.md +++ b/docs/tutorials/generic_field_type/1_implement_the_point2d_value_class.md @@ -6,8 +6,8 @@ ## Project installation -To start the tutorial, you need to make a clean eZ Platform installation. -Follow the guide for your system to [install eZ Platform](../../getting_started/install_ez_platform.md), +To start the tutorial, you need to make a clean [[= product_name_oss =]] installation. +Follow the guide for your system to [install [[= product_name_oss =]]](../../getting_started/install_ez_platform.md), [configure a server](../../getting_started/requirements.md), and [start the web server](../../getting_started/install_ez_platform.md#use-phps-built-in-server). Remember to install using the `dev` environment. diff --git a/docs/tutorials/generic_field_type/creating_a_point2d_field_type.md b/docs/tutorials/generic_field_type/creating_a_point2d_field_type.md index 50a218034d..3b35c522a5 100644 --- a/docs/tutorials/generic_field_type/creating_a_point2d_field_type.md +++ b/docs/tutorials/generic_field_type/creating_a_point2d_field_type.md @@ -4,7 +4,7 @@ The code created in this tutorial is available on [GitHub](https://github.com/ezsystems/generic-field-type-tutorial/tree/master). -This tutorial covers the creation and development of a custom eZ Platform [Field Type](../../api/field_type_reference.md) based on a [Generic Field Type](../../extending/extending_field_type.md). +This tutorial covers the creation and development of a custom [[= product_name_oss =]] [Field Type](../../api/field_type_reference.md) based on a [Generic Field Type](../../extending/extending_field_type.md). The Generic Field Type is a very powerful extension point. It enables you to easily build complex solutions on a ready-to-go Field Type template. Field Types are responsible for: @@ -19,7 +19,7 @@ It describes how each component of a Field Type interacts with the various layer ## Intended audience -This tutorial is aimed at developers who are familiar with eZ Platform and are comfortable with operating in PHP and Symfony. +This tutorial is aimed at developers who are familiar with [[= product_name_oss =]] and are comfortable with operating in PHP and Symfony. ## Content of the tutorial diff --git a/docs/tutorials/platform_beginner/1_get_ready.md b/docs/tutorials/platform_beginner/1_get_ready.md index 7506ca6404..68fc6bcf18 100644 --- a/docs/tutorials/platform_beginner/1_get_ready.md +++ b/docs/tutorials/platform_beginner/1_get_ready.md @@ -1,8 +1,8 @@ # Step 1 — Get ready -To begin the tutorial, you need a clean installation of eZ Platform. +To begin the tutorial, you need a clean installation of [[= product_name_oss =]]. -Get it by following the [install eZ Platform](../../getting_started/install_ez_platform.md) guide. +Get it by following the [install [[= product_name_oss =]]](../../getting_started/install_ez_platform.md) guide. You will need a web server, a relational database and PHP. The clean installation contains only a root Content item which displays a welcome page. diff --git a/docs/tutorials/platform_beginner/2_create_the_content_model.md b/docs/tutorials/platform_beginner/2_create_the_content_model.md index cfb5fe131d..8867c18697 100644 --- a/docs/tutorials/platform_beginner/2_create_the_content_model.md +++ b/docs/tutorials/platform_beginner/2_create_the_content_model.md @@ -1,13 +1,13 @@ # Step 2 — Create the content model -How your content is structured is a very important part of an eZ Platform project. Think of it as the database design of your application. +How your content is structured is a very important part of an [[= product_name_oss =]] project. Think of it as the database design of your application. To get full information, read the [content model](../../guide/content_model.md) documentation page. Below is a short introduction that only covers points needed for this tutorial. ## Content model overview -The eZ Platform content Repository is centered around **Content items**. A Content item is a single piece of content, for example an article, a product review, a place, etc. +The [[= product_name_oss =]] content Repository is centered around **Content items**. A Content item is a single piece of content, for example an article, a product review, a place, etc. Every Content item is an instance of a **Content Type**. Content Types define what **Fields** are included in each Content item. For example, an article could include Fields such as *title*, *image*, *abstract*, *article's body*, *publication date* and *list of authors*. diff --git a/docs/tutorials/platform_beginner/3_customize_the_front_page.md b/docs/tutorials/platform_beginner/3_customize_the_front_page.md index a0485b8073..21c2c3865c 100644 --- a/docs/tutorials/platform_beginner/3_customize_the_front_page.md +++ b/docs/tutorials/platform_beginner/3_customize_the_front_page.md @@ -24,7 +24,7 @@ ezplatform: Id\Location: 2 ``` -This tells eZ Platform to use the `template` when rendering content with Location ID `2`. +This tells [[= product_name_oss =]] to use the `template` when rendering content with Location ID `2`. `2` is the default Location for the root Content item. `Id\Location` is one of several [view matchers](../../guide/content_rendering.md#configuring-views-the-viewprovider) that you can use to customize rendering depending on different criteria. @@ -72,9 +72,9 @@ To add a template like this to your site, create a `main_layout.html.twig` file - + - eZ Platform Beginner Tutorial + Ibexa Platform Beginner Tutorial @@ -146,7 +146,7 @@ To add a template like this to your site, create a `main_layout.html.twig` file
-

Website design & content © copyright {{ "now"|date("Y") }} Ibexa. This website was made with eZ Platform.

+

Website design & content © copyright {{ "now"|date("Y") }} Ibexa. This website was made with Ibexa Platform.

@@ -177,7 +177,7 @@ Before proceeding, ensure that the structure of the added files looks like this: ### Configuring Webpack -In eZ Platform, you can add assets by using [Symfony Webpack Encore](https://symfony.com/doc/5.0/frontend.html#webpack-encore) +In [[= product_name_oss =]], you can add assets by using [Symfony Webpack Encore](https://symfony.com/doc/5.0/frontend.html#webpack-encore) — an integration of Webpack that enables you to build bundles of CSS stylesheets and JS scripts and add them to the project. For more details, see [importing assets from a bundle](../../guide/project_organization.md#importing-assets-from-a-bundle). diff --git a/docs/tutorials/platform_beginner/8_enable_account_registration.md b/docs/tutorials/platform_beginner/8_enable_account_registration.md index e624e96a89..88172afaf3 100644 --- a/docs/tutorials/platform_beginner/8_enable_account_registration.md +++ b/docs/tutorials/platform_beginner/8_enable_account_registration.md @@ -214,14 +214,14 @@ You now have the ability to create new Rides and Landmarks in the selected folde ## Congratulations! -Now you have created your first website with eZ Platform. +Now you have created your first website with [[= product_name_oss =]]. **You learned how to:** - create a content model -- organize files in an eZ Platform project +- organize files in an [[= product_name_oss =]] project - configure views for different Content Types -- add assets to an eZ Platform project +- add assets to an [[= product_name_oss =]] project - use and configure Webpack Encore - use Twig templates and controllers to display content - enable user registration diff --git a/docs/tutorials/platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md b/docs/tutorials/platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md index c1c592844c..3ab5adbbb1 100644 --- a/docs/tutorials/platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md +++ b/docs/tutorials/platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md @@ -1,10 +1,10 @@ -# Building a bicycle route tracker in eZ Platform +# Building a bicycle route tracker in [[= product_name_oss =]] -This tutorial is a step-by-step guide to building an eZ Platform website. +This tutorial is a step-by-step guide to building an [[= product_name_oss =]] website. ## Intended audience -The tutorial is intended for users who have little or no previous experience with eZ Platform. +The tutorial is intended for users who have little or no previous experience with [[= product_name_oss =]]. To follow it, you should: diff --git a/docs/updating/3_update_app.md b/docs/updating/3_update_app.md index bfce17449d..40c17d5ef7 100644 --- a/docs/updating/3_update_app.md +++ b/docs/updating/3_update_app.md @@ -14,7 +14,7 @@ If you want to first test how the update proceeds without actually updating any ##### Adding EzSystemsPlatformEEAssetsBundle - !!! enterprise "EZ ENTERPRISE" + !!! dxp "EZ ENTERPRISE" When upgrading from releases between (and including) v1.10 and v2.1 to v2.2 and higher, you need to disable `EzSystemsPlatformEEAssetsBundle` by removing: diff --git a/docs/updating/4_update_2.2.md b/docs/updating/4_update_2.2.md index ed1c66389f..b601bf57a2 100644 --- a/docs/updating/4_update_2.2.md +++ b/docs/updating/4_update_2.2.md @@ -46,7 +46,7 @@ Also make the corresponding change in `app/config/dfs/dfs.yml`. ## Page builder -!!! enterprise +!!! dxp To update to v2.2, you need to run a script to add database tables for the Page Builder. You can find it in https://github.com/ezsystems/ezplatform-ee-installer/blob/2.2/Resources/sql/schema.sql#L58 diff --git a/docs/updating/4_update_2.3.md b/docs/updating/4_update_2.3.md index e240bd8768..3ba7ec8e34 100644 --- a/docs/updating/4_update_2.3.md +++ b/docs/updating/4_update_2.3.md @@ -26,7 +26,7 @@ mysql -u -p < vendor/ezsystems/ezpublish-k ## Form builder -!!! enterprise +!!! dxp To create the *Forms* container under the content tree root use the following command: diff --git a/docs/updating/4_update_2.4.md b/docs/updating/4_update_2.4.md index 666fd98707..81c49d7a6a 100644 --- a/docs/updating/4_update_2.4.md +++ b/docs/updating/4_update_2.4.md @@ -10,14 +10,14 @@ If you are updating from a version prior to 2.3, you have implement all the chan ## Workflow -!!! enterprise +!!! dxp When updating an Enterprise installation, you need to run a script to add database tables for the Editorial Workflow. You can find it in https://github.com/ezsystems/ezplatform-ee-installer/blob/2.4/Resources/sql/schema.sql#L198 ## Changes to the Forms folder -!!! enterprise +!!! dxp The built-in Forms folder is located in the Form Section in versions 2.4+. diff --git a/docs/updating/4_update_2.5.md b/docs/updating/4_update_2.5.md index 8e6f39a979..b11aef02f4 100644 --- a/docs/updating/4_update_2.5.md +++ b/docs/updating/4_update_2.5.md @@ -85,7 +85,7 @@ bin/console cache:pool:clear cache.redis ### Page builder -!!! enterprise +!!! dxp This step is only **required when updating from versions higher than 2.2 and lower than 2.5.3**. In case of versions lower than 2.2, please skip this step or ignore the information that indexes from a script below already exist. diff --git a/docs/upgrading/4_9_upgrade_site_factory.md b/docs/upgrading/4_9_upgrade_site_factory.md index 66be8f566e..05fb1c1130 100644 --- a/docs/upgrading/4_9_upgrade_site_factory.md +++ b/docs/upgrading/4_9_upgrade_site_factory.md @@ -1,6 +1,6 @@ # 4.9. Upgrade Site Factory -!!! enterprise +!!! dxp For production, it is recommended to create the `ezsite` and `ezsite_public_access` tables manually importing their schemas definition: diff --git a/docs/upgrading/5_upgrade_database.md b/docs/upgrading/5_upgrade_database.md index 5d04ca176d..a13ea9a61a 100644 --- a/docs/upgrading/5_upgrade_database.md +++ b/docs/upgrading/5_upgrade_database.md @@ -8,7 +8,7 @@ or for PostgreSQL: `psql < upgrade/db/postgresql/ezplatform-2.5.latest-to-3.0.0.sql` -!!! enterprise +!!! dxp ### Date-based publisher database update diff --git a/material/base.html b/material/base.html index 0deb90a091..822913c2be 100644 --- a/material/base.html +++ b/material/base.html @@ -1,7 +1,7 @@ {% import "partials/language.html" as lang with context %} {% set config = { - 'site_name': 'eZ Platform Developer Documentation', + 'site_name': 'Ibexa Developer Documentation', 'repo_url': 'https://github.com/ezsystems/developer-documentation', 'copyright': 'Copyright 1999-2020 Ibexa AS and others', 'plugins': config.plugins, diff --git a/mkdocs.yml b/mkdocs.yml index c231028aa7..fa420551cc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,17 +1,17 @@ -site_name: eZ Platform Developer Documentation +site_name: Ibexa Developer Documentation repo_url: https://github.com/ezsystems/developer-documentation copyright: "Copyright 1999-2020 Ibexa and others" nav: - - 'eZ Platform Developer Documentation': 'index.md' + - 'Ibexa Developer Documentation': 'index.md' - Getting started: - 'Requirements': 'getting_started/requirements.md' - - 'Install eZ Platform': 'getting_started/install_ez_platform.md' + - 'Install Ibexa Platform': 'getting_started/install_ez_platform.md' - 'First steps': 'getting_started/first_steps.md' - 'Bundles starter pack': 'getting_started/bundles_starter_pack.md' - 'Troubleshooting': 'getting_started/troubleshooting.md' - Tutorials: - - eZ Platform beginner: - - 'eZ Platform beginner tutorial': 'tutorials/platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md' + - Ibexa Platform beginner: + - 'Ibexa Platform beginner tutorial': 'tutorials/platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md' - '1. Get ready': 'tutorials/platform_beginner/1_get_ready.md' - '2. Create the content model': 'tutorials/platform_beginner/2_create_the_content_model.md' - '3. Customize the front page': 'tutorials/platform_beginner/3_customize_the_front_page.md' @@ -20,8 +20,8 @@ nav: - '6. Improve configuration': 'tutorials/platform_beginner/6_improve_configuration.md' - '7. Embed content': 'tutorials/platform_beginner/7_embed_content.md' - '8. Enable account registration': 'tutorials/platform_beginner/8_enable_account_registration.md' - - eZ Enterprise beginner: - - 'eZ Enterprise beginner tutorial': 'tutorials/enterprise_beginner/ez_enterprise_beginner_tutorial_-_its_a_dogs_world.md' + - Ibexa DXP beginner: + - 'Ibexa DXP beginner tutorial': 'tutorials/enterprise_beginner/ez_enterprise_beginner_tutorial_-_its_a_dogs_world.md' - '1. Get a starter website': 'tutorials/enterprise_beginner/1_get_a_starter_website.md' - '2. Prepare the Landing Page': 'tutorials/enterprise_beginner/2_prepare_the_landing_page.md' - '3. Use existing blocks': 'tutorials/enterprise_beginner/3_use_existing_blocks.md' @@ -599,7 +599,7 @@ nav: - 'Reporting Issues': 'guide/reporting_issues.md' - 'Notifications': 'guide/sending_notifications.md' - 'Service container': 'guide/service_container.md' - - Extending eZ Platform: + - Extending Ibexa Platform: - Extending Back Office: - 'Extending Back Office': 'extending/extending_back_office.md' - 'Extending Menus': 'extending/extending_menus.md' @@ -631,7 +631,7 @@ nav: - 'Release process and roadmap': 'community_resources/release_process.md' - 'Support and Maintenance FAQ': 'community_resources/support_maintenance_faq.md' - Contributing: - - 'Install eZ Platform on macOS or Windows': 'community_resources/installing-on-mac-os-and-windows.md' + - 'Install Ibexa Platform on macOS or Windows': 'community_resources/installing-on-mac-os-and-windows.md' - 'How to contribute': 'community_resources/contributing.md' - 'Report and follow issues': 'community_resources/report_follow_issues.md' - 'Contribute code': 'community_resources/code.md' @@ -658,11 +658,11 @@ nav: - Design Principles: - 'Philosophy': 'guidelines/design_principles/Philosophy.md' - 'Accessibility': 'guidelines/design_principles/Accessibility.md' - - Migrating to eZ Platform: + - Migrating to Ibexa Platform: - 'Migrating from eZ Publish Platform': 'migrating/migrating_from_ez_publish_platform.md' - 'Migrating from eZ Publish': 'migrating/migrating_from_ez_publish.md' - 'Common issues': 'migrating/common_issues.md' - - Upgrading eZ Platform: + - Upgrading Ibexa Platform: - 'Upgrading to eZ Platform v3': 'upgrading/upgrading_to_v3.md' - '1. Check out a tagged version': 'upgrading/1_check_out_version.md' - '2. Merge composer.json': 'upgrading/2_merge_composer.md' @@ -683,8 +683,8 @@ nav: - '6. Platform.sh changes': 'upgrading/6_platform_sh_changes.md' - '7. Dump assets': 'upgrading/7_dump_assets.md' - '8. Commit, test and merge': 'upgrading/8_commit_test_merge.md' - - Updating eZ Platform: - - 'Updating eZ Platform': 'updating/updating_ez_platform.md' + - Updating Ibexa Platform: + - 'Updating Ibexa Platform': 'updating/updating_ez_platform.md' - '1. Check out a tagged version': 'updating/1_check_out_version.md' - '2. Merge composer.json': 'updating/2_merge_composer.md' - '3. Update the app': 'updating/3_update_app.md' @@ -772,10 +772,14 @@ extra: - '/guidelines/resources/' - '/index.md' related_docs: - - title: 'eZ Platform Developer Documentation' + - title: 'Ibexa Developer Documentation' url: '/' - - title: 'eZ Platform User Documentation' + - title: 'Ibexa User Documentation' url: '/projects/userguide' + # Global variables + product_name_oss: 'Ibexa Platform' + product_name_ee: 'Ibexa DXP' + product_name_com: 'Ibexa Commerce' extra_css: - fonts/MavenPro.css