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 7184c8e2ca ISIS-3103: update doc index
7184c8e2ca is described below
commit 7184c8e2cae2f0273540e4e92e47810ac728bf21
Author: Andi Huber <[email protected]>
AuthorDate: Tue Aug 2 07:46:30 2022 +0200
ISIS-3103: update doc index
---
.../applib/pages/index/layout/LayoutConstants.adoc | 18 +++++
.../index/services/bookmark/IdStringifier.adoc | 2 +-
.../IsisModuleViewerWicketApplibMixins.adoc} | 7 +-
.../mixins/Object_clearHints.adoc | 0
core/adoc/modules/_overview/pages/about.adoc | 89 +++++++++++++++++-----
5 files changed, 92 insertions(+), 24 deletions(-)
diff --git
a/antora/components/refguide-index/modules/applib/pages/index/layout/LayoutConstants.adoc
b/antora/components/refguide-index/modules/applib/pages/index/layout/LayoutConstants.adoc
new file mode 100644
index 0000000000..011a27dbfc
--- /dev/null
+++
b/antora/components/refguide-index/modules/applib/pages/index/layout/LayoutConstants.adoc
@@ -0,0 +1,18 @@
+= LayoutConstants
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this work
for additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by
applicable law or ag [...]
+
+Constant identifiers of the `layout.xml` that are commonly used in layouts.
+
+All of the mixins provided by the framework are bound to the
_FieldSetId#METADATA metadata_ field set, and so - unless explicitly specified
in the object's layout to some other location, will expect that the layout
includes a field set with this id.
+
+The service that loads layouts is
_org.apache.isis.applib.services.grid.GridSystemService_ , and the framework's
default implementation of this service supports the notion of a fallback
layout, used whenever an object has no associated layout file. This fallback
layout _does_ expose a _FieldSetId#METADATA metadata_ fieldset. (The fallback
layout itself can be found in the `GridFallbackLayout.xml` file).
+
+== API
+
+[source,java]
+.LayoutConstants.java
+----
+class LayoutConstants {
+}
+----
+
diff --git
a/antora/components/refguide-index/modules/applib/pages/index/services/bookmark/IdStringifier.adoc
b/antora/components/refguide-index/modules/applib/pages/index/services/bookmark/IdStringifier.adoc
index 6d4f1b30e5..03b6f82868 100644
---
a/antora/components/refguide-index/modules/applib/pages/index/services/bookmark/IdStringifier.adoc
+++
b/antora/components/refguide-index/modules/applib/pages/index/services/bookmark/IdStringifier.adoc
@@ -1,7 +1,7 @@
= IdStringifier
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this work
for additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by
applicable law or ag [...]
-SPI to converts the identifier (primary key) of an entity, of a given type (eg
Integer) into a string, and to convert back again into the key object used to
actually look up the target entity instance; supported by both JDO and JPA
persistence mechanisms.
+SPI to convert the identifier (primary key) of an entity, of a given type (eg
Integer) into a string, and to convert back again into the key object used to
actually look up the target entity instance; supported by both JDO and JPA
persistence mechanisms.
This is ultimately used by
xref:refguide:applib:index/services/bookmark/BookmarkService.adoc[BookmarkService]
where we hold a persistent reference to an entity. The resultant string also
appears in URLs of the Wicket viewer and Restful Objects viewers, and in
mementos eg in _org.apache.isis.schema.cmd.v2.CommandDto_ and
_org.apache.isis.schema.ixn.v2.InteractionDto_ .
diff --git
a/antora/components/refguide-index/modules/applib/pages/index/mixins/layout/LayoutMixinConstants.adoc
b/antora/components/refguide-index/modules/viewer/pages/index/wicket/applib/IsisModuleViewerWicketApplibMixins.adoc
similarity index 85%
rename from
antora/components/refguide-index/modules/applib/pages/index/mixins/layout/LayoutMixinConstants.adoc
rename to
antora/components/refguide-index/modules/viewer/pages/index/wicket/applib/IsisModuleViewerWicketApplibMixins.adoc
index 0ba5c30779..a1dac6f184 100644
---
a/antora/components/refguide-index/modules/applib/pages/index/mixins/layout/LayoutMixinConstants.adoc
+++
b/antora/components/refguide-index/modules/viewer/pages/index/wicket/applib/IsisModuleViewerWicketApplibMixins.adoc
@@ -1,13 +1,12 @@
-= LayoutMixinConstants
+= IsisModuleViewerWicketApplibMixins
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this work
for additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by
applicable law or ag [...]
== API
[source,java]
-.LayoutMixinConstants.java
+.IsisModuleViewerWicketApplibMixins.java
----
-class LayoutMixinConstants {
- public static final String METADATA_LAYOUT_GROUPNAME;
+class IsisModuleViewerWicketApplibMixins {
}
----
diff --git
a/antora/components/refguide-index/modules/viewer/pages/index/wicket/viewer/mixins/Object_clearHints.adoc
b/antora/components/refguide-index/modules/viewer/pages/index/wicket/applib/mixins/Object_clearHints.adoc
similarity index 100%
rename from
antora/components/refguide-index/modules/viewer/pages/index/wicket/viewer/mixins/Object_clearHints.adoc
rename to
antora/components/refguide-index/modules/viewer/pages/index/wicket/applib/mixins/Object_clearHints.adoc
diff --git a/core/adoc/modules/_overview/pages/about.adoc
b/core/adoc/modules/_overview/pages/about.adoc
index 99df77d66f..8e3c3bfb23 100644
--- a/core/adoc/modules/_overview/pages/about.adoc
+++ b/core/adoc/modules/_overview/pages/about.adoc
@@ -990,7 +990,6 @@
org.apache.isis.valuetypes:isis-valuetypes-markdown-applib:jar:<managed> +
org.apache.isis.valuetypes:isis-valuetypes-markdown-persistence-jdo:jar:<managed>
+
org.apache.isis.valuetypes:isis-valuetypes-markdown-persistence-jpa:jar:<managed>
+
org.assertj:assertj-core:jar:<managed> +
-org.projectlombok:lombok:jar:<managed> +
org.springframework.boot:spring-boot-configuration-processor:jar:<managed> +
****
@@ -1082,6 +1081,7 @@
org.apache.isis.extensions:isis-extensions-pdfjs-wicket-ui:jar:<managed> +
org.apache.isis.extensions:isis-extensions-sse-wicket:jar:<managed> +
org.apache.isis.valuetypes:isis-valuetypes-asciidoc-ui-wkt:jar:<managed> +
org.apache.isis.valuetypes:isis-valuetypes-markdown-ui-wkt:jar:<managed> +
+org.apache.isis.viewer:isis-viewer-wicket-applib:jar:<managed> +
org.apache.isis.viewer:isis-viewer-wicket-ui:jar:<managed> +
org.apache.isis.viewer:isis-viewer-wicket-viewer:jar:<managed> +
****
@@ -1498,7 +1498,7 @@ org.jmock:jmock:jar:<managed> +
.Document Index Entries
****
-xref:refguide:applib:index/Identifier.adoc[Identifier],
xref:refguide:applib:index/IsisModuleApplib.adoc[IsisModuleApplib],
xref:refguide:applib:index/IsisModuleApplibChangeAndExecutionLoggers.adoc[IsisModuleApplibChangeAndExecutionLoggers],
xref:refguide:applib:index/IsisModuleApplibMixins.adoc[IsisModuleApplibMixins],
xref:refguide:applib:index/ViewModel.adoc[ViewModel],
xref:refguide:applib:index/annotation/Action.adoc[Action],
xref:refguide:applib:index/annotation/ActionLayout.adoc[A [...]
+xref:refguide:applib:index/Identifier.adoc[Identifier],
xref:refguide:applib:index/IsisModuleApplib.adoc[IsisModuleApplib],
xref:refguide:applib:index/IsisModuleApplibChangeAndExecutionLoggers.adoc[IsisModuleApplibChangeAndExecutionLoggers],
xref:refguide:applib:index/IsisModuleApplibMixins.adoc[IsisModuleApplibMixins],
xref:refguide:applib:index/ViewModel.adoc[ViewModel],
xref:refguide:applib:index/annotation/Action.adoc[Action],
xref:refguide:applib:index/annotation/ActionLayout.adoc[A [...]
****
|Apache Isis Core - Code Gen (ByteBuddy)
@@ -1769,6 +1769,7 @@
o.a.i.core.runtimeservices.recognizer.dae.ExceptionRecognizerForDataAccessExcept
o.a.i.core.runtimeservices.repository.RepositoryServiceDefault +
o.a.i.core.runtimeservices.routing.RoutingServiceDefault +
o.a.i.core.runtimeservices.scratchpad.ScratchpadDefault +
+o.a.i.core.runtimeservices.serializing.SerializingAdapterDefault +
o.a.i.core.runtimeservices.session.InteractionIdGenerator +
o.a.i.core.runtimeservices.session.InteractionServiceDefault +
o.a.i.core.runtimeservices.sitemap.SitemapServiceDefault +
@@ -3012,15 +3013,22 @@ skinparam rectangle<<5>> {
FontColor #fffffe
BorderColor #2E6295
}
+skinparam rectangle<<6>> {
+ BackgroundColor #438dd5
+ FontColor #fffffe
+ BorderColor #2E6295
+}
package "Wicket\n[Software System]" {
rectangle "==Apache Isis Viewer - Wicket\n<size:10>[Container: packaging:
pom]</size>" <<2>> as 2
- rectangle "==Apache Isis Viewer - Wicket (Model)\n<size:10>[Container:
packaging: jar]</size>" <<3>> as 3
- rectangle "==Apache Isis Viewer - Wicket (UI
Components)\n<size:10>[Container: packaging: jar]</size>" <<4>> as 4
- rectangle "==Apache Isis Viewer - Wicket (Viewer)\n<size:10>[Container:
packaging: jar]</size>" <<5>> as 5
+ rectangle "==Apache Isis Viewer - Wicket (Applib)\n<size:10>[Container:
packaging: jar]</size>" <<3>> as 3
+ rectangle "==Apache Isis Viewer - Wicket (Model)\n<size:10>[Container:
packaging: jar]</size>" <<4>> as 4
+ rectangle "==Apache Isis Viewer - Wicket (UI
Components)\n<size:10>[Container: packaging: jar]</size>" <<5>> as 5
+ rectangle "==Apache Isis Viewer - Wicket (Viewer)\n<size:10>[Container:
packaging: jar]</size>" <<6>> as 6
}
2 .[#707070].> 3 : ""
2 .[#707070].> 4 : ""
2 .[#707070].> 5 : ""
+2 .[#707070].> 6 : ""
@enduml
----
.Projects/Modules (Wicket)
@@ -3038,6 +3046,25 @@ Directory: /viewers/wicket
----
|
+|Apache Isis Viewer - Wicket (Applib)
+[source,yaml]
+----
+Group: org.apache.isis.viewer
+Artifact: isis-viewer-wicket-applib
+Type: jar
+Directory: /viewers/wicket/applib
+----
+|.Dependencies
+****
+org.apache.isis.core:isis-applib:jar:<managed> +
+org.apache.isis.core:isis-core-internaltestsupport:jar:<managed> +
+****
+
+.Document Index Entries
+****
+xref:refguide:viewer:index/wicket/applib/IsisModuleViewerWicketApplibMixins.adoc[IsisModuleViewerWicketApplibMixins],
xref:refguide:viewer:index/wicket/applib/mixins/Object_clearHints.adoc[Object_clearHints]
+****
+
|Apache Isis Viewer - Wicket (Model)
[source,yaml]
----
@@ -3143,7 +3170,7 @@ org.springframework:spring-web:jar:<managed> +
.Document Index Entries
****
-xref:refguide:viewer:index/wicket/viewer/IsisModuleViewerWicketViewer.adoc[IsisModuleViewerWicketViewer],
xref:refguide:viewer:index/wicket/viewer/mixins/Object_clearHints.adoc[Object_clearHints]
+xref:refguide:viewer:index/wicket/viewer/IsisModuleViewerWicketViewer.adoc[IsisModuleViewerWicketViewer]
****
|===
@@ -5042,7 +5069,7 @@
xref:refguide:extensions:index/spring/security/oauth2/IsisModuleExtSpringSecurit
Group: org.apache.isis.extensions
Artifact: isis-extensions-sse
Type: pom
-Directory: /extensions/sse
+Directory: /extensions/vw/sse
----
|Dynamically updating HTML markup
@@ -5052,7 +5079,7 @@ Directory: /extensions/sse
Group: org.apache.isis.extensions
Artifact: isis-extensions-sse-applib
Type: jar
-Directory: /extensions/sse/applib
+Directory: /extensions/vw/sse/applib
----
|.Dependencies
****
@@ -5072,7 +5099,7 @@
xref:refguide:extensions:index/sse/applib/IsisModuleExtSseApplib.adoc[IsisModule
Group: org.apache.isis.extensions
Artifact: isis-extensions-sse-metamodel
Type: jar
-Directory: /extensions/sse/metamodel
+Directory: /extensions/vw/sse/metamodel
----
|.Components
****
@@ -5091,7 +5118,7 @@
org.apache.isis.extensions:isis-extensions-sse-applib:jar:<managed> +
Group: org.apache.isis.extensions
Artifact: isis-extensions-sse-wicket
Type: jar
-Directory: /extensions/sse/wicket
+Directory: /extensions/vw/sse/wicket
----
|.Components
****
@@ -5808,12 +5835,17 @@ skinparam {
}
hide stereotype
left to right direction
+skinparam rectangle<<22>> {
+ BackgroundColor #438dd5
+ FontColor #fffffe
+ BorderColor #2E6295
+}
skinparam rectangle<<11>> {
BackgroundColor #438dd5
FontColor #fffffe
BorderColor #2E6295
}
-skinparam rectangle<<22>> {
+skinparam rectangle<<23>> {
BackgroundColor #438dd5
FontColor #fffffe
BorderColor #2E6295
@@ -5927,14 +5959,15 @@ package "Regression Tests\n[Software System]" {
rectangle "==Apache Isis - Regression Tests (stable) - Event
Handling\n<size:10>[Container: packaging: jar]</size>" <<12>> as 12
rectangle "==Apache Isis - Regression Tests (stable) -
Factory\n<size:10>[Container: packaging: jar]</size>" <<13>> as 13
rectangle "==Apache Isis - Regression Tests (stable) -
Interact\n<size:10>[Container: packaging: jar]</size>" <<14>> as 14
- rectangle "==Apache Isis - Regression Tests (stable) - Persistence
(JDO)\n<size:10>[Container: packaging: jar]</size>" <<15>> as 15
- rectangle "==Apache Isis - Regression Tests (stable) - Persistence
(JPA)\n<size:10>[Container: packaging: jar]</size>" <<16>> as 16
- rectangle "==Apache Isis - Regression Tests (stable) - Publishing
(JPA)\n<size:10>[Container: packaging: jar]</size>" <<17>> as 17
- rectangle "==Apache Isis - Regression Tests (stable) -
Rest\n<size:10>[Container: packaging: jar]</size>" <<18>> as 18
- rectangle "==Apache Isis - Regression Tests (stable) - Value
Types\n<size:10>[Container: packaging: jar]</size>" <<19>> as 19
- rectangle "==Apache Isis - Regression Tests (stable) - Viewers
Common\n<size:10>[Container: packaging: jar]</size>" <<20>> as 20
- rectangle "==Apache Isis - Regression Tests (stable) - Viewers
JDO\n<size:10>[Container: packaging: jar]</size>" <<21>> as 21
- rectangle "==Apache Isis - Regression Tests (stable) - Viewers
JPA\n<size:10>[Container: packaging: jar]</size>" <<22>> as 22
+ rectangle "==Apache Isis - Regression Tests (stable) -
Layouts\n<size:10>[Container: packaging: jar]</size>" <<15>> as 15
+ rectangle "==Apache Isis - Regression Tests (stable) - Persistence
(JDO)\n<size:10>[Container: packaging: jar]</size>" <<16>> as 16
+ rectangle "==Apache Isis - Regression Tests (stable) - Persistence
(JPA)\n<size:10>[Container: packaging: jar]</size>" <<17>> as 17
+ rectangle "==Apache Isis - Regression Tests (stable) - Publishing
(JPA)\n<size:10>[Container: packaging: jar]</size>" <<18>> as 18
+ rectangle "==Apache Isis - Regression Tests (stable) -
Rest\n<size:10>[Container: packaging: jar]</size>" <<19>> as 19
+ rectangle "==Apache Isis - Regression Tests (stable) - Value
Types\n<size:10>[Container: packaging: jar]</size>" <<20>> as 20
+ rectangle "==Apache Isis - Regression Tests (stable) - Viewers
Common\n<size:10>[Container: packaging: jar]</size>" <<21>> as 21
+ rectangle "==Apache Isis - Regression Tests (stable) - Viewers
JDO\n<size:10>[Container: packaging: jar]</size>" <<22>> as 22
+ rectangle "==Apache Isis - Regression Tests (stable) - Viewers
JPA\n<size:10>[Container: packaging: jar]</size>" <<23>> as 23
}
3 .[#707070].> 4 : ""
3 .[#707070].> 5 : ""
@@ -5956,6 +5989,7 @@ package "Regression Tests\n[Software System]" {
2 .[#707070].> 20 : ""
2 .[#707070].> 21 : ""
2 .[#707070].> 22 : ""
+2 .[#707070].> 23 : ""
@enduml
----
.Projects/Modules (Regression Tests)
@@ -6194,6 +6228,23 @@ Directory: /regressiontests/stable-interact
org.apache.isis.regressiontests:isis-regressiontests-stable:jar:<managed> +
****
+|Apache Isis - Regression Tests (stable) - Layouts
+[source,yaml]
+----
+Group: org.apache.isis.regressiontests
+Artifact: isis-regressiontests-stable-layouts
+Type: jar
+Directory: /regressiontests/stable-layouts
+----
+|.Dependencies
+****
+org.apache.isis.core:isis-applib:jar:<managed> +
+org.apache.isis.core:isis-core-config:jar:<managed> +
+org.apache.isis.core:isis-core-runtimeservices:jar:<managed> +
+org.apache.isis.testing:isis-testing-fixtures-applib:jar:<managed> +
+org.apache.isis.viewer:isis-viewer-wicket-applib:jar:<managed> +
+****
+
|Apache Isis - Regression Tests (stable) - Persistence (JDO)
[source,yaml]
----
