You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The documentation should be written in a way that is understandable for
68
+
everyone. To help with that, we have a [glossary of terms](https://www.home-assistant.io/docs/glossary/)
69
+
that are used across Home Assistant, including our documentation.
70
+
71
+
If you use a term that is not in the glossary, feel free to add; or improve
72
+
the definition of an existing term.
73
+
74
+
Additionally, we have a terminology tooltip available, that can be added to
75
+
works everywhere in the documentation. This tooltip will show a definition
76
+
of the term when the user hovers over it and provides a link for more
77
+
information. This provides instant context to terminology a user might not
78
+
be familiar with.
79
+
80
+
The syntax for adding terminology tooltips is:
81
+
82
+
```liquid
83
+
{% term <term> [<text>] %}
84
+
```
85
+
86
+
The term referenced must, of course, be listed in our glossary, which is the
87
+
source for the tooltips.
88
+
89
+
For example, if you write a text about automations, you could add a tooltip
90
+
like this:
91
+
92
+
```liquid
93
+
This is an example text about {% term automations %}, which is used
94
+
to demonstrate the use of tooltips, in this case, for the term
95
+
"automations" earlier in this sentence.
96
+
```
97
+
98
+
The `<text>` is optional and can be useful if you want to add a terminology
99
+
tooltip to a piece of text that differs from the term itself. In the following
100
+
example the automation term tooltip is added to the "automate everything" text:
101
+
102
+
```liquid
103
+
Awesome, because this allowed me to {% automation "automate everything" %}
104
+
in my home! I love it!
105
+
```
106
+
65
107
## Renaming Pages
66
108
67
109
It can happen that an integration or platform is renamed, in this case the documentation needs to be updated as well. If you rename a page, add an entry to the `_redirects` file as shown below. Please consider to add details, like release number or old integration/platform name, to the page in a [note](/documenting/create-page.md/#html).
0 commit comments