Permalink
Browse files

A bit of spell checking.

I run all rst file expect the dev section through aspell.
  • Loading branch information...
1 parent b909a34 commit 40484083a80b6e35cbabc33150b10afafa5aab62 @skyluc skyluc committed Dec 14, 2011
View
@@ -1,9 +1,9 @@
Documentation for Scala IDE
---------------------------
-This documentation web site is using `Sphinx`_ to generate html pages from `reStructuredText`_ files.
+This documentation web site is using `Sphinx`_ to generate HTML pages from `reStructuredText`_ files.
-To setup Sphinx locally, use ``easy_instal``:
+To setup Sphinx locally, use ``easy_install``:
::
View
@@ -14,9 +14,9 @@ Welcome to Scala IDE's documentation!
* Project and source navigation including Scala support in the Package explorer view with embedded outline, outline view, quick outline, open type, open type hierarchy.
-* Incremental compilation, application launching with integrated debugger, hyperlinking from stacktraces to Scala source, interactive console.
+* Incremental compilation, application launching with integrated debugger, hyperlinking from stack traces to Scala source, interactive console.
-* Support for Eclipse plugin and OSGi development including hyperlinking to Scala source from plugin.xml and manifest files.
+* Support for Eclipse plug-in and OSGi development including hyperlinking to Scala source from plugin.xml and manifest files.
The Scala IDE is released under a :doc:`BSD-like license <license>` and community involvement in its development is strongly encouraged. See the `Developer Documentation`_ on how to take part.
@@ -119,7 +119,7 @@ Setting a few preferences in Eclipse will make everything easier to use.
* If you don't have the Web Development Tools for Eclipse installed, Eclipse opens ``.html`` files in a web browser. Configure it to use the ``Scala Editor`` instead.
.. image:: images/play20-scalaide20-14.png
- :alt: html file in text editor
+ :alt: HTML file in text editor
Importing the Play web application into Scala IDE
-------------------------------------------------
@@ -195,7 +195,7 @@ Now that everything is setup, we can change the content. Let's add a way to have
Going further
-------------
-You now have all you need to create great web applications with Play 2.0 and scala.
+You now have all you need to create great web applications with Play 2.0 and Scala.
For more information about Play 2.0, check out the `Play 2.0 wiki`_.
@@ -6,7 +6,7 @@ This page contains information to help you configure Eclipse and Scala IDE, to i
Eclipse Configuration
---------------------
-The default Eclipse heap configuration is often inadequate for the Scala IDE. It is strongly recommended to edit the ``eclipse/eclipse.ini`` (``eclipse/Eclipse.app/Contents/MacOS/eclipse.ini`` on Mac osX) file and add the following lines to increase various heap limits and VM options:
+The default Eclipse heap configuration is often inadequate for the Scala IDE. It is strongly recommended to edit the ``eclipse/eclipse.ini`` (``eclipse/Eclipse.app/Contents/MacOS/eclipse.ini`` on Mac osX) file and add the following lines to increase various heap limits and virtual machine options:
.. code-block:: bash
@@ -37,7 +37,7 @@ Required Preferences
* **JDT Weaving**
- ScalaIDE uses AOP to tweak the Eclipse JDT, so JDT weaving has to be enable. Otherwise, Scala files would be managed as Java files.
+ Scala IDE uses AOP to tweak the Eclipse JDT, so JDT weaving has to be enable. Otherwise, Scala files would be managed as Java files.
It is set in the ``JDT Weaving`` section of the Eclipse preferences [#preferences]_. It should say *'JDT Weaving is currently ENABLED'*. If it is not the case, use the ``Click to Enable`` button to enable it.
@@ -59,7 +59,7 @@ Garbage Collection activity and swap can be really bad for performance. It can t
Monitoring what is happening is the best option to keep a healthy system:
-* to monitor CPU and swap, use your native system monitor (some of the other system monitors are big resource users themseflves).
+* to monitor CPU and swap, use your native system monitor (some of the other system monitors are big resource users themselves).
* to monitor Garbage Collector activity, use *visualvm* on the eclipse instance. It is a profiling tool provided with jdk 1.6.x. It is possible also to get a feel of the memory usage with `the heap status bar <Optional Preferences>`_ in Eclipse.
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, ...).
View
@@ -8,7 +8,7 @@ Scala IDE is using 2 mailing lists host on Google Groups:
* `scala-ide-user`_ is the mailing list for questions and discussions relating to the installation and use of Scala IDE.
-* `scala-ide-dev`_ is the mailing list used by the development team and the commiters to discuss current and future work on Scala IDE.
+* `scala-ide-dev`_ is the mailing list used by the development team and the committers to discuss current and future work on Scala IDE.
When posting a message, please remember the suggestions from `How To Ask Questions The Smart Way`__. It helps you getting the best answer and us staying sane.
View
@@ -12,7 +12,7 @@ Right click on the project in the Package Explorer view, and in the context menu
I am running out of stack space in Eclipse. How do I increase the stack size?
..............................................................................
-If you are starting Eclipse from the command line, you can supply vm args, including stack size, like this:
+If you are starting Eclipse from the command line, you can supply virtual machine arguments, including stack size, like this:
.. code-block:: bash
@@ -35,7 +35,7 @@ can be replaced with something like (for an 8 megabyte stack, 700MB initial heap
-Xms700m
-Xmx2048m
-Scala IDE complains about 'no scala library...' or 'More than one scala library...'
+Scala IDE complains about 'no Scala library...' or 'More than one Scala library...'
...................................................................................
In Scala IDE 2.0.0, a classpath validator has been added to check that the Scala library has been correctly setup. It is checking two points: that the project build path contains only one Scala libraries, and that its version is compatible with the installed version of Scala IDE.
@@ -45,10 +45,10 @@ ___________________
It needs to be fixed manually.
-* If the error is 'no scala library...', one Scala library needs to be added to the build path. The simplest thing is to add the Scala library container: right-click on the project in the Package Explorer view, then in the context menu select ``Build Path → Add Libraries...``, and add the ``Scala Library``.
+* If the error is 'no Scala library...', one Scala library needs to be added to the build path. The simplest thing is to add the Scala library container: right-click on the project in the Package Explorer view, then in the context menu select ``Build Path → Add Libraries...``, and add the ``Scala Library``.
-* If the error is 'more than one scala library...', the number of Scala libraries needs to limited to one in the build path. If possible, make it being the Scala library container provided by Scala IDE.
+* If the error is 'more than one Scala library...', the number of Scala libraries needs to limited to one in the build path. If possible, make it being the Scala library container provided by Scala IDE.
Using m2eclipse
_______________
@@ -68,7 +68,7 @@ What are the limitations?
.........................
* The colon commands available in the terminal REPL are not supported.
-* Commands cannot be forcebly killed. For example, if an infinite loop is launched, it will continue in the background until Eclipse is shutdown.
+* Commands cannot be forcibly killed. For example, if an infinite loop is launched, it will continue in the background until Eclipse is shutdown.
Know Issues
-----------
@@ -84,12 +84,12 @@ The code contains Unicode niceties like ``←`` and ``⇒``, but the editor does
The operating system is not using UTF-8 by default, and its default encoding is used inside Eclipse.
-The encoding used to open files can be configured at different levels. Most of the time, setting Eclipse default encodint to UTF-8 in ``General → Workspace`` is enough. But in some case, the wrong encoding might also have been set in the project properties, or even the file properties.
+The encoding used to open files can be configured at different levels. Most of the time, setting Eclipse default encoding to UTF-8 in ``General → Workspace`` is enough. But in some case, the wrong encoding might also have been set in the project properties, or even the file properties.
-Red screen of death (red squigglies everywhere)
+Red screen of death (red squiggles everywhere)
...............................................
-The number one cause of nothing works is a mismatch between the Scala version of the Eclipse plugin and your project's. Make sure there is only one version of the Scala library on your classpath, and that it matches the version provided by Scala IDE.
+The number one cause of nothing works is a mismatch between the Scala version of the Eclipse plug-in and your project's. Make sure there is only one version of the Scala library on your classpath, and that it matches the version provided by Scala IDE.
The prime suspect is Maven Dependencies, which can download and add an incompatible scala-library.jar.
The classpath validator added in Scala IDE 2.0.0 should detect this problem and provide meaning full problem markers.
@@ -130,7 +130,7 @@ This will reduce the probability of getting a deadlock, but wont fix it.
If you encounter this problem, the best thing is to take a thread dump:
- Once the IDE is frozen, the following command provide the process id of the running VMs:
+ Once the IDE is frozen, the following command provide the process id of the running virtual machines:
.. code-block:: bash
@@ -149,11 +149,11 @@ NoClassDefFoundError (scala/tools/nsc/settings/MutableSettings$SettingValue)
**Symptoms**:
-After upgrading the Scala plugin, ``java.lang.NoClassDefFoundError: scala/tools/nsc/settings/MutableSettings$SettingValue`` exception is reported for all Scala projects in the workspace. Scala IDE is then unusable.
+After upgrading the Scala plug-in, ``java.lang.NoClassDefFoundError: scala/tools/nsc/settings/MutableSettings$SettingValue`` exception is reported for all Scala projects in the workspace. Scala IDE is then unusable.
**Solution**:
-If you have several update sites providing different version of Scala IDE, Eclipse may have decided that a newest Scala library should be used instead of the one provided by the plug-in to be installed. To avoid this problem, make sure to the uncheck the ``Contact all update sites during install to find required software``. It is situated at the bottom of the ``Help → Install New Software...`` dialog.
+If you have several update sites providing different version of Scala IDE, Eclipse may have decided that a newest Scala library should be used instead of the one provided by the plug-in to be installed. To avoid this problem, make sure to uncheck the ``Contact all update sites during install to find required software`` option. It is situated at the bottom of the ``Help → Install New Software...`` dialog.
.. _#1000317: https://scala-ide-portfolio.assembla.com/spaces/scala-ide/tickets/1000317
.. _m2eclipse-scala: https://github.com/sonatype/m2eclipse-scala
@@ -1,7 +1,7 @@
Formatting
==========
-The Scala formatter `scalariform`_ is integrated in Scala IDE. It allows for a good formatting of both Scala code and XML litterals.
+The Scala formatter `scalariform`_ is integrated in Scala IDE. It allows for a good formatting of both Scala code and XML literals.
Before:
@@ -20,4 +20,4 @@ It is activated by holding the ``Ctrl`` or the ``Cmd`` key, and hovering on vari
Open declaration
----------------
-In a similare way to hyperlinking, ``F3`` can be used to the declaration of the element currently under the carret.
+In a similar way to hyperlinking, ``F3`` can be used to the declaration of the element currently under the caret.
@@ -44,9 +44,9 @@ This action can be configure in the ``Scala → Organize Import`` preference pag
Renaming
--------
-The `Rename`_ action alllows to change any name, and update its reference.
+The `Rename`_ action allows to change any name, and update its reference.
-The action is performed in inline mode if the name as only a local scope.
+The action is performed in in-line mode if the name as only a local scope.
.. image:: ../images/feature-refactoring-rename-01.png
@@ -3,14 +3,14 @@ Scala Interpreter
Scala IDE integrate the Scala REPL. It is set in a view called ``Scala Interpreter``.
-Each view instance is associated to a project, andn all artefacts definde or refenced in the project are available to the interpreter.
+Each view instance is associated to a project, and all artifacts defined or referenced in the project are available to the interpreter.
Starting the interpreter
------------------------
There are multiple ways to start it:
-* Opening the view. The view can be opened with ``Window → Show View → Scala Interpreter`` from the Scala perspective, or ``Window → Show View → Other... → Scala → Scala Interpreter`` from anywhere. This will display the list of available projects. The interpreter is initialised and configured to use the selected one.
+* Opening the view. The view can be opened with ``Window → Show View → Scala Interpreter`` from the Scala perspective, or ``Window → Show View → Other... → Scala → Scala Interpreter`` from anywhere. This will display the list of available projects. The interpreter is initialized and configured to use the selected one.
* Executing some code. The |runSelection| ``Run Selection in Scala Interpreter`` command triggers the creation of a view for the current project if needed. The code currently selected in the editor is then run in the interpreter.
@@ -41,11 +41,11 @@ Toolbar
The toolbar contains the following five buttons:
================= ================================= ================================================================================================
-|replayAll| Replay All Comands Execute again all commands from the current session.
+|replayAll| Replay All Commands Execute again all commands from the current session.
|terminate| Terminate Stop the interpreter.
|terminateReplay| Terminate and Replay Reset the interpreter, and execute again all commands from the current session.
|clear| Clear Output Clear the view, but keeps the current session state.
-|autoreplay| Replay History on Project Rebuild If enable, the commands from the current session are executed everytime the project is rebuilt.
+|autoreplay| Replay History on Project Rebuild If enable, the commands from the current session are executed every time the project is rebuilt.
================= ================================= ================================================================================================
.. |replayAll| image:: ../images/restart_co.gif
@@ -24,16 +24,16 @@ The Scala elements compatible with Java are provided in **Java source files**.
Code Templates
--------------
-Code templates are available in the completion proposals in code assist. They provide shorcuts for boilerplate code like main method definition and asInstanceOf invocation.
+Code templates are available in the completion proposals in code assist. They provide shortcuts for boilerplate code like main method definition and asInstanceOf invocation.
.. image:: ../images/feature-template-01.png
The list of available templates can be viewed and modified in the ``Scala → Templates`` preference page.
-Mark Occurences
+Mark Occurrences
---------------
-As in the Java tooling, Mark Occurences highlights within a file where a type, variable or method is referenced.
+As in the Java tooling, Mark Occurrences highlights within a file where a type, variable or method is referenced.
.. image:: ../images/feature-occurences-01.png
Oops, something went wrong.

0 comments on commit 4048408

Please sign in to comment.