names and descriptions

Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/4a5e96c8
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/4a5e96c8
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/4a5e96c8

Branch: refs/heads/wip
Commit: 4a5e96c8e794f8f570bb3c5a1cbd7a38cb711145
Parents: 85b1e70
Author: Dan Haywood <d...@haywood-associates.co.uk>
Authored: Mon Apr 17 17:56:54 2017 +0100
Committer: Dan Haywood <d...@haywood-associates.co.uk>
Committed: Thu Apr 20 09:09:30 2017 +0100

----------------------------------------------------------------------
 .../_ugfun_ui-hints_names-and-descriptions.adoc | 48 ++++++++++++--------
 1 file changed, 30 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/isis/blob/4a5e96c8/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_names-and-descriptions.adoc
----------------------------------------------------------------------
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 769ee79..dde8ed0 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
@@ -4,37 +4,49 @@
 :_basedir: ../../
 :_imagesdir: images/
 
-NOTE: FIXME
 
+The name of classes and class members are usually inferred from the Java 
source code directly.
+For example, an action method called `placeOrder` will be rendered as "Place 
Order", and a collection called `orderItems` is rendered as "Order Items".
 
+Occasionally though the desired name is not possible; either the name is a 
Java reserved word (eg "class"), or might require characters that are not 
valid, for example abbreviations.
 
-NOTE: see also xref:../ugbtb/ugbtb.adoc#_ugbtb_i18n[Internationalization]
+In such cases the name can be specified declaratively.
 
-== Class (object)
+It is also possible to specify a description declaratively; this is used as a 
tooltip in the UI.
 
-NOTE: FIXME - 
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_named[`@DomainObjectLayout#named()`],
 
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_describedAs[`@DomainObjectLayout#describedAs()`]
+The table below summarizes the annotations available:
 
+.Names and descriptions
+[cols="1a,1a,1a", options="header"]
+|===
 
-== Property
+| Feature
+| Named
+| Description
 
-NOTE: FIXME - 
xref:../rgant/rgant.adoc#_rgant-PropertyLayout_named[`@PropertyLayout#named()`],
 
xref:../rgant/rgant.adoc#_rgant-PropertyLayout_describedAs[`@PropertyLayout#describedAs()`]
 
+| Class
+| 
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_named[`@DomainObjectLayout#named()`]
+| 
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_describedAs[`@DomainObjectLayout#describedAs()`]
 
 
-== Collections
+| Property
+| 
xref:../rgant/rgant.adoc#_rgant-PropertyLayout_named[`@PropertyLayout#named()`]
+| 
xref:../rgant/rgant.adoc#_rgant-PropertyLayout_describedAs[`@PropertyLayout#describedAs()`]
 
-NOTE: FIXME - 
xref:../rgant/rgant.adoc#_rgant-CollectionLayout_named[`@CollectionLayout#named()`],
 
xref:../rgant/rgant.adoc#_rgant-CollectionLayout_describedAs[`@CollectionLayout#describedAs()`]
+| Collection
+| 
xref:../rgant/rgant.adoc#_rgant-CollectionLayout_named[`@CollectionLayout#named()`]
+| 
xref:../rgant/rgant.adoc#_rgant-CollectionLayout_describedAs[`@CollectionLayout#describedAs()`]
 
+| Action
+| xref:../rgant/rgant.adoc#_rgant-ActionLayout_named[`@ActionLayout#named()`]
+| 
xref:../rgant/rgant.adoc#_rgant-ActionLayout_describedAs[`@ActionLayout#describedAs()`]
 
+| Action Parameters
+| 
xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[`@ParameterLayout#named()`]
+| 
xref:../rgant/rgant.adoc#_rgant-ParameterLayout_describedAs[`@ParameterLayout#describedAs()`]
 
-== Actions
-
-NOTE: FIXME - 
xref:../rgant/rgant.adoc#_rgant-ActionLayout_named[`@ActionLayout#named()`], 
xref:../rgant/rgant.adoc#_rgant-ActionLayout_describedAs[`@ActionLayout#describedAs()`]
-
-
-== Action Parameters
-
-NOTE: FIXME - 
xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[`@ParameterLayout#named()`],
 
xref:../rgant/rgant.adoc#_rgant-ParameterLayout_describedAs[`@ParameterLayout#describedAs()`]
+|===
 
 
 [TIP]
@@ -43,5 +55,5 @@ If you're running on Java 8, then note that it's possible to 
write Isis applicat
 ====
 
 
-
-
+The framework also supports i18n: locale-specific names and descriptions.
+for more information, see the 
xref:../ugbtb/ugbtb.adoc#_ugbtb_i18n[beyond-the-basics] guide.

Reply via email to