aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/architecture
diff options
context:
space:
mode:
authorZhe Sun <31067185+ZheSun88@users.noreply.github.com>2019-05-23 09:43:31 +0300
committerGitHub <noreply@github.com>2019-05-23 09:43:31 +0300
commit0b7457325200162961cae52e7d871db928dc3cd9 (patch)
tree880bbb73259b135e53ee753c2591099e480c70f4 /documentation/architecture
parentbb4898cdfb4f5d2bd34904eb1920b837ac9a3c37 (diff)
downloadvaadin-framework-0b7457325200162961cae52e7d871db928dc3cd9.tar.gz
vaadin-framework-0b7457325200162961cae52e7d871db928dc3cd9.zip
Update broken docs syntax in github (#11596)
* Add delay to the unstable test * Add delay for unstable tests * Update broken docs syntax in github * Merge branch 'master' into ZheSun88-patch-1 * Update doc reference syntax * Merge branch 'ZheSun88-patch-1' of github.com:vaadin/framework into ZheSun88-patch-1 # Conflicts: # documentation/components/components-overview.asciidoc * Merge branch 'master' into ZheSun88-patch-1 * use .asciidoc * Merge remote-tracking branch 'origin/ZheSun88-patch-1' into ZheSun88-patch-1 * use .asciidoc * Merge branch 'master' into ZheSun88-patch-1
Diffstat (limited to 'documentation/architecture')
-rw-r--r--documentation/architecture/architecture-client-side.asciidoc6
-rw-r--r--documentation/architecture/architecture-events.asciidoc2
-rw-r--r--documentation/architecture/architecture-overview.asciidoc18
-rw-r--r--documentation/architecture/architecture-technology.asciidoc12
-rw-r--r--documentation/architecture/chapter-architecture.asciidoc2
5 files changed, 20 insertions, 20 deletions
diff --git a/documentation/architecture/architecture-client-side.asciidoc b/documentation/architecture/architecture-client-side.asciidoc
index 63f62bcd63..2d62f912e5 100644
--- a/documentation/architecture/architecture-client-side.asciidoc
+++ b/documentation/architecture/architecture-client-side.asciidoc
@@ -24,9 +24,9 @@ and Vaadin-specific widgets. The two widget collections have significant
overlap, where the Vaadin widgets provide a bit different features than the GWT
widgets. In addition, many add-on widgets and their server-side counterparts
exist, and you can easily download and install them, as described in
-<<dummy/../../../framework/addons/addons-overview.asciidoc#addons.overview,"Using
+<<../addons/addons-overview.asciidoc#addons.overview,"Using
Vaadin Add-ons">>. You can also develop your own widgets, as described in
-<<dummy/../../../framework/clientside/clientside-overview.asciidoc#clientside.overview,"Client-Side
+<<../clientside/clientside-overview.asciidoc#clientside.overview,"Client-Side
Vaadin Development">>.
The rendering with widgets, as well as the communication to the server-side, is
@@ -36,5 +36,5 @@ each widget that has a server-side counterpart. The framework handles
serialization of component state transparently, and includes an RPC mechanism
between the two sides. Integration of widgets with their server-side counterpart
components is described in
-<<dummy/../../../framework/gwt/gwt-overview.asciidoc#gwt.overview,"Integrating
+<<../gwt/gwt-overview.asciidoc#gwt.overview,"Integrating
with the Server-Side">>.
diff --git a/documentation/architecture/architecture-events.asciidoc b/documentation/architecture/architecture-events.asciidoc
index 75da0f933c..6ffd5964f6 100644
--- a/documentation/architecture/architecture-events.asciidoc
+++ b/documentation/architecture/architecture-events.asciidoc
@@ -56,4 +56,4 @@ in this case the [classname]#Button#.
.Class Diagram of a Button Click Listener
image::img/events-classdiagram.png[width=80%, scaledwidth=100%]
-<<dummy/../../../framework/application/application-events#application.events,"Handling Events with Listeners">> goes into details of handling events in practice.
+<<../application/application-events#application.events,"Handling Events with Listeners">> goes into details of handling events in practice.
diff --git a/documentation/architecture/architecture-overview.asciidoc b/documentation/architecture/architecture-overview.asciidoc
index 9c873f3675..65ecab3ba6 100644
--- a/documentation/architecture/architecture-overview.asciidoc
+++ b/documentation/architecture/architecture-overview.asciidoc
@@ -51,7 +51,7 @@ task is to create the initial user interface out of UI components and set up
event listeners to handle user input. The UI can then be loaded in the browser
using an URL, or can be embedded to any HTML page. For detailed information
about implementing a [classname]#UI#, see
-<<dummy/../../../framework/application/application-overview.asciidoc#application.overview,"Writing
+<<../application/application-overview.asciidoc#application.overview,"Writing
a Server-Side Web Application">>.
+
@@ -69,7 +69,7 @@ client-side applications. The server-side components relay these events to the
application logic. Field components that have a value, which the user can view
or edit, can be bound to a data source (see below). For a more detailed
description of the UI component architecture, see
-<<dummy/../../../framework/components/components-overview.asciidoc#components.overview,"User
+<<../components/components-overview.asciidoc#components.overview,"User
Interface Components">>.
Client-Side Engine:: ((("Client-Side
@@ -82,12 +82,12 @@ browser by employing various client-side __widgets__, counterparts of the
server-side components. It communicates user interaction to the server-side, and
then again renders the changes in the UI. The communications are made using
asynchronous HTTP or HTTPS requests. See
-<<dummy/../../../framework/architecture/architecture-client-side#architecture.client-side,"Client-Side
+<<architecture-client-side#architecture.client-side,"Client-Side
Engine">>.
Vaadin Servlet:: ((("VaadinServlet")))
Server-side Vaadin applications work on top of the Java Servlet API (see
-<<dummy/../../../framework/architecture/architecture-technology#architecture.technology.servlet,"Java
+<<architecture-technology#architecture.technology.servlet,"Java
Servlets">>). The Vaadin servlet, or more exactly the [classname]#VaadinServlet#
class, receives requests from different clients, determines which user session
they belong to by tracking the sessions with cookies, and delegates the requests
@@ -105,14 +105,14 @@ defined in __themes__ as CSS or Sass. Vaadin provides a number of default
themes. User themes can, in addition to style sheets, include HTML templates
that define custom layouts and other resources, such as images and fonts. Themes
are discussed in detail in
-<<dummy/../../../framework/themes/themes-overview.asciidoc#themes.overview,"Themes">>.
+<<../themes/themes-overview.asciidoc#themes.overview,"Themes">>.
Events:: ((("events")))
Interaction with user interface components creates events, which are first
processed on the client-side by the widgets, then passed all the way through the
HTTP server, Vaadin servlet, and the user interface components to the event
listeners defined in the application. See
-<<dummy/../../../framework/architecture/architecture-events#architecture.events,"Events
+<<architecture-events#architecture.events,"Events
and Listeners">>.
Server Push:: ((("server
@@ -121,7 +121,7 @@ In addition to the event-driven programming model, Vaadin supports server push,
where the UI changes are pushed directly from the server to the client without a
client request or an event. This makes it possible to update UIs immediately
from other threads and other UIs, without having to wait for a request. See
-<<dummy/../../../framework/advanced/advanced-push#advanced.push,"Server Push">>.
+<<../advanced/advanced-push#advanced.push,"Server Push">>.
Data Binding:: ((("Data
Model")))
@@ -133,7 +133,7 @@ selection components, with a data source. Using data binding, the user interface
components can update the application data directly, often without the need for
any control code. For example, you can bind a data grid component to a backend query
response. For a complete overview of the data binding model, please refer to
-<<dummy/../../../framework/datamodel/datamodel-overview.asciidoc#datamodel.overview,"Binding
+<<../datamodel/datamodel-overview.asciidoc#datamodel.overview,"Binding
Components to Data">>.
Client-Side Applications:: In addition to server-side web applications, Vaadin supports client-side
@@ -143,7 +143,7 @@ They are useful when you have a need for highly responsive UI logic, such as for
games or for serving a large number of clients with possibly stateless
server-side code, and for various other purposes, such as offering an off-line
mode for server-side applications. Please see
-<<dummy/../../../framework/clientsideapp/clientsideapp-overview.asciidoc#clientsideapp.overview,"Client-Side
+<<../clientsideapp/clientsideapp-overview.asciidoc#clientsideapp.overview,"Client-Side
Applications">> for further details.
Back-end:: Vaadin is meant for building user interfaces, and it is recommended that other
diff --git a/documentation/architecture/architecture-technology.asciidoc b/documentation/architecture/architecture-technology.asciidoc
index 54e589b704..221d7dbd15 100644
--- a/documentation/architecture/architecture-technology.asciidoc
+++ b/documentation/architecture/architecture-technology.asciidoc
@@ -79,7 +79,7 @@ images, fonts, and other resources. Vaadin themes are specifically written in
Sass. In development mode, Sass files are compiled automatically to CSS. For
production use, you compile the Sass files to CSS with the included compiler.
The use of themes is documented in detail in
-<<dummy/../../../framework/themes/themes-overview.asciidoc#themes.overview,"Themes">>,
+<<../themes/themes-overview.asciidoc#themes.overview,"Themes">>,
which also gives an introduction to CSS and Sass.
@@ -138,17 +138,17 @@ communications and allows handling user interaction logic in a server-side
application. This makes the architecture of an AJAX-based web application much
simpler. Nevertheless, Vaadin Framework also allows developing pure client-side
applications, as described in
-<<dummy/../../../framework/clientsideapp/clientsideapp-overview.asciidoc#clientsideapp.overview,"Client-Side
+<<../clientsideapp/clientsideapp-overview.asciidoc#clientsideapp.overview,"Client-Side
Applications">>.
See
-<<dummy/../../../framework/architecture/architecture-client-side#architecture.client-side,"Client-Side
+<<architecture-client-side#architecture.client-side,"Client-Side
Engine">> for a description of how the client-side framework based on GWT is
used in the Client-Side Engine of Vaadin Framework.
-<<dummy/../../../framework/clientside/clientside-overview.asciidoc#clientside.overview,"Client-Side
+<<../clientside/clientside-overview.asciidoc#clientside.overview,"Client-Side
Vaadin Development">> provides information about the client-side development,
and
-<<dummy/../../../framework/gwt/gwt-overview.asciidoc#gwt.overview,"Integrating
+<<../gwt/gwt-overview.asciidoc#gwt.overview,"Integrating
with the Server-Side">> about the integration of client-side widgets with the
server-side components.
@@ -186,7 +186,7 @@ and then mostly JSON responses to synchronize the widgets and their server-side
counterparts. It also serves various resources, such as themes. The server-side
UIs are implemented as classes extending the [classname]#UI# class, as described
in
-<<dummy/../../../framework/application/application-overview.asciidoc#application.overview,"Writing
+<<../application/application-overview.asciidoc#application.overview,"Writing
a Server-Side Web Application">>. The class is given as a parameter to the
Vaadin Servlet in the deployment descriptor.
diff --git a/documentation/architecture/chapter-architecture.asciidoc b/documentation/architecture/chapter-architecture.asciidoc
index 60e0c57b09..25d8729c8a 100644
--- a/documentation/architecture/chapter-architecture.asciidoc
+++ b/documentation/architecture/chapter-architecture.asciidoc
@@ -2,7 +2,7 @@
== Architecture
In
-<<dummy/../../../framework/introduction/introduction-overview.asciidoc#intro.overview,"Introduction">>,
+<<../introduction/introduction-overview.asciidoc#intro.overview,"Introduction">>,
we gave a short introduction to the general architecture of Vaadin. This chapter
looks deeper into the architecture at a more technical level.