Page Key feature does not work
The page https://help.k15t.com/scroll-chm-exporter/using-the-scroll-versions-page-key-functionality-for-context-sensitive-help-132317975.html implies that it is possible to use the Page Key for exporting versioned pages to CHM.
However our tests showed that there is no setting when manually exporting.
Trying to use the linkNamingStrategy.fileNameSchema setting in the JSON (REST based export) and set it to PageKey instead of PageId ends up with a RollbackException.
Does this feature exist? Maybe there is a configuration setting we are missing?
-
Hi Florian,
Thanks for your post.
Have you been able to add the page key to your specific Confluence page in your versioned space? This option will appear when you select Versions > Add Page Key:
We also advise using an integer number when setting a page key, as the CHM format’s context-sensitive help feature is limited to numerical context IDs only.
Had you already performed these steps?
Cheers, Thomas (K15t)
-
Hey Thomas,
sorry for the late response. Thanks for your answer.
The problem is more about the fact that although I have assigned Page Keys to all pages once I export the pages those are linked and named still by page ID. The documentation AFAIU states that the Page Key export should also work. But I neither succeeded via GUI (there is nothing regarding the naming strategy in the wizard) nor via REST API (there is a 500 error being thrown when changing the naming strategy to PageKey).
Thanks and best,
Flo
-
Hi Florian.
There is an error with this article. Currently, Scroll CHM Exporter doesn't support file naming settings. We already have this improvement logged in our JIRA: https://k15t.jira.com/browse/EXP-767. Please sign up at https://k15t.jira.com/secure/Signup!default.jspa to watch, comment on or vote for this issue. You'll then get a notification for every status update on the issue.
The context-sensitive help works like this:- a Confluence page author defines pagekeys for Confluence pages (numeric-only pagekeys should be used if the help is CHM-based),
- a page author provides the numbers and information about which feature this page is created for to software developers,
- software developers map the certain feature to a certain pagekey,
- when a user of the software presses F1 on the specific screen or feature of the software, CHM will find and map the pagekey with the help page.
Please let me know if you have any other questions.
Cheers,
Roman. -
Hey Roman,
thanks for the answer.
One further question for clarity: This means if we have a documentation with different variants, versions, languages there is no way to have a single link but only the page IDs (which are different for each version)? This means the context-sensitive help would not work.
An additional problem is when the page ID does change, the software doing the call to the context-sensitive help needs to get adapted, right?
I will vote on the ticket but it is fairly old. Maybe some fresh wind will help :)
Best,
Flo
-
Hi Flo.
This means if we have a documentation with different variants, versions, languages there is no way to have a single link but only the page IDs (which are different for each version)?
You can define different page keys for different space versions of the same page. If the page has been already edited in a certain space version you can change the page key. This new page key will be only in this space version and in all versions it's inherited from.An additional problem is when the page ID does change, the software doing the call to the context-sensitive help needs to get adapted, right?
Could you please share a situation in which a page's ID could change?Roman.
Please sign in to leave a comment.
Comments
5 comments