[isis] branch master updated: ISIS-2602: adoc: remove associateWithSequence

[ah...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git


The following commit(s) were added to refs/heads/master by this push:
     new 9ebf2b6  ISIS-2602: adoc: remove associateWithSequence
9ebf2b6 is described below

commit 9ebf2b615e5828ba4e23a1eea71d7cb379975810
Author: ahuber@apache.org <ah...@luna>
AuthorDate: Fri Apr 9 11:49:27 2021 +0200

    ISIS-2602: adoc: remove associateWithSequence
---
 .../pages/index/annotation/hooks/Action_021-associating.adoc | 12 +++++-------
 .../relnotes/modules/ROOT/pages/2021/2.0.0-M6/mignotes.adoc  |  2 +-
 .../userguide/modules/fun/pages/ui/object-layout.adoc        | 12 ++++--------
 3 files changed, 10 insertions(+), 16 deletions(-)

diff --git a/antora/components/refguide-index/modules/applib/pages/index/annotation/hooks/Action_021-associating.adoc b/antora/components/refguide-index/modules/applib/pages/index/annotation/hooks/Action_021-associating.adoc
index d6c1040..d982217 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/annotation/hooks/Action_021-associating.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/annotation/hooks/Action_021-associating.adoc
@@ -5,7 +5,7 @@
 === Associating actions with properties and collections
 
 The `associateWith` element allows an action to be associated with other properties or collections of the same domain object.
-The optional `associateWithSequence` element specifies the order of the action in the UI.
+The optional `sequence` element specifies the order of the action in the UI.
 
 For example, an `Order` could have a collection of ``OrderItem``s, and might provide actions to add and remove items:
 
@@ -17,16 +17,14 @@ public class Order {
     @Collection
     private final SortedSet<OrderItem> items = ...
 
-    @Action(
-        associateWith="items",                      // <.>
-        associateWithSequence="1" )                 // <.>
+    @Action(associateWith="items")                  // <.>
+    @ActionLayout(sequence="1" )                    // <.>
     public Order addItem(Product p, int quantity) {
         // ...
     }
 
-    @Action(
-        associateWith="items",                      // <.>
-        associateWithSequence="2" )                 // <.>
+    @Action(associateWith="items")                  // <.>
+    @ActionLayout(sequence="2" )                    // <.>
     public Order removeItem(OrderItem item) {
         // ...
     }
diff --git a/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M6/mignotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M6/mignotes.adoc
index 272eee6..581c2d4 100644
--- a/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M6/mignotes.adoc
+++ b/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M6/mignotes.adoc
@@ -21,7 +21,7 @@
 | use `@ActionLayout(sequence=...)` instead
 
 | `@MemberOrder(name=...)` removed
-| instead on a _Property_ use `@PropertyLayout(group=...)` 
+| instead on a _Property_ use `@PropertyLayout(fieldSetId=..., fieldSetName=...)` 
 or on an _Action_ use `@Action(associateWith=...)`; 
 there is no counterpart for _Collection_ 
 
diff --git a/antora/components/userguide/modules/fun/pages/ui/object-layout.adoc b/antora/components/userguide/modules/fun/pages/ui/object-layout.adoc
index fa5a39a..57ce2f7 100644
--- a/antora/components/userguide/modules/fun/pages/ui/object-layout.adoc
+++ b/antora/components/userguide/modules/fun/pages/ui/object-layout.adoc
@@ -232,22 +232,18 @@ The annotations most relevant here is xref:refguide:applib:index/annotation/Memb
 
 * for properties:
 
-** `@MemberOrder#name()` can be used to identify associate a property with a fieldset.
+** `@PropertyLayout#fieldSetId()` and `@PropertyLayout#fieldSetName()` can be used to associate a property with a fieldset.
 +
 With this approach all of the fieldsets in the `layout.xml` file are left empty.
 The properties "slot into" the relevant field set to associate  = "...", sequence = "...")`.
 
-** `@MemberOrder#sequence()` specifies the order of properties within their fieldset
+** `@PropertyLayout#sequence()` specifies the order of properties within their fieldset
 
 * for actions:
 
-** `@MemberOrder#name()` is used to associate an action with a property.
-+
-The `@Action#associateWith()` annotation can be used instead as a direct replacement that "reads" better.
+** `@Action#associateWith()` is used to associate an action with a property.
 
-** `@MemberOrder#sequence()` specifies the order of actions (if there are multiple actions for a property)
-+
-The `@Action#associateWithSequence()` annotation can be used as a direct replacement.
+** `@ActionLayout#sequence()` specifies the order of actions (if there are multiple actions for a property)
 
 There are a number of other "layout" annotations, specifically xref:refguide:applib:index/annotation/PropertyLayout.adoc[@PropertyLayout], xref:refguide:applib:index/annotation/CollectionLayout.adoc[@CollectionLayout] and xref:refguide:applib:index/annotation/ActionLayout.adoc[@ActionLayout].
 All of the semantics in these layout annotations can also be specified in the `.layout.xml` files; which is used is a matter of taste.