Added quick start on creating new and importing existing project.

metaborg · Mar 4, 2016 · eb71f59 · eb71f59
1 parent 57226a9
commit eb71f59
Show file tree

Hide file tree

Showing 27 changed files with 136 additions and 9 deletions.
diff --git a/source/langdev/manual/env/intellij.md b/source/langdev/manual/env/intellij.md
diff --git a/source/langdev/manual/env/intellij/build-language-spec.md b/source/langdev/manual/env/intellij/build-language-spec.md
@@ -0,0 +1,5 @@
+# Building a language specification
+
+```eval_rst
+.. todo:: This part of the documentation has not been written yet.
+```
diff --git a/source/langdev/manual/env/intellij/build-project.md b/source/langdev/manual/env/intellij/build-project.md
@@ -0,0 +1,5 @@
+# Building a project
+
+```eval_rst
+.. todo:: This part of the documentation has not been written yet.
+```
diff --git a/source/langdev/manual/env/intellij/button_plus.png b/source/langdev/manual/env/intellij/button_plus.png
diff --git a/source/langdev/manual/env/intellij/dialog_selectjdkhome.png b/source/langdev/manual/env/intellij/dialog_selectjdkhome.png
diff --git a/source/langdev/manual/env/intellij/dialog_selectmetaborgsdkhome.png b/source/langdev/manual/env/intellij/dialog_selectmetaborgsdkhome.png
diff --git a/source/langdev/manual/env/intellij/existing-language-spec.md b/source/langdev/manual/env/intellij/existing-language-spec.md
@@ -0,0 +1,5 @@
+# Importing an existing language specification
+
+```eval_rst
+.. todo:: This part of the documentation has not been written yet.
+```
diff --git a/source/langdev/manual/env/intellij/existing-project.md b/source/langdev/manual/env/intellij/existing-project.md
@@ -0,0 +1,35 @@
+# Importing an existing project
+Follow this quick start guide to change an existing Java project such that you
+can use Metaborg languages in it.
+
+1. Open the project in IntelliJ IDEA.
+
+2. Go to the _Project Structure_ dialog, either through the _File_ →
+   _Project Structure..._ menu item, or by pressing <kbd>Ctrl</kbd>+
+   <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd>.
+
+3. Go to the _Facets_ tab.
+
+4. Click the ![Plus](button_plus.png) button and select _Metaborg_ from the drop-down menu.
+
+   !["Project Structure" dialog](projectstructure_addmetaborgfacet.png)
+
+5. Select the module to add the facet to, and click _OK_.
+
+6. In the _Modules_ tab, select the module.
+
+7. Go to the _Dependencies_ tab.
+
+8. Select the _Metaborg SDK_ as the module's SDK.
+
+   ![Select the "Metaborg SDK"](projectstructure_setmetaborgsdk.png)
+
+   ```eval_rst
+   .. include:: module-sdk.txt
+   ```
+
+5. Click _OK_ to apply the changes.
+
+The Java project will have the _Metaborg facet_, indicating that the
+project uses Metaborg languages. It will also have a `metaborg.yaml` file,
+which specifies the language dependencies of the project.
diff --git a/source/langdev/manual/env/intellij/importproject1.png b/source/langdev/manual/env/intellij/importproject1.png
diff --git a/source/langdev/manual/env/intellij/index.rst b/source/langdev/manual/env/intellij/index.rst
@@ -0,0 +1,14 @@
+=========================
+IntelliJ IDEA Environment
+=========================
+
+.. toctree::
+   :maxdepth: 1
+
+   new-project
+   existing-project
+   build-project
+   new-language-spec
+   existing-language-spec
+   build-language-spec
+
diff --git a/source/langdev/manual/env/intellij/messagebox_configurejava.png b/source/langdev/manual/env/intellij/messagebox_configurejava.png
diff --git a/source/langdev/manual/env/intellij/module-sdk.txt b/source/langdev/manual/env/intellij/module-sdk.txt
@@ -0,0 +1,18 @@
+.. note:: If the *Module SDK* displays *<None>* and you can't select the
+   Metaborg SDK, then you need to add it first.
+
+   1. Click the *New...* button next to the *Module SDK* field.
+
+   2. Select *Metaborg SDK*.
+
+      .. image:: projectstructure_newsdkmenu.png
+
+   3. You may get a warning if you have no Java JDK configured. Click *OK*
+      and configure the JDK's home location. The suggested home
+      directory is usually correct. Click *OK*.
+
+   4. Select a home directory for the Metaborg SDK. The default is the
+      Spoofax plugin's ``lib/`` folder, which is sufficient as it contains
+      all the core dependencies.
+
+   5. Click *OK*.
diff --git a/source/langdev/manual/env/intellij/new-language-spec.md b/source/langdev/manual/env/intellij/new-language-spec.md
@@ -0,0 +1,5 @@
+# Creating a new language specification
+
+```eval_rst
+.. todo:: This part of the documentation has not been written yet.
+```
diff --git a/source/langdev/manual/env/intellij/new-project-sdk.txt b/source/langdev/manual/env/intellij/new-project-sdk.txt
@@ -0,0 +1,18 @@
+.. note:: If the *Project SDK* displays *<None>* and you can't select the
+   Metaborg SDK, then you need to add it first.
+
+   1. Click the *New...* button next to the *Project SDK* field.
+
+   2. Select *Metaborg SDK*.
+
+      .. image:: newprojectform_newsdkmenu_small.png
+
+   3. You may get a warning if you have no Java JDK configured. Click *OK*
+      and configure the JDK's home location. The suggested home
+      directory is usually correct. Click *OK*.
+
+   4. Select a home directory for the Metaborg SDK. The default is the
+      Spoofax plugin's ``lib/`` folder, which is sufficient as it contains
+      all the core dependencies.
+
+   5. Click *OK*.
diff --git a/source/langdev/manual/env/intellij/new-project.md b/source/langdev/manual/env/intellij/new-project.md
@@ -0,0 +1,30 @@
+# Creating a new project
+Follow this quick start guide to create a new Java project in which you can use
+Metaborg languages.
+
+1. Choose _Create New Project_ from the welcome dialog, or the _File_ → _New_ →
+_Project..._ menu item, to open the _New Project_ dialog.
+
+2. Select the _Java_ project type.
+
+3. Check the _Metaborg_ framework.
+
+   !["New Project" dialog](newprojectform_checkmetaborgframework.png)
+
+4. Select the _Metaborg SDK_ as the project's SDK.
+
+   ![Select the "Metaborg SDK"](newprojectform_selectmetaborgsdk_small.png)
+
+   ```eval_rst
+   .. include:: new-project-sdk.txt
+   ```
+
+5. Click _Next_.
+
+6. Pick a project name and location, and click _Finish_.
+
+   ![Pick a project name](newprojectform_javaprojectname.png)
+
+The created Java project will have the _Metaborg facet_, indicating that the
+project uses Metaborg languages. It will also have a `metaborg.yaml` file, which
+specifies the language dependencies of the project.
diff --git a/source/langdev/manual/env/intellij/newproject1.png b/source/langdev/manual/env/intellij/newproject1.png
diff --git a/source/langdev/manual/env/intellij/newprojectform_checkmetaborgframework.png b/source/langdev/manual/env/intellij/newprojectform_checkmetaborgframework.png
diff --git a/source/langdev/manual/env/intellij/newprojectform_javaprojectname.png b/source/langdev/manual/env/intellij/newprojectform_javaprojectname.png
diff --git a/source/langdev/manual/env/intellij/newprojectform_newsdk.png b/source/langdev/manual/env/intellij/newprojectform_newsdk.png
diff --git a/source/langdev/manual/env/intellij/newprojectform_newsdkmenu.png b/source/langdev/manual/env/intellij/newprojectform_newsdkmenu.png
diff --git a/source/langdev/manual/env/intellij/newprojectform_newsdkmenu_small.png b/source/langdev/manual/env/intellij/newprojectform_newsdkmenu_small.png
diff --git a/source/langdev/manual/env/intellij/newprojectform_selectmetaborgsdk.png b/source/langdev/manual/env/intellij/newprojectform_selectmetaborgsdk.png
diff --git a/source/langdev/manual/env/intellij/newprojectform_selectmetaborgsdk_small.png b/source/langdev/manual/env/intellij/newprojectform_selectmetaborgsdk_small.png
diff --git a/source/langdev/manual/env/intellij/projectstructure_addmetaborgfacet.png b/source/langdev/manual/env/intellij/projectstructure_addmetaborgfacet.png
diff --git a/source/langdev/manual/env/intellij/projectstructure_newsdkmenu.png b/source/langdev/manual/env/intellij/projectstructure_newsdkmenu.png
diff --git a/source/langdev/manual/env/intellij/projectstructure_setmetaborgsdk.png b/source/langdev/manual/env/intellij/projectstructure_setmetaborgsdk.png
diff --git a/source/langdev/manual/index.rst b/source/langdev/manual/index.rst
@@ -8,6 +8,6 @@ Language Development Manual
    :maxdepth: 2
 
    env/eclipse
-   env/intellij
+   env/intellij/index
    project
    config