Richer formatting within Short Description

[kmank]

I am in need of creating a section within the home page (index.html) of the webhelp transformation to house top FAQs. I was envisioning something like a large tile that works similar to the Side TOC nav tile.

So, if I create a new top-level topic (Top FAQs) is there a way to create a richer formatting within its short description that has xrefs to content in the Top FAQs page (or other page)? It would need to be able to have links and line breaks.

I've tried using ph elements to get xrefs in the topic, but they do not transform to hyperlinks during transformation.

any thoughts/guidance?

[bogdan_cercelaru]

Hello,

You can add <xref /> elements in the DITA topics short description to add links to specific section or page.
Unfortunately, there is no line break element or equivalent in DITA. As a workaround you could use an empty <ph /> element with a custom @outputclass attribute and a custom CSS for styling the output.
For example, in the short description of your topic, insert the

Code: Select all

<ph outputclass="linebreak"/>

where you want to have a line break. In this case, the custom CSS should be:

Code: Select all

.linebreak {

	display: block;

}

Here you can find more information about customizing WebHelp output using CSS: CSS Styling to Customize WebHelp Output

Regards,
Bogdan

[kmank]

hi Bogdan

Good info - thanks!
I had already tried adding an xref to the shortdesc.

Code: Select all

<shortdesc>

	<xref href="#concept_vsh_1fm_kcb/div_gyg_4gm_kcb" format="dita">How do I change my password?</xref>

</shortdesc>

Somewhere during the transformation, the xref is stripped out.

Code: Select all

<div class=" wh_tile_shortdesc ">How do I change my password?</div>

Any idea where that is happening and how to prevent it?

[kmank]

BTW... this happens with any transformation - even the default oXygen transforms.

[bogdan_cercelaru]

Hello,

I've tested using Oxygen version 19.1 build 2017121318 and I can confirm this behavior.
I've just registered an issue in our internal bug tracking system to be analyzed.

Regards,
Bogdan

[kmank]

Thank you, Bogdan. I'll be watching for the resolution.

[kmank]

Bogdan

I've looked through the bug tracking system and cannot locate this one. Can you please provide the number?

[Costin]

Hi kmank,

The issue was logged, but the tracking system is internal, not public, so you can not actually see the issue.
However, for further discussions, you should mention "WH-1668", as this our internal issue reference.

Regards,
Costin