summaryrefslogtreecommitdiffstats
path: root/documentation/getting-started
diff options
context:
space:
mode:
authorPekka Hyvönen <pekka@vaadin.com>2017-01-02 13:40:48 +0200
committerGitHub <noreply@github.com>2017-01-02 13:40:48 +0200
commit9c6831bab067ccdb47c3063f2e77d3c0e7fe3440 (patch)
tree190002e96b0d76fe4ac2ebaa9b21cc31fd7bd406 /documentation/getting-started
parent6adc887b7f94f5fb6e83c34822358e2240018147 (diff)
downloadvaadin-framework-9c6831bab067ccdb47c3063f2e77d3c0e7fe3440.tar.gz
vaadin-framework-9c6831bab067ccdb47c3063f2e77d3c0e7fe3440.zip
Update documentation, BoV chapters 1 - 5.3 (#8085)
* Update documentation chapters 1 - 5.3 Images and diagrams have not been updated, but unnecessary images have been removed. * Sync application declarative and architecture sections source code. Screenshot image is updated to match the source code. * Old datamodel image is removed. * Ivy install image is removed. * Remove unnecessary linking / reference
Diffstat (limited to 'documentation/getting-started')
-rw-r--r--documentation/getting-started/getting-started-archetypes.asciidoc13
-rw-r--r--documentation/getting-started/getting-started-first-project.asciidoc292
-rw-r--r--documentation/getting-started/getting-started-idea.asciidoc38
-rw-r--r--documentation/getting-started/getting-started-libraries.asciidoc34
-rw-r--r--documentation/getting-started/getting-started-maven.asciidoc14
-rw-r--r--documentation/getting-started/getting-started-overview.adoc7
-rw-r--r--documentation/getting-started/getting-started-package.asciidoc40
-rw-r--r--documentation/getting-started/getting-started-scala.asciidoc2
-rw-r--r--documentation/getting-started/img/idea-maven-newproject-3.pngbin10116 -> 0 bytes
-rw-r--r--documentation/getting-started/img/idea-maven-newproject-4.pngbin55547 -> 0 bytes
-rw-r--r--documentation/getting-started/img/idea-maven-newproject-5.pngbin25660 -> 0 bytes
-rw-r--r--documentation/getting-started/img/idea-maven-run-1.pngbin26057 -> 0 bytes
-rw-r--r--documentation/getting-started/img/idea-maven-run-2.pngbin2793 -> 0 bytes
-rw-r--r--documentation/getting-started/img/idea-newproject-3.pngbin47603 -> 0 bytes
-rw-r--r--documentation/getting-started/img/ivyde-install-available.pngbin63226 -> 0 bytes
-rw-r--r--documentation/getting-started/img/maven-project-created.pngbin18769 -> 0 bytes
-rw-r--r--documentation/getting-started/img/myproject-ivy-created.pngbin21785 -> 0 bytes
-rw-r--r--documentation/getting-started/img/myproject-ivy-new-vaadin.pngbin32682 -> 0 bytes
-rw-r--r--documentation/getting-started/img/myproject-ivy-settings.pngbin50386 -> 0 bytes
-rw-r--r--documentation/getting-started/img/myproject-ivy-vaadin.pngbin45886 -> 0 bytes
-rw-r--r--documentation/getting-started/img/myproject-ivy-web.pngbin22378 -> 0 bytes
-rw-r--r--documentation/getting-started/img/runningMyProject.pngbin40320 -> 0 bytes
-rw-r--r--documentation/getting-started/img/tomcat-startserver-1.pngbin37348 -> 0 bytes
-rw-r--r--documentation/getting-started/img/tomcat-startserver-2.pngbin156483 -> 0 bytes
-rw-r--r--documentation/getting-started/img/tomcat-startserver-3.pngbin92646 -> 0 bytes
-rw-r--r--documentation/getting-started/img/tomcat-startserver-4.pngbin58063 -> 0 bytes
-rw-r--r--documentation/getting-started/img/tomcat-startserver-5.pngbin64013 -> 0 bytes
27 files changed, 37 insertions, 403 deletions
diff --git a/documentation/getting-started/getting-started-archetypes.asciidoc b/documentation/getting-started/getting-started-archetypes.asciidoc
index 18d1eda56d..99b4852f15 100644
--- a/documentation/getting-started/getting-started-archetypes.asciidoc
+++ b/documentation/getting-started/getting-started-archetypes.asciidoc
@@ -11,24 +11,19 @@ Vaadin currently offers the following Maven archetypes for different kinds of pr
`vaadin-archetype-application`::
This is a single-module project for simple applications.
-It is good for quick demos and trying out Vaadin.
-It is also useful when you are experienced with Vaadin and want to build all the aspects of the application yourself.
+It is good for quick demos and trying out Vaadin Framework.
+It is also useful when you are experienced with the framework and want to build all the aspects of the application yourself.
`vaadin-archetype-application-multimodule`::
-A complete Vaadin application development setup.
+A complete Vaadin Framework application development setup.
It features separate production and development profiles.
`vaadin-archetype-application-example`::
An example CRUD web application using multi-module project setup.
`vaadin-archetype-widget`::
-A multi-module project for a new Vaadin add-on.
+A multi-module project for a new Vaadin Framework add-on.
It has two modules: one for the add-on and another for a demo application.
-`vaadin-archetype-touchkit`::
-A mobile development starter project using Vaadin TouchKit.
-See <<dummy/../../../touchkit/mobile-overview#mobile.overview,"Vaadin TouchKit">>.
-Notice that this archetype uses the AGPL-licensed version of TouchKit, which requires that your project must also be licensed under the AGPL license.
-
`vaadin-archetype-liferay-portlet`::
A portlet development setup for the open-source Liferay portal.
diff --git a/documentation/getting-started/getting-started-first-project.asciidoc b/documentation/getting-started/getting-started-first-project.asciidoc
index 3262b8a4b1..73ad178d68 100644
--- a/documentation/getting-started/getting-started-first-project.asciidoc
+++ b/documentation/getting-started/getting-started-first-project.asciidoc
@@ -18,220 +18,20 @@ Vaadin Plugin. The task will include the following steps:
. Open a web browser to use the web application
-
We also show how you can debug the application in the debug mode in Eclipse.
This walkthrough assumes that you have already installed the Eclipse IDE, the Vaadin Plugin, and a development server, as instructed in
<<dummy/../../../framework/installing/installing-eclipse#installing.eclipse, "Installing the Eclipse IDE and Plugin">>.
-ifdef::web[]
-[[getting-started.first-project.ivy]]
-== Creating an Ivy Project
-endif::web[]
-
-ifdef::web[]
-NOTE: The following describes the creation of an Ivy project. The upcoming version of the Eclipse plug-in creates Maven projects. For that, see <<getting-started.first-project.creation>>.
-endif::web[]
-
-ifdef::web[]
-Let us create the first application project with the tools installed in the
-previous section. First, launch Eclipse and follow the following steps:
-
-. Start creating a new project by selecting from the menu "File > New > Project...".
-. In the [guilabel]#New Project# window that opens, select "Vaadin > Vaadin 7
-Project" and click [guibutton]#Next#.
-+
-image::img/myproject-ivy-new-vaadin.png[width=70%, scaledwidth=100%]
-
-. In the [guilabel]#Vaadin Project# step, you need to set the basic web project
-settings. You need to give at least the __project name__ and the runtime; the
-default values should be good for the other settings.
-+
-image::img/myproject-ivy-settings.png[width=70%, scaledwidth=100%]
-
-[guilabel]#Project name#:: Give the project a name. The name should be a valid identifier usable
-cross-platform as a filename and inside a URL, so using only lower-case
-alphanumerics, underscore, and minus sign is recommended.
-
-[guilabel]#Use default location#:: Define the directory under which the project is created. The default is under
-your workspace folder, and you should normally leave it as it is. You may need
-to set the directory, for example, if you are creating an Eclipse project on top
-of a version-controlled source tree.
-
-[guilabel]#Target runtime#:: Define the application server to use for deploying the application. The server
-that you have installed, for example Apache Tomcat, should be selected
-automatically. If not, click [guibutton]#New# to configure a new server under
-Eclipse.
-
-[guilabel]#Configuration#:: Select the configuration to use; you should normally use the default
-configuration for the application server. If you need to modify the project
-facets, click [guibutton]#Modify#. The recommended Servlet 3.0 configuration
-uses the @WebServlet deployment, while Servlet 2.4 uses the old
-[filename]#web.xml# deployment.
-
-[guilabel]#Deployment configuration#:: This setting defines the environment to which the application will be deployed,
-to generate the appropriate project directory layout and configuration files.
-The choises are:
-
-*** [guilabel]#Servlet# (default)
-*** [guilabel]#Google App Engine Servlet#
-*** [guilabel]#Generic Portlet (Portlet 2.0)#
-
-+
-The further steps in the New Project Wizard depend on the selected deployment
-configuration; the steps listed in this section are for the default servlet
-configuration.
-ifdef::web[]
-See <<dummy/../../../framework/portal/portal-overview.asciidoc#portal.overview,"Portal Integration">> for instructions regarding the use of Vaadin with portals.
-endif::web[]
-
-[guilabel]#Vaadin version#:: Select the Vaadin version to use. The drop-down list shows, by default, the
-latest available version of Vaadin. The selection includes nightly
-[literal]#++SNAPSHOT++# builds, if you want to keep up with the absolutely
-latest unstable versions.
-
-+
-You can change the version later in the [filename]#ivy.xml#.
-
-[guilabel]#Create TestBench test#:: When enabled, the application stub will include a test case for testing the UI
-with Vaadin TestBench, as described in
-<<dummy/../../../testbench/testbench-overview.asciidoc#testbench.overview,"Vaadin TestBench">>.
-Vaadin TestBench API library will be included in [filename]#ivy.xml# as a dependency.
-Vaadin version 7.3 or later is required to create the stub.
-
-+
-You can click [guibutton]#Finish# here to use the defaults for the rest of the
-settings, or click [guibutton]#Next#.
-
-. The settings in the [guilabel]#Web Module# step define the basic web application
-(WAR) deployment settings and the structure of the web application project. All
-the settings are pre-filled, and you should normally accept them as they are.
-
-+
-image::img/myproject-ivy-web.png[scaledwidth=100%]
-
-[guilabel]#Context Root#:: The context root (of the application) identifies the application in the URL used
-for accessing it. For example, if the project has a [literal]#++myproject++#
-context and a single UI at the context root, the URL would be
-http://example.com/myproject. The wizard will suggest the project name given in
-the first step as the context name. You can change the context root later in the
-Eclipse project properties.
-
-[guilabel]#Content Directory#:: The directory containing all the content to be included in the web application
-(WAR) that is deployed to the web server. The directory is relative to the root
-directory of the project.
-
-+
-You can just accept the defaults and click [guibutton]#Next#.
-
-. The [guilabel]#Vaadin project# step page has various Vaadin-specific application settings.
-If you are trying out Vaadin for the first time, you should not need
-to change anything. You can set most of the settings afterwards, except the
-creation of the portlet configuration.
-+
-image::img/myproject-vaadin.png[scaledwidth=100%]
-
-[guilabel]#Create project template#:: Make the wizard create an UI class stub.
-
-[guilabel]#Application Name#:: A name for the application UI, shown in the title bar of the browser window.
-
-[guilabel]#Base package name#:: The name of the Java package under which the UI class of the application is to
-be placed.
-
-[guilabel]#Application/UI class name#:: The name of the UI class for the application, in which the user interface is
-developed.
-
-[guilabel]#Portlet version#:: When a portlet version is selected (only Portlet 2.0 is supported), the wizard
-will create the files needed for running the application in a portal. See
-<<dummy/../../../framework/portal/portal-overview.asciidoc#portal.overview,"Portal
-Integration">> for more information on portlets.
-
-+
-Finally, click [guibutton]#Finish# to create the project.
-
-[[getting-started.first-project.exploring]]
-== Exploring the Project
-
-After the [guilabel]#New Project# wizard exits, it has done all the work for
-you: an UI class skeleton has been written to [filename]#src# directory and the
-[filename]#WebContent/WEB-INF/web.xml# contains a deployment descriptor. The
-project hierarchy shown in the Project Explorer is shown in
-<<figure.getting-started.first-project.exploring>>.
-
-[[figure.getting-started.first-project.exploring]]
-.A New Vaadin Project
-image::img/myproject-ivy-created.png[width=40%, scaledwidth=60%]
-
-The Vaadin libraries and other dependencies are managed by Ivy. Notice that the
-libraries are not stored under the project folder, even though they are listed
-in the "Java Resources > Libraries > ivy.xml" virtual folder.
-
-[[getting-started.first-project.exploring.ui]]
-=== The UI Class
-
-The UI class created by the plugin contains the following code:
-
-[source, java]
-----
-package com.example.myproject;
-
-import com.vaadin.ui.UI;
-...
-
-@SuppressWarnings("serial")
-@Theme("myproject")
-public class MyprojectUI extends UI {
-
- @WebServlet(value = "/*", asyncSupported = true)
- @VaadinServletConfiguration(
- productionMode = false,
- ui = MyprojectUI.class)
- public static class Servlet extends VaadinServlet {
- }
-
- @Override
- protected void init(VaadinRequest request) {
- final VerticalLayout layout = new VerticalLayout();
- layout.setMargin(true);
- setContent(layout);
-
- Button button = new Button("Click Me");
- button.addClickListener(new Button.ClickListener() {
- public void buttonClick(ClickEvent event) {
- layout.addComponent(
- new Label("Thank you for clicking"));
- }
- });
- layout.addComponent(button);
- }
-}
-----
-
-In a Servlet 3.0 project, the deployment is configured with servlet class and a
-[literal]#++@WebServlet++# annotation. The stub includes the servlet class as a
-static inner class. You may want to refactor it to a separate normal class.
-
-In a Servlet 2.3 project, you would have a [filename]#web.xml# deployment
-descriptor.
-
-For a more detailed treatment of the deployment, see
-<<dummy/../../../framework/application/application-environment#application.environment.web-xml,"Using a web.xml Deployment Descriptor">>.
-endif::web[]
-
[[getting-started.first-project.creation]]
== Creating a Maven Project
-ifdef::web[]
-NOTE: The following describes project creation in the upcoming version of the Eclipse plug-in, which creates Maven rather than Ivy projects.
-To use it, you must have installed the experimental version of the plug-in.
-endif::web[]
-
Let us create the first application project with the tools installed in the previous section.
First, launch Eclipse and follow the following steps:
. Start creating a new project by selecting from the menu "File > New > Project...".
-. In the [guilabel]#New Project# window that opens, select "Vaadin > Vaadin 7
+. In the [guilabel]#New Project# window that opens, select "Vaadin > Vaadin 8
Project (Maven)" and click [guibutton]#Next#.
+
image::img/myproject-new-vaadin.png[width=70%, scaledwidth=90%]
@@ -304,14 +104,11 @@ public class MyUI extends UI {
name.setCaption("Type your name here:");
Button button = new Button("Click Me");
- button.addClickListener( e -> {
+ button.addClickListener(e ->
layout.addComponent(new Label("Thanks " + name.getValue()
- + ", it works!"));
- });
+ + ", it works!")));
layout.addComponents(name, button);
- layout.setMargin(true);
- layout.setSpacing(true);
setContent(layout);
}
@@ -377,36 +174,16 @@ Follow the following steps:
. Switch to the [guilabel]#Servers# tab in the lower panel in Eclipse.
List of servers should be empty after Eclipse is installed.
Right-click on the empty area in the panel and select "New > Server".
-ifdef::web[]
-+
-image::img/tomcat-startserver-1.png[width=60%, scaledwidth=100%]
-endif::web[]
-. Select "Apache > Tomcat v7.0 Server" and set [guilabel]#Server's host name# as [literal]#++localhost++#, which should be the default. If you have only one Tomcat installed, [guilabel]#Server runtime# has only one choice. Click [guibutton]#Next#.
-ifdef::web[]
-+
-image::img/tomcat-startserver-2.png[width=60%, scaledwidth=100%]
-endif::web[]
+. Select "Apache > Tomcat v8.0 Server" and set [guilabel]#Server's host name# as [literal]#++localhost++#, which should be the default. If you have only one Tomcat installed, [guilabel]#Server runtime# has only one choice. Click [guibutton]#Next#.
. Add your project to the server by selecting it on the left and clicking [guibutton]#Add# to add it to the configured projects on the right. Click [guibutton]#Finish#.
-ifdef::web[]
-+
-image::img/tomcat-startserver-3.png[width=60%, scaledwidth=100%]
-endif::web[]
. The server and the project are now installed in Eclipse and are shown in the [guilabel]#Servers# tab.
To start the server, right-click on the server and select [guilabel]#Debug#.
To start the server in non-debug mode, select [guilabel]#Start#.
-ifdef::web[]
-+
-image::img/tomcat-startserver-4.png[width=60%, scaledwidth=100%]
-endif::web[]
. The server starts and the WebContent directory of the project is published to the server on http://localhost:8080/myproject/.
-ifdef::web[]
-+
-image::img/tomcat-startserver-5.png[width=60%, scaledwidth=100%]
-endif::web[]
[[getting-started.first-project.run]]
== Running and Debugging
@@ -415,13 +192,6 @@ Starting your application is as easy as selecting [guilabel]#myproject# from the
[guilabel]#Project Explorer# and then "Run > Debug As > Debug on Server".
Eclipse then opens the application in built-in web browser.
-////
-// This is rather irrelevant
-//
-.Running a Vaadin Application
-image::img/runningMyProject.png[width=60%, scaledwidth=80%]
-////
-
You can insert break points in the Java code by double-clicking on the left
margin bar of the source code window. For example, if you insert a breakpoint in
the [methodname]#buttonClick()# method and click the [guibutton]#What is the
@@ -438,15 +208,9 @@ Debugging client-side applications and widgets is described in
<<dummy/../../../framework/clientside/clientside-debugging#clientside.debugging,"Debugging Client-Side Code">>.
[[getting-started.eclipse.mavenlibraryupdate]]
-ifdef::web[]
-== Updating the Vaadin Libraries in Maven Projects
-endif::web[]
-// The book only describes Maven projects
-ifndef::web[]
-== Updating the Vaadin Libraries
-endif::web[]
-
-Updating the Vaadin plugin does not update Vaadin libraries. The libraries are
+== Updating the Vaadin Framework Libraries
+
+Updating the Vaadin plugin does not update Vaadin Framework libraries. The libraries are
project specific, as a different version might be required for different
projects, so you have to update them separately for each project.
@@ -468,45 +232,3 @@ right-clicking the server and selecting [guilabel]#Clean# as well as
If you experience problems after updating the libraries, you can try using
"Maven > Update Project".
-
-ifdef::web[]
-[[getting-started.eclipse.libraryupdate]]
-== Updating the Vaadin Libraries in Ivy Projects
-
-Updating the Vaadin plugin does not update Vaadin libraries.
-The libraries are project specific, as a different version might be required for different projects, so you have to update them separately for each project.
-
-. Open the [filename]#ivy.xml# in an editor in Eclipse.
-
-. Edit the entity definition at the beginning of the file to set the Vaadin
-version.
-+
-[subs="normal"]
-----
-&lt;!ENTITY vaadin.version "**8.x.x**"&gt;
-----
-+
-You can specify either a fixed version number, as shown in the above example, or
-a dynamic revision tag such as [literal]#++latest.release++#.
-You can find more information about the dependency declarations in Ivy documentation.
-
-. Right-click the project and select "Ivy > Resolve".
-+
-Updating the libraries can take several minutes. You can see the progress in the
-Eclipse status bar. You can get more details about the progress by clicking the
-indicator.
-
-. If you have compiled the widget set for your project, recompile it by clicking the *Compile Vaadin Widgetset* button in Eclipse toolbar.
-+
-image::img/myproject-compilewidgetset.png[width=50%, scaledwidth=60%]
-
-. Stop the integrated Tomcat (or other server) in Eclipse, clear its caches by
-right-clicking the server and selecting Clean as well as Clean Tomcat Work
-Directory, and restart it.
-
-If you experience problems after updating the libraries, you can try clearing
-the Ivy resolution caches by right-clicking the project and selecting "Ivy >
-Clean all caches".
-Then, do the "Ivy > Resolve" and other tasks again.
-
-endif::web[]
diff --git a/documentation/getting-started/getting-started-idea.asciidoc b/documentation/getting-started/getting-started-idea.asciidoc
index e3e648ff6c..d68b60e1c1 100644
--- a/documentation/getting-started/getting-started-idea.asciidoc
+++ b/documentation/getting-started/getting-started-idea.asciidoc
@@ -11,13 +11,6 @@ The Ultimate Edition of IntelliJ IDEA includes support for creating Vaadin appli
With the Community Edition, you can create a Vaadin application most easily with a Maven archetype and deploy it to a server with a Maven run/debug configuration.
-ifdef::web[]
-For more information, see the article "
-link:http://wiki.jetbrains.net/intellij/Creating_a_simple_Web_application_and_deploying_it_to_Tomcat[Creating
-a simple Web application and deploying it to Tomcat]" in the IntelliJ IDEA
-Encyclopedia wiki.
-endif::web[]
-
[[getting-started.idea.project]]
== Creating a Vaadin Web Application Project
@@ -39,7 +32,7 @@ image::img/idea-newproject-1.png[scaledwidth=100%]
+
Click [guibutton]#Next#.
-. Select "Web Application > Vaadin" to add Vaadin technology to the project.
+. Select "Web Application > Vaadin" to add Vaadin Framework to the project.
. Select Vaadin [guilabel]#Version# and [guilabel]#Distribution# installation
path. You probably also want an application stub, so select [guilabel]#Create
@@ -52,11 +45,6 @@ Do __not__ click [guibutton]#Finish# yet.
. Select [guilabel]#Application Server# in the same window.
Set it as an integrated server that you have configured in IntelliJ IDEA, as described previously in <<DUMMY/../../../framework/installing/installing-idea#installing.idea.ultimate.server, "Configuring an Application Server">>.
-ifdef::web[]
-+
-image::img/idea-newproject-3.png[scaledwidth=100%]
-endif::web[]
-
. Click [guibutton]#Finish#.
The project is created with the UI class stub and a [filename]#web.xml#
@@ -111,22 +99,12 @@ enter [guilabel]#GroupId# [literal]#++com.vaadin++#, [guilabel]#ArtifactId#
[literal]#++vaadin-archetype-application++#, and [guilabel]#Version#
[literal]#++LATEST++# (or a specific version number).
-ifdef::web[]
-+
-image::img/idea-maven-newproject-3.png[]
-endif::web[]
-
+
Click [guibutton]#OK# in the dialog.
//&lt;?dbfo-need height="8cm" ?&gt;
. Select the [literal]#++com.vaadin:vaadin-archetype-application++#.
-ifdef::web[]
-+
-image::img/idea-maven-newproject-4.png[]
-endif::web[]
-
+
Click [guibutton]#Next#.
//&lt;?dbfo-need height="8cm" ?&gt;
@@ -134,10 +112,6 @@ Click [guibutton]#Next#.
. Review the general Maven settings and settings for the new project.
You may need to override the settings, especially if you are creating a Maven project for the first time.
-ifdef::web[]
-+
-image::img/idea-maven-newproject-5.png[]
-endif::web[]
+
Click [guibutton]#Finish#.
@@ -179,22 +153,12 @@ launch a Vaadin Maven application on the light-weight Jetty web server.
. Enter a [guilabel]#Name# for the run configuration.
For the [guilabel]#Command line#, enter "`package jetty:run`# to first compile and package the project, and then launch Jetty to run it.
-ifdef::web[]
-+
-image::img/idea-maven-run-1.png[]
-endif::web[]
-
+
Click [guibutton]#OK#.
. Select the run configuration in the toolbar and click the [guibutton]#Run#
button beside it.
-ifdef::web[]
-+
-image::img/idea-maven-run-2.png[]
-endif::web[]
-
Compiling the project takes some time on the first time, as it compiles the
widget set and theme. Once the run console pane informs that Jetty Server has
diff --git a/documentation/getting-started/getting-started-libraries.asciidoc b/documentation/getting-started/getting-started-libraries.asciidoc
index 7e9f2ac899..39802e91b0 100644
--- a/documentation/getting-started/getting-started-libraries.asciidoc
+++ b/documentation/getting-started/getting-started-libraries.asciidoc
@@ -7,7 +7,7 @@ layout: page
[[getting-started.libraries]]
= Vaadin Libraries
-Vaadin comes as a set of library JARs, of which some are optional or alternative
+Vaadin Framework comes as a set of library JARs, of which some are optional or alternative
ones, depending on whether you are developing server-side or client-side
applications, whether you use add-on components, or use CSS or Sass themes.
@@ -17,12 +17,24 @@ The main library for developing server-side Vaadin applications, as described in
It requires the [filename]#vaadin-shared# and the [filename]#vaadin-themes# libraries.
You can use the pre-built [filename]#vaadin-client-compiled# for server-side development, unless you need add-on components or custom widgets.
+[filename]#vaadin-themes-8.x.x.jar#::
+Vaadin Framework built-in themes both as SCSS source files and precompiled CSS files.
+The library is required both for basic use with CSS themes and for compiling custom Sass themes.
+
+[filename]#vaadin-push-8.x.x.jar#::
+The implementation of server push for Vaadin Framework.
+This is needed for web applications which use server push (e.g. using the @Push annotation in a Servlet class).
+
[filename]#vaadin-shared-8.x.x.jar#::
A shared library for server-side and client-side development.
It is always needed.
+[filename]#vaadin-client-compiled-8.x.x.jar#::
+A pre-compiled Vaadin Client-Side Engine (widget set) that includes all the basic built-in widgets in Vaadin.
+This library is not needed if you compile the application widget set with the Vaadin Client Compiler.
+
[filename]#vaadin-client-8.x.x.jar#::
-The client-side Vaadin framework, including the basic GWT API and Vaadin-specific widgets and other additions.
+The client-side Vaadin Framework, including the basic GWT API and Vaadin-specific widgets and other additions.
It is required when using the [filename]#vaadin-client-compiler# to compile client-side modules.
It is not needed if you just use the server-side framework with the pre-compiled Client-Side Engine.
You should not deploy it with a web application.
@@ -31,26 +43,16 @@ You should not deploy it with a web application.
The Vaadin Client Compiler is a Java-to-JavaScript compiler that allows building client-side modules, such as the Client-Side Engine (widget set) required for server-side applications.
The compiler is needed, for example, for compiling add-on components to the application widget set, as described in <<dummy/../../../framework/addons/addons-overview.asciidoc#addons.overview,"Using Vaadin Add-ons">>.
+
-//TODO There's a need for such section.
For detailed information regarding the compiler, see
<<dummy/../../../framework/clientside/clientside-compiling#clientside.compiling,"Compiling a Client-Side Module">>.
Note that you should not deploy this library with a web application.
-[filename]#vaadin-client-compiled-8.x.x.jar#::
-A pre-compiled Vaadin Client-Side Engine (widget set) that includes all the basic built-in widgets in Vaadin.
-This library is not needed if you compile the application widget set with the Vaadin Client Compiler.
-
-[filename]#vaadin-themes-8.x.x.jar#::
-Vaadin built-in themes both as SCSS source files and precompiled CSS files.
-The library is required both for basic use with CSS themes and for compiling custom Sass themes.
-
-[filename]#vaadin-push-8.x.x.jar#::
-The implementation of server push for Vaadin.
-This is needed for web applications which use server push (e.g. using the @Push annotation in a Servlet class).
+[filename]#vaadin-compatibility-*-8.x.x.jar#::
+The Vaadin Framework 7 compatibility packages contain the components and themes that are present in framework version 7, but not in version 8. These packages exist for making it easier to migrate from version 7 to 8. There is a compatibility package for everything except [filename]#vaadin-client-compiler#.
-Some of the libraries depend on each other as well as on the dependency libraries provided in the [filename]#lib# folder of the installation package, especially the [filename]#lib/vaadin-shared-deps.jar#.
+Some of the libraries depend on each other, for instance [filename]#vaadin-shared# is included as a dependency of [filename]#vaadin-server#.
The different ways to install the libraries are described in the subsequent sections.
-Note that the [filename]#vaadin-client-compiler# and [filename]#vaadin-client# JARs should not be deployed with the web application by including them in [filename]#WEB-INF/lib#.
+Note that the [filename]#vaadin-client-compiler# and [filename]#vaadin-client# JARs should not be deployed with the web application. The Maven scope [filename]#provided# can be used.
Some other libraries, such as [filename]#vaadin-sass-compiler#, are not needed in production deployment.
diff --git a/documentation/getting-started/getting-started-maven.asciidoc b/documentation/getting-started/getting-started-maven.asciidoc
index aca26b8115..387c1318c1 100644
--- a/documentation/getting-started/getting-started-maven.asciidoc
+++ b/documentation/getting-started/getting-started-maven.asciidoc
@@ -16,8 +16,6 @@ You can then import such a project in your IDE.
In addition to regular Maven, you can use any Maven-compatible build or
dependency management system, such as Ivy or Gradle. For Gradle, see the
link:https://github.com/johndevs/gradle-vaadin-plugin[Gradle Vaadin Plugin].
-Vaadin Plugin for Eclipse uses Ivy for resolving dependencies in Vaadin
-projects, and it should provide you with the basic Ivy configuration.
For an interactive guide, see the instructions at link:https://vaadin.com/maven[vaadin.com/maven].
It automatically generates you the command to create a new project based on archetype selection.
@@ -50,8 +48,7 @@ See the list of available archetypes in <<dummy/../../../framework/getting-start
[parameter]#archetypeVersion#::
Version of the archetype to use.
-This should be [literal]#++LATEST++# for normal Vaadin releases.
-For prerelease versions it should be the exact version number, such as [literal]#++7.6.4++#.
+For prerelease versions it should be the exact version number, such as [literal]#++8.0.0.beta2++#.
[parameter]#groupId#:: A Maven group ID for your project. It is normally your organization domain name
in reverse order, such as com.example. The group ID is also used as a prefix for
@@ -71,14 +68,7 @@ version numbering format.
-Creating a project can take a while as Maven fetches all the dependencies. The
-created project structure is shown in
-<<figure.getting-started.maven.archetype.created>>.
-
-[[figure.getting-started.maven.archetype.created]]
-.A New Vaadin Project with Maven
-image::img/maven-project-created.png[scaledwidth=60%]
-
+Creating a project can take a while as Maven fetches all the dependencies.
[[getting-started.maven.compiling]]
== Compiling and Running the Application
diff --git a/documentation/getting-started/getting-started-overview.adoc b/documentation/getting-started/getting-started-overview.adoc
index 6adde0a9b4..3cf8b870f4 100644
--- a/documentation/getting-started/getting-started-overview.adoc
+++ b/documentation/getting-started/getting-started-overview.adoc
@@ -7,16 +7,15 @@ layout: page
[[getting-started.overview]]
= Overview
-Once you have installed a development environment, as described in the previous chapter, creating a Vaadin project proceeds in the IDE that you have chosen.
+Once you have installed a development environment, as described in the previous chapter, creating a Vaadin Framework project proceeds in the IDE that you have chosen.
-The Vaadin core library and all Vaadin add-ons are available through Maven, a commonly used build and dependency management system.
+The Vaadin Framework core library and all Vaadin add-ons are available through Maven, a commonly used build and dependency management system.
The recommended way to create a Vaadin application project is to use a Maven archetype.
The archetypes contain all the needed dependencies, which Maven takes care of.
-The Eclipse IDE plugin currently also supports creating a normal Eclipse web project using the Ivy dependency manager.
In this chapter, we:
-* Give an overview of the Vaadin libraries
+* Give an overview of the Vaadin Framework libraries
* List the available Maven archetypes
* Give step-by-step instructions for creating a project in the Eclipse IDE, NetBeans IDE, and IntelliJ IDEA, as well as with command-line.
diff --git a/documentation/getting-started/getting-started-package.asciidoc b/documentation/getting-started/getting-started-package.asciidoc
index a5bcedb3fc..982fa36277 100644
--- a/documentation/getting-started/getting-started-package.asciidoc
+++ b/documentation/getting-started/getting-started-package.asciidoc
@@ -10,43 +10,5 @@ layout: page
While the recommended way to create a Vaadin project and install the libraries is to use an IDE plugin or a dependency management system, such as Maven, Vaadin is also available as a ZIP distribution package.
You can download the newest Vaadin installation package from the download page
-at http://vaadin.com/download/. Please use a ZIP decompression utility available
+at https://vaadin.com/download/. Please use a ZIP decompression utility available
in your operating system to extract the files from the ZIP package.
-
-[[getting-started.package.contents]]
-== Package Contents
-
-[filename]#README.TXT#:: This README file gives simple instructions for installing Vaadin in your project.
-
-[filename]#release-notes.html#:: The Release Notes contain information about the new features in the particular release, give upgrade instructions, describe compatibility, etc.
-Please open the HTML file with a web browser.
-
-[filename]#license.html#:: Apache License version 2.0.
-Please open the HTML file with a web browser.
-
-[filename]#lib# folder:: All dependency libraries required by Vaadin are contained within the [filename]#lib# folder.
-
-[filename]#*.jar#:: Vaadin libraries, as described in <<getting-started-libraries#getting-started.libraries,"Overview of Vaadin Libraries">>.
-
-
-[[getting-started.package.install]]
-== Installing the Libraries
-
-You can install the Vaadin ZIP package in a few simple steps:
-
-. Copy the JAR files at the package root folder to the [filename]#WEB-APP/lib# web
-library folder in the project. Some of the libraries are optional, as explained
-in
-<<dummy/../../../framework/getting-started/getting-started-libraries#getting-started.libraries,"Overview
-of Vaadin Libraries">>.
-
-. Also copy the dependency JAR files at the [filename]#lib# folder to the
-[filename]#WEB-APP/lib# web library folder in the project.
-
-
-The location of the [filename]#WEB-APP/lib# folder depends on the project
-organization, which depends on the development environment.
-
-* In Eclipse Dynamic Web Application projects: [filename]#WebContent/WEB-INF/lib#.
-
-* In Maven projects: [filename]#src/main/webapp/WEB-INF/lib#.
diff --git a/documentation/getting-started/getting-started-scala.asciidoc b/documentation/getting-started/getting-started-scala.asciidoc
index f31a16b1e8..85d4bec191 100644
--- a/documentation/getting-started/getting-started-scala.asciidoc
+++ b/documentation/getting-started/getting-started-scala.asciidoc
@@ -34,7 +34,7 @@ of the application server. If copying outside Eclipse to a project, refresh the
project by selecting it and pressing kbd:[F5].
+
-You could also get it with an Ivy or Maven dependency, just make sure that the
+You could also get it with a Maven dependency, just make sure that the
version is same as what the Scala IDE uses.
diff --git a/documentation/getting-started/img/idea-maven-newproject-3.png b/documentation/getting-started/img/idea-maven-newproject-3.png
deleted file mode 100644
index b0b56b311a..0000000000
--- a/documentation/getting-started/img/idea-maven-newproject-3.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/idea-maven-newproject-4.png b/documentation/getting-started/img/idea-maven-newproject-4.png
deleted file mode 100644
index 9dc571499f..0000000000
--- a/documentation/getting-started/img/idea-maven-newproject-4.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/idea-maven-newproject-5.png b/documentation/getting-started/img/idea-maven-newproject-5.png
deleted file mode 100644
index 1e22e8d6d8..0000000000
--- a/documentation/getting-started/img/idea-maven-newproject-5.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/idea-maven-run-1.png b/documentation/getting-started/img/idea-maven-run-1.png
deleted file mode 100644
index 976711c36a..0000000000
--- a/documentation/getting-started/img/idea-maven-run-1.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/idea-maven-run-2.png b/documentation/getting-started/img/idea-maven-run-2.png
deleted file mode 100644
index a567bb6661..0000000000
--- a/documentation/getting-started/img/idea-maven-run-2.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/idea-newproject-3.png b/documentation/getting-started/img/idea-newproject-3.png
deleted file mode 100644
index fe35a7c787..0000000000
--- a/documentation/getting-started/img/idea-newproject-3.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/ivyde-install-available.png b/documentation/getting-started/img/ivyde-install-available.png
deleted file mode 100644
index 9b8500c356..0000000000
--- a/documentation/getting-started/img/ivyde-install-available.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/maven-project-created.png b/documentation/getting-started/img/maven-project-created.png
deleted file mode 100644
index 075e2e49ea..0000000000
--- a/documentation/getting-started/img/maven-project-created.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/myproject-ivy-created.png b/documentation/getting-started/img/myproject-ivy-created.png
deleted file mode 100644
index 0cebb5f0db..0000000000
--- a/documentation/getting-started/img/myproject-ivy-created.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/myproject-ivy-new-vaadin.png b/documentation/getting-started/img/myproject-ivy-new-vaadin.png
deleted file mode 100644
index e2243d5c1a..0000000000
--- a/documentation/getting-started/img/myproject-ivy-new-vaadin.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/myproject-ivy-settings.png b/documentation/getting-started/img/myproject-ivy-settings.png
deleted file mode 100644
index 20d4509317..0000000000
--- a/documentation/getting-started/img/myproject-ivy-settings.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/myproject-ivy-vaadin.png b/documentation/getting-started/img/myproject-ivy-vaadin.png
deleted file mode 100644
index fff616e6fe..0000000000
--- a/documentation/getting-started/img/myproject-ivy-vaadin.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/myproject-ivy-web.png b/documentation/getting-started/img/myproject-ivy-web.png
deleted file mode 100644
index ae47d37c0f..0000000000
--- a/documentation/getting-started/img/myproject-ivy-web.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/runningMyProject.png b/documentation/getting-started/img/runningMyProject.png
deleted file mode 100644
index 0e1617366d..0000000000
--- a/documentation/getting-started/img/runningMyProject.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/tomcat-startserver-1.png b/documentation/getting-started/img/tomcat-startserver-1.png
deleted file mode 100644
index 8120911a0a..0000000000
--- a/documentation/getting-started/img/tomcat-startserver-1.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/tomcat-startserver-2.png b/documentation/getting-started/img/tomcat-startserver-2.png
deleted file mode 100644
index 1ae1ef5c1a..0000000000
--- a/documentation/getting-started/img/tomcat-startserver-2.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/tomcat-startserver-3.png b/documentation/getting-started/img/tomcat-startserver-3.png
deleted file mode 100644
index d9e4e3d2b9..0000000000
--- a/documentation/getting-started/img/tomcat-startserver-3.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/tomcat-startserver-4.png b/documentation/getting-started/img/tomcat-startserver-4.png
deleted file mode 100644
index 68ddcafe6a..0000000000
--- a/documentation/getting-started/img/tomcat-startserver-4.png
+++ /dev/null
Binary files differ
diff --git a/documentation/getting-started/img/tomcat-startserver-5.png b/documentation/getting-started/img/tomcat-startserver-5.png
deleted file mode 100644
index 55d1425f9b..0000000000
--- a/documentation/getting-started/img/tomcat-startserver-5.png
+++ /dev/null
Binary files differ