Skip to content

Commit

Permalink
Capitalization & vale fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
julitafalcondusza committed Sep 26, 2024
1 parent 818fc12 commit b9f123a
Show file tree
Hide file tree
Showing 15 changed files with 91 additions and 92 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you'd like to see Ibexa DXP in your language, you can [contribute to the tran
## Build and preview documentation

To build and preview your changes locally, you need to install Python along with its package manager (`pip`).
Other required tools will be installed by using the following command:
Other required tools can be installed by using the following command:

```bash
pip install -r requirements.txt
Expand Down
10 changes: 5 additions & 5 deletions docs/content_management/block_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ The following blocks are provided with a clean installation of [[= product_name

## Block basics

Handling blocks is straightforward, drag and drop them into the desired spot within the drop zone.
Handling blocks is straightforward, drag and drop them into the desired spot within the drop zone.
There's no need to worry about getting their placement perfect initially, you can rearrange them whenever you need.

### Settings

You have the ability to control individual blocks by accessing their settings.
Click on the settings icon next to the block's name.
You have the ability to control individual blocks by accessing their settings.
Click on the settings icon next to the block's name.

![Block settings](img/block_settings.png "Block settings")

Expand Down Expand Up @@ -90,7 +90,7 @@ On the **Design** tab, in the **View** field, select the layout to be used to pr

## Campaign block

Displays a campaign created and configured in [[[= product_name_engage =]]](../ibexa_engage/ibexa_engage.md).
Displays a campaign created and configured in [[[= product_name_engage =]]](../ibexa_engage/ibexa_engage.md).
On the **Properties** tab, set values in the following fields:

- **Name** – Enter a name for the campaign.
Expand Down Expand Up @@ -121,7 +121,7 @@ On the **Properties** tab, set values in the following fields:

## Collection block

Displays a collection of content items manually selected from the Content structure, allowing you to feature specific content for promotional campaigns or highlight essential information on your website.
Displays a collection of content items manually selected from the content structure, allowing you to feature specific content for promotional campaigns or highlight essential information on your website.
On the **Properties** tab, set values in the following fields:

- **Name** — Enter a name for the page block.
Expand Down
39 changes: 18 additions & 21 deletions docs/content_management/configure_ct_field_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ description: Configure field settings in content types.

# Configure content type fields

When you work with a [content type](content_model.md#content-types) to add or modify [fields](content_model.md#fields-and-field-types),
you must configure different settings that control the way [[= product_name =]]
treats the contents of each field. Apart from general settings, certain field types, for example, [landing page](#default-configuration-of-pages) and [Content relation](#content-relation-settings) field types may have additional settings.
When you work with a [content type](content_model.md#content-types) to add or modify [fields](content_model.md#fields-and-field-types),
you must configure different settings that control the way [[= product_name =]]
treats the contents of each field. Apart from general settings, certain field types, for example, [landing page](#default-configuration-of-pages) and [content relation](#content-relation-settings) field types may have additional settings.

You can only create or modify content types when your [user role](../permission_management/work_with_permissions.md) has the `ContentType/Create` or `ContentType/Update` permission.

1\. [Create or open a content type](create_edit_content_types.md) for editing.

2\. In the **Field definitions** area, find a section, for example, **Content**.
2\. In the **Field definitions** area, find a section, for example, **Content**.

3\. If your application requires a more granular organization of fields within a content type, click **+ Add** to add more sections.

Expand All @@ -23,13 +23,13 @@ All sections are later presented as headers on the content item details screen,

4\. Add, reorder or remove fields as required:

- To add a field, from the **Field types** area, drag the required field tile to the section on the left.
- To add a field, from the **Field types** area, drag the required field tile to the section on the left.
- To reorder fields, drag and drop them within the section or between sections on the left.
- To remove fields from the section completely, click the **X** icon in the field's header.

![Adding a field](img/add_field.png "Adding a field")

5\. Expand the header of a field that you want to modify, then [change its settings](#general-settings).
5\. Expand the header of a field that you want to modify, then [change its settings](#general-settings).

6\. To save your changes:

Expand All @@ -43,11 +43,11 @@ All sections are later presented as headers on the content item details screen,

## General settings

Depending on their type, fields can have different combinations of the following general settings.
Depending on their type, fields can have different combinations of the following general settings.

|Setting|Description|Use|
--------|-----------|---|
|Name|A user-friendly name that describes the field, used in the interface. It can be up to 255 characters long and consist of letters, digits, spaces and special characters.|Required|
|Name|A user-friendly name that describes the field, used in the interface. It can be up to 255 characters long and consist of letters, digits, spaces, and special characters.|Required|
|Identifier|An identifier for system use in configuration files, templates, or PHP code. It can be up to 50 characters long and can only contain lowercase letters, digits and underscores. Also used in name patterns for the content type.|Required|
|Description|A detailed description of the field. It's displayed next to it when the user edits the content item.|Optional|
|Required|Indicates whether a value of the field is required for the content item to be saved or published.|Optional|
Expand All @@ -57,7 +57,7 @@ Depending on their type, fields can have different combinations of the following

## Default configuration of pages

The following settings control the behavior of content items of [Page](../content_management/create_edit_pages.md) type.
The following settings control the behavior of content items of [Page](../content_management/create_edit_pages.md) type.
You modify them in the **Field definitions** section, the **Landing Page** field.

Check warning on line 61 in docs/content_management/configure_ct_field_settings.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/configure_ct_field_settings.md#L61

[Ibexa.DontCapitalize] Don't capitalize 'Landing Page' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Landing Page' if inside the sentence.", "location": {"path": "docs/content_management/configure_ct_field_settings.md", "range": {"start": {"line": 61, "column": 61}}}, "severity": "WARNING"}

### Block display
Expand All @@ -75,21 +75,19 @@ Now, only selected page blocks are available in the edit mode.

!!! caution

When you deselect blocks, any related blocks that are included in the Page
hide as well.
When you deselect blocks, any related blocks that are included in the Page
hide as well.
To publish the Page, the editor has to remove these blocks from the Page, too.

### Available page layouts

You can decide which page layouts are available for an editor.

Expand the **Select layouts** section, and define which layouts are available
for this Page.
Expand the **Select layouts** section, and define which layouts are available for this Page.

![Layouts](img/select_layouts.png "Layouts")

If you deselect a layout that is currently used on a Page, the editor has to change
the layout to be able to edit the Page.
If you deselect a layout that is currently used on a Page, the editor has to change the layout to be able to edit the Page.

### Preferred editing mode

Expand All @@ -100,22 +98,21 @@ To do it, in the **Select Editor launch mode** section, select one of the availa

## Content relation settings

When you add or modify a **[Content relation](create_edit_content_items.md#relation_field)** or **Content relation (multiple)**
When you add or modify a **[Content relation](create_edit_content_items.md#relation_field)** or **Content relation (multiple)**
field in a content type, you can decide:

- which content tree location opens in the
[Content Browser](content_model.md#content-browser) when the user browses to a related
content item
- which content tree location opens in the
[content browser](content_model.md#content-browser) when the user browses to a related content item
- whether relations can be to content items of a specific type only, or any content type

#### Relation starting location

In the **Select starting Location** area, select from the available options:

- **Default** - the starting location is automatically assigned to the default location in the tree of a created content item.
- **Browse** - use to manually select the location from the Content Browser.
- **Browse** - use to manually select the location from the content browser.
- **Content location** - the starting location is the location of the content item that is edited by the user. For example, if the user edits the content item with the location `50`, it sets the starting location to this value with children under this location.
- **Root default location** - use if you want the Content Browser to start at the defined location with only children available for selection.
- **Root default location** - use if you want the content browser to start at the defined location with only children available for selection.

![Select starting location](img/select_start_location.png "Selecting a starting location")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ To do it, [disable the Focus mode](../../getting_started/discover_ui.md#disable-

## Bookmarks

You can bookmark any content item by clicking the star icon next to the Content name.
You can bookmark any content item by clicking the star icon next to the content name.

![Bookmark icon](img/bookmark_icon.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Copy, move, remove, or hide content item, either individually or in

## Move or copy

In content tree, you can move or copy existing content items by selecting an
In content tree, you can move or copy existing content items by selecting an
option at the top of the screen.
You can also copy the whole subtree (a content item with all content under it in the structure).

Expand Down Expand Up @@ -58,11 +58,11 @@ You can also permanently remove all content from the Trash by clicking **Empty T

## Multi-file delete

There are multiple ways to delete multiple items, for example:
You have multiple ways to delete multiple items, for example:

- in content tree, select multiple items.
Then click the three dots menu and select **Delete**
- in content item's details screen, the **Sub-items** tab, select multiple items and click **Delete**
- in content item's details screen, the **Sub-items** tab, select multiple items, and click **Delete**

Confirm your choice in the pop-up window with the **Send to trash** button. All selected files are moved to trash.

Expand Down Expand Up @@ -93,5 +93,5 @@ in all of its Locations.
If you need to restrict access to a given content item, you could create a role that grants read access for a given
[**Section**](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/classify_content/#sections)
or [**Object State**](https://doc.ibexa.co/projects/userguide/en/latest/content_management/content_organization/classify_content/#object-states),
and set a different Section or Object State for the given Content.
and set a different Section or Object State for the given content.
Or use other permission-based [**Limitations**](https://doc.ibexa.co/projects/userguide/en/latest/permission_management/work_with_permissions/).
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ A single Location can only have one content item in it.
Even if a content item is placed in more than one Location, one of the Locations is always treated as the main one.

To assign other Locations to content, [disable the Focus mode](../../getting_started/discover_ui.md#disable-focus-mode), go to the content item's **Locations** tab and click **+ Add**.
Then select the new parent from the Content Browser.
Then select the new parent from the content browser.

![Content with two locations](img/content_with_two_locations.png "Content with two Locations")

Expand Down
24 changes: 12 additions & 12 deletions docs/content_management/create_edit_content_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@ description: Create content for your website with different fields, rich text, t

1. Start creating a new content item in one of the following ways:

- In the left panel, go to **Content** -> **Content structure**. Then select a parent content item and click **Create content**.
- In the left panel, go to **Content** -> **Content structure**. Then select a parent content item and click **Create content**.

The new content item becomes a child of the content item that you originally selected.

- In the **Quick actions** block of the [Dashboard](../getting_started/discover_ui.md#dashboard) screen, click **Create content**.
Then choose a location for the new item in [Content Browser](../getting_started/discover_ui.md#content-browser) and click **Create**.
Then choose a location for the new item in [content browser](../getting_started/discover_ui.md#content-browser) and click **Create**.

!!! tip

An alternative way of creating content items is to [drag one or more files](#upload-multiple-content-items) onto the **Sub-items** tab when viewing any content item in a [content tree](../getting_started/discover_ui.md#content-tree).
An alternative way of creating content items is to [drag one or more files](#upload-multiple-content-items) onto the **Sub-items** tab when viewing any content item in a [content tree](../getting_started/discover_ui.md#content-tree).

1. In a slide-out pane, make initial choices in the following fields, and click **Create**:

- **Select a language** - from a drop-down list, select the base language for the content item.
- **Select a content type** - use this field to narrow down the list of choices displayed below. Then select a content type to serve as a template for the content item.

!!! note

If you're using [[= product_name_exp =]] or [[= product_name_com =]], the options include forms and pages.
You then [build forms](work_with_forms.md) and [create pages](create_edit_pages.md) by using their respective specialist tools.

Expand All @@ -34,7 +34,7 @@ description: Create content for your website with different fields, rich text, t
1. Click **Preview** to see how the content item could look to an end-user.

!!! tip

A content item can look different on different [SiteAccesses](translate_content.md#siteaccess).
You can select a SiteAccess to preview by using a drop-down in the preview screen.

Expand All @@ -45,7 +45,7 @@ description: Create content for your website with different fields, rich text, t
- Click **Save** to continue editing.
- Click **Save and close** to close the window.

1. To send your changes to another editor [for review](editorial_workflow.md), click **Send to review**.
1. To send your changes to another editor [for review](editorial_workflow.md), click **Send to review**.

1. When the content item is ready for publication:

Expand Down Expand Up @@ -76,7 +76,7 @@ When a file is uploaded with multi-file upload, it's automatically stored in a f

## Edit new or existing content items

Each content item is based on a [content type](create_edit_content_types.md). The content type defines what fields
Each content item is based on a [content type](create_edit_content_types.md). The content type defines what fields
you have to fill in when creating a new item.
It may also determine the layout or style in which this item is displayed.

Expand All @@ -91,7 +91,7 @@ A *Location* field is a point on the map. You can type the place name, enter its

!!! note

When you create or edit a content item that contains an *Image* or an *Image asset* field,
When you create or edit a content item that contains an *Image* or an *Image asset* field,
you can perform basic image editing functions by using an [Image Editor](../image_management/edit_images.md).

### Edit Rich Text fields
Expand Down Expand Up @@ -177,7 +177,7 @@ See [Images]([[= developer_doc =]]/content_management/images/images/) for a tec
![Table options in online editor](img/online_editor_table.png)

In table options you can define the first row and/or column as headers,
add or delete rows and columns in any part of the table, as well as merge and split cells.
add or delete rows and columns in any part of the table, and also merge or split cells.

#### Custom elements

Expand All @@ -200,7 +200,7 @@ Here you can also add a link to the text. You can link to an external website, o

### Add taxonomy entries

To keep your content organized and easy to find, you can add taxonomy entries to a content item while creating or editing it.
To keep your content organized and searchable, you can add taxonomy entries to a content item while creating or editing it.
For this feature to work as described, the content type must have a **Metadata** section, with a **Taxonomy Entry** field in it.

1. Switch to the **Meta** tab.
Expand Down
Loading

0 comments on commit b9f123a

Please sign in to comment.