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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ config:
punctuation: [".", ":", ";",]
no-multiple-space-atx: true
blanks-around-headings: true
# heading-increment: true
heading-increment: true
ul-style: dash
ul-indent:
indent: 4
Expand Down
6 changes: 3 additions & 3 deletions docs/administration/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ description: In Ibexa DXP you store and manage configuration in project files, t
[[= product_name =]] configuration is delivered by means of a number of dedicated configuration files.
It contains everything from selecting the content repository to SiteAccesses to language settings.

### Configuration format
## Configuration format

The recommended configuration format is YAML.
It's used by default in the kernel (and in examples throughout the documentation).
However, you can also use XML or PHP formats for configuration.

### Configuration files
## Configuration files

Configuration files are located in the `config` folder.
Configuration is provided per package in the `config/packages` folder, and routes are defined per package in `config/routes`.
Expand Down Expand Up @@ -43,7 +43,7 @@ These files contain additional settings and point to the general (not environmen

Be careful when copy-pasting text from a word processing software or a PDF, because it might contain hidden characters like the [soft hyphen](https://en.wikipedia.org/wiki/Soft_hyphen).

### Configuration handling
## Configuration handling

!!! note

Expand Down
2 changes: 1 addition & 1 deletion docs/administration/content_organization/sections.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Other references to the section remain and thus the system most likely loses con
Section ID numbers aren't recycled.
If a section is removed, its ID number cannot be reused when a new section is created.

### Registering users
## Registering users

Registration form for your website is placed under this address: <yourdomain>/register.
By default, new users created in this way are placed in the Guest accounts group.
Expand Down
2 changes: 1 addition & 1 deletion docs/commerce/order_management/order_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ The component exposes the following:
- [PHP API](order_management_api.md) that allows for managing orders
- [REST API](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Orders) that helps get order information over HTTP

### Order management service
## Order management service

The Order Management package provides the `Ibexa\Contracts\OrderManagement\OrderServiceInterface` service, which is the entrypoint for calling the [backend API](order_management_api.md).
2 changes: 1 addition & 1 deletion docs/commerce/payment/payment.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The component exposes the following APIs:
- [Payment method REST API](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Payments) that helps manage payment methods over HTTP
- [Payment PHP API](payment_api.md) that allows for managing payments

### Services
## Services

The Payment package provides the following services, which are entry points for calling backend APIs:

Expand Down
2 changes: 1 addition & 1 deletion docs/commerce/shipping_management/shipping_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The component exposes the following:
- [Shipping method PHP API](shipping_method_api.md) that allows for managing shipping methods
- [Shipment PHP API](shipment_api.md) that allows for managing shipments

### Services
## Services

The Shipping package provides the following services, which are entry points for calling backend APIs:

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/content_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ A content item consists of:
- [Fields](#fields), defined by the [content type](content_types.md).
The fields can cover data ranging from single variables and text lines to media files or blocks of formatted text.

#### Content information
### Content information

General information about a content item is stored in a [`ContentInfo`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-ContentInfo.html) object.
`ContentInfo` doesn't include fields. It contains following information:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This field type allows the storage and retrieval of one or more authors. For eac

### Value object

##### Properties
#### Properties

| Attribute | Type | Description | Example |
|-----------|------------------------------------------|------------------|-----------|
Expand All @@ -33,7 +33,7 @@ $authorList = Author\Value([
]);
```

### Hash format
#### Hash format

The hash format mostly matches the value object. It has the following key `authors`.

Expand All @@ -54,7 +54,7 @@ Example
]
```

##### String representation
#### String representation

The string contains all the authors with their names and emails.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Checkbox field type stores the current status for a checkbox input, checked

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The format used by the toHash method is the Alpha2 value, however the input is c

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This field type represents a customer group that a user belongs to.

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ It's also possible to directly pass an instance of `\DateTime`.

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
|--------|---------------|---------------------|
| `Date` | `ibexa_date` | mixed |

#### PHP API field type
## PHP API field type

Check notice on line 9 in docs/content_management/field_types/field_type_reference/datefield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/field_types/field_type_reference/datefield.md#L9

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

### Input expectations

Expand All @@ -26,7 +26,7 @@

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The EmailAddress field type represents an email address, in the form of a string

### Value object

##### Properties
#### Properties

The `Value` class of this field type contains the following properties:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The field type expects a number as input. Both decimal and integer numbers are a

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ It makes them reusable across system.
|--------------|---------------------|
| `ImageAsset` | `ibexa_image_asset` |

### Input expectations
## Input expectations

Example array:

Expand All @@ -18,9 +18,9 @@ Example array:
| `string` | ID of the Asset content item. | `"150"` |
| `integer` | ID of the Asset content item. | `150` |

### Value object
## Value object

##### Properties
### Properties

Value object of `ibexa_image_asset` contains the following properties:

Expand All @@ -36,7 +36,7 @@ $imageAssetValue->destinationContentId = $contentInfo->id;
$imageAssetValue->alternativeText = "Picture of an apple.";
```

##### Constructor
#### Constructor

The `ImageAsset\Value` constructor initializes a new value object with the value provided.
It expects an ID of a content item representing asset and the alternative text.
Expand All @@ -54,7 +54,7 @@ This field type validates if:

- `destinationContentId` points to a content item which has correct content type

### Configuration
## Configuration

ImageAsset field type allows configuring the following options:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A **variation service** handles the conversion of the original image into differ

The `value` property of an Image field returns an `Ibexa\Core\FieldType\Image\Value` object with the following properties:

##### Properties
#### Properties

| Property | Type | Example | Description |
|-------------------|--------|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This field type represents an integer value.

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

Expand All @@ -29,7 +29,7 @@ The Value class of this field type contains the following properties:
$integer->value = 8
```

##### Constructor
#### Constructor

The `Integer\Value` constructor initializes a new value object with the value provided.
It expects a numeric, integer value.
Expand All @@ -42,13 +42,13 @@ use Ibexa\Core\FieldType\Integer;
$integerValue = new Integer\Value( 8 );
```

### Hash format
#### Hash format

Hash value of this field type is an integer value as a string.

Example: `"8"`

### String representation
#### String representation

String representation of the field type's value returns the integer value as a string.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ This field type represents an ISBN string either an ISBN-10 or ISBN-13 format.

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

| Property | Type | Description |
|----------|----------|--------------------------------------------|
| `$isbn` | `string` | This property is used for the ISBN string. |

##### String representation
#### String representation

An ISBN's string representation is the `$isbn` property's value, as a string.

##### Constructor
#### Constructor

The constructor for this value object initializes a new value object with the value provided.
It accepts a string as argument and sets it to the `isbn` attribute.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This field type stores one or several comma-separated keywords as a string or ar

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ As input it expects three values:

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

Expand All @@ -31,7 +31,7 @@ The Value class of this field type contains the following properties:
| `$longitude` | `float` | This property stores the longitude value of the map location reference. |
| `$address` | `string` | This property stores the address of map location. |

##### Constructor
#### Constructor

The `MapLocation\Value` constructor initializes a new value object with values provided as hash.
Accepted keys are `latitude` (`float`), `longitude` (`float`), `address` (`string`).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ Assuming that the service exists as `$measurementService`, the expected input ex

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

| Property | Type | Description |
|----------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `$value` | `Ibexa\Contracts\Measurement\Value\ValueInterface` | Stores the Measurement API Value, which can be either an instance of `Ibexa\Contracts\Measurement\Value\SimpleValueInterface` or `Ibexa\Contracts\Measurement\Value\RangeValueInterface`. |

##### Constructor
#### Constructor

The `Measurement\Value` constructor for this value object initializes a new value object with the value provided.
As its first argument it accepts an object of `Ibexa\Contracts\Measurement\Value\ValueInterface` type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ It's capable of handling the following types of files:

### Value object

##### Properties
#### Properties

`Ibexa\Core\FieldType\Media\Value` offers the following properties.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This field type makes it possible to store and retrieve the value of a relation

### Value object

##### Properties
#### Properties

The Value class of this field type contains the following properties:

Expand All @@ -31,7 +31,7 @@ The Value class of this field type contains the following properties:
$relation->destinationContentId = $contentInfo->id;
```

##### Constructor
#### Constructor

The `Relation\Value` constructor initializes a new value object with the value provided. It expects a mixed value.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This field type makes it possible to store and retrieve values of a relation to

### Value Object

##### Properties
#### Properties

`Ibexa\Core\FieldType\RelationList\Value` contains the following properties:

Expand All @@ -36,7 +36,7 @@ $relationList->destinationContentId = [
];
```

##### Constructor
#### Constructor

The `RelationList\Value` constructor initializes a new value object with the value provided.
It expects a mixed array as value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@
| `DOMDocument` | XML document in one of the field type's input formats as a `DOMDocument` object. |
| `Ibexa\FieldTypeRichText\FieldType\RichText\Value` | An instance of the field type's `Value` object. |

##### Input formats
### Input formats

The field type expects an XML value as input, in the form of a string, `DOMDocument` object, or field type's `Value` object.
The field type's `Value` object must hold the value in the field type's [internal format](#internal-format).
For a string of a `DOMDocument` object, if the input doesn't conform to this format, it's converted into it.

##### Internal format
#### Internal format

As its internal format, the RichText field type uses a [custom flavor of the DocBook format](#custom-docbook-format).

Expand All @@ -48,7 +48,7 @@
</section>
```

##### XHTML5 edit format
#### XHTML5 edit format

Check notice on line 51 in docs/content_management/field_types/field_type_reference/richtextfield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/field_types/field_type_reference/richtextfield.md#L51

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

The XHTML5 format is used by the Online Editor.

Expand Down
Loading
Loading