aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/layout
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/layout
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/layout')
-rw-r--r--documentation/layout/layout-accordion.asciidoc2
-rw-r--r--documentation/layout/layout-formlayout.asciidoc6
-rw-r--r--documentation/layout/layout-gridlayout.asciidoc10
-rw-r--r--documentation/layout/layout-orderedlayout.asciidoc2
-rw-r--r--documentation/layout/layout-overview.asciidoc4
-rw-r--r--documentation/layout/layout-root-layout.asciidoc2
-rw-r--r--documentation/layout/layout-settings.asciidoc12
-rw-r--r--documentation/layout/layout-sub-window.asciidoc2
8 files changed, 20 insertions, 20 deletions
diff --git a/documentation/layout/layout-accordion.asciidoc b/documentation/layout/layout-accordion.asciidoc
index 737f25082f..8ee8257e60 100644
--- a/documentation/layout/layout-accordion.asciidoc
+++ b/documentation/layout/layout-accordion.asciidoc
@@ -17,7 +17,7 @@ endif::web[]
on a tab opens its contained component in the space between the tab and the next
one. You can use an [classname]#Accordion# identically to a
[classname]#TabSheet#, which it actually inherits. See
-<<dummy/../../../framework/layout/layout-tabsheet#layout.tabsheet,"TabSheet">>
+<<layout-tabsheet#layout.tabsheet,"TabSheet">>
for more information.
The following example shows how you can create a simple accordion. As the
diff --git a/documentation/layout/layout-formlayout.asciidoc b/documentation/layout/layout-formlayout.asciidoc
index 17eb6fb879..6278fc7d3c 100644
--- a/documentation/layout/layout-formlayout.asciidoc
+++ b/documentation/layout/layout-formlayout.asciidoc
@@ -18,7 +18,7 @@ shown for each field. The field captions can have an icon in addition to the
text. [classname]#FormLayout# is an ordered layout and much like
[classname]#VerticalLayout#. For description of margins, spacing, and other
features in ordered layouts, see
-<<dummy/../../../framework/layout/layout-orderedlayout#layout.orderedlayout, "VerticalLayout and HorizontalLayout">>.
+<<layout-orderedlayout#layout.orderedlayout, "VerticalLayout and HorizontalLayout">>.
The following example shows typical use of [classname]#FormLayout# in a form:
@@ -88,6 +88,6 @@ is shown as a dedicated column, the indicator for required fields is currently
shown as a part of the caption column.
For information on setting margins and spacing, see also
-<<dummy/../../../framework/layout/layout-orderedlayout#layout.orderedlayout.spacing,"Spacing
+<<layout-orderedlayout#layout.orderedlayout.spacing,"Spacing
in Ordered Layouts">> and
-<<dummy/../../../framework/layout/layout-settings#layout.settings.margins, "Layout Margins">>.
+<<layout-settings#layout.settings.margins, "Layout Margins">>.
diff --git a/documentation/layout/layout-gridlayout.asciidoc b/documentation/layout/layout-gridlayout.asciidoc
index 0ce3528e5d..f5c60113f1 100644
--- a/documentation/layout/layout-gridlayout.asciidoc
+++ b/documentation/layout/layout-gridlayout.asciidoc
@@ -65,18 +65,18 @@ A conflict causes throwing a [classname]#GridLayout.OverlapsException#.
[[layout.gridlayout.sizing]]
== Sizing Grid Cells
-You can define the size of both a grid layout and its components in either fixed or percentual units, or leave the size undefined altogether, as described in <<dummy/../../../framework/components/components-features#components.features.sizeable,"Sizing Components">>.
-<<dummy/../../../framework/layout/layout-settings#layout.settings.size,"Layout Size">> gives an introduction to sizing of layouts.
+You can define the size of both a grid layout and its components in either fixed or percentual units, or leave the size undefined altogether, as described in <<../components/components-features#components.features.sizeable,"Sizing Components">>.
+<<layout-settings#layout.settings.size,"Layout Size">> gives an introduction to sizing of layouts.
The size of the [classname]#GridLayout# component is undefined by default, so it will shrink to fit the size of the components placed inside it.
In most cases, especially if you set a defined size for the layout but do not set the contained components to full size, there will be some unused space.
The position of the non-full components within the grid cells will be determined by their __alignment__.
-See <<dummy/../../../framework/layout/layout-settings#layout.settings.alignment,"Layout Cell Alignment">> for details on how to align the components inside the cells.
+See <<layout-settings#layout.settings.alignment,"Layout Cell Alignment">> for details on how to align the components inside the cells.
The components contained within a [classname]#GridLayout# layout can be laid out
in a number of different ways depending on how you specify their height or
width.
-The layout options are similar to [classname]#HorizontalLayout# and [classname]#VerticalLayout#, as described in <<dummy/../../../framework/layout/layout-orderedlayout#layout.orderedlayout, "VerticalLayout and HorizontalLayout">>.
+The layout options are similar to [classname]#HorizontalLayout# and [classname]#VerticalLayout#, as described in <<layout-orderedlayout#layout.orderedlayout, "VerticalLayout and HorizontalLayout">>.
[WARNING]
.A layout that contains components with percentual size must have a defined size!
@@ -86,7 +86,7 @@ the component would fill the space given by the layout, while the layout would
shrink to fit the space taken by the component, which is a paradox. This
requirement holds for height and width separately. The debug mode allows
detecting such invalid cases; see
-<<dummy/../../../framework/advanced/advanced-debug#advanced.debug.mode,"Enabling
+<<../advanced/advanced-debug#advanced.debug.mode,"Enabling
the Debug Mode">>.
====
diff --git a/documentation/layout/layout-orderedlayout.asciidoc b/documentation/layout/layout-orderedlayout.asciidoc
index 8dc153bc06..118973efcf 100644
--- a/documentation/layout/layout-orderedlayout.asciidoc
+++ b/documentation/layout/layout-orderedlayout.asciidoc
@@ -178,7 +178,7 @@ the component would fill the space given by the layout, while the layout would
shrink to fit the space taken by the component, which would be a paradox. This
requirement holds for height and width separately. The debug window allows
detecting such invalid cases; see
-<<dummy/../../../framework/advanced/advanced-debug#advanced.debug.hierarchy,"Inspecting
+<<../advanced/advanced-debug#advanced.debug.hierarchy,"Inspecting
Component Hierarchy">>.
====
diff --git a/documentation/layout/layout-overview.asciidoc b/documentation/layout/layout-overview.asciidoc
index 9e6a58a836..3c0025b135 100644
--- a/documentation/layout/layout-overview.asciidoc
+++ b/documentation/layout/layout-overview.asciidoc
@@ -66,13 +66,13 @@ Or in the declarative format (roughly):
You will usually need to tune the layout components a bit by setting sizes,
expansion ratios, alignments, spacings, and so on. The general settings are
described in
-<<dummy/../../../framework/layout/layout-settings#layout.settings,"Layout
+<<layout-settings#layout.settings,"Layout
Formatting">>.
Layouts are coupled with themes that specify various layout features, such as
backgrounds, borders, text alignment, and so on. Definition and use of themes is
described in
-<<dummy/../../../framework/themes/themes-overview.asciidoc#themes.overview,"Themes">>.
+<<../themes/themes-overview.asciidoc#themes.overview,"Themes">>.
You can see a finished version of the above example in
<<figure.layout.intro.simple>>.
diff --git a/documentation/layout/layout-root-layout.asciidoc b/documentation/layout/layout-root-layout.asciidoc
index 86bab9d587..0b82967280 100644
--- a/documentation/layout/layout-root-layout.asciidoc
+++ b/documentation/layout/layout-root-layout.asciidoc
@@ -54,7 +54,7 @@ content.addComponent(menuview);
----
See
-<<dummy/../../../framework/layout/layout-settings#layout.settings.size,"Layout
+<<layout-settings#layout.settings.size,"Layout
Size">> for more information about setting layout sizes.
diff --git a/documentation/layout/layout-settings.asciidoc b/documentation/layout/layout-settings.asciidoc
index da18da92fb..97edabd9b9 100644
--- a/documentation/layout/layout-settings.asciidoc
+++ b/documentation/layout/layout-settings.asciidoc
@@ -22,7 +22,7 @@ The size of a layout component can be specified with the
[methodname]#setWidth()# and [methodname]#setHeight()# methods defined in the
[classname]#Sizeable# interface, just like for any component. It can also be
undefined, in which case the layout shrinks to fit the component(s) inside it.
-<<dummy/../../../framework/components/components-features#components.features.sizeable,"Sizing
+<<../components/components-features#components.features.sizeable,"Sizing
Components">> gives details on the interface.
[[figure.layout.settings.size.undefined]]
@@ -51,7 +51,7 @@ the component will try to fill the space given by the layout, while the layout
will shrink to fit the space taken by the component, which is a paradox. This
requirement holds for height and width separately. The debug mode allows
detecting such invalid cases; see
-<<dummy/../../../framework/advanced/advanced-debug#advanced.debug.hierarchy,"Inspecting
+<<../advanced/advanced-debug#advanced.debug.hierarchy,"Inspecting
Component Hierarchy">>.
====
@@ -120,9 +120,9 @@ example below, the buttons have 1:2:3 ratio for the expansion.
Expansion is covered in detail in the documentation of the layout components that
support it. See
-<<dummy/../../../framework/layout/layout-orderedlayout#layout.orderedlayout,"VerticalLayout
+<<layout-orderedlayout#layout.orderedlayout,"VerticalLayout
and HorizontalLayout">> and
-<<dummy/../../../framework/layout/layout-gridlayout#layout.gridlayout,"GridLayout">>
+<<layout-gridlayout#layout.gridlayout,"GridLayout">>
for details on components with relative sizes.
@@ -301,7 +301,7 @@ you can customize it in a custom theme.
In the Valo theme, you can specify the spacing with the
$v-layout-spacing-vertical and $v-layout-spacing-horizontal parameters, as
described in
-<<dummy/../../../framework/themes/themes-valo#themes.valo.variables,"Common
+<<../themes/themes-valo#themes.valo.variables,"Common
Settings">>. The spacing defaults to the $v-unit-size measure.
When adjusting spacing in other themes, you should note that it is implemented
@@ -321,7 +321,7 @@ HTML element of the layout component.
In the Valo theme, the margin sizes default to $v-unit-size. You can customize
them with $v-layout-margin-top, right, bottom, and left. See
-<<dummy/../../../framework/themes/themes-valo#themes.valo.variables,"Common
+<<../themes/themes-valo#themes.valo.variables,"Common
Settings">> for a description of the parameters.
To customize the default margins in other themes, you can define each margin
diff --git a/documentation/layout/layout-sub-window.asciidoc b/documentation/layout/layout-sub-window.asciidoc
index 9d10876efc..c1fe9550e4 100644
--- a/documentation/layout/layout-sub-window.asciidoc
+++ b/documentation/layout/layout-sub-window.asciidoc
@@ -160,7 +160,7 @@ Scroll bars in sub-windows are handled with regular HTML features, namely
As [classname]#Window# extends [classname]#Panel#, windows are also
[interfacename]#Scrollable#. Note that the interface defines __programmatic
scrolling__, not scrolling by the user. Please see
-<<dummy/../../../framework/layout/layout-panel#layout.panel,"Panel">>.
+<<layout-panel#layout.panel,"Panel">>.
(((range="endofrange", startref="term.layout.sub-window.scrolling.scrollbars")))