summaryrefslogtreecommitdiffstats
path: root/documentation/getting-started
diff options
context:
space:
mode:
authorMarko Gronroos <magi@vaadin.com>2016-03-18 15:52:20 +0200
committerMarko Gronroos <magi@vaadin.com>2016-03-18 15:52:20 +0200
commitef406ae250aa650a52111a60369d9f0796714b00 (patch)
tree79382008db7aec388bfdc41ea8885230fbefad64 /documentation/getting-started
parent3db9dc11b20c8c3ea256cd20478c70b07642cea7 (diff)
downloadvaadin-framework-ef406ae250aa650a52111a60369d9f0796714b00.tar.gz
vaadin-framework-ef406ae250aa650a52111a60369d9f0796714b00.zip
Fixed some missing images and broken xrefs, as well as problems in the getting-started chapter (#19639).
Change-Id: Ie8e371c059f70600bafcf781938ef35878f41324
Diffstat (limited to 'documentation/getting-started')
-rw-r--r--documentation/getting-started/getting-started-archetypes.asciidoc2
-rw-r--r--documentation/getting-started/getting-started-maven.asciidoc32
-rw-r--r--documentation/getting-started/getting-started-netbeans.asciidoc20
-rw-r--r--documentation/getting-started/img/netbeans-created-annotated-hi.pngbin99367 -> 100861 bytes
-rw-r--r--documentation/getting-started/original-drawings/netbeans-created-annotated.svg2
5 files changed, 21 insertions, 35 deletions
diff --git a/documentation/getting-started/getting-started-archetypes.asciidoc b/documentation/getting-started/getting-started-archetypes.asciidoc
index fbb75093e1..18d1eda56d 100644
--- a/documentation/getting-started/getting-started-archetypes.asciidoc
+++ b/documentation/getting-started/getting-started-archetypes.asciidoc
@@ -27,7 +27,7 @@ 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/touchkit-overview#touchkit.overview,"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`::
diff --git a/documentation/getting-started/getting-started-maven.asciidoc b/documentation/getting-started/getting-started-maven.asciidoc
index 79f3b2febb..5d4618cb94 100644
--- a/documentation/getting-started/getting-started-maven.asciidoc
+++ b/documentation/getting-started/getting-started-maven.asciidoc
@@ -46,34 +46,12 @@ The parameters are as follows:
archetypes.
[parameter]#archetypeArtifactId#:: The archetype ID.
-Vaadin 7 currently supports the following archetypes:
+See the list of available archetypes in <<dummy/../../../framework/getting-started-archetypes#getting-started.archetypes,"Overview of Maven Archetypes">>.
-`vaadin-archetype-application`;;
-A single-module project for simple applications.
-Good for quick demos and trying out Vaadin.
-
-`vaadin-archetype-application-multimodule`;;
-A complete Vaadin 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.
-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/touchkit-overview#touchkit.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.
-
-[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.5.3++#.
+[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++#.
[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
diff --git a/documentation/getting-started/getting-started-netbeans.asciidoc b/documentation/getting-started/getting-started-netbeans.asciidoc
index eff1697243..f5fa0afb14 100644
--- a/documentation/getting-started/getting-started-netbeans.asciidoc
+++ b/documentation/getting-started/getting-started-netbeans.asciidoc
@@ -59,7 +59,7 @@ Creating the project can take a while as Maven loads all the needed
dependencies.
[[getting-started.netbeans.exploring]]
-== Exploring a Project
+== Exploring the Project
The project wizard has done all the work for you: a UI class skeleton has been written to the [filename]#src# directory.
The project hierarchy shown in the Project Explorer is shown in <<figure.getting-started.netbeans.exploring>>.
@@ -68,6 +68,14 @@ The project hierarchy shown in the Project Explorer is shown in <<figure.getting
.A new Vaadin project in NetBeans
image::img/netbeans-created-annotated-hi.png[width=80%]
+[filename]#mytheme#::
+The theme of the UI.
+See <<DUMMY/../../../framework/themes/themes-overview#themes.overview, "Themes">> for information about themes.
+
+[filename]#MyUI.java#::
+The UI class, which is the main entry-point of your application.
+See <<DUMMY/../../../framework/application/application-overview#application.overview, "Server-Side Applications">> for information about the basic structure of Vaadin applications.
+
The Vaadin libraries and other dependencies are managed by Maven.
Notice that the libraries are not stored under the project folder, even though they are listed in the "Java Resources > Libraries > Maven Dependencies" virtual folder.
@@ -78,16 +86,16 @@ Once created, you can run it in a server as follows.
. In [guilabel]#Projects# tab, select the project and click in the [guilabel]#Run Project# button in the tool bar (or press kbd:[F6]).
-. In the [guilabel]#Select deployment server#, select a server from the [guilabel]#Server# list.
-It should show either GlassFish or Apache Tomcat, depending on what you chose in NetBeans installation.
+. In the [guilabel]#Select deployment server# window, select a server from the [guilabel]#Server# list.
+It should show either GlassFish or Apache Tomcat or both, depending on what you chose in NetBeans installation.
+
-image::img/netbeans-server.png[width=60%]
+image::img/netbeans-server.png[width=75%]
+
Also, select [guilabel]#Remember Permanently# if you want to use the same server also in future while developing applications.
+
Click [guibutton]#OK#.
-.
-It will compile the widget set at this point, which may take a while.
++
+The widget set will be compiled at this point, which may take a while.
If all goes well, NetBeans starts the server in port 8080 and, depending on your
system configuration, launches the default browser to display the web
diff --git a/documentation/getting-started/img/netbeans-created-annotated-hi.png b/documentation/getting-started/img/netbeans-created-annotated-hi.png
index fd94e88321..5abea08c58 100644
--- a/documentation/getting-started/img/netbeans-created-annotated-hi.png
+++ b/documentation/getting-started/img/netbeans-created-annotated-hi.png
Binary files differ
diff --git a/documentation/getting-started/original-drawings/netbeans-created-annotated.svg b/documentation/getting-started/original-drawings/netbeans-created-annotated.svg
index 3b87ce23e0..ae0176f25b 100644
--- a/documentation/getting-started/original-drawings/netbeans-created-annotated.svg
+++ b/documentation/getting-started/original-drawings/netbeans-created-annotated.svg
@@ -297,7 +297,7 @@
sodipodi:role="line"
id="tspan13163-0"
x="354.74399"
- y="839.23932">The widget set</tspan></text>
+ y="839.23932">The widget set definition</tspan></text>
<text
xml:space="preserve"
style="font-size:16px;font-style:normal;font-variant:normal;font-weight:300;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Helvetica LT Std;-inkscape-font-specification:Helvetica LT Std Light"