From 785f7869568f65116e94e7cfaee0f096f0e3d873 Mon Sep 17 00:00:00 2001 From: perjury Date: Tue, 28 Jan 2020 14:40:23 +0000 Subject: [PATCH] Consistency and readability (#11897) * 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. * Update views.markdown * Update views.markdown * Update source/lovelace/views.markdown Co-Authored-By: Franck Nijhof * Update source/lovelace/views.markdown Co-Authored-By: Franck Nijhof Co-authored-by: Franck Nijhof --- source/lovelace/views.markdown | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/source/lovelace/views.markdown b/source/lovelace/views.markdown index aad366c3b48..ff5e4e451c8 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: @@ -83,11 +83,11 @@ 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 +#### Example View config: @@ -107,11 +107,11 @@ Picture card config: navigation_path: /lovelace/living_room ``` -## Icons +## Icon 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 @@ -158,18 +158,18 @@ 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. -### Example +#### Example ```yaml - title: Home 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).