diff options
author | Zhe Sun <31067185+ZheSun88@users.noreply.github.com> | 2019-05-23 09:43:31 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-05-23 09:43:31 +0300 |
commit | 0b7457325200162961cae52e7d871db928dc3cd9 (patch) | |
tree | 880bbb73259b135e53ee753c2591099e480c70f4 /documentation/themes | |
parent | bb4898cdfb4f5d2bd34904eb1920b837ac9a3c37 (diff) | |
download | vaadin-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/themes')
-rw-r--r-- | documentation/themes/themes-compiling.asciidoc | 2 | ||||
-rw-r--r-- | documentation/themes/themes-creating.asciidoc | 6 | ||||
-rw-r--r-- | documentation/themes/themes-eclipse.asciidoc | 4 | ||||
-rw-r--r-- | documentation/themes/themes-fonticon.asciidoc | 2 | ||||
-rw-r--r-- | documentation/themes/themes-overview.asciidoc | 6 | ||||
-rw-r--r-- | documentation/themes/themes-responsive.asciidoc | 4 | ||||
-rw-r--r-- | documentation/themes/themes-sass.asciidoc | 6 | ||||
-rw-r--r-- | documentation/themes/themes-valo.asciidoc | 6 |
8 files changed, 18 insertions, 18 deletions
diff --git a/documentation/themes/themes-compiling.asciidoc b/documentation/themes/themes-compiling.asciidoc index 83db89aafa..df72e0f843 100644 --- a/documentation/themes/themes-compiling.asciidoc +++ b/documentation/themes/themes-compiling.asciidoc @@ -23,7 +23,7 @@ If you edit the Sass theme, it is recompiled the next time you reload the page. The on-the-fly compilation takes a bit time, so it is only available when the Vaadin servlet is in the development mode, as described in -<<dummy/../../../framework/application/application-environment#application.environment.parameters,"Other +<<../application/application-environment#application.environment.parameters,"Other Servlet Configuration Parameters">>. Also, it requires the theme compiler and all its dependencies to be in the class path of the servlet. At least for production, you must compile the theme to CSS, as described next. diff --git a/documentation/themes/themes-creating.asciidoc b/documentation/themes/themes-creating.asciidoc index 4eed47018d..5fd2b603a4 100644 --- a/documentation/themes/themes-creating.asciidoc +++ b/documentation/themes/themes-creating.asciidoc @@ -204,7 +204,7 @@ public class MyUI extends UI { The Valo theme comes with a custom icon font, VaadinIcons, which you can use as font icons, as described in -<<dummy/../../../framework/themes/themes-fonticon#themes.fonticon,"Font +<<themes-fonticon#themes.fonticon,"Font Icons">>. ifdef::web[] @@ -238,7 +238,7 @@ projects). You can also serve static content from a front-end caching server, which reduces the load of the application server. In portals, you install the themes globally in the portal in similar way, as described in -<<dummy/../../../framework/portal/portal-liferay#portal.liferay.install,"Installing +<<../portal/portal-liferay#portal.liferay.install,"Installing Vaadin Resources">>. Just make sure to update the static content when you upgrade to a newer version @@ -250,7 +250,7 @@ endif::web[] Creation of a default theme for custom GWT widgets is described in -<<dummy/../../../framework/gwt/gwt-styling#gwt.styling,"Styling a Widget">>. +<<../gwt/gwt-styling#gwt.styling,"Styling a Widget">>. [[themes.creating.addon]] diff --git a/documentation/themes/themes-eclipse.asciidoc b/documentation/themes/themes-eclipse.asciidoc index bd35ce6fed..d0441208f1 100644 --- a/documentation/themes/themes-eclipse.asciidoc +++ b/documentation/themes/themes-eclipse.asciidoc @@ -57,10 +57,10 @@ image::img/eclipse-theme-created-annotated-hi.png[] The created theme extends a built-in base theme with an [literal]#++@import++# statement. See the explanation of theme inheritance in -<<dummy/../../../framework/themes/themes-creating#themes.creating,"Creating and +<<themes-creating#themes.creating,"Creating and Using Themes">>. Notice that the [filename]#reindeer# theme is not located in the [filename]#widgetsets# folder, but in the Vaadin JAR. See -<<dummy/../../../framework/themes/themes-creating#themes.creating.builtin,"Built-in +<<themes-creating#themes.creating.builtin,"Built-in Themes">> for information for serving the built-in themes. If you selected a UI class or classes in the [guilabel]#Modify application diff --git a/documentation/themes/themes-fonticon.asciidoc b/documentation/themes/themes-fonticon.asciidoc index 9131a004f8..623d4800b4 100644 --- a/documentation/themes/themes-fonticon.asciidoc +++ b/documentation/themes/themes-fonticon.asciidoc @@ -163,7 +163,7 @@ including WOFF, TTF, EOT, and SVG. Not all browsers support any one of them, so all are needed to support all the common browsers. Extract the [filename]#fonts# folder from the package to under your theme. -See <<dummy/../../../framework/themes/themes-fonts#themes.fonts.loading,"Loading +See <<themes-fonts#themes.fonts.loading,"Loading Local Fonts">> for instructions for loading a custom font. diff --git a/documentation/themes/themes-overview.asciidoc b/documentation/themes/themes-overview.asciidoc index 05005ab83b..a111a733d5 100644 --- a/documentation/themes/themes-overview.asciidoc +++ b/documentation/themes/themes-overview.asciidoc @@ -39,7 +39,7 @@ images, [filename]#layouts# for custom layouts, and [filename]#css# for additional stylesheets. Custom themes need to extend a base theme, as described in -<<dummy/../../../framework/themes/themes-creating#themes.creating,"Creating and +<<themes-creating#themes.creating,"Creating and Using Themes">>. Copying and modifying an existing theme is also possible, but it is not recommended, as it may need more work to maintain if the modifications are small. @@ -64,12 +64,12 @@ changed as needed. In addition to style sheets, a theme can contain HTML templates for custom layouts used with [classname]#CustomLayout#. See -<<dummy/../../../framework/layout/layout-customlayout#layout.customlayout,"Custom +<<../layout/layout-customlayout#layout.customlayout,"Custom Layouts">> for details. Resources provided in a theme can also be accessed using the [classname]#ThemeResource# class, as described in -<<dummy/../../../framework/application/application-resources#application.resources.theme,"Theme +<<../application/application-resources#application.resources.theme,"Theme Resources">>. This allows displaying theme resources in component icons, in the [classname]#Image# component, and other such uses. diff --git a/documentation/themes/themes-responsive.asciidoc b/documentation/themes/themes-responsive.asciidoc index b0f03c65f6..07c0f47ce6 100644 --- a/documentation/themes/themes-responsive.asciidoc +++ b/documentation/themes/themes-responsive.asciidoc @@ -80,7 +80,7 @@ resources must be loaded from the same domain as the application. The problem occurs only in Firefox. A SecurityError is shown in the debug window. The limitation concerns stylesheets such as for web fonts served from external sites, as described in -<<dummy/../../../framework/themes/themes-fonts#themes.fonts.webfonts,"Loading +<<themes-fonts#themes.fonts.webfonts,"Loading Web Fonts">>. endif::web[] @@ -172,7 +172,7 @@ You could also play with the [literal]#++display: block++# vs Notice that, while the [classname]#Responsive# extension makes it possible to do various CSS trickery with component sizes, the normal rules for component and layout sizes apply, as described in -<<dummy/../../../framework/layout/layout-settings#layout.settings.size,"Layout +<<layout-settings#layout.settings.size,"Layout Size">> and elsewhere, and you should always check the size behaviour of the components. In the above example, we set the label to have undefined width, which disables word wrap, so we had to re-enable it. diff --git a/documentation/themes/themes-sass.asciidoc b/documentation/themes/themes-sass.asciidoc index 4b1f529de1..941fceab90 100644 --- a/documentation/themes/themes-sass.asciidoc +++ b/documentation/themes/themes-sass.asciidoc @@ -17,7 +17,7 @@ Sass can be used in two basic ways in Vaadin applications, either by compiling SCSS files to CSS or by doing the compilation on the fly. The latter way is possible if the development mode is enabled for the Vaadin servlet, as described in -<<dummy/../../../framework/application/application-environment#application.environment.parameters,"Other +<<../application/application-environment#application.environment.parameters,"Other Servlet Configuration Parameters">>. [[themes.sass.overview]] @@ -132,7 +132,7 @@ The above SCSS would translated to the following CSS: You can also have nested rules in a mixin, which makes them especially powerful. Mixing in rules is used when extending Vaadin themes, as described in -<<dummy/../../../framework/themes/themes-creating#themes.creating.sass,"Sass +<<themes-creating#themes.creating.sass,"Sass Themes">>. Vaadin themes are defined as mixins to allow for certain uses, such as different @@ -148,7 +148,7 @@ excellent documentation at http://sass-lang.com/. In the following, we give just basic introduction to using it with Vaadin. You can create a new Sass-based theme with the Eclipse plugin, as described in -<<dummy/../../../framework/themes/themes-eclipse#themes.eclipse,"Creating a +<<themes-eclipse#themes.eclipse,"Creating a Theme in Eclipse">>. diff --git a/documentation/themes/themes-valo.asciidoc b/documentation/themes/themes-valo.asciidoc index 4ead457d62..b80f12ff07 100644 --- a/documentation/themes/themes-valo.asciidoc +++ b/documentation/themes/themes-valo.asciidoc @@ -234,7 +234,7 @@ $v-hover-styles-enabled(default:[literal]#++true++#):: Specifies whether various that mouse pointer hovers over an element. $v-disabled-opacity(default:[literal]#++0.5++#):: Opacity of disabled components, as described in -<<dummy/../../../framework/components/components-features#components.features.enabled,"Enabled">>. +<<../components/components-features#components.features.enabled,"Enabled">>. $v-selection-color(default:[literal]#++$v-focus-color++#):: Color for indicating selection in selection components. @@ -242,12 +242,12 @@ $v-default-field-width(default:[literal]#++$v-unit-size * 5++#):: Default width [methodname]#setWidth()#. $v-error-indicator-color(default:[literal]#++#ed473b++#):: Color of the component error indicator, as described in -<<dummy/../../../framework/application/application-errors#application.errors.error-indicator,"Error +<<../application/application-errors#application.errors.error-indicator,"Error Indicator and Message">>. $v-required-field-indicator-color(default:[literal]#++$v-error-indicator-color++#):: Color of the required indicator in field components. ifdef::vaadin7[] -Field components are described in <<dummy/../../../framework/components/components-fields#components.fields.field,"Field Interface">>. +Field components are described in <<../components/components-fields#components.fields.field,"Field Interface">>. endif::vaadin7[] Color specifications for $v-border, $v-bevel, and $v-shadow may use, in addition |