Skip to content

Commit

Permalink
Mention project in the OC docs (Lombiq Technologies: OCC-167) (#14795)
Browse files Browse the repository at this point in the history
  • Loading branch information
porgabi authored and Skrypt committed Jan 25, 2024
1 parent 2c42316 commit 202ebcc
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 12 deletions.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ nav:
- Create a website: docs/guides/create-cms-application/README.md
- Leverage CSPROJ meta information: docs/guides/leverage-csproj-meta-info/README.md
- Create a Decoupled CMS site: docs/guides/decoupled-cms/README.md
- Create a webshop using the Commerce module: https://commerce.orchardcore.net/en/latest/guides/create-webshop/
- Add an admin menu: docs/guides/add-admin-menu/README.md
- Implement Full Text search: docs/guides/implement-fulltext-search/README.md
- Install localization files: docs/guides/install-localization-files/README.md
Expand Down Expand Up @@ -192,6 +193,7 @@ nav:
- Ticket store: docs/reference/modules/Users/TicketStore.md
- Home Route: docs/reference/modules/HomeRoute/README.md
- Feeds: docs/reference/modules/Feeds/README.md
- Commerce: https://commerce.orchardcore.net/en/latest
- Core Modules:
- Audit Trail: docs/reference/modules/AuditTrail/README.md
- Auto Setup: docs/reference/modules/AutoSetup/README.md
Expand Down
34 changes: 22 additions & 12 deletions src/docs/reference/modules/Layers/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
# Layers (`OrchardCore.Layers`)

The layers can be managed from the `Design > Widgets` page in the admin.
The Layers can be managed from the `Design > Widgets` page in the admin.

A layer has a name, a description and a rule in which you specify a condition to render the widgets that will be associated to this layer.
A Layer has a name, a description and a rule in which you specify a condition to render the widgets that will be associated to this Layer.

When you add a widget into a zone, you must also select a Layer to associate the widget with. The widget is displayed if the layer's corresponding display rule evaluates to true.
![Create Layer.](./assets/create-layer.png)

You can select the checkbox next to each layer in order to highlight the associated Widgets on the left.
_The Layer needs to be saved first to reveal the Rule option._

In the rule you may specify multiple conditions which must evaluate to true, or you can use condition groups, `All` or `Any` to vary the rule.
When you add a widget into a zone, you must also select a Layer to associate the widget with. The widget is displayed if the Layer's corresponding display rule evaluates to true.

![Add widget.](./assets/add-widget.png)

You can select the checkbox next to each Layer in order to highlight the associated Widgets on the left.

In the rule you may specify multiple conditions which must evaluate to true, or you can use condition groups, `All` or `Any`, to vary the rule.

![Rules](./assets/rules.png)

_There can be multiple Rules in place for one Layer._

!!! note
Layer rules have been upgraded from a single javascript rule to conditions during RC2, so this document may differ depending on your version.
A migration converts existing javascript rules into either matching conditions, or javascript conditions.
Layer rules have been upgraded from a single JavaScript rule to conditions during RC2, so this document may differ depending on your version.
A migration converts existing JavaScript rules into either matching conditions or JavaScript conditions.

## Conditions

Expand All @@ -27,22 +37,22 @@ Here are some available conditions:
| `Url` | A url condition evaluates the current url against a value. |
| `Culture` | A culture condition evaluates the current ui culture against a value. |
| `Content Type` | A content type condition evaluates the currently displayed content types against a value. |
| `Javascript` | A script condition written in javascript. |
| `Javascript` | A script condition written in JavaScript. |
| `All` | An all condition group contains other conditions which are all required to be true. |
| `Any` | An any condition group contains other conditions but only requires any condition to be true. |
| `Boolean` | A boolean condition evaluating to `true` or `false`. |

Ex: The `Always` layer has a `Boolean Condition` set to `true`, so widgets on this layer will always be shown.
Ex: The `Always` Layer has a `Boolean Condition` set to `true`, so widgets on this Layer will always be shown.

Refer [Rules](../Rules/README.md) for more information about creating custom conditions.
Refer to [Rules](../Rules/README.md) for more information about creating custom conditions.

Refer [Scripting](../Scripting/README.md#layers-orchardcorelayers) for more information about the available javascript methods.
Refer to [Scripting](../Scripting/README.md#layers-orchardcorelayers) for more information about the available JavaScript methods.

## Zones

The zones that are listed can be set in the `Design > Settings > Zones` admin page.

You must have declared the corresponding zones as sections in your theme :
You must have declared the corresponding zones as sections in your theme:

=== "Liquid"

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 202ebcc

Please sign in to comment.