You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2017/10/09 23:48:38 UTC
[isis] branch master updated: ISIS-1465: aggregated hints-n-tips,
and updated cheat sheet
This is an automated email from the ASF dual-hosted git repository.
danhaywood 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 078692b ISIS-1465: aggregated hints-n-tips, and updated cheat sheet
078692b is described below
commit 078692bfcfb46600b4929f6d030008ea457f399b
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Tue Oct 10 00:43:36 2017 +0100
ISIS-1465: aggregated hints-n-tips, and updated cheat sheet
---
.../src/main/asciidoc/documentation.adoc | 39 +++++------
.../src/main/asciidoc/guides/htg.adoc | 72 +++++++++++++++++++++
.../guides/ugbtb/_ugbtb_hints-and-tips.adoc | 31 +++++----
.../ugbtb/_ugbtb_hints-and-tips_are-you-sure.adoc | 4 +-
...d-tips_how-to-handle-void-and-null-results.adoc | 4 +-
...s-and-tips_how-to-implement-a-spellchecker.adoc | 4 +-
.../ugbtb/_ugbtb_hints-and-tips_multi-tenancy.adoc | 4 +-
.../_ugbtb_hints-and-tips_persisted-title.adoc | 4 +-
.../_ugbtb_hints-and-tips_pushing-changes.adoc | 4 +-
..._replacing-default-service-implementations.adoc | 4 +-
...-and-tips_simulating-collections-of-values.adoc | 4 +-
...nts-and-tips_subclass-properties-in-tables.adoc | 4 +-
...btb_hints-and-tips_transactions-and-errors.adoc | 4 +-
.../_ugbtb_hints-and-tips_vetoing-visibility.adoc | 4 +-
...tb_hints-and-tips_view-model-instantiation.adoc | 5 +-
.../asciidoc/guides/ugfun/_ugfun_ui-hints.adoc | 22 ++++---
.../_ugfun_ui-hints_action-icons-and-css.adoc | 4 +-
.../ugfun/_ugfun_ui-hints_eager-rendering.adoc | 4 +-
.../guides/ugfun/_ugfun_ui-hints_layout.adoc | 4 +-
.../_ugfun_ui-hints_names-and-descriptions.adoc | 4 +-
.../_ugfun_ui-hints_object-titles-and-icons.adoc | 4 +-
.../src/main/asciidoc/guides/ugfun/ugfun.adoc | 1 +
.../guides/ugodn/_ugodn_hints-and-tips.adoc | 18 ++++--
.../_ugodn_hints-and-tips_diagnosing-n-plus-1.adoc | 4 +-
.../guides/ugodn/_ugodn_hints-and-tips_java8.adoc | 4 +-
..._hints-and-tips_overriding-jdo-annotations.adoc | 4 +-
...nd-tips_subtype-entity-not-fully-populated.adoc | 4 +-
...-and-tips_typesafe-queries-and-fetchgroups.adoc | 4 +-
.../guides/ugsec/_ugsec_hints-and-tips.adoc | 14 ++--
...ts-and-tips_configuring-isis-to-use-bypass.adoc | 4 +-
.../guides/ugsec/_ugsec_hints-and-tips_run-as.adoc | 4 +-
.../ugsec/_ugsec_hints-and-tips_shiro-caching.adoc | 4 +-
.../guides/ugvro/_ugvro_hints-and-tips.adoc | 14 ++--
.../ugvro/_ugvro_hints-and-tips_angular-tips.adoc | 4 +-
.../_ugvro_hints-and-tips_pretty-printing.adoc | 4 +-
...gvro_hints-and-tips_restful-image-property.adoc | 4 +-
...ugvro_hints-and-tips_using-chrome-devtools.adoc | 4 +-
.../asciidoc/guides/ugvw/_ugvw_hints-and-tips.adoc | 12 ++--
...hints-and-tips_i18n-label-in-wicket-viewer.adoc | 4 +-
.../ugvw/_ugvw_hints-and-tips_per-user-themes.adoc | 4 +-
.../ugvw/_ugvw_hints-and-tips_svg-support.adoc | 4 +-
.../cheat-sheet/images/cheat-sheets/cover.png | Bin 151235 -> 141052 bytes
.../resources/cheat-sheets/IsisCheatSheet.docx | Bin 33225 -> 28593 bytes
.../resources/cheat-sheets/IsisCheatSheet.pdf | Bin 432718 -> 582035 bytes
44 files changed, 223 insertions(+), 129 deletions(-)
diff --git a/adocs/documentation/src/main/asciidoc/documentation.adoc b/adocs/documentation/src/main/asciidoc/documentation.adoc
index c66c4e4..1b60176 100644
--- a/adocs/documentation/src/main/asciidoc/documentation.adoc
+++ b/adocs/documentation/src/main/asciidoc/documentation.adoc
@@ -58,36 +58,37 @@ pass:[<br/>]
|*User Guides:*
-* *link:guides/ugfun/ugfun.html[Fundamentals^]* image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugfun/ugfun.pdf"]
-* link:guides/ugvw/ugvw.html[Wicket Viewer^] image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugvw/ugvw.pdf"]
-* link:guides/ugvro/ugvro.html[Restful Objects Viewer^] image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugvro/ugvro.pdf"]
-* link:guides/ugodn/ugodn.html[DataNucleus Object Store^] image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugvro/ugvro.pdf"]
-* link:guides/ugsec/ugsec.html[Security^] image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugsec/ugsec.pdf"]
-* *link:guides/ugtst/ugtst.html[Testing^]* image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugtst/ugtst.pdf"]
-* link:guides/ugbtb/ugbtb.html[Beyond the Basics^] image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugbtb/ugbtb.pdf"]
+* *link:guides/ugfun/ugfun.html[Fundamentals^]*
+* link:guides/ugvw/ugvw.html[Wicket Viewer^]
+* link:guides/ugvro/ugvro.html[Restful Objects Viewer^]
+* link:guides/ugodn/ugodn.html[DataNucleus Object Store^]
+* link:guides/ugsec/ugsec.html[Security^]
+* *link:guides/ugtst/ugtst.html[Testing^]*
+* link:guides/ugbtb/ugbtb.html[Beyond the Basics^]
|*Reference Guides:*
-* *link:guides/rgant/rgant.html[Annotations^]* image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgant/rgant.pdf"]
-* *link:guides/rgsvc/rgsvc.html[Domain Services^]* image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgsvc/rgsvc.pdf"]
-* link:guides/rgcfg/rgcfg.html[Core Config'n Properties^] image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgcfg/rgcfg.pdf"]
-* link:guides/rgcms/rgcms.html[Classes, Methods and Schema^] image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgcms/rgcms.pdf"]
-* link:guides/rgmvn/rgmvn.html[Apache Isis Maven plugin^] image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgmvn/rgmvn.pdf"]
-* link:guides/rgfis/rgfis.html[Framework Internal Services^] image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgfis/rgfis.pdf"]
+* *link:guides/rgant/rgant.html[Annotations^]*
+* *link:guides/rgsvc/rgsvc.html[Domain Services^]*
+* link:guides/rgcfg/rgcfg.html[Core Config'n Properties^]
+* link:guides/rgcms/rgcms.html[Classes, Methods and Schema^]
+* link:guides/rgmvn/rgmvn.html[Apache Isis Maven plugin^]
+* link:guides/rgfis/rgfis.html[Framework Internal Services^]
|*"Supporting" Guides:*
-* *link:guides/dg/dg.html[Developers' Guide^]* image:{_imagesdir}PDF-50.png[width="20px" link="./guides/dg/dg.pdf"]
-** Setting up link:guides/dg/dg.html#_dg_ide_intellij[IntelliJ^] or link:guides/dg/dg.html#_dg_ide_eclipse[Eclipse^]
-** link:guides/dg/dg.html#_dg_contributing[Contributing patches^] (pull requests)
+* *link:guides/dg/dg.html[Developers' Guide^]*
+** link:guides/dg/dg.html#_dg_ide_intellij[IntelliJ^] + link:guides/dg/dg.html#_dg_ide_eclipse[Eclipse^]
+** link:guides/dg/dg.html#_dg_contributing[Pull requests^]
** link:guides/dg/dg.html#_dg_asciidoc-syntax[Asciidoc syntax^]
-* link:guides/cgcom/cgcom.html[Committers' Guide^] image:{_imagesdir}PDF-50.png[width="20px" link="./guides/cgcom/cgcom.pdf"]
-** link:guides/cgcom/cgcom.html#_cgcom_cutting-a-release[Cutting a release^]
-** link:guides/cgcom/cgcom.html#_cgcom_verifying-releases[Verifying a release^]
+* link:guides/cgcom/cgcom.html[Committers' Guide^]
+** link:guides/cgcom/cgcom.html#_cgcom_cutting-a-release[Cutting^] + link:guides/cgcom/cgcom.html#_cgcom_verifying-releases[Verifying^]
+
+* *link:guides/htg.html[Hints-n-Tips^]*
|===
diff --git a/adocs/documentation/src/main/asciidoc/guides/htg.adoc b/adocs/documentation/src/main/asciidoc/guides/htg.adoc
new file mode 100644
index 0000000..64f6e32
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/htg.adoc
@@ -0,0 +1,72 @@
+[[htg]]
+= Hints & Tips Guide
+: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 [...]
+:_basedir: ../../
+:_imagesdir: images/
+:numbered:
+:generate_pdf:
+:toc: right
+
+
+This document brings together the hints-n-tips chapters from the various user guides.
+
+== Fundamentals (UI Hints)
+
+Hints and tips for the most commonly used techniques for customising the way that the framework renders domain objects in the user interface.
+Taken from the xref:ugfun/ugfun.adoc[Fundamentals] guide.
+
+:_imagesdir: ugfun/images/
+include::ugfun/_ugfun_ui-hints.adoc[leveloffset=+1,tags=inclusions]
+
+== Wicket Viewer
+
+Hints and tips for more advanced customisation of the UI.
+Taken from the xref:ugvw/ugvw.adoc[Wicket viewer] guide.
+
+:_imagesdir: ugvw/images/
+include::ugvw/_ugvw_hints-and-tips.adoc[leveloffset=+1,tags=inclusions]
+
+== Restful Objects Viewer
+
+Hints and tips for working with the REST API, for example when developing a custom application.
+Taken from the xref:ugvro/ugvro.adoc[Restful Objects viewer] guide.
+
+:_imagesdir: ugvro/images/
+include::ugvro/_ugvro_hints-and-tips.adoc[leveloffset=+1,tags=inclusions]
+
+== DataNucleus Object Store
+
+Hints and tips for working with persistent entities.
+Taken from the xref:ugodn/ugodn.adoc[DataNucleus Object Store].
+
+See also the official link:http://www.datanucleus.org[DataNucleus] documentation, for much more on mappings and so forth.
+
+:_imagesdir: ugodn/images/
+include::ugodn/_ugodn_hints-and-tips.adoc[leveloffset=+1,tags=inclusions]
+
+
+== Security
+
+Hints and tips for working with security module.
+Taken from the xref:ugsec/ugsec.adoc[Security] guide.
+
+:_imagesdir: ugsec/images/
+include::ugsec/_ugsec_hints-and-tips.adoc[leveloffset=+1,tags=inclusions]
+
+//== Testing
+//
+//:_imagesdir: ugtst/images/
+//include::ugtst/_ugtst_hints-and-tips.adoc[leveloffset=+1,lines=6..-1]
+
+== Beyond the Basics
+
+Miscellaneous hints and tips, either advanced or just obscure.
+Taken from the xref:ugbtb/ugbtb.adoc[Beyond the Basics] guide.
+
+:_imagesdir: ugbtb/images/
+include::ugbtb/_ugbtb_hints-and-tips.adoc[leveloffset=+1,tags=inclusions]
+
+== Developers' Guide
+
+include::dg/_dg_hints-and-tips.adoc[leveloffset=+1,tags=inclusions]
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips.adoc
index 9b98dd7..9d94444 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips]]
= Hints and Tips
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
:toc: right
@@ -23,20 +23,23 @@ See also hints-n-tips chapters in the:
* the xref:../ugbtb/ugbtb.adoc#_ugbtb_hints-and-tips[Beyond the Basics] guide (this chapter).
-include::_ugbtb_hints-and-tips_are-you-sure.adoc[leveloffset=+1]
-include::_ugbtb_hints-and-tips_replacing-default-service-implementations.adoc[leveloffset=+1]
-include::_ugbtb_hints-and-tips_vetoing-visibility.adoc[leveloffset=+1]
-include::_ugbtb_hints-and-tips_transactions-and-errors.adoc[leveloffset=+1]
-include::_ugbtb_hints-and-tips_persisted-title.adoc[leveloffset=+1]
-include::_ugbtb_hints-and-tips_view-model-instantiation.adoc[leveloffset=+1]
+// tag::inclusions[]
+
+include::_ugbtb_hints-and-tips_are-you-sure.adoc[leveloffset=+1,lines=3..-1]
+include::_ugbtb_hints-and-tips_replacing-default-service-implementations.adoc[leveloffset=+1,lines=3..-1]
+include::_ugbtb_hints-and-tips_vetoing-visibility.adoc[leveloffset=+1,lines=3..-1]
+include::_ugbtb_hints-and-tips_transactions-and-errors.adoc[leveloffset=+1,lines=3..-1]
+include::_ugbtb_hints-and-tips_persisted-title.adoc[leveloffset=+1,lines=3..-1]
+include::_ugbtb_hints-and-tips_view-model-instantiation.adoc[leveloffset=+1,lines=3..-1]
-include::_ugbtb_hints-and-tips_simulating-collections-of-values.adoc[leveloffset=+1]
+include::_ugbtb_hints-and-tips_simulating-collections-of-values.adoc[leveloffset=+1,lines=3..-1]
-include::_ugbtb_hints-and-tips_how-to-handle-void-and-null-results.adoc[leveloffset=+1]
-include::_ugbtb_hints-and-tips_multi-tenancy.adoc[leveloffset=+1]
+include::_ugbtb_hints-and-tips_how-to-handle-void-and-null-results.adoc[leveloffset=+1,lines=3..-1]
+include::_ugbtb_hints-and-tips_multi-tenancy.adoc[leveloffset=+1,lines=3..-1]
-include::_ugbtb_hints-and-tips_subclass-properties-in-tables.adoc[leveloffset=+1]
-include::_ugbtb_hints-and-tips_pushing-changes.adoc[leveloffset=+1]
-include::_ugbtb_hints-and-tips_how-to-implement-a-spellchecker.adoc[leveloffset=+1]
+include::_ugbtb_hints-and-tips_subclass-properties-in-tables.adoc[leveloffset=+1,lines=3..-1]
+include::_ugbtb_hints-and-tips_pushing-changes.adoc[leveloffset=+1,lines=3..-1]
+include::_ugbtb_hints-and-tips_how-to-implement-a-spellchecker.adoc[leveloffset=+1,lines=3..-1]
+// end::inclusions[]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_are-you-sure.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_are-you-sure.adoc
index 1a66c98..f2d8ed0 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_are-you-sure.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_are-you-sure.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_are-you-sure]]
= 'Are you sure?' idiom
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
Sometimes an action might perform irreversible changes. In such a case it's probably a good idea for the UI to require that the
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_how-to-handle-void-and-null-results.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_how-to-handle-void-and-null-results.adoc
index f3bcd51..0025a7c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_how-to-handle-void-and-null-results.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_how-to-handle-void-and-null-results.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_how-to-handle-void-and-null-results]]
= How to handle void/null results
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_how-to-implement-a-spellchecker.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_how-to-implement-a-spellchecker.adoc
index f7e51ed..4f94d51 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_how-to-implement-a-spellchecker.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_how-to-implement-a-spellchecker.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_how-to-implement-a-spellchecker]]
= How to implement a spellchecker?
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_multi-tenancy.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_multi-tenancy.adoc
index 0744626..1595867 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_multi-tenancy.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_multi-tenancy.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_multi-tenancy]]
= Multi-tenancy
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
Of the various modules provided by the (non-ASF) link:http://platform.incode.org[Incode Platform^], the security module has the most features.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_persisted-title.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_persisted-title.adoc
index d19b068..8ece0eb 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_persisted-title.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_persisted-title.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_persisted-title]]
= Persisted Title
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_pushing-changes.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_pushing-changes.adoc
index 44f6eb9..a72814a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_pushing-changes.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_pushing-changes.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_pushing-changes]]
= Pushing Changes (deprecated)
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
[NOTE]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_replacing-default-service-implementations.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_replacing-default-service-implementations.adoc
index 9b1c02f..5e74f97 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_replacing-default-service-implementations.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_replacing-default-service-implementations.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_replacing-default-service-implementations]]
= Overriding Default Service Implns
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_simulating-collections-of-values.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_simulating-collections-of-values.adoc
index f606ba7..5e9bb9f 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_simulating-collections-of-values.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_simulating-collections-of-values.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_simulating-collections-of-values]]
= Collections of values
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_subclass-properties-in-tables.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_subclass-properties-in-tables.adoc
index 7c29f55..6eeed3d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_subclass-properties-in-tables.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_subclass-properties-in-tables.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_subclass-properties-in-tables]]
= Subclass properties in tables
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_transactions-and-errors.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_transactions-and-errors.adoc
index 3d505f1..bf0c3a0 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_transactions-and-errors.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_transactions-and-errors.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_transactions-and-errors]]
= Transactions and Errors
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
In Apache Isis, every interaction (action invocation or property edit) is automatically wrapped in a transaction,
and any repository query automatically does a flush before hand.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_vetoing-visibility.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_vetoing-visibility.adoc
index c6509d1..b0e8238 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_vetoing-visibility.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_vetoing-visibility.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_vetoing-visibility]]
= Vetoing Visibility
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
NOTE: FIXME - a write-up of the "vetoing subscriber" design pattern, eg as described in the xref:../rgsvc/rgsvc.adoc#_rgsvc_integration-api_BookmarkService[`BookmarkService`]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_view-model-instantiation.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_view-model-instantiation.adoc
index aa0cb41..a0f350e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_view-model-instantiation.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_hints-and-tips_view-model-instantiation.adoc
@@ -1,9 +1,8 @@
-
+:_basedir: ../../
+:_imagesdir: images/
[[_ugbtb_hints-and-tips_view-model-instantiation]]
= View Model Instantiation
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
Vith view models, some care must be taken in how they are instantiated.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints.adoc
index ab2ef6a..e7ce957 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints.adoc
@@ -1,18 +1,24 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugfun_ui-hints]]
= UI Hints
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
-The Apache Isis programming model includes several mechanisms for a domain object to provide UI hints. These range from their title (so an end-user can distinguish one object from another) through to hints that can impact their CSS styling.
+The Apache Isis programming model includes several mechanisms for a domain object to provide UI hints.
+These range from their title (so an end-user can distinguish one object from another) through to hints that can impact their CSS styling.
+
+
+
+// tag::inclusions[]
+include::_ugfun_ui-hints_layout.adoc[leveloffset=+1,lines=3..-1]
-include::_ugfun_ui-hints_layout.adoc[leveloffset=+1]
+include::_ugfun_ui-hints_object-titles-and-icons.adoc[leveloffset=+1,lines=3..-1]
+include::_ugfun_ui-hints_action-icons-and-css.adoc[leveloffset=+1,lines=3..-1]
-include::_ugfun_ui-hints_object-titles-and-icons.adoc[leveloffset=+1]
-include::_ugfun_ui-hints_action-icons-and-css.adoc[leveloffset=+1]
+include::_ugfun_ui-hints_names-and-descriptions.adoc[leveloffset=+1,lines=3..-1]
-include::_ugfun_ui-hints_names-and-descriptions.adoc[leveloffset=+1]
+include::_ugfun_ui-hints_eager-rendering.adoc[leveloffset=+1,lines=3..-1]
-include::_ugfun_ui-hints_eager-rendering.adoc[leveloffset=+1]
+// end::inclusions[]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_action-icons-and-css.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_action-icons-and-css.adoc
index 7700bb8..9a3c772 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_action-icons-and-css.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_action-icons-and-css.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugfun_ui-hints_action-icons-and-css]]
= Action Icons and CSS
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
Apache Isis allows link:http://fortawesome.github.io/Font-Awesome/icons/[font awesome] icons to be associated with each action, and for link:http://getbootstrap.com/css/#buttons[Bootstrap CSS] to be applied to action rendered as buttons.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_eager-rendering.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_eager-rendering.adoc
index 5686774..11e2b0c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_eager-rendering.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_eager-rendering.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugfun_ui-hints_eager-rendering]]
= Eager rendering
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
By default, parented collections all rendered lazily, in other words in a "collapsed" table view.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_layout.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_layout.adoc
index eed9488..52551b5 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_layout.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_layout.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugfun_ui-hints_layout]]
= Layout
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
The most significant aspect of the UI is the layout of the object's members: its properties, collections and actions.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_names-and-descriptions.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_names-and-descriptions.adoc
index 7121074..48f8680 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_names-and-descriptions.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_names-and-descriptions.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugfun_ui-hints_names-and-descriptions]]
= Names and Descriptions
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
The name of classes and class members are usually inferred from the Java source code directly.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_object-titles-and-icons.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_object-titles-and-icons.adoc
index 87fb10d..230a1f9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_object-titles-and-icons.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_object-titles-and-icons.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugfun_ui-hints_object-titles-and-icons]]
= Object Titles and Icons
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
In Apache Isis every object is identified to the user by a title (label) and an icon.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/ugfun.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/ugfun.adoc
index bff8c4d..5ad57f5 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/ugfun.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/ugfun.adoc
@@ -5,6 +5,7 @@
:_imagesdir: images/
:numbered:
:generate_pdf:
+:toc:
[[__ugfun]]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips.adoc b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips.adoc
index 297f13b..a85c7e5 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugodn_hints-and-tips]]
= Hints and Tips
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
This chapter provides some solutions for problems we've encountered ourselves or have been raised on the Apache Isis mailing lists.
@@ -22,11 +22,15 @@ See also hints-n-tips chapters in the:
* the xref:../ugbtb/ugbtb.adoc#_ugbtb_hints-and-tips[Beyond the Basics] guide.
-include::_ugodn_hints-and-tips_overriding-jdo-annotations.adoc[leveloffset=+1]
-include::_ugodn_hints-and-tips_subtype-entity-not-fully-populated.adoc[leveloffset=+1]
-include::_ugodn_hints-and-tips_java8.adoc[leveloffset=+1]
+// tag::inclusions[]
+
+include::_ugodn_hints-and-tips_overriding-jdo-annotations.adoc[leveloffset=+1,lines=3..-1]
+
+include::_ugodn_hints-and-tips_subtype-entity-not-fully-populated.adoc[leveloffset=+1,lines=3..-1]
+include::_ugodn_hints-and-tips_java8.adoc[leveloffset=+1,lines=3..-1]
-include::_ugodn_hints-and-tips_diagnosing-n-plus-1.adoc[leveloffset=+1]
-include::_ugodn_hints-and-tips_typesafe-queries-and-fetchgroups.adoc[leveloffset=+1]
+include::_ugodn_hints-and-tips_diagnosing-n-plus-1.adoc[leveloffset=+1,lines=3..-1]
+include::_ugodn_hints-and-tips_typesafe-queries-and-fetchgroups.adoc[leveloffset=+1,lines=3..-1]
+// end::inclusions[]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_diagnosing-n-plus-1.adoc b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_diagnosing-n-plus-1.adoc
index 165cc9b..8371f26 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_diagnosing-n-plus-1.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_diagnosing-n-plus-1.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugodn_hints-and-tips_diagnosing-n-plus-1]]
= Diagnosing n+1 Issues
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
(As of DN 4.1) set a break point in `FetchRequest#execute(...)`:
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_java8.adoc b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_java8.adoc
index 5f1dfed..51c7142 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_java8.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_java8.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugodn_hints-and-tips_java8]]
= Java8
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_overriding-jdo-annotations.adoc b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_overriding-jdo-annotations.adoc
index ca08cf6..69632b7 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_overriding-jdo-annotations.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_overriding-jdo-annotations.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugodn_hints-and-tips_overriding-jdo-annotations]]
= Overriding JDO Annotations
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_subtype-entity-not-fully-populated.adoc b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_subtype-entity-not-fully-populated.adoc
index 90a670d..97de44d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_subtype-entity-not-fully-populated.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_subtype-entity-not-fully-populated.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugodn_hints-and-tips_subtype-entity-not-fully-populated]]
= Subtype not fully populated
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
Taken from link:http://markmail.org/message/ovgai56uqgfgnrx7[this thread] on the Apache Isis users mailing list...
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_typesafe-queries-and-fetchgroups.adoc b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_typesafe-queries-and-fetchgroups.adoc
index e9bfa3b..27fe2ef 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_typesafe-queries-and-fetchgroups.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_hints-and-tips_typesafe-queries-and-fetchgroups.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugodn_hints-and-tips_typesafe-queries-and-fetchgroups]]
= Typesafe Queries and Fetch-groups
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips.adoc b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips.adoc
index 276576e..652d837 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugsec_hints-and-tips]]
= Hints and Tips
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
:toc: right
@@ -25,6 +25,10 @@ See also hints-n-tips chapters in the:
-include::_ugsec_hints-and-tips_configuring-isis-to-use-bypass.adoc[leveloffset=+1]
-include::_ugsec_hints-and-tips_run-as.adoc[leveloffset=+1]
-include::_ugsec_hints-and-tips_shiro-caching.adoc[leveloffset=+1]
+// tag::inclusions[]
+
+include::_ugsec_hints-and-tips_configuring-isis-to-use-bypass.adoc[leveloffset=+1,lines=3..-1]
+include::_ugsec_hints-and-tips_run-as.adoc[leveloffset=+1,lines=3..-1]
+include::_ugsec_hints-and-tips_shiro-caching.adoc[leveloffset=+1,lines=3..-1]
+
+// end::inclusions[]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_configuring-isis-to-use-bypass.adoc b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_configuring-isis-to-use-bypass.adoc
index a0b4cbd..4610fc5 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_configuring-isis-to-use-bypass.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_configuring-isis-to-use-bypass.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugsec_hints-and-tips_configuring-isis-to-use-bypass]]
= Bypassing security
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
The bypass security component consists of an implementation of both the `AuthenticationManager` and `AuthorizationManager` APIs, and are intended for prototyping use only.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_run-as.adoc b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_run-as.adoc
index 6b088d0..76862e0 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_run-as.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_run-as.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugsec_hints-and-tips_run-as]]
= Run-as
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_shiro-caching.adoc b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_shiro-caching.adoc
index bdfead9..ad1ab56 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_shiro-caching.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_hints-and-tips_shiro-caching.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugsec_hints-and-tips_shiro-caching]]
= Caching and other Shiro Features
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
We don't want to repeat the entire link:http://shiro.apache.org/documentation.html[Shiro documentation set] here, but we should flag a number of other features that are worth checking out.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips.adoc
index d83beb4..6f994f7 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugvro_hints-and-tips]]
= Hints and Tips
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
This chapter provides some solutions for problems we've encountered ourselves or have been raised on the Apache Isis mailing lists.
@@ -27,11 +27,13 @@ Since the Restful Objects viewer is designed for computer programs to interact w
This section provides a few hints-and-tips to help you on your way.
+// tag::inclusions[]
-include::_ugvro_hints-and-tips_using-chrome-devtools.adoc[leveloffset=+1]
-include::_ugvro_hints-and-tips_angular-tips.adoc[leveloffset=+1]
-include::_ugvro_hints-and-tips_pretty-printing.adoc[leveloffset=+1]
-include::_ugvro_hints-and-tips_restful-image-property.adoc[leveloffset=+1]
+include::_ugvro_hints-and-tips_using-chrome-devtools.adoc[leveloffset=+1,lines=3..-1]
+include::_ugvro_hints-and-tips_angular-tips.adoc[leveloffset=+1,lines=3..-1]
+include::_ugvro_hints-and-tips_pretty-printing.adoc[leveloffset=+1,lines=3..-1]
+include::_ugvro_hints-and-tips_restful-image-property.adoc[leveloffset=+1,lines=3..-1]
+// end::inclusions[]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_angular-tips.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_angular-tips.adoc
index 1ad8f1e..35b6131 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_angular-tips.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_angular-tips.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugvro_hints-and-tips_angular-tips]]
= Angular Tips
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_pretty-printing.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_pretty-printing.adoc
index 22108b4..abf90ed 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_pretty-printing.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_pretty-printing.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugvro_hints-and-tips_pretty-printing]]
= Pretty printing
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
The JSON representations generated by the Restful Objects viewer are in compact form if the xref:../rgcfg/rgcfg.adoc#_rgcfg_deployment-types[deployment type] is SERVER (ie production), but will automatically be "pretty printed" (in other words indented) if the deployment type is PROTOTYPE.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_restful-image-property.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_restful-image-property.adoc
index 898df04..2ddb71c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_restful-image-property.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_restful-image-property.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugvro_hints-and-tips_restful-image-property]]
= How parse images in RO viewer?
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
From this link:http://markmail.org/message/4kcu7sml4ufdsah3[thread] on the Apache Isis users mailing list:
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_using-chrome-devtools.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_using-chrome-devtools.adoc
index 74eb6b8..c803ff2 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_using-chrome-devtools.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_hints-and-tips_using-chrome-devtools.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugvro_hints-and-tips_using-chrome-devtools]]
= Using Chrome Dev Tools
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips.adoc
index 9faabef..c856631 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugvw_hints-and-tips]]
= Hints and Tips
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
@@ -23,10 +23,12 @@ See also hints-n-tips chapters in the:
* the xref:../ugbtb/ugbtb.adoc#_ugbtb_hints-and-tips[Beyond the Basics] guide.
+// tag::inclusions[]
-include::_ugvw_hints-and-tips_per-user-themes.adoc[leveloffset=+1]
-include::_ugvw_hints-and-tips_i18n-label-in-wicket-viewer.adoc[leveloffset=+1]
-include::_ugvw_hints-and-tips_svg-support.adoc[leveloffset=+1]
+include::_ugvw_hints-and-tips_per-user-themes.adoc[leveloffset=+1,lines=3..-1]
+include::_ugvw_hints-and-tips_i18n-label-in-wicket-viewer.adoc[leveloffset=+1,lines=3..-1]
+include::_ugvw_hints-and-tips_svg-support.adoc[leveloffset=+1,lines=3..-1]
+// end::inclusions[]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_i18n-label-in-wicket-viewer.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_i18n-label-in-wicket-viewer.adoc
index 476aeea..b0fe3a8 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_i18n-label-in-wicket-viewer.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_i18n-label-in-wicket-viewer.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugvw_hints-and-tips_i18n-label-in-wicket-viewer]]
= How i18n the Wicket viewer?
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_per-user-themes.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_per-user-themes.adoc
index 53cce7b..5118eb5 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_per-user-themes.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_per-user-themes.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugvw_hints-and-tips_per-user-themes]]
= Per-user Themes
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
From link:http://isis.markmail.org/thread/kb4442niwwbnghey[this thread] on the Apache Isis users mailing list:
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_svg-support.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_svg-support.adoc
index 7f879a3..07600f2 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_svg-support.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_hints-and-tips_svg-support.adoc
@@ -1,8 +1,8 @@
+:_basedir: ../../
+:_imagesdir: images/
[[_ugvw_hints-and-tips_svg-support]]
= SVG Support
: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 [...]
-:_basedir: ../../
-:_imagesdir: images/
(As per link:https://issues.apache.org/jira/browse/ISIS-1604[ISIS-1604]), SVG images can be used:
diff --git a/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/images/cheat-sheets/cover.png b/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/images/cheat-sheets/cover.png
index 258356a..a2b9d48 100644
Binary files a/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/images/cheat-sheets/cover.png and b/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/images/cheat-sheets/cover.png differ
diff --git a/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/resources/cheat-sheets/IsisCheatSheet.docx b/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/resources/cheat-sheets/IsisCheatSheet.docx
index be3757f..961a3c5 100644
Binary files a/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/resources/cheat-sheets/IsisCheatSheet.docx and b/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/resources/cheat-sheets/IsisCheatSheet.docx differ
diff --git a/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/resources/cheat-sheets/IsisCheatSheet.pdf b/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/resources/cheat-sheets/IsisCheatSheet.pdf
index 4f2c297..1047778 100644
Binary files a/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/resources/cheat-sheets/IsisCheatSheet.pdf and b/adocs/documentation/src/main/asciidoc/pages/cheat-sheet/resources/cheat-sheets/IsisCheatSheet.pdf differ
--
To stop receiving notification emails like this one, please contact
['"commits@isis.apache.org" <co...@isis.apache.org>'].