Skip to content

Commit 7584ebb

Browse files
author
DominikaK
authored
Product renaming (#1185)
1 parent 75f0ebc commit 7584ebb

File tree

206 files changed

+586
-717
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

206 files changed

+586
-717
lines changed

docs/api/commerce_api/field_type_reference/field_type_reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Commerce Field Types
22

3-
eZ Commerce uses special ecommerce-related Field Types:
3+
[[= product_name_com =]] uses special ecommerce-related Field Types:
44

55
- [sesselection](sesselection.md) - offers a selection using options from a YAML file
66
- [sesexternaldata](sesexternaldata.md)

docs/api/commerce_api/fields_for_ecommerce_data/fields_for_ecommerce_data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Fields for eCommerce data
22

3-
eZ Commerce uses custom Fields to store eCommerce related data, for example for the catalog or basket.
3+
[[= product_name_com =]] uses custom Fields to store eCommerce related data, for example for the catalog or basket.
44

55
The shop provides a flexible way to store data using concrete instances of classes implementing `FieldInterface` and inheriting from the `AbstractField` class.
66
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)).

docs/api/commerce_api/helper_services/mailhelperservice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MailHelperService
22

3-
`MailHelperService` is used to create, render and send emails from eZ Commerce.
3+
`MailHelperService` is used to create, render and send emails from [[= product_name_com =]].
44

55
## Interface and implementations
66

docs/api/commerce_rest_api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Commerce REST API
22

3-
eZ Commerce extends the REST API of eZ Platform with the following features:
3+
[[= product_name_com =]] extends the REST API of [[= product_name_oss =]] with the following features:
44

55
## Basket API
66

docs/api/creating_content_with_binary_attachments_via_rest_api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ As for the response, it's possible to use either JSON or XML in input.
1010
The following examples use JSON (and assume [HTTP Basic Auth](general_rest_usage.md#http-basic-authentication) is enabled).
1111

1212
``` php
13-
// URL to eZ Platform installation
13+
// URL to [[= product_name_oss =]] installation
1414
$base_url = "http://127.0.0.1";
1515
// User credentials
1616
$username = "admin";
@@ -99,7 +99,7 @@ curl_close($curl);
9999
To publish the image use the following code:
100100

101101
``` php
102-
// URL to eZ Platform installation
102+
// URL to [[= product_name_oss =]] installation
103103
$base_url = "http://127.0.0.1";
104104
// User credentials
105105
$username = "admin";

docs/api/creating_custom_rest_api_response.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

5-
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.
5+
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.
66

77
## Implementation of dedicated Visitor
88

@@ -246,7 +246,7 @@ Please note that you should set a proper `Accept` header value. For this example
246246
"value": [
247247
{
248248
"_languageCode": "eng-GB",
249-
"#text": "eZ Platform"
249+
"#text": "Ibexa Platform"
250250
}
251251
]
252252
},

docs/api/extending_the_rest_api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Extending the REST API
22

3-
The eZ Platform REST API comes with a framework that makes it easy to extend the API for your own needs.
3+
The [[= product_name_oss =]] REST API comes with a framework that makes it easy to extend the API for your own needs.
44

55
## Requirements
66

7-
REST routes are required to use the eZ Platform REST API prefix, `/api/ezp/v2`. You can create new resources below this prefix.
7+
REST routes are required to use the [[= product_name_oss =]] REST API prefix, `/api/ezp/v2`. You can create new resources below this prefix.
88

99
To do so, you will/may need to create:
1010

docs/api/field_type_api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Basic information
44

55
Field Types are the smallest building blocks of content.
6-
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.
6+
[[= 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.
77

88
Field Types are responsible for:
99

@@ -14,7 +14,7 @@ Field Types are responsible for:
1414

1515
## Custom data
1616

17-
eZ Platform can support custom data to be stored in the Fields of a Content item.
17+
[[= product_name_oss =]] can support custom data to be stored in the Fields of a Content item.
1818
To do so, you need to create a custom Field Type.
1919

2020
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
2525
Remember that all your custom Field Types must be registered in `config/services.yml`.
2626
For more information see [Registration section](field_type_type_and_value.md#registration).
2727

28-
In order to provide custom functionality for a Field Type, the SPI interacts with multiple layers of the eZ Platform architecture:
28+
In order to provide custom functionality for a Field Type, the SPI interacts with multiple layers of the [[= product_name_oss =]] architecture:
2929

3030
![Field Type Overview](img/field_type_overview.png)
3131

@@ -39,7 +39,7 @@ Below that, the Field Type must support the **Public API** implementation regard
3939

4040
On the bottom level, a Field Type can additionally hook into the **Persistence SPI**
4141
in order to store data from a `FieldValue` in an external service.
42-
Note that all non-standard eZ Platform database tables (e.g. `ezurl`)
42+
Note that all non-standard [[= product_name_oss =]] database tables (e.g. `ezurl`)
4343
will be treated as [external storage](field_type_storage.md#external-storage).
4444

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

docs/api/field_type_reference.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
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.
44

5-
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.
5+
[[= 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.
66

77
!!! tip
88

99
For general Field Type documentation, see [Field Type API](../api/field_type_api.md).
1010

11-
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.
11+
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 =]].
1212

1313

1414
## Available Field Types
@@ -37,7 +37,7 @@ Custom Field Types have to be programmed in PHP. However, the built-in Field Ty
3737
| [Rating](#rating-field-type) | **Deprecated** | N/A | N/A |
3838
| [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 |
3939
| [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 |
40-
| [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 |
40+
| [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 |
4141
| [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 |
4242
| [TextBlock](#textblock-field-type) | Validates and stores a larger block of text. | Yes[^1^](#1-note-on-legacy-search-engine) | Yes |
4343
| [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/
5757

5858
|FieldType|Description|Searchable|Editing support in Platform UI|Planned to be included in the future|
5959
|------|------|------|------|------|
60-
| [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))*</br>The XmlText Field Type is not enabled by default in eZ Platform.|
60+
| [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))*</br>The XmlText Field Type is not enabled by default in [[= product_name_oss =]].|
6161

6262
### Field Types provided by Community
6363

@@ -308,7 +308,7 @@ This Field Type maps an executable Repository query to a Field.
308308
|-----------|---------------|----------------|
309309
| `Content query` | `ezcontentquery` | `string` |
310310

311-
The Content query Field Type is available via the eZ Platform Query Field Type Bundle
311+
The Content query Field Type is available via the Query Field Type Bundle
312312
provided by the [ezplatform-query-fieldtype](https://github.com/ezsystems/ezplatform-query-fieldtype) package.
313313

314314
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
342342

343343
#### Validation
344344

345-
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.
345+
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 =]].
346346

347347
#### Settings
348348

@@ -790,7 +790,7 @@ $floatFieldCreateStruct->validatorConfiguration = [
790790

791791
This Field Type does not support settings.
792792

793-
!!! enterprise
793+
!!! dxp
794794

795795
## Form Field Type
796796

@@ -1317,7 +1317,7 @@ This Field Type stores one or several comma-separated keywords as a string or ar
13171317
|Type|Example|
13181318
|------|------|
13191319
|`string`|`"documentation"`|
1320-
|`string`|`"php, eZ Platform, html5"`|
1320+
|`string`|`"php, Ibexa Platform, html5"`|
13211321
|`string[]`|`[ "Ibexa", "Enterprise", "User Experience Management" ]`|
13221322

13231323
#### Value object
@@ -1338,7 +1338,7 @@ use eZ\Publish\Core\FieldType\Keyword\Value;
13381338
$keywordValue = new Value();
13391339
 
13401340
// Sets an array of keywords as a value
1341-
$keyword->value = [ "php", "css3", "html5", "eZ Platform" ];
1341+
$keyword->value = [ "php", "css3", "html5", "Ibexa Platform" ];
13421342
```
13431343

13441344
##### Constructor
@@ -1458,7 +1458,7 @@ This Field represents and handles a table of rows and columns of data.
14581458
|----------|---------------|----------------|
14591459
| `Matrix` | `ezmatrix` | `array` |
14601460

1461-
The Matrix Field Type is available via the eZ Platform Matrix Bundle
1461+
The Matrix Field Type is available via the Matrix Bundle
14621462
provided by the [ezplatform-matrix-fieldtype](https://github.com/ezsystems/ezplatform-matrix-fieldtype) package.
14631463

14641464
### PHP API Field Type
@@ -1793,7 +1793,7 @@ This Field Type is used as fallback for migration scenarios, and for testing pur
17931793

17941794
### Description
17951795

1796-
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.
1796+
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 =]].
17971797

17981798
Null Field Type will accept anything provided as a value and is usually combined with:
17991799
- NullConverter: Makes it not store anything to the legacy storage engine (database), nor will it read any data.
@@ -1822,13 +1822,13 @@ services:
18221822
tags: [{name: ezplatform.field_type.indexable, alias: example}]
18231823
```
18241824
1825-
!!! enterprise
1825+
!!! dxp
18261826
18271827
## Page Field Type
18281828
18291829
Page Field Type represents a Page with a layout consisting of multiple zones. Each zone can in turn contain blocks.
18301830
1831-
Page Field Type is only used in the Page Content Type that is included in eZ Enterprise.
1831+
Page Field Type is only used in the Page Content Type that is included in [[= product_name_ee =]].
18321832
18331833
| Name | Internal name | Expected input |
18341834
|----------------|-----------------|-----------------|
@@ -2104,7 +2104,7 @@ $validators = [
21042104

21052105
## RichText Field Type
21062106

2107-
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.
2107+
The RichText Field Type is available via the RichText Field Type Bundle provided by the [ezplatform-richtext](https://github.com/ezsystems/ezplatform-richtext) package.
21082108

21092109
This Field Type validates and stores structured rich text, and exposes it in several formats.
21102110

@@ -2130,7 +2130,7 @@ Currently supported input formats are described in the table below:
21302130

21312131
|Name|Description|
21322132
|------|------|
2133-
|eZ Platform's DocBook variant|Field Type's internal format|
2133+
|[[= product_name_oss =]]'s DocBook variant|Field Type's internal format|
21342134
|XHTML5 editing format|Typically used with in-browser HTML editor|
21352135
|Legacy eZXML format|Compatibility with legacy XML format, used by [XmlText Field Type](#xmltext-field-type)|
21362136

@@ -2150,7 +2150,7 @@ Currently supported input formats are described in the table below:
21502150

21512151
###### Example of the Field Type's XHTML5 edit format
21522152

2153-
This format is used by eZ Platform's Online Editor.
2153+
This format is used by [[= product_name_oss =]]'s Online Editor.
21542154

21552155
``` xml
21562156
<?xml version="1.0" encoding="UTF-8"?>
@@ -2587,7 +2587,7 @@ This Field Type validates and stores information about a user.
25872587

25882588
## XmlText Field Type
25892589

2590-
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.
2590+
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.
25912591

25922592
This Field Type validates and stores formatted text using the eZ Publish legacy format, eZXML. 
25932593

docs/api/field_type_storage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Storage conversion
44

5-
If you want to store Field values in regular eZ Platform database tables,
5+
If you want to store Field values in regular [[= product_name_oss =]] database tables,
66
the `FieldValue` must be converted to the storage-specific format used by the Persistence SPI:
77
`eZ\Publish\SPI\Persistence\Content\FieldValue`.
88
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:
1919
|Property|Description|
2020
|--------|-----------|
2121
|`$data`|The data to be stored in the database. This may be a scalar value, an associative array or a simple, serializable object.|
22-
|`$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).|
22+
|`$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).|
2323
|`$sortKey`|A value which can be used to sort content by this Field.|
2424

2525
### Legacy storage engine
@@ -85,7 +85,7 @@ The tag has the following attribute:
8585

8686
A Field Type may store arbitrary data in external data sources.
8787
External storage can be e.g. a web service, a file in the file system, another database
88-
or even the eZ Platform database itself (in form of a non-standard table).
88+
or even the [[= product_name_oss =]] database itself (in form of a non-standard table).
8989

9090
In order to store data in external storage, the Field Type will interact with the Persistence SPI
9191
through the `eZ\Publish\SPI\FieldType\FieldStorage` interface.
@@ -102,7 +102,7 @@ calls one of the following methods to also access the external data:
102102
|`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).|
103103

104104
Each of the above methods (except `hasFieldData`) receives a `$context` array with information on the underlying storage and the environment.
105-
To retrieve and store data in the eZ Platform data storage,
105+
To retrieve and store data in the [[= product_name_oss =]] data storage,
106106
but outside of the normal structures (e.g. a custom table in an SQL database),
107107
use [Gateway-based storage](#gateway-based-storage) with properly injected Doctrine Connection.
108108

0 commit comments

Comments
 (0)