From d3f80a70368e534343300cf672197c3b8d53df3f Mon Sep 17 00:00:00 2001 From: Peter Hilton Date: Sat, 25 Jun 2011 21:45:18 +0200 Subject: [PATCH] [#732] Docs: document $PLAY_HOME/support --- documentation/manual/ide.textile | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/documentation/manual/ide.textile b/documentation/manual/ide.textile index 1322fe8f76..084d53d1e8 100644 --- a/documentation/manual/ide.textile +++ b/documentation/manual/ide.textile @@ -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). Generate configuration files for Eclipse +h2(#eclipse). Eclipse + +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: @@ -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). Generate configuration files for NetBeans +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). NetBeans Play provides a command to simplify NetBeans configuration. To transform an existing application to a valid NetBeans project, use the @netbeansify@ command: @@ -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). Generate configuration files for IntelliJ IDEA +h2(#intellij). IntelliJ IDEA Play provides a command to simplify IntelliJ IDEA configuration. To transform an existing application to a valid IntelliJ IDEA module, use the @idealize@ command: @@ -74,14 +81,19 @@ The generated configuration files contains absolute references to your framework h2(#textmate). Textmate -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). Manually configure your preferred editor +h2(#vim). Vim + +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). Custom configuration -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