Keyword versus indexterm

Post here questions and problems related to editing and publishing DITA content.
ann.jensen
Posts: 295
Joined: Wed Jun 17, 2015 10:19 am

Keyword versus indexterm

Post by ann.jensen »

Hi,
I have been including <indexterm> elements within the prolog element for each of my topics.
I had assumed that these would be used by Oxygen WebHelp search but am realising that is not the case now.
Should I be putting both <indexterm> and <keyword> elements in my <prolog>?
Regards,
Ann
radu_pisoi
Posts: 403
Joined: Thu Aug 21, 2003 11:36 am
Location: Craiova
Contact:

Re: Keyword versus indexterm

Post by radu_pisoi »

Hi,

You can use either indexterm or keyword element in the topic's prolog to increase the word scoring for WebHelp search function.

I have tested with WebHelp Responsive 20.1 inserting an indexterm in a topic's prolog:

Code: Select all


<prolog>
<metadata>
<keywords>
<indexterm>gardening</indexterm>
</keywords>
</metadata>
</prolog>
You can read more about How to Change Element Scoring in Search Results in our documentation.
Radu Pisoi
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com
ann.jensen
Posts: 295
Joined: Wed Jun 17, 2015 10:19 am

Re: Keyword versus indexterm

Post by ann.jensen »

Hi,
Thanks for your reply. I have tested this using indexterm in Oxygen 19.1

Code: Select all

  <prolog>
<metadata>
<keywords>
<indexterm>Work Order Scheduling</indexterm>
<indexterm>Task Scheduler</indexterm>
</keywords>
</metadata>
</prolog>
After publishing to WebHelp and doing an exact search for the words "Task Scheduler" in double quotes, I get no results.
I can see the term in the generated index but it doesn't appear to be used by the search.
Is this because I am using an older version?
Regards,
Ann
radu_pisoi
Posts: 403
Joined: Thu Aug 21, 2003 11:36 am
Location: Craiova
Contact:

Re: Keyword versus indexterm

Post by radu_pisoi »

Hi,

The phrase search (for example, "grow flowers") return results only if words are found consecutively in the document, the consecutive words from index terms are not analyzed.

I will register this improvement in our internal issue tracker.
Radu Pisoi
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com
ann.jensen
Posts: 295
Joined: Wed Jun 17, 2015 10:19 am

Re: Keyword versus indexterm

Post by ann.jensen »

Hi Radu,
Thanks for that. if I don't use a phrase search, it appears to only search the text within the topic.
I don't understand how the use of <indexterm> element is used by search at all.

My scoring.properties has the following

Code: Select all


# Meta keyword and indexterm
meta_keywords = 100
meta_indexterms = 100
so I would expect topics with the words 'task scheduler' as an index term to be in the top results but it is not the case.
Instead topics with the 2 words task and scheduler in their heading and text (1 time) are appearing at the top of the results.
It doesn't make sense to me.
Any feedback appreciated,
Regards,
Ann
radu_pisoi
Posts: 403
Joined: Thu Aug 21, 2003 11:36 am
Location: Craiova
Contact:

Re: Keyword versus indexterm

Post by radu_pisoi »

Hi,

Sorry for the late reply.

I think I can reproduce the issue you have reported. In case when your search query contains multiple keywords, the WebHelp search function promote topics that contain all keywords in topic's content. The issue is that this does not happen when search keywords are specified as indexterms or keywords.

Thank you for reporting this issue.
Radu Pisoi
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com
Post Reply