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

Creating own help files (help-contextual) #203

Open
juancarloscamargo opened this issue Nov 19, 2024 · 2 comments
Open

Creating own help files (help-contextual) #203

juancarloscamargo opened this issue Nov 19, 2024 · 2 comments

Comments

@juancarloscamargo
Copy link

Hi,
We would like to create our own contextual help files for custom modules, but cannot find where in the DB the configuration for entries in HELP_CONTEXTUAL (help-contextual.service.ts) gets stored:

{
"Heading": "string",
"Details": [
"string"
],
"Links": [
{
"Title": "string",
"Url": "string",
"IsExternal": true
}
]
}

Could any developer shed some light?
Thanks!

@hannoquest
Copy link
Collaborator

Hi @juancarloscamargo,

This JSON is not stored in the database, but compiled to code and linking the technical documentation. You can extend the HelpContextualService with another data source of your own. Could you describe your use case in a little more detail? Are you looking to change some text, or do you have another source for documentation links?

@juancarloscamargo
Copy link
Author

Hi @hannoquest , thanks.
We would like to add new documentation files to the existing ones.
These are some of the "contextId" already in the code, they're defined in qbm/help-contextual.service.ts :

image

Let's say, for the DataExplorerIdentities:'data-explorer-identities' , once you click on the information icon, the value for the json is :

image

We now want to add another help icon for one of our modules, let's say, WordPress Roles. We would then add an entry in help-contextual.service.ts for the HELP_CONTEXTUAL constant but we dont know how to fill up the rest of the json with the title, url to the imx/doc/ htm help file that we would create as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants