Hi Alessandro,

thank you!

I'll see if I can add some notes to the docs.

Cheers, Hannes

On 28.11.23 11:34, Alessandro Pasotti wrote:
HI Johannes,

digging into very old memories here, IIRC when I wrote that metadata
docs I was mainly worried about displaying the plugin metadata.txt ini
file information in the plugin website, that's why I thought it was
wise to ban HTML formatting.



On Tue, Nov 28, 2023 at 11:05 AM Johannes Kröger (WhereGroup) via
QGIS-Developer <qgis-developer@lists.osgeo.org> wrote:
Hi!

https://docs.qgis.org/3.34/en/docs/pyqgis_developer_cookbook/plugins/plugins.html#metadata-txt
says for the fields "about", "description" and "changelog": "no HTML
allowed"

But actually we *can* use some HTML
(https://doc.qt.io/qt-5/richtext-html-subset.html I assume).
The plugin's information will be nicely rendered at least in QGIS'
plugin manager.
<img> does not seem to work, it just shows a placeholder. Clicking an
<a> makes the plugin manager display a white page and open my system's
web browser with the URL. But other formatting things work well.

Example image:
https://matrix.osgeo.org/_matrix/media/r0/download/matrix.wheregroup.com/nKHOTGcYWWpYqQKNWaSjuFbu/html%20in%20metadata.txt.png

It would be super useful for me in a non-public plugin so I wonder:

- Does "no HTML allowed" refer to the display in the official plugin
repository https://plugins.qgis.org only?
- Is it a bug that we can use some HTML in those fields or can we rely
on it for the future?

I am a bit torn between "oh yay, we can add some more detailed
information in a nicely formatted way" and "oh dear lord this might lead
to complex chaos in plugin descriptions".

Cheers, Hannes

_______________________________________________
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer


--
Johannes Kröger / GIS-Entwickler/-Berater

---------------------------------------------
Aufwind durch Wissen!
Web-Seminare und Online-Schulungen
bei der www.foss-academy.com
---------------------------------------------

WhereGroup GmbH
c/o KK03 GmbH
Lange Reihe 29
20099 Hamburg
Germany

Tel: +49 (0)228 / 90 90 38 - 36
Fax: +49 (0)228 / 90 90 38 - 11

johannes.kroe...@wheregroup.com
www.wheregroup.com
Geschäftsführer:
Olaf Knopp, Peter Stamm
Amtsgericht Bonn, HRB 9885
-------------------------------

_______________________________________________
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Reply via email to