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

Add xml parameters brandProductName and brandproductURL #11029

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

meven
Copy link
Contributor

@meven meven commented Jan 27, 2025

In user_interface section.

Change-Id: If5033a3221de985cf82eace8dc7c28fec220c419

  • Resolves: #
  • Target version: master

Summary

This allows to set a product name and product url.

The option is visible only in COOL.

Checklist

  • I have run make prettier-write and formatted the code.
  • All commits have Change-Id
  • I have run tests with make check
  • I have issued make run and manually verified that everything looks okay
  • Documentation (manuals or wiki) has been updated or is not required

@meven meven requested a review from mmeeks January 27, 2025 15:54
Copy link
Contributor

@mmeeks mmeeks left a comment

Choose a reason for hiding this comment

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

Looks reasonable to me I'd prefer @timar to review though. Thanks.

Copy link
Member

@timar timar left a comment

Choose a reason for hiding this comment

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

It will not work with brand package, because settings in branding.js will overwrite the settings in global.js. You have to put them into a branding_override.js, and load it after branding.js, but only if the product name and URL are actually overridden. So the settings could be brandProductNameOverride and brandProductURLOverride to begin with, and their default value should be an empty string.
When you add a new config setting to coolwsd.xml, please add the default value to DefAppConfig map.

configure.ac Outdated
@@ -999,12 +1000,16 @@ else
WELCOME_CONFIG_FRAGMENT="<welcome>
<enable type=\"bool\" desc=\"Controls whether the welcome screen should be shown to the users on new install and updates. When enabled, your custom welcome screen must be created at /usr/share/coolwsd/browser/dist/welcome/welcome.html.\" default=\"false\">false</enable>
</welcome>"
CONFIG_INTERFACE_FRAGMENT="<brandProductName desc=\"Change the displayed name the application will have for the user.\" type=\"string\"></brandProductName>
<brandProductURL desck=\"Change the url of the , empty makes disable the link\" type=\"string\">https://www.collaboraonline.com</brandProductURL>"
Copy link
Member

Choose a reason for hiding this comment

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

typo: desck
Incomplete sentence in description

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It will not work with brand package, because settings in branding.js will overwrite the settings in global.js.

It is meant to be used when no branding is set.

branding_override.js, and load it after branding.js

I'd like to avoid adding a new request, plus this file has to be dynamic since it depends on settings, so that would adding some file generation logic and serving. It seems to me way too complicated for what the feature I am adding.

Having a different name with Override postfix would make things compatible, but do we really need it ?

In user_interface section.

Signed-off-by: Méven Car <[email protected]>
Change-Id: If5033a3221de985cf82eace8dc7c28fec220c419
@meven meven force-pushed the meven/product-name-url branch from d38313a to de204c1 Compare January 28, 2025 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

3 participants