Skip to content

Commit

Permalink
[#732] Docs: document $PLAY_HOME/support
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Hilton committed Jun 25, 2011
1 parent c1cf5de commit d3f80a7
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions documentation/manual/ide.textile
Expand Up @@ -5,7 +5,9 @@ Working with Play is easy. You don’t even need a sophisticated IDE as Play com
However, using a modern Java IDE provides cool productivity features like auto-completion, on-the-fly compilation, assisted refactoring and debugging. Play supports the "NetBeans":http://www.netbeans.org, "IntelliJ IDEA":http://www.jetbrains.com/idea/index.html and "Eclipse":http://www.eclipse.org platforms.


h2(#eclipse). <a>Generate configuration files for Eclipse</a>
h2(#eclipse). <a>Eclipse</a>

h3. Generate configuration

Play provides a command to simplify Eclipse configuration. To transform a Play application into a working Eclipse project, use the @eclipsify@ command:

Expand All @@ -19,13 +21,18 @@ The @eclipsify@ command generates several launchers for the application. The mai

If you make any important changes to your application, such as changing the classpath, use @eclipsify@ again to regenerate the configuration files.

Additionally, an Eclipse plugin is available in your Play distribution, in the @support/eclipse/@ directory. To install it, simply copy the JAR file you will find to your Eclipse installation’s @dropins@ folder.

p(note). **Do not commit Eclipse configuration files when you work in a team!**

The generated configuration files contain absolute references to your framework installation. These are specific to your own installation. When you work in a team, each developer must keep his Eclipse configuration files private.

h2(#netbeans). <a>Generate configuration files for NetBeans</a>
h3. Play Eclipse plug-in

Additionally, Play comes with an Eclipse plug-in that provides editors for HTML view templates, @application.conf@ and the @routes@ file.

To install, copy the JAR file from @$PLAY_HOME/support/eclipse@ to @$ECLIPSE_HOME/dropins@.


h2(#netbeans). <a>NetBeans</a>

Play provides a command to simplify NetBeans configuration. To transform an existing application to a valid NetBeans project, use the @netbeansify@ command:

Expand All @@ -39,11 +46,11 @@ Use the standard *Run* button to start the application. When the application is

If you make any important change to your application such as changing the classpath, use @netbeansify@ again to regenerate the configuration files.

p(note). **Do not commit the nbproject/ directory when you work in a team!**
p(note). **Do not commit the @nbproject/@ directory when you work in a team!**

The generated configuration files contains absolute references to your framework installation. These are specific to your own installation. When you work in a team on the same application, each developer must keep his NetBeans configuration files private.

h2(#intellij). <a>Generate configuration files for IntelliJ IDEA</a>
h2(#intellij). <a>IntelliJ IDEA</a>

Play provides a command to simplify IntelliJ IDEA configuration. To transform an existing application to a valid IntelliJ IDEA module, use the @idealize@ command:

Expand Down Expand Up @@ -74,14 +81,19 @@ The generated configuration files contains absolute references to your framework

h2(#textmate). <a>Textmate</a>

Download and install the bundle provided for "Textmate":http://macromates.com/ to enable syntax coloring and auto-completion. The bundle also eases navigation between controllers and views.
Install the "Textmate":http://macromates.com/ bundle provided at @$PLAY_HOME/support/textmate.zip@ to enable syntax coloring and auto-completion. The bundle also eases navigation between controllers and views.

!images/editor!


h2(#custom). <a>Manually configure your preferred editor</a>
h2(#vim). <a>Vim</a>

Inspired by Textmate, the "snipMate":http://www.vim.org/scripts/script.php?script_id=2540 plug-in provides keyword auto-completion in "Vim":http://www.vim.org/. Play provides snippets files for HTML and Java: to use them, install snipMate and copy @$PLAY_HOME/support/vim/*.snippets@ to @~/.vim/snippets/@.


h2(#custom). <a>Custom configuration</a>

As Play applications are standard Java applications, you don’t need a specific plug-in to work with your preferred editor. This, however, requires a little bit of knowledge of how Play works.
As Play applications are standard Java applications, you don’t need a specific plug-in to work with your preferred editor. This, however, requires a little bit of knowledge of how Play works.

h3. Classpath settings

Expand Down

0 comments on commit d3f80a7

Please sign in to comment.