From 2af72ba9636bec70046394c41744f89ce4572e35 Mon Sep 17 00:00:00 2001 From: Ilia Motornyi Date: Thu, 3 Dec 2015 14:59:05 +0000 Subject: Revert "Merge branch 'documentation'" This reverts commit f6874bde3d945c8b2d1b5c17ab50e2d0f1f8ff00. Change-Id: I67ee1c30ba3e3bcc3c43a1dd2e73a822791514bf --- .../clientside/clientside-compiling.asciidoc | 81 ---------------------- 1 file changed, 81 deletions(-) delete mode 100644 documentation/clientside/clientside-compiling.asciidoc (limited to 'documentation/clientside/clientside-compiling.asciidoc') diff --git a/documentation/clientside/clientside-compiling.asciidoc b/documentation/clientside/clientside-compiling.asciidoc deleted file mode 100644 index 18afb2c6ac..0000000000 --- a/documentation/clientside/clientside-compiling.asciidoc +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Compiling a Client-Side Module -order: 4 -layout: page ---- - -[[clientside.compiling]] -= Compiling a Client-Side Module - -A client-side module, either a widget set or a pure client-side module, needs to -be compiled to JavaScript using the Vaadin Client Compiler. During development, -the Development Mode makes the compilation automatically when you reload the -page, provided that the module has been initially compiled once with the -compiler. - -As most Vaadin add-ons include widgets, widget set compilation is usually needed -when using add-ons. In that case, the widget sets from different add-ons are -compiled into a __project widget set__, as described in -<>.//// -TODO Provide a link to a proper add-on compilation section when one is -available. -//// - -[[clientside.compiling.overview]] -== Vaadin Compiler Overview - -The Vaadin Client Compiler compiles Java to JavaScript. It is provided as the -[filename]#vaadin-client-compiler# JAR, which you can execute with the -[literal]#++-jar++# parameter for the Java runtime. It requires the -[filename]#vaadin-client# JAR, which contains the Vaadin client-side framework. - -The compiler compiles a __client module__, which can be either a pure -client-side module or a Vaadin widget set, that is, the Vaadin Client-Side -Engine that includes the widgets used in the application. The client module is -defined with a module descriptor, which was described in -<>. - -The compiler writes the compilation result to a target folder that will include -the compiled JavaScript with any static resources included in the module. - - -[[clientside.compiling.eclipse]] -== Compiling in Eclipse - -When the Vaadin Plugin is installed in Eclipse, you can simply click the -[guibutton]#Compile Vaadin widgets# button in the toolbar. It will compile the -widget set it finds from the project. If the project has multiple widget sets, -such as one for custom widgets and another one for the project, you need to -select the module descriptor of the widget set to compile before clicking the -button. - -The compilation with Vaadin Plugin for Eclipse currently requires that the -module descriptor has suffix [filename]#Widgetset.gwt.xml#, although you can use -it to compile also other client-side modules than widget sets. The result is -written under [filename]#WebContent/VAADIN/widgetsets# folder. - - -[[clientside.compiling.ant]] -== Compiling with Ant - -You can find a script template for compiling widget sets with Ant and Ivy at the -link:http://vaadin.com/download/[Vaadin download page]. You can copy the build -script to your project and, once configured, run it with Ant. - - -[[clientside.compiling.maven]] -== Compiling with Maven - -You can compile the widget set with the [literal]#++vaadin:compile++# goal as -follows: - -[subs="normal"] ----- -[prompt]#$# [command]#mvn# [parameter]#vaadin:compile# ----- - - - -- cgit v1.2.3