Page 1 of 1

Plugin <description> displayed in Hardware page

Posted: Monday 19 February 2018 12:04
by Dnpwwo
Update pushed to Domoticz to allow plugin authors to include guidance to users on plugin configuration or to just communicate what the plugin does.

The optional <description> tag in the plugin definition is now sent to the browser in the Hardware page and displayed as HTML.

For example:

Code: Select all

"""
<plugin key="Kodi" name="Kodi Players" author="dnpwwo" version="2.4.1" wikilink="https://github.com/dnpwwo/Domoticz-Kodi-Plugin" externallink="https://kodi.tv/">
    <description>
		<h2>Kodi Media Player Plugin</h2><br/>
		<h3>Features</h3>
		<ul style="list-style-type:square">
			<li>Comes with three selectable icon sets</li>
			<li>Display Domoticz notifications on Kodi screen</li>
			<li>Multiple Shutdown action options</li>
		</ul>
		<h3>Devices</h3>
		<ul style="list-style-type:square">
			<li>Status</li>
			<li>Volume</li>
			<li>Source</li>
			<li>Playing</li>
		</ul>
    </description>
    <params>
	...
will now look like this:
Untitled.png
Untitled.png (28.96 KiB) Viewed 714 times

Re: Plugin <description> displayed in Hardware page

Posted: Saturday 24 February 2018 9:29
by ycahome
Hello,

tried to use without success.

Can you spot an error to my code regarding description?

https://github.com/ycahome/pp-manager/b ... /plugin.py

Re: Plugin <description> displayed in Hardware page

Posted: Saturday 24 February 2018 9:51
by blauwebuis

Re: Plugin <description> displayed in Hardware page

Posted: Saturday 24 February 2018 22:41
by Dnpwwo
@ycahome,

Assuming you are running a current beta you definition looks fine.

There was a change to the Hardware page itself, did you refresh your browser cache?

Re: Plugin <description> displayed in Hardware page

Posted: Sunday 25 February 2018 8:04
by ycahome
@Dnpwwo

You are right but, requires not just a refresh but a clear cache/Delete Browser Data (depends on browser).

Thanks,