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

#10279: Show credits/attribution text in printed page #10451

Merged
merged 4 commits into from
Jul 5, 2024

Conversation

mahmoudadel54
Copy link
Collaborator

Description

In this PR, adding credit/attribution section to print map is enabled by adding a new section into config.yaml of print.
Now in print map, the attribution section will be displayed if the map has layers with credit titles [attributions].
Update the config.yaml file is required if attribution/credit section is need to added.
This PR includes also migration guide for this.

Please check if the PR fulfills these requirements

What kind of change does this PR introduce? (check one with "x", remove the others)

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

Issue

#10279

What is the current behavior?
#10279

What is the new behavior?
The credits/attributions text will be displayed in printed page.

Breaking change

Does this PR introduce a breaking change? (check one with "x", remove the other)

  • Yes, and I documented them in migration notes
  • No

Other useful information

Description:
- add credit layer values to print configration object to send it to the server
- create a util function to parse credit text by removing tags and | symbol
- edit config.yaml of print
- add migration guide
- add unit test
@mahmoudadel54 mahmoudadel54 added this to the 2024.01.02 milestone Jul 3, 2024
@mahmoudadel54 mahmoudadel54 requested a review from MV88 July 3, 2024 04:55
@mahmoudadel54 mahmoudadel54 self-assigned this Jul 3, 2024
@mahmoudadel54 mahmoudadel54 linked an issue Jul 3, 2024 that may be closed by this pull request
14 tasks
@MV88 MV88 added the BackportNeeded Commits provided for an issue need to be backported to the milestone's stable branch label Jul 3, 2024
Copy link
Contributor

@MV88 MV88 left a comment

Choose a reason for hiding this comment

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

@mahmoudadel54
Please checkout my comments.
There are needed a few changes here and there

docs/developer-guide/mapstore-migration-guide.md Outdated Show resolved Hide resolved
web/client/utils/PrintUtils.js Show resolved Hide resolved
web/client/utils/PrintUtils.js Outdated Show resolved Hide resolved
…w comments)

Description:
- add PR link to migration guide file for the added section
- add js doc to 'parseCreditRemovingTagsOrSymbol' method
- simplified the method of 'getLayersCredits'
…w comments)

Description:
- edit clear phrase migration guide file for the added section
- fix FE test for the simplified the method of 'getLayersCredits'
@mahmoudadel54 mahmoudadel54 requested a review from MV88 July 5, 2024 10:02
docs/developer-guide/mapstore-migration-guide.md Outdated Show resolved Hide resolved
@MV88 MV88 merged commit 2d097ff into geosolutions-it:master Jul 5, 2024
5 checks passed
@MV88
Copy link
Contributor

MV88 commented Jul 5, 2024

@ElenaGallo please test it in DEV

@ElenaGallo
Copy link
Contributor

Test passed, @mahmoudadel54 please backport to 2024.01.xx. Thanks

mahmoudadel54 added a commit to mahmoudadel54/MapStore2 that referenced this pull request Jul 8, 2024
…eosolutions-it#10451)

* geosolutions-it#10279: Show credits/attribution text in printed page
Description:
- add credit layer values to print configuration object to send it to the server
- create a util function to parse credit text by removing tags and | symbol
- edit config.yaml of print
- add migration guide
- add unit test
@tdipisa tdipisa removed the BackportNeeded Commits provided for an issue need to be backported to the milestone's stable branch label Jul 8, 2024
tdipisa pushed a commit that referenced this pull request Jul 8, 2024
* #10279: Show credits/attribution text in printed page
Description:
- add credit layer values to print configuration object to send it to the server
- create a util function to parse credit text by removing tags and | symbol
- edit config.yaml of print
- add migration guide
- add unit test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants