From 1d7c3de1dfde0d8b1a89b1b7c1a3e794099c453b Mon Sep 17 00:00:00 2001 From: Martin Goik <goik@hdm-stuttgart.de> Date: Sat, 29 Sep 2018 08:30:13 +0200 Subject: [PATCH] Aligning SE1 / Sda1 --- Doc/Sd1/gettingStarted.xml | 4 +- Doc/Sda1/prerequisites.xml | 232 ++++++++++++++++--------------------- todo.txt | 2 + 3 files changed, 107 insertions(+), 131 deletions(-) create mode 100644 todo.txt diff --git a/Doc/Sd1/gettingStarted.xml b/Doc/Sd1/gettingStarted.xml index 5a7811cf4..c6991da42 100644 --- a/Doc/Sd1/gettingStarted.xml +++ b/Doc/Sd1/gettingStarted.xml @@ -182,7 +182,7 @@ <para><uri xlink:href="https://cloud.mi.hdm-stuttgart.de/owncloud/index.php/s/df9f296af3298f96361a15a679390e59">https://cloud.mi.hdm-stuttgart.de/owncloud/index.php/s/df9f296af3298f96361a15a679390e59</uri></para> - <para>Access to code being discussed during the lectures.</para> + <para>Accessing code being discussed during the lectures.</para> </figure> <figure xml:id="sd1_fig_IntelliJidea"> @@ -204,7 +204,7 @@ <itemizedlist> <listitem> - <para>Contains all Linux software from MI pool workstations.</para> + <para>Contain all MI pool workstation Linux software.</para> </listitem> <listitem> diff --git a/Doc/Sda1/prerequisites.xml b/Doc/Sda1/prerequisites.xml index c365c13e2..5d8c95011 100644 --- a/Doc/Sda1/prerequisites.xml +++ b/Doc/Sda1/prerequisites.xml @@ -45,140 +45,81 @@ <section xml:id="sda1_sect_resources"> <title>Lecture related resources</title> - <glosslist> - <glossentry> - <glossterm>Live lecture additions</glossterm> - - <glossdef> - <para><link - xlink:href="https://cloud.mi.hdm-stuttgart.de/owncloud/index.php/s/dae5c53f0a05d6661209527cee45d323">https://cloud.mi.hdm-stuttgart.de/owncloud/index.php/s/dae5c53f0a05d6661209527cee45d323</link></para> - </glossdef> - </glossentry> - - <glossentry> - <glossterm>List of exercises</glossterm> - - <glossdef> - <para>The lecture notes contain exercises to be solved by you! A - complete list is available at <uri + <figure xml:id="sda1_fig_liveLectureAdditions"> + <title>Live lecture additions</title> + + <para><uri + xlink:href="https://cloud.mi.hdm-stuttgart.de/owncloud/index.php/s/dae5c53f0a05d6661209527cee45d323">https://cloud.mi.hdm-stuttgart.de/owncloud/index.php/s/dae5c53f0a05d6661209527cee45d323</uri></para> + + <para>Accessing code being discussed during the lectures.</para> + </figure> + + <figure xml:id="sda1_fig_text_listOfExercises"> + <title>List of exercises</title> + + <itemizedlist> + <listitem> + <para>Tight relationship with respect to the examination.</para> + </listitem> + + <listitem> + <para>Complete list available at <uri xlink:href="apd.html">apd.html</uri>.</para> + </listitem> + </itemizedlist> + </figure> - <para>You may also want to use the corresponding PDF version of the - above table within <filename - xlink:href="printversion.pdf">printversion.pdf</filename> to keep - track of your personal advances by filling in your completion status - on individual exercises.</para> - </glossdef> - </glossentry> - - <glossentry> - <glossterm><xref linkend="glo_Javadoc"/> references and source - code</glossterm> - - <glossdef> - <para>The lecture notes contain a lot of <xref - linkend="glo_Javadoc"/> references. Most classes appearing within - these lecture notes have <xref linkend="glo_Javadoc"/> generated - links to the source code as well. For example when clicking on the - class name in <classname>sda.jdbc.intro.v1.SimpleInsert</classname> - you will see the complete implementation.</para> - </glossdef> - </glossentry> - - <glossentry> - <glossterm>Links to animated figures</glossterm> - - <glossdef> - <para>The lecture notes' online version contains links to <uri - xlink:href="jdbcWrite.html">PDF images</uri>. Clicking on - <quote>Animated PDF Version</quote> takes you to a referenced PDF - which in full screen mode of Acrobat Reader or - <trademark>google-chrome</trademark> provides a slide like - animation.</para> - </glossdef> - </glossentry> - - <glossentry> - <glossterm><trademark>Virtualbox</trademark> / <productname - xlink:href="https://my.vmware.com/en/web/vmware/free#desktop_end_user_computing/vmware_workstation_player/14_0">VMware - Workstation</productname> image / native (dual boot) - installation</glossterm> - - <glossdef> - <para>See <xref linkend="sd1_fig_MiLinuxImages"/>.</para> - </glossdef> - </glossentry> - - <glossentry xml:id="oxygenLicenseKey"> - <glossterm><uri>Oxygen Xml Editor</uri> license key</glossterm> - - <glossdef> - <para>This is the only software component in this lecture requiring - a license. Your <orgname>HdM</orgname> affiliation entitles you to - use the <productname - xlink:href="http://oxygenxml.com/">Oxygenxml</productname> software - for educational (non-commercial) purposes. The corresponding key is - available at <uri - xlink:href="https://mirror.mi.hdm-stuttgart.de/Firmen/Oxygen/Keys">https://mirror.mi.hdm-stuttgart.de/Firmen/Oxygen/Keys</uri>.</para> + <figure xml:id="sda1_fig_text_virtualboxVmware"> + <title>Virtualized Linux images</title> - <para>This license key is compatible both with the standalone and - the Eclipse plugin version of the product.</para> - </glossdef> - </glossentry> + <para>See <xref linkend="sd1_fig_MiLinuxImages"/>.</para> + </figure> - <glossentry> - <glossterm>Source code of lecture resources</glossterm> + <figure xml:id="sda1_fig_text_oxygenxml"> + <title><productname>Oxygenxml</productname></title> - <glossdef> - <para>The complete lecture sources are available from <link - xlink:href="https://gitlab.mi.hdm-stuttgart.de/goik/GoikLectures.git">https://gitlab.mi.hdm-stuttgart.de/goik/GoikLectures.git</link>.</para> + <itemizedlist> + <listitem> + <para>Download software from <uri + xlink:href="https://oxygenxml.com">https://oxygenxml.com</uri>.</para> + </listitem> - <para>You may simply execute <quote><command - xlink:href="https://git-scm.com">git</command> - <option>clone</option> - <option>https://gitlab.mi.hdm-stuttgart.de/goik/GoikLectures.git</option> - <option>.</option></quote> to check out the master tree.</para> - </glossdef> - </glossentry> + <listitem> + <para>Both standalone version (preferred) and Eclipse plugin on + offer.</para> + </listitem> - <glossentry> - <glossterm>Source code of exercises and examples</glossterm> + <listitem> + <para>HdM non-commercial license key at <uri + xlink:href="https://mirror.mi.hdm-stuttgart.de/Firmen/Oxygen/Keys">https://mirror.mi.hdm-stuttgart.de/Firmen/Oxygen/Keys</uri>.</para> + </listitem> + </itemizedlist> + </figure> - <glossdef> - <para>These sources contain a subdirectory - <filename>ws/eclipse/Jdbc</filename> which can be imported as an - eclipse project. This allows for browsing solutions to the exercises - and executing sample applications. Import into eclipse works the - following way:</para> + <figure xml:id="sda1_fig_lectureSourceCode"> + <title>Examples and exercises source code</title> - <itemizedlist> - <listitem> - <para>When starting eclipse choose - <filename>.../ws/eclipse</filename> as workspace</para> - </listitem> + <itemizedlist> + <listitem> + <para>Git repository <link + xlink:href="https://gitlab.mi.hdm-stuttgart.de/goik/GoikLectures.git">https://gitlab.mi.hdm-stuttgart.de/goik/GoikLectures.git</link>.</para> + </listitem> - <listitem> - <para>In eclipse click <quote>File --> Import --> General - --> Existing Projects into Workspace</quote>. After - re-selecting the current workspace - <filename>.../ws/eclipse</filename> the folder - <filename>Jdbc</filename> should be on the list of importable - projects.</para> - - <para>Depending on your eclipse installation you may have to - adjust the <xref linkend="glo_Java"/> system libraries. Right - click on your project root in the package explorer and choose - <quote>Build Path --> Configure Buildpath</quote>. The - <quote>JRE System Library</quote> entry in the - <quote>Libraries</quote> tab may have to be changed to suit your - eclipse's installation needs. You may want to create a dummy - <xref linkend="glo_Java"/> project to find the correct - setting.</para> - </listitem> - </itemizedlist> - </glossdef> - </glossentry> - </glosslist> + <listitem> + <para><command xlink:href="https://git-scm.com">git</command> + <option>clone</option> + <option>https://gitlab.mi.hdm-stuttgart.de/goik/GoikLectures.git</option></para> + </listitem> + + <listitem> + <para>Samples and exercise code below subfolder + <filename>P/Sda1</filename> and + <filename>ws/eclipse/Jdbc</filename>.</para> + + <para>To be imported as <xref linkend="glo_Maven"/> projects.</para> + </listitem> + </itemizedlist> + </figure> </section> <section xml:id="tools"> @@ -186,7 +127,7 @@ <para>The subsequent sections describe tools being helpful to successfully carry out the exercises. These descriptions are suitable for current - Linux/Ubuntu systems. However these tool are available for + Linux/Ubuntu systems. However these tools are available for <trademark>Windows</trademark> or <trademark>Apple</trademark> systems as well. For the latter some command line hints may have to be replaced by using GUI based tools.</para> @@ -194,6 +135,39 @@ <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> + + <listitem> + <para>Setup:</para> + + <itemizedlist> + <listitem> + <para>Mysql database server</para> + </listitem> + + <listitem> + <para>Java Jdk</para> + </listitem> + + <listitem> + <para>IntelliJ (Java coding)</para> + </listitem> + + <listitem> + <para>Oxygenxml (XML coding)</para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + </figure> + <section xml:id="eclipse"> <title><productname xlink:href="http://www.oracle.com/technetwork/java/javase/jdk-7-readme-429198.html">JDK</productname> @@ -238,9 +212,9 @@ This boils down to (being executed as user root or preceded by <command>sudo</command> <option>...</option>):</para> - <screen>add-apt-repository ppa:webupd8team/java + <screen>add-apt-repository ppa:linuxuprising/java apt-get update -apt-get install oracle-jdk8-installer</screen> +apt-get install oracle-java10-installer oracle-java10-set-default</screen> <para>During the installation process you will have to accept Oracle's license terms. If you do so this information will be cached and not be @@ -268,8 +242,8 @@ Java HotSpot(TM) 64-Bit Server VM (build 25.60-b23, mixed mode)</screen> and download the standalone version <quote>oXygen XML Editor</quote>.</para> - <para>See <xref linkend="oxygenLicenseKey"/> for obtaining a license - key.</para> + <para>See <xref linkend="sda1_fig_text_oxygenxml"/> for obtaining an HdM + license key.</para> </section> <section xml:id="mysql"> diff --git a/todo.txt b/todo.txt new file mode 100644 index 000000000..9ae083d9e --- /dev/null +++ b/todo.txt @@ -0,0 +1,2 @@ +add MI git Weblink to GoikLectures in Sda1/prerequisites.xml at »Git repository « + -- GitLab