From 253102ddc21f775ffb348d9c7a1153871105f20b Mon Sep 17 00:00:00 2001 From: perjury Date: Tue, 28 Jan 2020 11:12:55 +0000 Subject: [PATCH 1/5] Consistency and readability Change headings to match key names to avoid confusion (e.g heading Path instead of Paths to describe the Path key) Also readability changes to make the documentation clearer. --- source/lovelace/views.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/lovelace/views.markdown b/source/lovelace/views.markdown index aad366c3b483..49c690a667c8 100644 --- a/source/lovelace/views.markdown +++ b/source/lovelace/views.markdown @@ -83,9 +83,9 @@ View config: image: /local/lights.png ``` -## Paths +## Path -You can link to one view from another view by its path. For this use cards that support navigation (`navigation_path`). Do not use special characters in paths. Do not begin a path with a number. This will cause the parser to read your path as a view index. +You can link to one view from a card in another view when using cards that support navigation (`navigation_path`). The string supplied here will be appended to the string /lovelace/ to create the path to the view. Do not use special characters in paths. Do not begin a path with a number. This will cause the parser to read your path as a view index. ### Example @@ -107,7 +107,7 @@ Picture card config: navigation_path: /lovelace/living_room ``` -## Icons +## Icon If you define an icon the title will be used as a tool-tip. @@ -158,7 +158,7 @@ This renders the first card on full width, other cards in this view will not be - zone.home ``` -## Themes +## Theme Set a separate [theme](/integrations/frontend/#themes) for the view and its cards. From c182963a9f1924bc9c8445009a46827372e262a5 Mon Sep 17 00:00:00 2001 From: perjury Date: Tue, 28 Jan 2020 11:56:07 +0000 Subject: [PATCH 2/5] Update views.markdown --- source/lovelace/views.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/lovelace/views.markdown b/source/lovelace/views.markdown index 49c690a667c8..a06951de3d6d 100644 --- a/source/lovelace/views.markdown +++ b/source/lovelace/views.markdown @@ -169,7 +169,7 @@ Set a separate [theme](/integrations/frontend/#themes) for the view and its card theme: happy ``` -### Background +## Background You can style the background of your views with a [theme](/integrations/frontend/#themes). You can use the CSS variable `lovelace-background`. For wallpapers you probably want to use the example below, more options can be found [here](https://developer.mozilla.org/en-US/docs/Web/CSS/background). From b81e2c00bf04e0b752d3dd2999a2fb813236a66b Mon Sep 17 00:00:00 2001 From: perjury Date: Tue, 28 Jan 2020 12:04:04 +0000 Subject: [PATCH 3/5] Update views.markdown --- source/lovelace/views.markdown | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/source/lovelace/views.markdown b/source/lovelace/views.markdown index a06951de3d6d..4c37738761e5 100644 --- a/source/lovelace/views.markdown +++ b/source/lovelace/views.markdown @@ -57,7 +57,7 @@ views: default: true {% endconfiguration %} -## Options For Visible +### Options For Visible If you define `visible` as objects instead of a boolean to specify conditions for displaying the view tab: @@ -87,7 +87,7 @@ View config: You can link to one view from a card in another view when using cards that support navigation (`navigation_path`). The string supplied here will be appended to the string /lovelace/ to create the path to the view. Do not use special characters in paths. Do not begin a path with a number. This will cause the parser to read your path as a view index. -### Example +#### Example View config: @@ -111,7 +111,7 @@ Picture card config: If you define an icon the title will be used as a tool-tip. -### Example +#### Example ```yaml - title: Garden @@ -122,7 +122,7 @@ If you define an icon the title will be used as a tool-tip. You can specify the visibility of views as a whole or per-user. (Note: This is only for the display of the tabs. The url path is still accessible) -### Example +#### Example ```yaml views: @@ -142,11 +142,11 @@ views: ... ``` -## Panel mode +## Panel -This renders the first card on full width, other cards in this view will not be rendered. Good for cards like `map`, `stack` or `picture-elements`. +Setting panel true sets the view to panel mode. In this mode the first card is rendered full width Other cards in the view will not be rendered. This mode is good when using cards like `map`, `stack` or `picture-elements`. -### Example +#### Example ```yaml - title: Map @@ -162,7 +162,7 @@ This renders the first card on full width, other cards in this view will not be Set a separate [theme](/integrations/frontend/#themes) for the view and its cards. -### Example +#### Example ```yaml - title: Home From 71dac88ced9a68df4b252e3276858f7f0f36cc37 Mon Sep 17 00:00:00 2001 From: perjury Date: Tue, 28 Jan 2020 13:57:25 +0000 Subject: [PATCH 4/5] Update source/lovelace/views.markdown Co-Authored-By: Franck Nijhof --- source/lovelace/views.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/lovelace/views.markdown b/source/lovelace/views.markdown index 4c37738761e5..c0cd8efe9ff7 100644 --- a/source/lovelace/views.markdown +++ b/source/lovelace/views.markdown @@ -85,7 +85,7 @@ View config: ## Path -You can link to one view from a card in another view when using cards that support navigation (`navigation_path`). The string supplied here will be appended to the string /lovelace/ to create the path to the view. Do not use special characters in paths. Do not begin a path with a number. This will cause the parser to read your path as a view index. +You can link to one view from a card in another view when using cards that support navigation (`navigation_path`). The string supplied here will be appended to the string `/lovelace/` to create the path to the view. Do not use special characters in paths. Do not begin a path with a number. This will cause the parser to read your path as a view index. #### Example From 2bd532023680c491c2941fcf51a32b32035aa141 Mon Sep 17 00:00:00 2001 From: perjury Date: Tue, 28 Jan 2020 13:58:01 +0000 Subject: [PATCH 5/5] Update source/lovelace/views.markdown Co-Authored-By: Franck Nijhof --- source/lovelace/views.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/lovelace/views.markdown b/source/lovelace/views.markdown index c0cd8efe9ff7..ff5e4e451c85 100644 --- a/source/lovelace/views.markdown +++ b/source/lovelace/views.markdown @@ -144,7 +144,7 @@ views: ## Panel -Setting panel true sets the view to panel mode. In this mode the first card is rendered full width Other cards in the view will not be rendered. This mode is good when using cards like `map`, `stack` or `picture-elements`. +Setting panel true sets the view to panel mode. In this mode the first card is rendered full-width, other cards in the view will not be rendered. This mode is good when using cards like `map`, `stack` or `picture-elements`. #### Example