Richer formatting within Short Description

kmank
Posts: 83

Richer formatting within Short Description

Thu Jan 04, 2018 1:35 am

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
Posts: 203

Re: Richer formatting within Short Description

Thu Jan 04, 2018 3:41 pm

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
Bogdan Cercelaru
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com
kmank
Posts: 83

Re: Richer formatting within Short Description

Thu Jan 04, 2018 5:21 pm

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
Posts: 83

Re: Richer formatting within Short Description

Thu Jan 04, 2018 5:23 pm

BTW... this happens with any transformation - even the default oXygen transforms.
bogdan_cercelaru
Posts: 203

Re: Richer formatting within Short Description

Fri Jan 05, 2018 5:26 pm

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
Bogdan Cercelaru
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com
kmank
Posts: 83

Re: Richer formatting within Short Description

Fri Jan 05, 2018 6:41 pm

Thank you, Bogdan. I'll be watching for the resolution.
kmank
Posts: 83

Re: Richer formatting within Short Description

Fri Feb 23, 2018 7:02 pm

Bogdan

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

Re: Richer formatting within Short Description

Mon Feb 26, 2018 12:25 pm

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
Costin Sandoi
oXygen XML Editor and Author Support

Return to “DITA (Editing and Publishing DITA Content)”

Who is online

Users browsing this forum: No registered users and 0 guests