Merge pull request #49 from huitseeker/maintenance/release-upheaval

Fix various long-standing doc issues.

src/sphinx/2.0.x/features/typingviewing.rst

@@ -4,7 +4,7 @@ Typing and Viewing
 As You Type Error Reporting
 ---------------------------
 
-The Scala code is check as it is entered. It allows to see small or more complex compilation error as the code is type. No more endless cycle *code → code → code → compile → error reported → fix error → compile → error reported → fix error →...*.
+The Scala code is checked as it is entered. It allows to see small or more complex compilation error as the code is type. No more endless cycle *code → code → code → compile → error reported → fix error → compile → error reported → fix error →...*.
 
 .. image:: ../images/feature-typing-error-01.png
    :width: 100%

src/sphinx/3.0.x/advancedsetup/index.rst

@@ -54,10 +54,41 @@ Optional Preferences
      :width: 100%
      :target: ../_images/advancedsetup-heapstatus-01.png
 
+
+* **Limit Simultaneously Open Editors**
+
+  Having too many editors open can claim a lot of memory. Unless you are an exceptional multi-tasker or you use a task-focused interface such as `Mylyn <http://www.eclipse.org/mylyn/>`_, you may want to limit the number of simultaneously opened editors in the ``General`` section [#preferences]_..
+
+    .. image:: images/limit-editors.png
+     :width: 100%
+     :target: ../_images/limit-editors.png
+
+* **Deactivate Automatic Java Content Assist**
+
+  Since Scala-IDE is built over JDT, the Java Content Assist is enabled by default for Scala files, even though it is not relevant for Scala language files development. You can safely deactivate it if most of your edition is done in Scala files.
+
+.. note::
+
+   Naturally, if you have a mixed Scala/Java project, this may not
+   be a good idea : proceed at your own risk.
+
+
+.. image:: images/content-assist-deactivation.png
+     :width: 100%
+     :target: ../_images/content-assist-deactivation.png
+
+* **Activate Completion**
+
+  You should enable completion however — and you may even want to activate word proposals, if you don't want to have to hit several shortcuts to complete what you type.
+
+    .. image:: images/completion.png
+     :width: 100%
+     :target: ../_images/completion.png
+
 Performance
 -----------
 
-Garbage Collection activity and swap can be really bad for performance. It can trigger Eclipse freezes and general system slow down. 
+Garbage Collection activity and swap can be really bad for performance. It can trigger Eclipse freezes and cuase a general system slow down.
 
 Monitoring what is happening is the best option to keep a healthy system:
 
@@ -66,6 +97,11 @@ Monitoring what is happening is the best option to keep a healthy system:
 
 Depending of the problem, the memory allocated to the JVM can be increased, or some of the other application closed (like the web browser, or some flash application, ...).
 
+Suggested interesting keyboard shortcuts
+----------------------------------------
+
+You may want to head out to our :ref:`shortcuts` page to get a list of shortcuts that will speed up your Scala development.
+
 Additional Links
 ----------------
 

src/sphinx/3.0.x/features/navigating/index.rst

@@ -11,3 +11,5 @@ Navigating
    implicit-hyperlinking
    open-type
    open-declaration
+   outline-view
+   tasks-view

src/sphinx/3.0.x/features/navigating/outline-view.rst

@@ -0,0 +1,16 @@
+.. include:: /global_defs.hrst
+
+Outline View
+============
+
+The outline view of the standard Eclipse editors is also supported for the Scala IDE ! Hit ``Alt + Shift + Q, O`` to bring it up. You will be able to see eclarations for package, class, member, etc.
+
+.. image:: ./images/outline-view-2.png
+
+The outline view is also linked to your editor : clicking on members in the Outline view focuses your editor to the region of text where that element is declared. In a large file, this may be very useful.
+
+.. image:: ./images/outline-view-1.png
+
+A lighter version of the same feature is available if you press ``Ctrl + O`` (``Command + O`` on Mac) with the focus on the current editor.
+
+.. image:: ./images/quick-outline-1.png

src/sphinx/3.0.x/features/navigating/tasks-view.rst

@@ -0,0 +1,8 @@
+.. include:: /global_defs.hrst
+
+Tasks View
+==========
+
+The Scala IDE will also look through your comments and list TODO or FIXME mentions in the Tasks view. You can then navigate to them by clicking on them. The Tasks view can be brought up by clicking on ``Alt + Shift + Q, K``.
+
+.. image:: ./images/tasks-view-1.png

src/sphinx/3.0.x/features/typingviewing/errors-as-you-type.rst

@@ -3,8 +3,8 @@
 As You Type Error Reporting
 ===========================
 
-The Scala code is check as it is entered. It allows to see small or more complex compilation error as the code is type. No more endless cycle *code → code → code → compile → error reported → fix error → compile → error reported → fix error →...*.
+The Scala code is checked as it is entered. It allows to see small or more complex compilation error as the code is type. No more endless cycle *code → code → code → compile → error reported → fix error → compile → error reported → fix error →...*.
 
 .. image:: images/feature-typing-error-01.png
    :width: 100%
-   :target: ../_images/feature-typing-error-01.png
+   :target: ../_images/feature-typing-error-01.png

src/sphinx/3.0.x/features/typingviewing/index.rst

@@ -10,6 +10,7 @@ Typing and Viewing
    code-completion
    code-templates
    formatting/index
+   inferred-hover
    implicit-highlighting/index
    javadoc
    mark-occurrences

src/sphinx/3.0.x/features/typingviewing/inferred-hover.rst

@@ -0,0 +1,10 @@
+.. include:: /global_defs.hrst
+
+Inferred Type Hover
+===================
+
+If you click or hover on an element of the Editor, the IDE will display a tooltip with its definition and type declaration.
+
+.. image:: ./images/inferred-types-01.png
+   :width: 100%
+   :target: .././_images/inferred-types-01.png

src/sphinx/3.0.x/features/typingviewing/structured-selection.rst

@@ -10,5 +10,6 @@ Using ``alt+shift+up`` and ``alt+shift+down`` selects larger or smaller portion
 
 .. image:: images/feature-structured-selection-01.png
 
-This feature will also benefit from hover typing, just as when
-you place the cursor on a specific element.
+Hovering over the selection will also bring up a dialog dispaying
+the inferred type of the selected expression, just as it would if
+you put the cursor on a :doc:`specific element </current-user-doc/features/typingviewing/inferred-hover>`.

src/sphinx/dev/appendix/appendix.rst

@@ -5,8 +5,8 @@ Contents:
 
 .. toctree::
    :maxdepth: 1
-   
+
    what-to-work-on
-   scala-compiler-dev-with-eclipse
    git-github
-   resources
+   resources
+   shortcuts

src/sphinx/dev/appendix/shortcuts.rst

@@ -0,0 +1,22 @@
+.. _shortcuts:
+
+Suggested Shortcuts
+===================
+
+Here you can find a collection of shortcuts you will find useful for Scala development. Replace ``Ctrl`` by ``CMD`` if you are using a Mac.
+
+
+* ``Alt+Shift+X S`` : Run As Scala Application. It is quicker than the popup menu because it does not need to scan every Launcher to see what type of Launches can be acted upon.
+* ``Alt+Shift+X T`` : Run As JUnit. Also quicker than a popup menu for the same reasons.
+* ``Ctrl+Space``    : completion (using code, templates,...)
+* ``Alt + /``       : complete word (unless you have chosen to integrate word completion in completion proposals above)
+* ``Ctrl + /``        : toggle comment of a block (the selected line(s) or current line)
+*  ``Ctrl-3`` Quick Access -- a huge time saver. Opens up a dialog with incremental search on all commands available on the platform
+*  ``Ctrl-Shift-R`` Open Resource -- opens up a dialog with incremental search on all files in the workspace
+* ``Ctrl-.`` Go to the next error in the current editor
+* ``F2`` Show the error for the position under the cursor
+* ``F3`` Navigate to definition (same as ``Ctrl-click`` on an identifier)
+* ``Ctrl-O`` Quick Outline -- opens up a dialog with incremental search on all definitions in the current editor
+* ``Ctrl-J`` Incremental search
+* ``Ctrl-F11`` Launch the debugger. By default it tries to launch the current file. I configure Eclipse to always launch the last application.
+* ``Ctrl-Shift-F11`` Launch the application (with no debugger attached)

src/sphinx/tutorials/continuations-plugin/index.rst

@@ -24,9 +24,6 @@ Enabling continuations in Scala 2.9 is really simple, you only need to pass
 ``-P:continuations:enable`` to the Scala compiler, and the continuations plugin will be loaded and
 used to compile your sources.
 
-Note that in Scala 2.10 (trunk) the continuations plugin is enabled by default. Meaning that
-no configuration is needed to use continuations in the Scala IDE with Scala 2.10!
-
 In this tutorial we will learn how to enable the continuations plugin with the Scala IDE for Scala 2.9.
 
 Enabling continuations plugin

src/sphinx/tutorials/scalac-trunk/index.rst

@@ -31,7 +31,7 @@ In order to build the Scala compiler inside Eclipse, you need to make sure Eclip
 
 .. note::
 
-  If you have an older version of the Scala IDE plugin, you may run into trouble when updating to the latest nightly. Frequent changes in the compiler version numbering scheme may confuse Eclipse, and keep an older version of the compiler bundle that doesn't match the IDE. To make sure things run smoothly, you can uninstall the previous version. There is `command line tool`_ for doing that without firing up Eclipse.
+  If you have an older version of the Scala IDE plugin, you may run into trouble when updating to the latest nightly. Frequent changes in the compiler version numbering scheme may confuse Eclipse, and keep an older version of the compiler bundle that doesn't match the IDE. To make sure things run smoothly, you can uninstall the previous version. There is a `command line tool`_ for doing that without firing up Eclipse.
 
 Setting up the Eclipse project
 -------------------------------
@@ -53,11 +53,13 @@ Setting up the Eclipse project
 You should see at least the following projects in your workspace:
 
 * asm
-* fjbg
+* continuations-library
 * reflect
 * scala-library
 * scala-compiler
 
+If you work on a version of the scala compiler older than 2.10.0, you may also find here the old ``fjbg`` project (an older bytecode generator backend).
+
 Before you go on, you need to follow the steps described in the `README.md`_ on the Scala website. Come back once you are done.
 
 Using Eclipse for compiler development
@@ -92,25 +94,7 @@ Now you can launch the scala compiler, by choosing either ``Run`` or ``Debug`` f
 Cheat sheet
 -----------
 
-Here's a collection of the shortcuts I use the most in my daily development. Hopefully they will be helpful for others:
-
-*  ``CMD-3`` Quick Access -- a huge time saver. Opens up a dialog with incremental search on all commands available on the platform
-
-*  ``CMD-Shift-R`` Open Resource -- opens up a dialog with incremental search on all files in the workspace
-
-* ``CMD-.`` Go to the next error in the current editor
-
-* ``F2`` Show the error for the position under the cursor
-
-* ``F3`` Navigate to definition (same as ``CMD-click`` on an identifier)
-
-* ``CMD-O`` Quick Outline -- opens up a dialog with incremental search on all definitions in the current editor
-
-* ``CMD-J`` Incremental search
-
-* ``CMD-F11`` Launch the debugger. By default it tries to launch the current file. I configure Eclipse to always launch the last application.
-
-* ``CMD-Shift-F11`` Launch the application (with no debugger attached)
+On our :doc:`shortcuts </dev/appendix/shortcuts>` page, you will find a collection of the shortcuts used the most in daily development. Hopefully they will be helpful for others.
 
 If you are new to Eclipse, you should have a look at the :doc:`getting started </current-user-doc/gettingstarted/index>` guide and watch the screencast.
 
@@ -178,7 +162,7 @@ Please use github tickets and pull requests system for feedback.
 
 Iulian Dragos - `@jaguarul`_
 
-based on the document created by Grzegorz Kossakowski - `@gkossakowski`_ and improved by `Vlad Ureche`_.
+based on a document created by Grzegorz Kossakowski - `@gkossakowski`_ and improved by `Vlad Ureche`_, and input from `Hubert Plociniczak`_ and Nada Amin - `@nadamin`_.
 
 
 .. _#1000907: http://www.assembla.com/spaces/scala-ide/tickets/1000907
@@ -193,6 +177,8 @@ based on the document created by Grzegorz Kossakowski - `@gkossakowski`_ and imp
 .. _command line tool: http://scala-ide.org/blog/director-script.html
 .. _Sbt: https://github.com/harrah/xsbt
 .. _Vlad Ureche: http://people.epfl.ch/vlad.ureche
+.. _Hubert Plociniczak: http://people.epfl.ch/hubert.plociniczak
+.. _@nadamin: https://twitter.com/nadamin
 .. _update-scala.sh: https://github.com/scala-ide/scala-ide/blob/master/update-scala.sh
 .. _eclipse-director.sh: https://github.com/scala-ide/scala-ide/blob/master/eclipse-director.sh
-.. _README.md: https://github.com/scala/scala/blob/master/src/eclipse/README.md
+.. _README.md: https://github.com/scala/scala/blob/master/src/eclipse/README.md