Do not show shortdescriptions

Post here questions and problems related to editing and publishing DITA content.
catherine
Posts: 158
Joined: Fri Nov 10, 2017 8:16 am

Do not show shortdescriptions

Post by catherine »

Hi, I don't want to show the short descriptions under a topic link.
Only display topic links. no short descriptions.
How to solve this?
Costin
Posts: 837
Joined: Mon Dec 05, 2011 6:04 pm

Re: Do not show shortdescriptions

Post by Costin »

Hi catherine,

What document type are you trying to publish to?
An easy way to hide the <shortdescription> elements in the output would be through CSS.
If you are publishing to WebHelp Responsive, you should create a custom .css file, containing the rules below:

Code: Select all

.wh_tile_shortdesc {
display:none;
}
.wh_tile {
min-height:10px;
}
Then you should edit the DITA Map WebHelp Responsive transformation scenario, go to the "Parameters" tab, set the "args.copycss" to "yes" and set the path to your custom CSS in the "args.css" parameter.

Using the custom .css file would hide the <shortdesc> element in the output and set a minimum height for its container element.

Regards,
Costin
Costin Sandoi
oXygen XML Editor and Author Support
catherine
Posts: 158
Joined: Fri Nov 10, 2017 8:16 am

Re: Do not show shortdescriptions

Post by catherine »

Hi, Costin
Thanks for your reply!
The output is webhelp.
I mean the short description under the child link.
If I show the short description under the child link, it will make the link not so "clean".
I just want to show the child link, no short description under the child link.
Costin
Posts: 837
Joined: Mon Dec 05, 2011 6:04 pm

Re: Do not show shortdescriptions

Post by Costin »

Hi Catherine,

Just in order to clearlt understand what exactly you refer to, could you please provide a screenshot on our support email (support@oxygenxml.com) emphasizing the specific short description you need to remove from output?

Thank you!
Costin
Costin Sandoi
oXygen XML Editor and Author Support
catherine
Posts: 158
Joined: Fri Nov 10, 2017 8:16 am

Re: Do not show shortdescriptions

Post by catherine »

Hi, Costin
Thanks for your reply! :)
In our writing style, we need to write short description in each topic.
And I set to "webhelp.show.child.links" to "yes".

As a result, when I generate a webhelp output, I get child links, and also the short descriptions.

My question is, how to remove the short descriptions under the child links, and only show the child links.

Hope my problem is clear to you this time. :)
Costin
Posts: 837
Joined: Mon Dec 05, 2011 6:04 pm

Re: Do not show shortdescriptions

Post by Costin »

Hi Catherine,

I think it's clear now.

In a similar fashion, you could add a CSS rule for the specific selector matching the short descriptions in your childlinks.
I.e, to hide the short descriptions for the childlinks in your custom .css, you should use something like:

Code: Select all

.wh_child_links > nav li div {
display: none;
}
Whenever you need to customize your WebHelp output through CSS styling, you should consider this "How to" guide from our User-Guide.
It provides information on how you could find the selectors you need to apply CSS rules to, how to create and use a custom CSS containing your rules.

Regards,
Costin
Costin Sandoi
oXygen XML Editor and Author Support
catherine
Posts: 158
Joined: Fri Nov 10, 2017 8:16 am

Re: Do not show shortdescriptions

Post by catherine »

Hi, Costin
Thanks for your reply!
I added the css code in my customized css file, but it did not work?
Have you tried that?

Let me explain my demand clearly. :)

I want to show childlinks, so I set the "webhelp.show.child.links" to "yes".
But I don't want to show the short descriptions (that are written in each topic) under the childlinks.

I find that if the childlinks are "related topic" links, the short descriptions would not be displayed.
But, if the childlinks are the "child-topic of the parent-topic " links, the short descriptions would be displayed.
Costin
Posts: 837
Joined: Mon Dec 05, 2011 6:04 pm

Re: Do not show shortdescriptions

Post by Costin »

Hi Catherine,

Yes, I understood your use case and I also tested the CSS rule before.
However, it seems that, somehow, I tested this on a specific content from a file at my side, for which the rule worked, but I now tested this again against a general DITA Map that contains topics with short descriptions and I can confirm the rule I suggested does not work.
Sorry for the confusion.

We also investigated this further and found out that there is actually an issue, as the short descriptions are just plain text, not being wrapped in an XML element, so there is no selector we could use in a rule to hide them in the output.
That's why we already have an improvement request logged in our internal tracking system so our developers will try to find a possible solution, which would be implemented in a future version of oXygen. I also added your vote for it on the issue, so we will notify this thread when the improvement will get implemented.
Meanwhile, I'm afraid that currently there is no workaround I could provide you to hide the short descriptions.

Regards,
Costin
Costin Sandoi
oXygen XML Editor and Author Support
catherine
Posts: 158
Joined: Fri Nov 10, 2017 8:16 am

Re: Do not show shortdescriptions

Post by catherine »

Yes, As I checked the html source code, I got the same conclusion as yours.
Thanks, Costin!
aremaci
Posts: 5
Joined: Wed Jul 03, 2019 12:31 pm

Re: Do not show shortdescriptions

Post by aremaci »

I would also like to add my vote to this issue.
Costin
Posts: 837
Joined: Mon Dec 05, 2011 6:04 pm

Re: Do not show shortdescriptions

Post by Costin »

aremaci wrote: Thu Aug 29, 2019 12:09 pm I would also like to add my vote to this issue.
Vote added.

Regards,
Costin
Costin Sandoi
oXygen XML Editor and Author Support
natemyersibm
Posts: 3
Joined: Fri Apr 07, 2023 1:24 am

Re: Do not show shortdescriptions

Post by natemyersibm »

Hello :) I am also curious about this issue. Any updates?
ionela
Posts: 403
Joined: Mon Dec 05, 2011 6:08 pm

Re: Do not show shortdescriptions

Post by ionela »

Hi,

I'm sorry, but in the current version of Oxygen XML WebHelp this issue is not implemented. I have added your vote and comments to it.

Regards,
Ionela
Ionela Istodor
oXygen XML Editor and Author Support
julien_lacour
Posts: 514
Joined: Wed Oct 16, 2019 3:47 pm

Re: Do not show shortdescriptions

Post by julien_lacour »

Hello,

The child links description are wrapped into a <div> element:

Code: Select all

<li class="- topic/link link ulchildlink">
	<strong>
		<a href="first.html">First</a>
	</strong>
	<div class="- topic/desc desc">A short description of the task.</div>
</li>
So to remove them it is possible to use a CSS rule similar to this one:

Code: Select all

.wh_child_links .desc {
  display: none;
}
I tested this scenario using <oXygen/> XML Editor 26.1, build 2024031806 and the 'webhelp.show.child.links' parameter enabled.

Regards,
Julien
Post Reply