WebHelp keyword highlighting

Posts: 3
Joined: Wed Mar 20, 2019 12:29 am

WebHelp keyword highlighting

Post by tct » Tue Apr 30, 2019 3:54 pm

I'm comparably new to DITA so I am lurking around a lot on this page: https://www.oxygenxml.com/dita/1.3/specs/index.html
So far it has been a great help in allowing me to work our first DITA documentation using Oxygen XML Editor. We currently only publish to Oxygen's XML responsive WebHelp output.

My question is rather simple: How can I achieve the highlighting of "programming terms" as used a lot by the documentation linked above? I'm referring to these (link):Image

I am aware of apiname, codeph and most of the other tags provided by the DITA programming domain. However, none of them render as shown in the screenshot when generating the WebHelp output.
It seems that it's something that can also be used within dlentry / dt and other body elements.

How can I achieve this effect? Is this a custom template? If so, is it accessible somewhere so I can modify our (very basic) WebHelp template to render these words in the same way?

Posts: 156
Joined: Tue Mar 06, 2018 1:34 am

Re: WebHelp keyword highlighting

Post by mdslup » Tue Apr 30, 2019 11:03 pm

Use the CODEPH element. This highlights the text as you point out, within the current line of regular text.

If you want to offset a larger block with the same highlighting, use CODEBLOCK.

Posts: 7331
Joined: Fri Jul 09, 2004 5:18 pm

Re: WebHelp keyword highlighting

Post by Radu » Thu May 02, 2019 6:00 am


In the specific screenshot above I think the original DITA tags were xmlelement and xmlatt:

https://www.oxygenxml.com/dita/1.3/spec ... ement.html
https://www.oxygenxml.com/dita/1.3/spec ... mlatt.html

which indeed are styled similar to code phrases.

Radu Coravu
<oXygen/> XML Editor

Post Reply