This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch CAUSEWAY-2485 in repository https://gitbox.apache.org/repos/asf/causeway.git
commit 5755cf998d1b163927ec45fbc8b37e1b061bfb79 Author: danhaywood <[email protected]> AuthorDate: Wed Apr 19 06:38:14 2023 +0100 CAUSEWAY-2485: reformats headings is all --- .../choicesFrom/ActionChoicesFromPage-description.adoc | 2 +- .../ActionCommandPublishing-description.adoc | 2 +- .../ActionCommandPublishingPage-description.adoc | 4 ++-- .../domainEvent/ActionDomainEventPage-description.adoc | 2 +- .../ActionExecutionPublishing-description.adoc | 2 +- .../ActionExecutionPublishingPage-description.adoc | 4 ++-- .../restrictTo/ActionRestrictToPage-description.adoc | 2 +- .../semantics/ActionSemanticsPage-description.adoc | 16 ++++++++-------- .../Action/typeOf/ActionTypeOfPage-description.adoc | 2 +- .../ActionLayoutAssociateWithPage-description.adoc | 4 ++-- .../cssClass/ActionLayoutCssClassPage-description.adoc | 14 +++++++------- .../ActionLayoutCssClassFaPage-description.adoc | 6 +++--- .../ActionLayoutDescribedAsPage-description.adoc | 4 ++-- .../fieldSet/ActionLayoutFieldSetPage-description.adoc | 2 +- .../hidden/ActionLayoutHidden-description.adoc | 2 +- .../hidden/ActionLayoutHiddenPage-description.adoc | 2 +- .../named/ActionLayoutNamedPage-description.adoc | 6 +++--- .../position/ActionLayoutPositionPage-description.adoc | 2 +- .../ActionLayoutPromptStylePage-description.adoc | 6 +++--- .../ActionLayoutRedirectPolicyPage-description.adoc | 2 +- .../sequence/ActionLayoutSequencePage-description.adoc | 16 ++++++++-------- .../aliased/DomainObjectAliasedPage-description.adoc | 2 +- .../DomainObjectAutoCompletePage-description.adoc | 2 +- .../bounded/DomainObjectBoundingPage-description.adoc | 2 +- .../editing/DomainObjectEditingPage-description.adoc | 2 +- ...DomainObjectEntityChangePublishingVm-description.adoc | 2 +- .../DomainObjectIntrospectionPage-description.adoc | 2 +- .../DomainObjectMixinMethodPage-description.adoc | 2 +- .../nature/DomainObjectNaturePage-description.adoc | 2 +- .../DomainObjectXxxDomainEventPage-description.adoc | 2 +- .../DomainObjectXxxLifecycleEventPage-description.adoc | 2 +- .../DomainObjectLayoutBookmarkingPage-description.adoc | 2 +- .../DomainObjectLayoutBookmarkingJpa-description.adoc | 2 +- .../DomainObjectLayoutCssClassPage-description.adoc | 2 +- .../DomainObjectLayoutCssClassFaPage-description.adoc | 2 +- .../DomainObjectLayoutDescribedAsPage-description.adoc | 2 +- .../named/DomainObjectLayoutNamedPage-description.adoc | 2 +- .../paged/DomainObjectLayoutPagedPage-description.adoc | 4 ++-- ...DomainObjectLayoutTableDecoratorPage-description.adoc | 4 ++-- .../DomainObjectLayoutXxxUiEventPage-description.adoc | 2 +- .../PropertyCommandPublishing-description.adoc | 2 +- .../PropertyCommandPublishingPage-description.adoc | 4 ++-- .../PropertyExecutionPublishing-description.adoc | 2 +- .../PropertyExecutionPublishingPage-description.adoc | 4 ++-- .../hidden/PropertyLayoutHidden-description.adoc | 2 +- .../hidden/PropertyLayoutHiddenPage-description.adoc | 2 +- .../domain/src/main/resources/static/css/application.css | 14 ++++++++++++++ 47 files changed, 94 insertions(+), 80 deletions(-) diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/choicesFrom/ActionChoicesFromPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/choicesFrom/ActionChoicesFromPage-description.adoc index 9a814cde61..d7faa457d1 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/choicesFrom/ActionChoicesFromPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/choicesFrom/ActionChoicesFromPage-description.adoc @@ -43,7 +43,7 @@ The end-user can select the choices using checkboxes rendered with the collectio TIP: Such actions are sometimes called "bulk" actions because they (can) act upon many objects at once. -=== How this demo works +== How this demo works The collection on the left hand side shows a set of domain objects, along with a couple of actions that both accept a collection of said objects as one of their parameters. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/commandPublishing/ActionCommandPublishing-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/commandPublishing/ActionCommandPublishing-description.adoc index 6f5104d6a4..4287ecb6fc 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/commandPublishing/ActionCommandPublishing-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/commandPublishing/ActionCommandPublishing-description.adoc @@ -2,7 +2,7 @@ This domain class is used in the demo of `@Action#commandPublishing`. -=== How this demo works +== How this demo works This entity has two actions, each of which can be used to change its name. One of the actions is published, the other is not. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/commandPublishing/ActionCommandPublishingPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/commandPublishing/ActionCommandPublishingPage-description.adoc index bbbfa8378d..6e9d58f3ad 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/commandPublishing/ActionCommandPublishingPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/commandPublishing/ActionCommandPublishingPage-description.adoc @@ -11,7 +11,7 @@ This can be invaluable for auditing and performance monitoring. It is also possible to register additional subscribers for your own purposes. -=== How this demo works +== How this demo works The collection on the left hand side shows a list of entities, and two associated actions. These actions can be used to change the name of any one of those entities. @@ -44,7 +44,7 @@ include::ActionCommandPublishingPage_publishedCommands.java[tags=class] -=== Related configuration property +== Related configuration property To set the global default for `commandPublishing`, use this configuration property: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/domainEvent/ActionDomainEventPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/domainEvent/ActionDomainEventPage-description.adoc index 2e0bdff256..85fb822c57 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/domainEvent/ActionDomainEventPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/domainEvent/ActionDomainEventPage-description.adoc @@ -18,7 +18,7 @@ If no `domainEvent` is specified on the action itself, then the domain event cla And if not specified at the class level, then an instance of `o.a.c.applib.events.domain.ActionDomainEvent.Default` is emitted as the fallback. -=== How this demo works +== How this demo works This page object has a single property, `text` and two (mixin) actions that update it. One is annotated with a custom domain event, the other is not. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/executionPublishing/ActionExecutionPublishing-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/executionPublishing/ActionExecutionPublishing-description.adoc index 0698a4ee55..461a9c3fe9 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/executionPublishing/ActionExecutionPublishing-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/executionPublishing/ActionExecutionPublishing-description.adoc @@ -2,7 +2,7 @@ This domain class is used in the demo of `@Action#executionPublishing`. -=== How this demo works +== How this demo works This entity has two actions, each of which can be used to change its name. One of the actions is published, the other is not. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/executionPublishing/ActionExecutionPublishingPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/executionPublishing/ActionExecutionPublishingPage-description.adoc index 4d6f7e667a..4a930a3e56 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/executionPublishing/ActionExecutionPublishingPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/executionPublishing/ActionExecutionPublishingPage-description.adoc @@ -14,7 +14,7 @@ It is designed for integration scenarios, interacting with downstream systems. It is of course also possible to register additional subscribers for your own purposes. -=== How this demo works +== How this demo works The collection on the left hand side shows a list of entities, and three associated actions. These actions can be used to change the name of any one of those entities. @@ -67,7 +67,7 @@ include::ActionExecutionPublishingPage_publishedExecutions.java[tags=class] -=== Related configuration property +== Related configuration property To set the global default for `executionPublishing`, use this configuration property: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/restrictTo/ActionRestrictToPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/restrictTo/ActionRestrictToPage-description.adoc index e3fbb48971..5ae2b94970 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/restrictTo/ActionRestrictToPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/restrictTo/ActionRestrictToPage-description.adoc @@ -14,7 +14,7 @@ export PROTOTYPING=true ---- -=== How this demo works +== How this demo works This page is a view model that defines three actions, each of which defines a different `restrictTo` element: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/semantics/ActionSemanticsPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/semantics/ActionSemanticsPage-description.adoc index cf7236fcc8..13184d6c6f 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/semantics/ActionSemanticsPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/semantics/ActionSemanticsPage-description.adoc @@ -22,11 +22,11 @@ Note this does require that the action is invoked "through" the link:https://cau * `NON_IDEMPOTENT_ARE_YOU_SURE` similarly displays an "are you sure" prompt, but for non-idempotent actions. -=== How this demo works +== How this demo works This page provides actions with different semantics. -==== No annotations +=== No annotations If the `semantics` element is omitted completely, then the action is assumed to be non-idempotent: @@ -36,7 +36,7 @@ include::ActionSemanticsPage.java[tags=action-no-annotation] ---- <.> does not indicate any `semantic` element, and so non-idempotent is assumed -==== Annotated as Safe +=== Annotated as Safe An action with safe semantics means that there are bi side-effects; it does not change the state of the system. This is also sometimes called _query-only_. @@ -55,7 +55,7 @@ The framework does not verify or ensure that the action results in no side-effec ==== -===== Safe and Request Cacheable +==== Safe and Request Cacheable Since invoking a safe query-only action will often return the same result (at least for some short period of time), the framework also provides a variant that will automatically cache the result for the duration of the interaction (HTTP request). @@ -83,7 +83,7 @@ include::ActionSemanticsPage.java[tags=action-semantics-safe-and-request-cacheab In this case the called action should indicate it was only executed once. -==== Annotated as Idempotent +=== Annotated as Idempotent Annotating an action as idempotent means that it will change the state of the system, but invoking more than once will not change the state of the system further. @@ -99,7 +99,7 @@ include::ActionSemanticsPage.java[tags=action-semantics-idempotent] ---- <.> idempotent semantics -===== Idempotent, are you sure? +==== Idempotent, are you sure? Because an idempotent action will change the state of the system, the framework offers a variant that will cause the viewer to render an "are you sure?" pop-up. @@ -110,7 +110,7 @@ include::ActionSemanticsPage.java[tags=action-semantics-idempotent-are-you-sure] <.> idempotent semantics, with "are you sure" prompt -==== Annotated as Not Idempotent +=== Annotated as Not Idempotent Annotating an action as non-idempotent means that it will change the state of the system, and invoking more than once will change the state of the system further. @@ -123,7 +123,7 @@ include::ActionSemanticsPage.java[tags=action-semantics-non-idempotent] <.> non-idempotent semantics -===== Not idempotent, are you sure ? +==== Not idempotent, are you sure ? Because a non-idempotent action will change the state of the system, the framework offers a variant that will cause the viewer to render an "are you sure?" pop-up. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/typeOf/ActionTypeOfPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/typeOf/ActionTypeOfPage-description.adoc index 062ef56f50..a98f0d84e9 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/typeOf/ActionTypeOfPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/Action/typeOf/ActionTypeOfPage-description.adoc @@ -8,7 +8,7 @@ The framework uses the generic parameter to ensure that the list is rendered app In some rare scenarios though it may be necessary to return only a raw (non-parameterized) `List`. In these cases the link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/Action.html#typeof[@Action#typeOf] element can be used to indicate the element type of the returned `List`. -=== How this demo works +== How this demo works This page object defines a `children` collection: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/associateWith/ActionLayoutAssociateWithPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/associateWith/ActionLayoutAssociateWithPage-description.adoc index 6ebad18dc8..ba33392c36 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/associateWith/ActionLayoutAssociateWithPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/associateWith/ActionLayoutAssociateWithPage-description.adoc @@ -6,7 +6,7 @@ In such cases, it generally makes sense for the action's button to be close to t One way to specify this is with the `.layout.xml` files, but another option is to use the link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/ActionLayout.html#associatewith[@ActionLayout#associateWith] element (along with link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/ActionLayout.html#associatewith[@ActionLayout#sequence] if there are several actions associated with the property/collection). -=== How this demo works +== How this demo works This page defines a `name` property, and a `children` collection: @@ -38,7 +38,7 @@ which has the additional semantic of the rows of the element being used as choic of the same type as the elements of the collection. -=== .layout.xml +== .layout.xml Instead of using `@ActionLayout#associateWith`, it is also possible to associate actions with objects using the `<action id="..." cssClass="...">` in the link:https://causeway.apache.org/userguide/2.0.0-RC1/fun/ui.html#by-example[.layout.xml] file. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/cssClass/ActionLayoutCssClassPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/cssClass/ActionLayoutCssClassPage-description.adoc index 2a8ee3b9ac..1df4a4c8b5 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/cssClass/ActionLayoutCssClassPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/cssClass/ActionLayoutCssClassPage-description.adoc @@ -8,12 +8,12 @@ One option is to reference a style that you have defined yourself in the `applic Alternatively, you can exploit the fact that the Wicket viewer uses the link:https://getbootstrap.com/[bootstrap] design system, and so just use one of the styles defined there, for example, the link:https://getbootstrap.com/docs/5.0/components/buttons/#button-tags[button tags] -=== How this demo works +== How this demo works This page defines a single `name` property along with a set of actions, all of which can be used to update that property. Those actions are rendered in a number of different positions, all using a different _Bootstrap_ class. -==== Positioned below the property +=== Positioned below the property Two actions: @@ -36,7 +36,7 @@ include::ActionLayoutCssClassPage.java[tags=below-btn-warning] <.> specifies the order in which associated actions in the same position are rendered -==== Positioned on the panel that contains the property +=== Positioned on the panel that contains the property Two actions: @@ -60,7 +60,7 @@ include::ActionLayoutCssClassPage.java[tags=panel-btn-secondary] <.> specifies the order in which associated actions in the same position are rendered -==== Positioned on the drop-down of the panel that contains the property: +=== Positioned on the drop-down of the panel that contains the property: WARNING: although the CSS class is applied, the Bootstrap styling does not apply; see link:https://issues.apache.org/jira/browse/CAUSEWAY-3427[CAUSEWAY-3427]. @@ -83,7 +83,7 @@ include::ActionLayoutCssClassPage.java[tags=panel-dropdown-btn-dark] ---- <.> appends the `btn-dark` CSS class -==== At the object level +=== At the object level One action: @@ -97,7 +97,7 @@ Yhis last example has no `@ActionLayout#cssClass` defined, but it nevertheless w This is because it picks up the global configuration property, as described in the next section. -=== Related configuration properties +== Related configuration property Rather than styling each action individually, it's possible to use a configuration property which defines styles globally. @@ -122,7 +122,7 @@ causeway: This is the reason why the "delete" action (shown in the previous section) is rendered using "btn-danger". -=== .layout.xml +== .layout.xml Instead of using `@ActionLayout#cssClass`, it is also possible to specify the CSS class using the `<action id="..." cssClass="...">` in the link:https://causeway.apache.org/userguide/2.0.0-RC1/fun/ui.html#by-example[.layout.xml] file. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/cssClassFa/ActionLayoutCssClassFaPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/cssClassFa/ActionLayoutCssClassFaPage-description.adoc index 2707da1f79..f9e4025be9 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/cssClassFa/ActionLayoutCssClassFaPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/cssClassFa/ActionLayoutCssClassFaPage-description.adoc @@ -5,7 +5,7 @@ To help the end-user navigate a page, it can sometimes be helpful to decorate in The link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/ActionLayout.html#cssclassfa[@ActionLayout#cssClassFa] element allows this to be done by specifying the _Font Awesome_ CSS class (or classes) with which to decorate an action. This is used for whether the action is rendered as a button or as a menu item. -=== How this demo works +== How this demo works This page has a `name` property and two actions, both of which can be used to update that property. The two actions have different fa icons. @@ -31,7 +31,7 @@ include::ActionLayoutCssClassFaPage.java[tags=updateNameWithFaIconOnTheRight] in effect the icon is rendered on the _right_ of the action button -==== Related configuration property +== Related configuration property Rather than styling each action individually, it's possible to use a configuration property which defines styles globally. @@ -64,7 +64,7 @@ causeway: ---- -=== .layout.xml +== .layout.xml Instead of using `@ActionLayout#cssClassFa`, it is also possible to specify the fa icon class using the `<action id="..." cssClass="...">` in the link:https://causeway.apache.org/userguide/2.0.0-RC1/fun/ui.html#by-example[.layout.xml] file. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/describedAs/ActionLayoutDescribedAsPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/describedAs/ActionLayoutDescribedAsPage-description.adoc index 603d6366d0..0b6ab253de 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/describedAs/ActionLayoutDescribedAsPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/describedAs/ActionLayoutDescribedAsPage-description.adoc @@ -6,7 +6,7 @@ But, for less experienced users, or for new features, the link:https://causeway. For an action button, this description is displayed as a tooltip. -=== How this demo works +== How this demo works This page has a `name` property and a `children` collection. It also has with a number of actions, with the actions each having descriptions. @@ -60,7 +60,7 @@ include::../ActionLayoutMenu.java[tags=menu-item-described-as] ---- -=== .layout.xml +== .layout.xml Instead of using `@ActionLayout#describedAs`, it is also possible to specify a tooltip using the `<action id="..." describedAs="...">` in the link:https://causeway.apache.org/userguide/2.0.0-RC1/fun/ui.html#by-example[.layout.xml] file. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/fieldSet/ActionLayoutFieldSetPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/fieldSet/ActionLayoutFieldSetPage-description.adoc index 05eae41108..8bd97fca46 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/fieldSet/ActionLayoutFieldSetPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/fieldSet/ActionLayoutFieldSetPage-description.adoc @@ -17,7 +17,7 @@ It's even possible to combine the two approaches. Some people use the `.layout.xml` file for the large-scale layout (rows, columns, fieldsets), and then use annotations to slot the properties, collections and actions into that larger-scale layout. -=== How this demo works +== How this demo works This page object has two properties, each of which is in its own fieldset. A `.layout.xml` file defines this: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/hidden/ActionLayoutHidden-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/hidden/ActionLayoutHidden-description.adoc index da728f7819..be20343544 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/hidden/ActionLayoutHidden-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/hidden/ActionLayoutHidden-description.adoc @@ -2,7 +2,7 @@ This domain class is used in the demo of `@ActionLayout#hidden`. -=== How this demo works +== How this demo works This entity defines four actions, and depending upon context, they may be visible on an object form or when rendered in a collection. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/hidden/ActionLayoutHiddenPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/hidden/ActionLayoutHiddenPage-description.adoc index 2f231f1199..d401f4d882 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/hidden/ActionLayoutHiddenPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/hidden/ActionLayoutHiddenPage-description.adoc @@ -2,7 +2,7 @@ The link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/ActionLayout.html#hidden[@ActionLayout#hidden] element specifies whether an action should be visible in the UI or not. -=== How this demo works +== How this demo works The collection on the left hand side shows a set of domain objects. That domain object defines four actions, and depending upon context, they may be visible on an object form or when rendered in a collection. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/named/ActionLayoutNamedPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/named/ActionLayoutNamedPage-description.adoc index cf392c2c26..1ce616501c 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/named/ActionLayoutNamedPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/named/ActionLayoutNamedPage-description.adoc @@ -9,7 +9,7 @@ This can also be used if you want the name to include characters such as bracket -=== How this demo works +== How this demo works This page object has two properties and an associated action with each. Both of these actions use `@ActionLayout#named`, for different reasons: @@ -31,7 +31,7 @@ include::ActionLayoutNamedPage.java[tags=updateNotes] <.> specifies the name to use in the UI. -=== .layout.xml +== .layout.xml Instead of using `@ActionLayout#named`, it is also possible to specify a name in the link:https://causeway.apache.org/userguide/2.0.0-RC1/fun/ui.html#by-example[.layout.xml] file: @@ -48,7 +48,7 @@ Instead of using `@ActionLayout#named`, it is also possible to specify a name in The main advantage of using the `.layout.xml` file is that changes can be picked up without having to restart the application. -=== Alternatives +== Alternatives Where the `@ActionLayout#named` is being used to avoid a clash with a reserved keyword, an alternative option is to use a mixin action. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/position/ActionLayoutPositionPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/position/ActionLayoutPositionPage-description.adoc index 65f185c93d..0350f88ffd 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/position/ActionLayoutPositionPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/position/ActionLayoutPositionPage-description.adoc @@ -12,7 +12,7 @@ The link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annota * as a drop-down of the panel containing the property. -=== How this demo works +== How this demo works This demo page defines two properties, each with four corresponding mixin actions that simply update the property. However, the actions are positioned in the four different location. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/promptStyle/ActionLayoutPromptStylePage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/promptStyle/ActionLayoutPromptStylePage-description.adoc index 4fb031a744..a16afaaa19 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/promptStyle/ActionLayoutPromptStylePage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/promptStyle/ActionLayoutPromptStylePage-description.adoc @@ -3,7 +3,7 @@ Most actions take parameters, and so the framework renders a prompt to allow the parameter arguments to be specified. The link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/ActionLayout.html#promptstyle[@ActionLayout#promptStyle] element allows the position of this prompt to be specified. -=== How this demo works +== How this demo works This page has two properties, `name` and `notes`. The `name` property has three associated (mixin) actions, each of which can be used to update it, but demonstrating three of the prompt styles: @@ -42,7 +42,7 @@ include::ActionLayoutPromptStylePage_updateNotesPromptInlineAsIfEdit.java[tags=c This means that for the end-user it seems that they are just editing the property directly, but in the code the action is invoked. -=== Related configuration property +== Related configuration property The Wicket viewer allows the default prompt style to be specified using a global configuration property: @@ -68,7 +68,7 @@ causeway: NOTE: For both of these configuration properties, note that the two other variants (`inline` and `inline-as-if-edit`) are not available. -=== .layout.xml +== .layout.xml Instead of using `@ActionLayout#promptStyle`, it is also possible to specify a name in the link:https://causeway.apache.org/userguide/2.0.0-RC1/fun/ui.html#by-example[.layout.xml] file: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/redirectPolicy/ActionLayoutRedirectPolicyPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/redirectPolicy/ActionLayoutRedirectPolicyPage-description.adoc index 44e66bd90f..d76a3d64c3 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/redirectPolicy/ActionLayoutRedirectPolicyPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/redirectPolicy/ActionLayoutRedirectPolicyPage-description.adoc @@ -10,7 +10,7 @@ whether to update the page or instead to redirect (forcing a re-rendering of a n Not re-rendering can provide a smoother UI experience. -=== How this demo works +== How this demo works This page has a `count` property with two associated actions. These both increment the `count`, but use different redirect policies. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/sequence/ActionLayoutSequencePage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/sequence/ActionLayoutSequencePage-description.adoc index c660a46a43..71067e8e7c 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/sequence/ActionLayoutSequencePage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/actions/ActionLayout/sequence/ActionLayoutSequencePage-description.adoc @@ -7,7 +7,7 @@ The value of the `sequence` element is a string, interpreted as a Dewey-decimal "1" < "1.0" < "1.1" < "1.1.1" < "1.1.2" < "1.2" < "1.3" < "2" -=== How this demo works +== How this demo works This page has a `name` property and a `children` collection, and then has a number of actions associated with these members. In the case of the `name` property, its associated action are positioned in various locations (using `@ActionLayout#position`). @@ -15,7 +15,7 @@ In the case of the `name` property, its associated action are positioned in vari In all cases, the `@ActionLayout#sequence` is used to specify the order. This order is chosen to be the opposite of the alphabetic ordering of the action's identifier (eg `updateNameSeqZ` is ordered before `updateNameSeqY`). -==== Positioned below property +=== Positioned below property There are three actions associated with the `name` property and positioned below: @@ -47,7 +47,7 @@ include::ActionLayoutSequencePage_updateNameSeqX.java[tags=class] ---- <.> rendered third; "2" < "3" -==== Positioned to the right of the property +=== Positioned to the right of the property There are two actions positioned to the right of the `name` property: @@ -70,7 +70,7 @@ include::ActionLayoutSequencePage_updateNamePositionedRightSeqX.java[tags=class] ---- <.> uses Dewey format; "1.2" < "1.2.1" -==== Positioned on panel +=== Positioned on panel Two further actions positioned on the panel: @@ -92,7 +92,7 @@ include::ActionLayoutSequencePage_updateNamePositionedPanelSeqX.java[tags=class] ---- <.> uses Dewey format, "1" < "1.0" -==== Positioned on panel drop-down +=== Positioned on panel drop-down Finally there are two actions associated with `name` that are rendered on the panel drop-down: @@ -114,7 +114,7 @@ include::ActionLayoutSequencePage_updateNamePositionedPanelDropDownSeqX.java[tag ---- <.> uses Dewey format; "1.0" < "1.1" -==== For Collection +=== For Collection There are also two actions associated with the `children` collection: @@ -135,7 +135,7 @@ include::ActionLayoutSequencePage_addChild.java[tags=class] include::ActionLayoutSequencePage_removeChild.java[tags=class] ---- -==== Top-level actions +=== Top-level actions Lastly there are two actions that are not associated with any object members. Because of the presence of the "unreferencedActions" attribute in the `.layout.xml`, these are rendered at the top, by the object header: @@ -171,7 +171,7 @@ include::ActionLayoutSequencePage_noopSeqX.java[tags=class] ---- -=== .layout.xml +== .layout.xml Instead of using `@ActionLayout#associateWith` and `@ActionLayout#sequence`, it is also possible to specify a all of these semantics using the link:https://causeway.apache.org/userguide/2.0.0-RC1/fun/ui.html#by-example[.layout.xml] file. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/aliased/DomainObjectAliasedPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/aliased/DomainObjectAliasedPage-description.adoc index 1c7d41c40c..626e1c4b18 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/aliased/DomainObjectAliasedPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/aliased/DomainObjectAliasedPage-description.adoc @@ -14,7 +14,7 @@ For example, suppose an `Customer` type initially is part of the "customer" modu Later on, you decide to move `Customer` to a more generic "party" module, with a new logical type name being "party.Customer". However, any bookmarks in the old format of "customer.Customer:1234" should still resolve. -=== How this demo works +== How this demo works The collection on the left shows a set of entity instances, each indicating their current bookmark and a previous bookmark that corresponds to the value of their link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/DomainObject.html#aliased[@DomainObject#alias]. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/autoComplete/DomainObjectAutoCompletePage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/autoComplete/DomainObjectAutoCompletePage-description.adoc index 858627154e..f4589c320b 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/autoComplete/DomainObjectAutoCompletePage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/autoComplete/DomainObjectAutoCompletePage-description.adoc @@ -8,7 +8,7 @@ The link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annota TIP: In fact, the return type of the `autoComplete` method does not need to exactly match that of the annotated domain type; it is sufficient to return any superclass or indeed an interface. -=== How this demo works +== How this demo works The collection on the left shows a set of entity instances, of type `DomainObjectAutoComplete`. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/bounded/DomainObjectBoundingPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/bounded/DomainObjectBoundingPage-description.adoc index 094e559806..535921e449 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/bounded/DomainObjectBoundingPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/bounded/DomainObjectBoundingPage-description.adoc @@ -6,7 +6,7 @@ One means to do that is to write a supporting `choices` or `autoComplete` method If the entity is "reference data" with a small, fixed set of instances, then a better option is to declare that the entity is bounded (as in "has a bounded set of instances"). This is done using link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/DomainObject.html#bounding[@DomainObject#bounding] attribute. -=== How this demo works +== How this demo works The collection on the left shows a set of entity instances, of type `DomainObjectBounding`. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/editing/DomainObjectEditingPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/editing/DomainObjectEditingPage-description.adoc index 7d82c87675..a4a4e64188 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/editing/DomainObjectEditingPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/editing/DomainObjectEditingPage-description.adoc @@ -28,7 +28,7 @@ Alternatively, this works in the opposite direction also: if the global config p In addition, the link:https://causeway.apache.org/refguide/2.0.0-RC1/applib/index/annotation/DomainObject.html#editingDisabledReason[@DomainObject#editingDisabledReason] can be used to specify the reason why a property cannot be edited. This can also be specified at the property level using link:https://causeway.apache.org/refguide/2.0.0-RC1/applib/index/annotation/Property.html#editingDisabledReason[@Property#editingDisabledReason]. -=== How this demo works +== How this demo works The collection on the left shows a set of entity instances, which use `@DomainObject#editing` to enable editing of their properties. However, `@Property#editing` is then used to disable the "originalName" property. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/entityChangePublishing/DomainObjectEntityChangePublishingVm-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/entityChangePublishing/DomainObjectEntityChangePublishingVm-description.adoc index cfd8dcc0a3..dc05e299fc 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/entityChangePublishing/DomainObjectEntityChangePublishingVm-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/entityChangePublishing/DomainObjectEntityChangePublishingVm-description.adoc @@ -27,7 +27,7 @@ Entity change publishing can also be enabled on a case by case basis using the l -=== How this demo works +== How this demo works The collection on the left shows a set of entity instances, which have `@DomainObject#entityChangePublishing` to enable the publishing of any changes to their state. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/introspection/DomainObjectIntrospectionPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/introspection/DomainObjectIntrospectionPage-description.adoc index ae92725025..defe2adcdb 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/introspection/DomainObjectIntrospectionPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/introspection/DomainObjectIntrospectionPage-description.adoc @@ -40,7 +40,7 @@ causeway: Normally there would be little reason to override this - just adopt the convention that best fits your style, and leave it at that. However, it the need arises then it can be overridden on a class by class basis using the link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/DomainObject.html#introspection[@DomainObject#introspection] attribute. -=== How this demo works +== How this demo works The collections on the left show three variants of the same entity, each with a property and an action, but each configured to use a different introspection policy. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/mixinMethod/DomainObjectMixinMethodPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/mixinMethod/DomainObjectMixinMethodPage-description.adoc index 9b2dc5c782..053122a922 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/mixinMethod/DomainObjectMixinMethodPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/mixinMethod/DomainObjectMixinMethodPage-description.adoc @@ -13,7 +13,7 @@ In most circumstances there will be little need to use `@DomainObject#mixinMetho However, if you prefer some other method names other than the defaults then you can annotate your mixins with this annotation; or define your own annotation (eg `@MyAction`) and meta-annotate it with both `@Action` and `@DomainObject#mixinMethod` as appropriate. -=== How this demo works +== How this demo works The collection on the left is a mixin to this view model, but (for demonstration purposes) uses `@DomainObject#mixinMethod` to change the default method name from "coll" to "collection": diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/nature/DomainObjectNaturePage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/nature/DomainObjectNaturePage-description.adoc index fcc623df75..3811bfca8f 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/nature/DomainObjectNaturePage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/nature/DomainObjectNaturePage-description.adoc @@ -22,7 +22,7 @@ This is actually enough for the framework to infer that this domain object is a <.> Nevertheless, it's generally good practice to specify the nature explicitly. -=== How this demo works +== How this demo works There are two collections on the left hand side, one of domain entities and the other of view models. The entities are obtained by querying a repository, while the view models are created on the fly, each wrapping a corresponding entity: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/xxxDomainEvent/DomainObjectXxxDomainEventPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/xxxDomainEvent/DomainObjectXxxDomainEventPage-description.adoc index 60ecdd5796..3e7b630816 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/xxxDomainEvent/DomainObjectXxxDomainEventPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/xxxDomainEvent/DomainObjectXxxDomainEventPage-description.adoc @@ -14,7 +14,7 @@ Most commonly the domain event to emit is specified at the member level, using l But as a fallback the `domainEvent` can also be at the class level using link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/DomainObject.html#actiondomainevent[@DomainObject#actionDomainEvent]. -=== How this demo works +== How this demo works This page object has a single (editable) property, `text`, an action to update it, and a collection. None of these domain members are annotated with a domainEvent directly, but their containing page object _is_ annotated. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/xxxLifecycleEvent/DomainObjectXxxLifecycleEventPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/xxxLifecycleEvent/DomainObjectXxxLifecycleEventPage-description.adoc index 12ed556805..aadc198d5e 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/xxxLifecycleEvent/DomainObjectXxxLifecycleEventPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObject/xxxLifecycleEvent/DomainObjectXxxLifecycleEventPage-description.adoc @@ -31,7 +31,7 @@ Must be a subclass of https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib removingLifecycleEvent] - when an already-persisted entity is about to be DELETEd from the database. Must be a subclass of https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/events/lifecycle/ObjectRemovingEvent[ObjectRemovingEvent]. -=== How this demo works +== How this demo works The page provides actions to allow a single entity to be created, updated and deleted. It also shows a list of events that are captured by a subscriber, for each of the corresponding lifecycle events. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/bookmarking/DomainObjectLayoutBookmarkingPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/bookmarking/DomainObjectLayoutBookmarkingPage-description.adoc index 7c1250959e..465564f655 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/bookmarking/DomainObjectLayoutBookmarkingPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/bookmarking/DomainObjectLayoutBookmarkingPage-description.adoc @@ -7,7 +7,7 @@ To make this set of bookmarks more useful, the set of bookmarks can be organised An object annotated as a link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/BookmarkPolicy.html#as_root[root] bookmark will always be added. However an object annotated as a link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/BookmarkPolicy.html#as_child[child] bookmark will only be added if its parent object is also bookmarked. -=== How this demo works +== How this demo works On the left hand side is a collection of objects. These are all annotated as root bookmarks. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/bookmarking/jpa/DomainObjectLayoutBookmarkingJpa-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/bookmarking/jpa/DomainObjectLayoutBookmarkingJpa-description.adoc index 94e16d0133..ac68297876 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/bookmarking/jpa/DomainObjectLayoutBookmarkingJpa-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/bookmarking/jpa/DomainObjectLayoutBookmarkingJpa-description.adoc @@ -9,7 +9,7 @@ include::../DomainObjectLayoutBookmarking.java[tags=class] <.> uses root bookmark policy -=== How this demo works +== How this demo works Use the "addChildren" action to add some children, and navigate into them. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/cssClass/DomainObjectLayoutCssClassPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/cssClass/DomainObjectLayoutCssClassPage-description.adoc index 6c6a093fff..ceeb58d412 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/cssClass/DomainObjectLayoutCssClassPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/cssClass/DomainObjectLayoutCssClassPage-description.adoc @@ -4,7 +4,7 @@ The link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annota The idea is that corresponding styling is added to the `css/application.css` file that the framework's UI references in every response, so that certain domain classes -- perhaps the most important ones in the domain -- are always rendered with their own specific styling. -=== How this demo works +== How this demo works The collection on the left shows a list of entities where the `cssClass` attribute has been set to a value of "custom". diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/cssClassFa/DomainObjectLayoutCssClassFaPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/cssClassFa/DomainObjectLayoutCssClassFaPage-description.adoc index 3e4fae63ed..6d255cc634 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/cssClassFa/DomainObjectLayoutCssClassFaPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/cssClassFa/DomainObjectLayoutCssClassFaPage-description.adoc @@ -5,7 +5,7 @@ The most common way to define the icon is with a `.png` image file with the same An alternative though is to use a fontawesome icon, specified using link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/DomainObjectLayout.html#cssclassfa[@DomainObjectLayout#cssClassFa]. -=== How this demo works +== How this demo works The collection on the left shows a list of entities where the `cssClass` attribute has been set to a value of "fa-user". diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/describedAs/DomainObjectLayoutDescribedAsPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/describedAs/DomainObjectLayoutDescribedAsPage-description.adoc index 87af16c6c0..9f9dc0e40f 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/describedAs/DomainObjectLayoutDescribedAsPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/describedAs/DomainObjectLayoutDescribedAsPage-description.adoc @@ -2,7 +2,7 @@ The purpose of the link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/DomainObjectLayout.html#describedas[@DomainObjectLayout#describedAs] is simply to provide a static description of the domain object. -=== How this demo works +== How this demo works The collection on the left hand side shows a set of objects that have been annotated with `describedAs`. Hover over the icons of the objects in the collection, and this text will be shown in (the bottom half of) each tooltip. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/named/DomainObjectLayoutNamedPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/named/DomainObjectLayoutNamedPage-description.adoc index b1e29d1232..3ebb9ec580 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/named/DomainObjectLayoutNamedPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/named/DomainObjectLayoutNamedPage-description.adoc @@ -7,7 +7,7 @@ One reason to use this annotation is if the default name (derived from the physi Note that this does _not_ affect the bookmark, for example as used in the URL; for that, specify the logical type name using `@javax.inject.Named`. -=== How this demo works +== How this demo works The collection on the left hand side shows a set of objects that have been annotated with `named`. Hover over the icons of the objects in the collection, and the name will be shown in the (top half of) each tooltip. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/paged/DomainObjectLayoutPagedPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/paged/DomainObjectLayoutPagedPage-description.adoc index 9aa66276c8..6f81400348 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/paged/DomainObjectLayoutPagedPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/paged/DomainObjectLayoutPagedPage-description.adoc @@ -7,7 +7,7 @@ NOTE: for parented collections, the `paged` value can be overridden on a case-by -=== How this demo works +== How this demo works The collection on the left hand side shows a set of objects that have been annotated with `paged` of 5.` Accordingly, only 5 objects are shown per page. @@ -24,7 +24,7 @@ include::DomainObjectLayoutPaged.java[tags=class] <.> indicates that collections of this domain class should have no more than 5 objects per page. p -=== Related configuration property +== Related configuration property To set the global default for `paged`, use this configuration property: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/tabledec/DomainObjectLayoutTableDecoratorPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/tabledec/DomainObjectLayoutTableDecoratorPage-description.adoc index 6a8a79162a..564c04173c 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/tabledec/DomainObjectLayoutTableDecoratorPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/tabledec/DomainObjectLayoutTableDecoratorPage-description.adoc @@ -7,7 +7,7 @@ NOTE: for parented collections, the `tableDecorator` value can be overridden on There is currently just one decorator available, for link:https://datatables.net/[datatables.net]. If specified, the effect of `@DomainObjectLayout#paged` or `@CollectionLayout#paged` is ignored. -=== How this demo works +== How this demo works The collection on the left hand side shows a set of domain objects that have been annotated with `tableDecorator` of "datatables". @@ -24,7 +24,7 @@ include::DomainObjectLayoutTableDecorator.java[tags=class] <.> indicates that the "datatables" decoration is used. -=== Related configuration property +== Related configuration property To set the global default for `tableDecorator`, use this configuration property: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/xxxUiEvent/DomainObjectLayoutXxxUiEventPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/xxxUiEvent/DomainObjectLayoutXxxUiEventPage-description.adoc index bfabb9a7f3..9ba88675df 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/xxxUiEvent/DomainObjectLayoutXxxUiEventPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/objects/DomainObjectLayout/xxxUiEvent/DomainObjectLayoutXxxUiEventPage-description.adoc @@ -21,7 +21,7 @@ specifies the UI event class for a subscriber to listen to for changing the CSS specifies the UI event class for a subscriber to listen to for changing the layout -=== How this demo works +== How this demo works The collection on the left hand side shows a set of domain objects that have been annotated with a UI event class for each of the four presentational elements. A subscriber listens to each of these events, and alters the presentation based upon whether the object's name ("Joey", "Monica", "Tom" etc) is in the first- or the second-half of the alphabet. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/commandPublishing/PropertyCommandPublishing-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/commandPublishing/PropertyCommandPublishing-description.adoc index 88da7e468f..15d94e54d4 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/commandPublishing/PropertyCommandPublishing-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/commandPublishing/PropertyCommandPublishing-description.adoc @@ -2,7 +2,7 @@ This domain class is used in the demo of `@Property#commandPublishing`. -=== How this demo works +== How this demo works This entity has two editable properties, `name` and `notes`. One `name` property has command publishing enabled, while the `notes` property does not. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/commandPublishing/PropertyCommandPublishingPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/commandPublishing/PropertyCommandPublishingPage-description.adoc index 4fd4789b92..6fb7279dc8 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/commandPublishing/PropertyCommandPublishingPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/commandPublishing/PropertyCommandPublishingPage-description.adoc @@ -11,7 +11,7 @@ This can be invaluable for auditing and performance monitoring. It is also possible to register additional subscribers for your own purposes. -=== How this demo works +== How this demo works The collection on the left hand side shows a list of entities. Those entities have two properties, `name` and `description`. @@ -22,7 +22,7 @@ Navigate into the entities and edit the properties. Invoking the published property will result in a command representing the property edit invocation from being persisted; these are listed in the collection at the bottom of the entity. -=== Related configuration property +== Related configuration property To set the global default for `commandPublishing`, use this configuration property: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/executionPublishing/PropertyExecutionPublishing-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/executionPublishing/PropertyExecutionPublishing-description.adoc index fccdd2cc43..cebf6eb858 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/executionPublishing/PropertyExecutionPublishing-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/executionPublishing/PropertyExecutionPublishing-description.adoc @@ -2,7 +2,7 @@ This domain class is used in the demo of `@Property#executionPublishing`. -=== How this demo works +== How this demo works This entity has two editable properties, `name` and `notes`. One `name` property has execution publishing enabled, while the `notes` property does not. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/executionPublishing/PropertyExecutionPublishingPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/executionPublishing/PropertyExecutionPublishingPage-description.adoc index 833cd41eb1..92ac763cff 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/executionPublishing/PropertyExecutionPublishingPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/Property/executionPublishing/PropertyExecutionPublishingPage-description.adoc @@ -14,7 +14,7 @@ It is designed for integration scenarios, interacting with downstream systems. It is of course also possible to register additional subscribers for your own purposes. -=== How this demo works +== How this demo works The collection on the left hand side shows a list of entities. Those entities have two properties, `name` and `description`. @@ -25,7 +25,7 @@ Navigate into the entities and edit the properties. Editing the published property will result in the execution representing the property edit invocation being persisted; these are listed in the collection at the bottom of the entity's page. -=== Related configuration property +== Related configuration property To set the global default for `executionPublishing`, use this configuration property: diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/PropertyLayout/hidden/PropertyLayoutHidden-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/PropertyLayout/hidden/PropertyLayoutHidden-description.adoc index dfb27ed794..09b42ad806 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/PropertyLayout/hidden/PropertyLayoutHidden-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/PropertyLayout/hidden/PropertyLayoutHidden-description.adoc @@ -2,7 +2,7 @@ This domain class is used in the demo of `@PropertyLayout#hidden`. -=== How this demo works +== How this demo works This entity defines four properties, and depending upon context, they may be visible on an object form or when rendered in a collection. diff --git a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/PropertyLayout/hidden/PropertyLayoutHiddenPage-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/PropertyLayout/hidden/PropertyLayoutHiddenPage-description.adoc index 5ff493a5b5..ed2ae294f6 100644 --- a/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/PropertyLayout/hidden/PropertyLayoutHiddenPage-description.adoc +++ b/examples/demo/domain/src/main/java/demoapp/dom/domain/properties/PropertyLayout/hidden/PropertyLayoutHiddenPage-description.adoc @@ -2,7 +2,7 @@ The link:https://causeway.apache.org/refguide/2.0.0-SNAPSHOT/applib/index/annotation/PropertyLayout.html#hidden[@PropertyLayout#hidden] element specifies whether a property should be visible in the UI or not. -=== How this demo works +== How this demo works The collection on the left hand side shows a set of domain objects. That domain object defines four properties, and depending upon context, they may be visible on an object form or when rendered in a collection. diff --git a/examples/demo/domain/src/main/resources/static/css/application.css b/examples/demo/domain/src/main/resources/static/css/application.css index e7ca19bb21..b7a90e17be 100644 --- a/examples/demo/domain/src/main/resources/static/css/application.css +++ b/examples/demo/domain/src/main/resources/static/css/application.css @@ -324,3 +324,17 @@ tr.odd.custom2 > td, .navbar-nav.tertiary ul.dropdown-menu { max-height: 800px; } + +div.sect1 > h2 { + font-size: 1.5rem; + font-weight: bolder; +} +div.sect2 > h3 { + font-size: 1.2rem; + font-weight: bold; +} +div.sect3 > h4 { + font-size: 1.1rem; + font-style: italic; + font-weight: bold; +} \ No newline at end of file
