Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure html label section and add word-spacing #9249

Closed

Conversation

folinimarc
Copy link
Contributor

@folinimarc folinimarc commented Sep 11, 2024

Fixes #9245

This PR proposes the following changes:

  • Document the word-spacing CSS property.
  • Refactor the "Allow HTML Formatting" into its own subsection to de-clutter the text tab bullet point list.
  • Change some of the wording to be more precise, i.e. distinguish between CSS properties and HTML tags.

Discussed with @selmaVH1 at Hackfest, thanks Selma!

Copy link
Collaborator

@DelazJ DelazJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea for the dedicated section @folinimarc

docs/user_manual/style_library/label_settings.rst Outdated Show resolved Hide resolved
docs/user_manual/style_library/label_settings.rst Outdated Show resolved Hide resolved
docs/user_manual/style_library/label_settings.rst Outdated Show resolved Hide resolved
docs/user_manual/style_library/label_settings.rst Outdated Show resolved Hide resolved
@folinimarc folinimarc requested a review from DelazJ September 13, 2024 10:31
@folinimarc
Copy link
Contributor Author

folinimarc commented Sep 13, 2024

@DelazJ Re-requesting review. I added your suggestions and while doing so streamlined the html and css sections a little more.

Copy link
Collaborator

@DelazJ DelazJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a question and a formatting suggestion

With :guilabel:`Allow HTML Formatting` enabled, you need to provide the HTML code in the :guilabel:`Value` field.
Use whitespaces instead of tabs for any kind of indentation.
The expression is parsed and any supported HTML tag overrides its corresponding setting in the labels properties.
An exhaustive list of the supported subset of HTML tags and CSS properties can be found `here <https://doc.qt.io/qt-5/richtext-html-subset.html>`_.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@folinimarc Maybe do I misunderstand or nitpick but we do not yet support all these tags/properties, do we? They are more like targets afaict, "to be supported".

Copy link
Contributor

@nyalldawson nyalldawson Sep 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, we only support a small subset of them:

  • font colour
  • font size
  • font family
  • bold
  • italic
  • strike through
  • underline/overline
  • super/subscript
  • br
  • div
  • p

Copy link
Contributor Author

@folinimarc folinimarc Sep 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you both for bringing this up and the clarification! I should have seen this myself in the source code (or just stick to the scope of the change >.<). Will update the PR next week as soon as I am back at my laptop.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@folinimarc it might worth waiting till qgis/QGIS#58716 is merged, since that also relates

:ref:`textual properties <text_format>` of the label.
Likewise, you can create/overwrite a text format from there.
CSS properties can be set on HTML tags with the style attribute.
The HTML tag span does not apply any formatting to text by itself and is ideal if you just want to apply CSS styling.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The HTML tag span does not apply any formatting to text by itself and is ideal if you just want to apply CSS styling.
The HTML tag ``span`` does not apply any formatting to text by itself and is ideal if you just want to apply CSS styling.

@DelazJ
Copy link
Collaborator

DelazJ commented Oct 14, 2024

Any news @folinimarc ?

@DelazJ DelazJ added the Feedback Waiting for feedback label Oct 14, 2024
Copy link

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has had no activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check - that all comments by reviewers have been addressed - that there is enough information for reviewers, in particular

  • link to any issues which this pull request fixes
  • add a description of workflows which this pull request fixes
  • add screenshots if applicable
    In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request. If there is no further activity on this pull request, it will be closed in a week.

@github-actions github-actions bot added the Stale Issue or PR without any activity for a moment label Oct 29, 2024
Copy link

github-actions bot commented Nov 6, 2024

While we hate to see this happen, this PR has been automatically closed because it has had no activity in the last 21 days despite being marked as feedback. If this pull request should be reconsidered, please follow the guidelines in the previous comment and reopen this pull request. Or, if you have any further questions, just ask! We love to help, and if there's anything the QGIS project can do to help push this PR forward please let us know how we can assist.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feedback Waiting for feedback Stale Issue or PR without any activity for a moment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[feature] Add support for word-spacing CSS in html labels (Request in QGIS)
3 participants