Page 1 of 1

Resourceid appname & appid

Posted: Fri Jul 08, 2016 3:39 pm
by Tristan
Hi,

Are there plans to translate the appname & appid attributes in a <resourceid> to the context-help-map.xml in the webhelp output?
If so will the two attributes be concatenated in the helpID?

e.g. <resourceid appname="application" appid="functionid"/> becomes
<appContext HelpID="application.functionid" path="..."/>

Thanks,

Tristan

Re: Resourceid appname & appid

Posted: Mon Jul 11, 2016 11:45 am
by radu_pisoi
Hi,

Yes, we want to update the Context-Sensitive WebHelp system to take care about the new attributes added to the resourceID element in DITA 1.3 specification.
Tristan wrote:Hi,

Are there plans to translate the appname & appid attributes in a <resourceid> to the context-help-map.xml in the webhelp output?
If so will the two attributes be concatenated in the helpID?

e.g. <resourceid appname="application" appid="functionid"/> becomes
<appContext HelpID="application.functionid" path="..."/>

Tristan
For the case when both @appname and @appid attributes are specified, I think we will adopt the next convention:

Code: Select all

<appContext helpID="functionid" appName="application" path="topics/topic.html"/>
where the @helpID value is taken from resourceid@appid. So, the information from the @appname attribute will be transferred in the 'context-help-map.xml' file as it is.

Re: Resourceid appname & appid

Posted: Mon Jul 11, 2016 11:59 am
by Tristan
Thanks for the swift reply and considering the update.
I assume the appid will then also be added as a parameter in the url next to the contextid?

Code: Select all


index.html?contextId=functionid?appid=application
Best regards,

Tristan

Re: Resourceid appname & appid

Posted: Mon Jul 11, 2016 12:22 pm
by radu_pisoi
Tristan wrote:I assume the appid will then also be added as a parameter in the url next to the contextid?

Code: Select all
index.html?contextId=functionid?appid=application
I suppose that you are referring to the @appname attribute.

Yes, we will update the list of parameters allowed by Context-Sensitive WebHelp system by adding the 'appname' parameter.
So, for you case:

Code: Select all

<appContext helpID="functionid" appName="application" path="topics/topic.html"/>
you will be able to open a WebHelp system showing the page 'topics/topic.html' with the next query:

Code: Select all

index.html?contextId=functionid;appName=application

Re: Resourceid appname & appid

Posted: Mon Jul 11, 2016 12:27 pm
by Tristan
Perfect!
Indeed it was appname I wanted to refer to and the ? should have been a ; in my url
I blame it on the monday morning feeling :wink:

Thanks again,

Tristan

Re: Resourceid appname & appid

Posted: Wed Nov 02, 2016 12:37 pm
by alin
Hello,

I wanted to let you know that the feature you have requested was implemented in oXygen 18.1 which was released a few weeks ago.
Here is a fragment from the "What is new" section:
Context Sensitive WebHelp was Updated for DITA 1.3
The Context Sensitive WebHelp system was updated to support the new changes from DITA 1.3 specifications. For example, you can now associate a topic with an application by using the @appid and @appname attributes available on the resourceid element.
You can read more in our User Manual:
https://www.oxygenxml.com/doc/versions/ ... -resp.html

Regards,

Alin