diff --git a/Doc/Sd1/gettingStarted.xml b/Doc/Sd1/gettingStarted.xml index c6991da425ca9372c3e20f6792326c9c8030336f..6609e4d0d71ff9551bc99c9deae20b2ff2afee79 100644 --- a/Doc/Sd1/gettingStarted.xml +++ b/Doc/Sd1/gettingStarted.xml @@ -1997,70 +1997,118 @@ loop # 12</screen> <section xml:id="sd1SectToolsOfTheTrade2"> <title>Tools of the trade, part 2</title> - <itemizedlist> - <listitem> - <para>For <link - xlink:href="https://www.jetbrains.com/help/idea/installing-and-launching.html">installation</link> - of <xref linkend="glo_Soft_IntellijIDEA"/> please choose the - <quote>Ultimate</quote> edition from <link - xlink:href="https://www.jetbrains.com/idea/download/index.html">https://www.jetbrains.com/idea/download/index.html</link>.</para> - </listitem> + <figure xml:id="sd1_fig_ideaDownload"> + <title>Downloading IntelliJ idea</title> - <listitem> - <para>Programming exercises are being supported by the <productname - xlink:href="https://www.jetbrains.com/idea">IntelliJ - IDEA</productname> <xref linkend="glo_IDE"/> being licensed to all HdM - affiliates. When starting the beast for the first time choose the - <quote>License server</quote> option:</para> + <itemizedlist> + <listitem> + <para><link + xlink:href="https://www.jetbrains.com/help/idea/installing-and-launching.html">Installation + notes</link>.</para> + </listitem> - <mediaobject> - <imageobject> - <imagedata fileref="Ref/Fig/intelliJIDEALicenseActivation.png"/> - </imageobject> - </mediaobject> + <listitem> + <para><link + xlink:href="https://www.jetbrains.com/idea/download">https://www.jetbrains.com/idea/download</link></para> - <para>The license server address should appear automatically. If - not:</para> + <para>Choose »Ultimate«.</para> + </listitem> - <itemizedlist> - <listitem> - <para>Try entering - <uri>http://jetbrains.mi.hdm-stuttgart.de:11111</uri> manually and - hit <quote>Activate</quote>.</para> - </listitem> + <listitem> + <para>Linux users:</para> - <listitem> - <para>In case activation fails most likely your system is unable - to connect to the license server. Chances are you do not have a - network connection or your system resides outside the HdM network - (<abbrev>e.g.</abbrev> at home) thus requiring a <link - xlink:href="https://wiki.mi.hdm-stuttgart.de/wiki/VPN#OpenVPN_Konfigurationsdatei">MI - VPN connection</link> to be activated.</para> - </listitem> - </itemizedlist> - </listitem> - </itemizedlist> - - <para>So far you've created plain <productname - xlink:href="https://www.jetbrains.com/idea">IntelliJ IDEA</productname> - <xref linkend="glo_Java"/> projects. For various reasons to be explained - later the <xref linkend="glo_IDE"/> also supports the <xref - linkend="glo_Maven"/> build software which among other features offers - both automated testing your code and logging messages at runtime. Moreover - <xref linkend="glo_Maven"/> allows for working on projects choosing - different platforms (Linux, Windows, Mac-OS): Thus you benefit from - seamlessly working on your exercises both at HdM and when using your - private Hardware.</para> - - <para><xref linkend="glo_Maven"/> is based on so called archetypes being - blueprints for projects. The MI department provides enhanced versions of - publicly available archetypes. In addition <link - xlink:href="https://maven.apache.org/glossary.html">Maven artifacts</link> - (libraries) are being provided as well. The <link - xlink:href="https://maven.mi.hdm-stuttgart.de/nexus">corresponding - repository</link> must be configured to be used both by command line or - the <productname xlink:href="https://www.jetbrains.com/idea">IntelliJ - IDEA</productname> <xref linkend="glo_IDE"/>.</para> + <para><command>snap</command> <option>install</option> + <option>--classic</option> + <option>intellij-idea-ultimate</option></para> + </listitem> + </itemizedlist> + </figure> + + <figure xml:id="sd1_fig_ideaUltimateLicenseTypes"> + <title>Idea »Ultimate« license types</title> + + <itemizedlist> + <listitem> + <para>By HdM license server:</para> + + <para><uri>http://jetbrains.mi.hdm-stuttgart.de:11111</uri></para> + </listitem> + + <listitem> + <para>By activation code for offline usage:</para> + + <para>Apply at <uri + xlink:href="https://www.jetbrains.com/shop/eform/students">https://www.jetbrains.com/shop/eform/students</uri>.</para> + </listitem> + </itemizedlist> + </figure> + + <figure xml:id="sd1_fig_ideaUltimateHdmLicenseServer"> + <title>HdM license server</title> + + <informaltable border="0"> + <tr> + <td valign="top"><mediaobject> + <imageobject> + <imagedata fileref="Ref/Fig/intelliJIDEALicenseActivation.png"/> + </imageobject> + </mediaobject></td> + + <td valign="top"><para>Troubleshooting: Insert address + manually:</para><para><uri>http://jetbrains.mi.hdm-stuttgart.de:11111</uri></para><para>External + usage requires <link linkend="sd1_fig_text_MiVpn">VPN</link> + !</para></td> + </tr> + </informaltable> + </figure> + + <para>For various reasons to be explained later the <xref + linkend="glo_IDE"/> also supports the <xref linkend="glo_Maven"/> build + software which among other features offers:</para> + + <figure xml:id="sd1_fig_reasonsUsingMaven"> + <title>Using <xref linkend="glo_Maven"/></title> + + <itemizedlist> + <listitem> + <para>Automated builds and testing.</para> + </listitem> + + <listitem> + <para>Third party libraries <abbrev>e.g.</abbrev> logging.</para> + </listitem> + + <listitem> + <para>Operating system agnostic: Linux, Windows, Mac-OS</para> + </listitem> + </itemizedlist> + </figure> + + <para>You thus benefit from seamlessly working on your exercises both at + HdM and when using your private Hardware.</para> + + <figure xml:id="sd1_fig_mavenArchetypes"> + <title><xref linkend="glo_Maven"/> archetypes</title> + + <itemizedlist> + <listitem> + <para>Blueprints for projects.</para> + </listitem> + + <listitem> + <para>Easy initial project creation.</para> + </listitem> + + <listitem> + <para><xref linkend="glo_CLI"/> and <xref linkend="glo_IDE"/> + support.</para> + </listitem> + + <listitem> + <para>Extensibility based on archetype catalogs.</para> + </listitem> + </itemizedlist> + </figure> <section xml:id="sd1_sect_mavenCli"> <title>Maven command line usage</title> @@ -2079,18 +2127,18 @@ loop # 12</screen> <filename>~/.m2</filename> below your home directory using a terminal window:</para> - <screen>mkdir ~/.m2</screen> + <screen>mkdir -p ~/.m2</screen> </listitem> <listitem> <para>Use a text editor (<command>vim</command>, <command>nano</command>, <command>emacs</command>, IntelliJ,...) - to create a file <filename>settings.xml</filename> in this newly - created directory:</para> + to create a <filename>settings.xml</filename> file within + <filename>~/.m2</filename>:</para> <screen>nano ~/.m2/settings.xml</screen> - <para>Use the editor to paste the following content into + <para>Paste the following content into <filename>~/.m2/settings.xml</filename> and save it:</para> <programlisting language="xml" diff --git a/Doc/Sda1/prerequisites.xml b/Doc/Sda1/prerequisites.xml index 5d8c95011e6180b1928e44343dd00e420acb7b09..8ab6e8456b730a61ae615c2fa7b267cfd447374c 100644 --- a/Doc/Sda1/prerequisites.xml +++ b/Doc/Sda1/prerequisites.xml @@ -132,40 +132,53 @@ well. For the latter some command line hints may have to be replaced by using GUI based tools.</para> - <para>You may want to consider using either of MI VirtualBox or VMware - image, see <xref linkend="sd1_fig_MiLinuxImages"/> for details.</para> - <figure xml:id="sda1_fig_tools"> <title>Tooling options</title> - <itemizedlist> - <listitem> - <para>MI VirtualBox or VMware image, see <xref - linkend="sd1_fig_MiLinuxImages"/>.</para> - </listitem> + <informaltable border="0"> + <tr> + <td valign="top"><itemizedlist> + <listitem> + <para>Setup:</para> - <listitem> - <para>Setup:</para> + <itemizedlist> + <listitem> + <para>Mysql database server</para> + </listitem> - <itemizedlist> - <listitem> - <para>Mysql database server</para> - </listitem> + <listitem> + <para>Java Jdk</para> + </listitem> - <listitem> - <para>Java Jdk</para> - </listitem> + <listitem> + <para>IntelliJ (Java coding)</para> + </listitem> - <listitem> - <para>IntelliJ (Java coding)</para> - </listitem> + <listitem> + <para><productname>Oxygenxml</productname> (XML + coding)</para> + </listitem> - <listitem> - <para>Oxygenxml (XML coding)</para> - </listitem> - </itemizedlist> - </listitem> - </itemizedlist> + <listitem> + <para><link linkend="sd1_sect_mavenCli">MI Maven + repository</link></para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist></td> + + <td valign="top"><itemizedlist> + <listitem> + <para>MI <link xlink:href="sd1_fig_MiLinuxImages">VirtualBox + or VMware image</link>.</para> + </listitem> + + <listitem> + <para/> + </listitem> + </itemizedlist></td> + </tr> + </informaltable> </figure> <section xml:id="eclipse">