Envisage documentation refinements Update screenshots Refine names in samples (used in screenshots) Refine sample code snipped Add a few words
Project: http://git-wip-us.apache.org/repos/asf/polygene-java/repo Commit: http://git-wip-us.apache.org/repos/asf/polygene-java/commit/2da10844 Tree: http://git-wip-us.apache.org/repos/asf/polygene-java/tree/2da10844 Diff: http://git-wip-us.apache.org/repos/asf/polygene-java/diff/2da10844 Branch: refs/heads/yeoman-work Commit: 2da108441b12cdd2973a455390c73bc540f0162f Parents: 5ba2575 Author: Paul Merlin <[email protected]> Authored: Sun May 21 16:52:25 2017 +0200 Committer: Paul Merlin <[email protected]> Committed: Sun May 21 16:52:25 2017 +0200 ---------------------------------------------------------------------- .../images/tools-envisage-stacked-collapsed.png | Bin 30355 -> 211242 bytes .../resources/images/tools-envisage-stacked.png | Bin 36070 -> 225560 bytes .../images/tools-envisage-structure.png | Bin 90145 -> 277222 bytes .../resources/images/tools-envisage-type.png | Bin 88278 -> 279752 bytes tools/envisage/src/docs/envisage.txt | 9 +++++---- .../envisage/school/EnvisageSchoolSample.java | 10 ++++------ .../envisage/school/SchoolAssembler.java | 8 ++++---- 7 files changed, 13 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/polygene-java/blob/2da10844/manual/src/docs/website/resources/images/tools-envisage-stacked-collapsed.png ---------------------------------------------------------------------- diff --git a/manual/src/docs/website/resources/images/tools-envisage-stacked-collapsed.png b/manual/src/docs/website/resources/images/tools-envisage-stacked-collapsed.png index 33a0bec..7a825d8 100644 Binary files a/manual/src/docs/website/resources/images/tools-envisage-stacked-collapsed.png and b/manual/src/docs/website/resources/images/tools-envisage-stacked-collapsed.png differ http://git-wip-us.apache.org/repos/asf/polygene-java/blob/2da10844/manual/src/docs/website/resources/images/tools-envisage-stacked.png ---------------------------------------------------------------------- diff --git a/manual/src/docs/website/resources/images/tools-envisage-stacked.png b/manual/src/docs/website/resources/images/tools-envisage-stacked.png index ddcdb53..0eedc87 100644 Binary files a/manual/src/docs/website/resources/images/tools-envisage-stacked.png and b/manual/src/docs/website/resources/images/tools-envisage-stacked.png differ http://git-wip-us.apache.org/repos/asf/polygene-java/blob/2da10844/manual/src/docs/website/resources/images/tools-envisage-structure.png ---------------------------------------------------------------------- diff --git a/manual/src/docs/website/resources/images/tools-envisage-structure.png b/manual/src/docs/website/resources/images/tools-envisage-structure.png index 1ecd0ce..293df7f 100644 Binary files a/manual/src/docs/website/resources/images/tools-envisage-structure.png and b/manual/src/docs/website/resources/images/tools-envisage-structure.png differ http://git-wip-us.apache.org/repos/asf/polygene-java/blob/2da10844/manual/src/docs/website/resources/images/tools-envisage-type.png ---------------------------------------------------------------------- diff --git a/manual/src/docs/website/resources/images/tools-envisage-type.png b/manual/src/docs/website/resources/images/tools-envisage-type.png index 326cbbb..33a03d3 100644 Binary files a/manual/src/docs/website/resources/images/tools-envisage-type.png and b/manual/src/docs/website/resources/images/tools-envisage-type.png differ http://git-wip-us.apache.org/repos/asf/polygene-java/blob/2da10844/tools/envisage/src/docs/envisage.txt ---------------------------------------------------------------------- diff --git a/tools/envisage/src/docs/envisage.txt b/tools/envisage/src/docs/envisage.txt index 4aecf37..9202133 100644 --- a/tools/envisage/src/docs/envisage.txt +++ b/tools/envisage/src/docs/envisage.txt @@ -33,7 +33,7 @@ source=tools/envisage/src/test/java/org/apache/polygene/envisage/school/Envisage tag=envisage ---- -As you can see, Envisage operates on the ApplicationModel, this means that you +As you can see, Envisage operates on the ApplicationDescriptor, this means that you can easily embed it in your own Applications too. From the sources you can run the `runEnvisageSample` or `runEnvisageSchoolSample` Gradle tasks @@ -43,13 +43,14 @@ to run interactive examples. See <<build-system>> if you need some guidance. image:tools-envisage-structure.png[width="800px"] -image:tools-envisage-type.png[width="800px"] +image:tools-envisage-stacked-collapsed.png[width="800px"] image:tools-envisage-stacked.png[width="800px"] -image:tools-envisage-stacked-collapsed.png[width="800px"] +image:tools-envisage-type.png[width="800px"] -== Embedd in your Application == +== Embed into your Application == include::../../build/docs/buildinfo/artifact.txt[] +It can be handy to run Envisage in development <<def-application-mode, Mode>> while working on assemblies. http://git-wip-us.apache.org/repos/asf/polygene-java/blob/2da10844/tools/envisage/src/test/java/org/apache/polygene/envisage/school/EnvisageSchoolSample.java ---------------------------------------------------------------------- diff --git a/tools/envisage/src/test/java/org/apache/polygene/envisage/school/EnvisageSchoolSample.java b/tools/envisage/src/test/java/org/apache/polygene/envisage/school/EnvisageSchoolSample.java index b89cf41..9dbefcc 100644 --- a/tools/envisage/src/test/java/org/apache/polygene/envisage/school/EnvisageSchoolSample.java +++ b/tools/envisage/src/test/java/org/apache/polygene/envisage/school/EnvisageSchoolSample.java @@ -21,6 +21,7 @@ package org.apache.polygene.envisage.school; import org.apache.polygene.api.structure.ApplicationDescriptor; +import org.apache.polygene.bootstrap.ApplicationAssembler; import org.apache.polygene.bootstrap.Energy4Java; import org.apache.polygene.envisage.Envisage; @@ -28,14 +29,11 @@ public class EnvisageSchoolSample { // START SNIPPET: envisage public static void main( String[] args ) - throws Exception { Energy4Java energy4Java = new Energy4Java(); - - ApplicationDescriptor applicationModel - = energy4Java.newApplicationModel( new SchoolAssembler() ); - - new Envisage().run( applicationModel ); + ApplicationAssembler assembler = new SchoolAssembler(); + ApplicationDescriptor descriptor = energy4Java.newApplicationModel( assembler ); + new Envisage().run( descriptor ); } // END SNIPPET: envisage } http://git-wip-us.apache.org/repos/asf/polygene-java/blob/2da10844/tools/envisage/src/test/java/org/apache/polygene/envisage/school/SchoolAssembler.java ---------------------------------------------------------------------- diff --git a/tools/envisage/src/test/java/org/apache/polygene/envisage/school/SchoolAssembler.java b/tools/envisage/src/test/java/org/apache/polygene/envisage/school/SchoolAssembler.java index b9148af..475baf6 100644 --- a/tools/envisage/src/test/java/org/apache/polygene/envisage/school/SchoolAssembler.java +++ b/tools/envisage/src/test/java/org/apache/polygene/envisage/school/SchoolAssembler.java @@ -62,12 +62,12 @@ public class SchoolAssembler private LayerAssembly createInfrastructureLayer( ApplicationAssembly appAssembly ) throws AssemblyException { - LayerAssembly layerInfrastructure = appAssembly.layer( "Infrastructure" ); + LayerAssembly layerInfrastructure = appAssembly.layer( "infrastructure" ); - ModuleAssembly moduleMail = layerInfrastructure.module( "Mail" ); + ModuleAssembly moduleMail = layerInfrastructure.module( "mail" ); new MailServiceAssembler().assemble( moduleMail ); - ModuleAssembly modulePersistence = layerInfrastructure.module( "Persistence" ); + ModuleAssembly modulePersistence = layerInfrastructure.module( "persistence" ); new PersistenceAssembler().assemble( modulePersistence ); return layerInfrastructure; @@ -100,7 +100,7 @@ public class SchoolAssembler private LayerAssembly createUILayer( ApplicationAssembly appAssembly ) throws AssemblyException { - LayerAssembly layerUI = appAssembly.layer( "UI" ); + LayerAssembly layerUI = appAssembly.layer( "ui" ); // Add admin ModuleAssembly moduleAdmin = layerUI.module( "admin" );
