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 2016/04/29 12:32:35 UTC
[3/3] isis-site git commit: ISIS-1335: doc improvement - importing
settings for intellij, workaround
ISIS-1335: doc improvement - importing settings for intellij, workaround
Project: http://git-wip-us.apache.org/repos/asf/isis-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis-site/commit/4d591ceb
Tree: http://git-wip-us.apache.org/repos/asf/isis-site/tree/4d591ceb
Diff: http://git-wip-us.apache.org/repos/asf/isis-site/diff/4d591ceb
Branch: refs/heads/asf-site
Commit: 4d591ceb36424b2820def9d926421911d7503288
Parents: 2db69af
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Fri Apr 29 11:30:52 2016 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Fri Apr 29 11:30:52 2016 +0100
----------------------------------------------------------------------
content/guides/dg.html | 80 +-
content/guides/dg.pdf | 4417 +++++++++++++++++++++-------------------
content/guides/ugfun.html | 4 +-
content/guides/ugfun.pdf | 674 +++---
4 files changed, 2688 insertions(+), 2487 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis-site/blob/4d591ceb/content/guides/dg.html
----------------------------------------------------------------------
diff --git a/content/guides/dg.html b/content/guides/dg.html
index bbd4f89..b536795 100644
--- a/content/guides/dg.html
+++ b/content/guides/dg.html
@@ -684,7 +684,7 @@ as Jenkins)</p>
<div class="title">Figure 6. IntelliJ Installation Wizard - Import Settings</div>
</div>
<div class="paragraph">
-<p>Finally, if you are young and trendy, set the UI theme to Darcula:</p>
+<p>Finally, if you are a trendy hipster, set the UI theme to Darcula:</p>
</div>
<div class="imageblock">
<div class="content">
@@ -756,8 +756,10 @@ as Jenkins)</p>
<div class="title">Figure 13. File templates</div>
</div>
<div class="paragraph">
-<p>The file templates are provided as a settings JAR file, namely <strong><a href="resources/appendices/dev-env/intellij/isis-settings-file-templates.jar">isis-settings-file-templates.jar</a></strong>. Download this file and import using <code>File > Import Settings</code>, specifying the
-directory that you have downloaded the file to:</p>
+<p>The file templates are provided as a settings JAR file, namely <strong><a href="resources/appendices/dev-env/intellij/isis-settings-file-templates.jar">isis-settings-file-templates.jar</a></strong>. Download this file.</p>
+</div>
+<div class="paragraph">
+<p>Next, import using <code>File > Import Settings</code>, specifying the directory that you have downloaded the file to:</p>
</div>
<div class="imageblock">
<div class="content">
@@ -766,13 +768,39 @@ directory that you have downloaded the file to:</p>
<div class="title">Figure 14. IntelliJ Import Settings - Specify JAR file</div>
</div>
<div class="paragraph">
-<p>Select all the categories (there should just be one), and hit OK. then hit restart:</p>
+<p>Select all the categories (there should just be one), and hit OK. then hit restart.</p>
</div>
-<div class="imageblock">
-<div class="content">
-<img src="images/appendices/dev-env/intellij-idea/030-import-settings/030-restart.png" alt="030 restart" width="250px">
+<div class="admonitionblock warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>Apparently no categories are shown if importing into IntelliJ 2016.1.1 Community Edition (and perhaps other 2016
+versions). The file does import ok into IntelliJ 15.0.x, so we think this is a bug in the 2016 version.</p>
</div>
-<div class="title">Figure 15. IntelliJ Import Settings - Restart</div>
+<div class="paragraph">
+<p>The workaround is to extract the <code>.jar</code> file locally and copy the files into IntelliJ’s <code>config</code> directory, somewhere
+in your home directory:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Windows <code><User home>\.IdeaIC2016\config</code></p>
+</li>
+<li>
+<p>Linux <code>~/..IdeaIC2016/config</code></p>
+</li>
+<li>
+<p>Mac OS <code>~/Library/Preferences/IdeaIC2016</code></p>
+</li>
+</ul>
+</div>
+</td>
+</tr>
+</table>
</div>
</div>
<div class="sect4">
@@ -784,7 +812,7 @@ directory that you have downloaded the file to:</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/030-import-settings/050-live-templates.png" alt="050 live templates" width="600px">
</div>
-<div class="title">Figure 16. Live templates</div>
+<div class="title">Figure 15. Live templates</div>
</div>
<div class="paragraph">
<p>The live templates have a prefix of prefixed either:</p>
@@ -829,7 +857,7 @@ provided as a settings file, namely <strong><a href="resources/appendices/dev-en
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/040-other-settings-compiler/010-build-automatically.png" alt="010 build automatically" width="700px">
</div>
-<div class="title">Figure 17. IntelliJ Compiler Settings</div>
+<div class="title">Figure 16. IntelliJ Compiler Settings</div>
</div>
<div class="paragraph">
<p>On the <strong>Annotation Processors</strong> page, enable and adjust for the 'default' setting:</p>
@@ -838,7 +866,7 @@ provided as a settings file, namely <strong><a href="resources/appendices/dev-en
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/040-other-settings-compiler/020-annotation-processor.png" alt="020 annotation processor" width="700px">
</div>
-<div class="title">Figure 18. IntelliJ Annotation Processor Settings</div>
+<div class="title">Figure 17. IntelliJ Annotation Processor Settings</div>
</div>
<div class="paragraph">
<p>This setting enables the generation of the <code>Q*</code> classes for DataNucleus type-safe queries, as well as being required
@@ -871,7 +899,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/042-other-settings-maven/010-maven-installation.png" alt="010 maven installation" width="700px">
</div>
-<div class="title">Figure 19. IntelliJ Maven Settings - Installation</div>
+<div class="title">Figure 18. IntelliJ Maven Settings - Installation</div>
</div>
<div class="paragraph">
<p>Still on the Maven settings page, configure as follows:</p>
@@ -880,7 +908,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/042-other-settings-maven/020-maven-configuration.png" alt="020 maven configuration" width="700px">
</div>
-<div class="title">Figure 20. IntelliJ Maven Settings - Configuration</div>
+<div class="title">Figure 19. IntelliJ Maven Settings - Configuration</div>
</div>
</div>
<div class="sect4">
@@ -895,7 +923,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/044-other-settings-misc/010-auto-import.png" alt="010 auto import" width="700px">
</div>
-<div class="title">Figure 21. IntelliJ Maven Settings - Auto Import</div>
+<div class="title">Figure 20. IntelliJ Maven Settings - Auto Import</div>
</div>
</div>
</div>
@@ -911,7 +939,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/100-maven-module-mgmt/010-maven-modules-view.png" alt="010 maven modules view" width="730px">
</div>
-<div class="title">Figure 22. IntelliJ Maven Module Management - Importing Maven modules</div>
+<div class="title">Figure 21. IntelliJ Maven Module Management - Importing Maven modules</div>
</div>
<div class="paragraph">
<p>We can then import another module (from some other directory). For example, here we are importing the Isis Addons' todoapp example:</p>
@@ -920,7 +948,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/100-maven-module-mgmt/020-adding-another-module.png" alt="020 adding another module" width="400px">
</div>
-<div class="title">Figure 23. IntelliJ Maven Module Management - Importing another Module</div>
+<div class="title">Figure 22. IntelliJ Maven Module Management - Importing another Module</div>
</div>
<div class="paragraph">
<p>You should then see the new Maven module loaded in the <em>Projects</em> window and also the <em>Maven Projects</em> window:</p>
@@ -929,7 +957,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/100-maven-module-mgmt/030-other-module-added.png" alt="030 other module added" width="730px">
</div>
-<div class="title">Figure 24. IntelliJ Maven Module Management -</div>
+<div class="title">Figure 23. IntelliJ Maven Module Management -</div>
</div>
<div class="paragraph">
<p>If any dependencies are already loaded in the project, then IntelliJ will automatically update the CLASSPATH to resolve to locally held modules (rather from <code>.m2/repository</code> folder). So, for example (assuming that the <code><version></code> is correct, of course), the Isis todoapp will have local dependencies on the Apache Isis core.</p>
@@ -944,7 +972,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/100-maven-module-mgmt/040-ignoring-modules.png" alt="040 ignoring modules" width="730px">
</div>
-<div class="title">Figure 25. IntelliJ Maven Module Management - Ignoring Modules</div>
+<div class="title">Figure 24. IntelliJ Maven Module Management - Ignoring Modules</div>
</div>
<div class="paragraph">
<p>Confirm that it’s ok to ignore these modules:</p>
@@ -953,7 +981,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/100-maven-module-mgmt/050-ignoring-modules-2.png" alt="050 ignoring modules 2" width="300px">
</div>
-<div class="title">Figure 26. IntelliJ Maven Module Management - Ignoring Modules (ctd)</div>
+<div class="title">Figure 25. IntelliJ Maven Module Management - Ignoring Modules (ctd)</div>
</div>
<div class="paragraph">
<p>All being well you should see that the <em>Projects</em> window now only contains the code you are working on. Its classpath dependencies will be adjusted (eg to resolve to Apache Isis core from <code>.m2/repository</code>):</p>
@@ -962,7 +990,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/100-maven-module-mgmt/060-ignored-modules.png" alt="060 ignored modules" width="730px">
</div>
-<div class="title">Figure 27. IntelliJ Maven Module Management - Updated Projects Window</div>
+<div class="title">Figure 26. IntelliJ Maven Module Management - Updated Projects Window</div>
</div>
</div>
<div class="sect3">
@@ -982,7 +1010,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/110-running-the-app/010-run-configuration.png" alt="010 run configuration" width="600px">
</div>
-<div class="title">Figure 28. IntelliJ Running the App - Run Configuration</div>
+<div class="title">Figure 27. IntelliJ Running the App - Run Configuration</div>
</div>
<div class="paragraph">
<p>We specify the <code>Main class</code> to be <code>org.apache.isis.WebServer</code>; this is a wrapper around Jetty. It’s possible to pass program arguments to this (eg to automatically install fixtures), but for now leave this blank.</p>
@@ -997,7 +1025,7 @@ for frameworks such as <a href="#_cg_ide_project-lombok">Project Lombok</a>.</p>
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/110-running-the-app/020-datanucleus-enhancer-goal.png" alt="020 datanucleus enhancer goal" width="400px">
</div>
-<div class="title">Figure 29. IntelliJ Running the App - Datanucleus Enhancer Goal</div>
+<div class="title">Figure 28. IntelliJ Running the App - Datanucleus Enhancer Goal</div>
</div>
<div class="paragraph">
<p>The <code>-o</code> flag in the goal means run off-line; this will run faster.</p>
@@ -1027,7 +1055,7 @@ if you forget to set up the enhancer goal, or don’t run it on the correct
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/110-running-the-app/030-running-unit-tests.png" alt="030 running unit tests" width="600px">
</div>
-<div class="title">Figure 30. IntelliJ Running the App - Unit Tests Run Configuration</div>
+<div class="title">Figure 29. IntelliJ Running the App - Unit Tests Run Configuration</div>
</div>
<div class="paragraph">
<p>As a side-effect, this will create a run configuration, very similar to the one we manually created for the main app:</p>
@@ -1036,7 +1064,7 @@ if you forget to set up the enhancer goal, or don’t run it on the correct
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/110-running-the-app/040-running-unit-tests-run-configuration.png" alt="040 running unit tests run configuration" width="600px">
</div>
-<div class="title">Figure 31. IntelliJ Running the App - Unit Tests Run Configuration</div>
+<div class="title">Figure 30. IntelliJ Running the App - Unit Tests Run Configuration</div>
</div>
<div class="paragraph">
<p>Thereafter, you should run units by selecting this configuration (if you use the right click approach you’ll end up with lots of run configurations, all similar).</p>
@@ -1054,7 +1082,7 @@ if you forget to set up the enhancer goal, or don’t run it on the correct
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/110-running-the-app/050-running-integration-tests-run-configuration.png" alt="050 running integration tests run configuration" width="600px">
</div>
-<div class="title">Figure 32. IntelliJ Running the App - Integration Tests Run Configuration</div>
+<div class="title">Figure 31. IntelliJ Running the App - Integration Tests Run Configuration</div>
</div>
</div>
</div>
@@ -1289,7 +1317,7 @@ if you forget to set up the enhancer goal, or don’t run it on the correct
<div class="content">
<img src="images/appendices/dev-env/intellij-idea/050-some-plugins/020-some-plugins-confirmation.png" alt="020 some plugins confirmation" width="600px">
</div>
-<div class="title">Figure 33. IntelliJ Plugins</div>
+<div class="title">Figure 32. IntelliJ Plugins</div>
</div>
<div class="sect5">
<h6 id="_maven_helper_plugin">Maven Helper Plugin</h6>