Page 1 of 1

Hide short description in topic file

Posted: Wed Dec 20, 2017 10:55 am
by catherine
Hi,
I write short description in my first-level topic, so the short description will display below the webhelp title.
But, I want to hide the short description in the topic, just like oxygen webhelp.

short description displays below the title.
For example, below the title "getting started", the short description is "Information and resources to help you get started using Oxygen XML Editor as quickly as possible".
https://www.oxygenxml.com/doc/versions/ ... index.html

but this short description should not display in the topic "getting started"
https://www.oxygenxml.com/doc/versions/ ... intro.html

How to achive this?

Re: Hide short description in topic file

Posted: Wed Dec 20, 2017 11:09 am
by Radu
Hi Catherine,

Here's how we do it in our user's manual DITA Map:

Code: Select all

  <topicref href="../topics/getting-started-intro.dita" collection-type="sequence">
    <topicmeta>
      <shortdesc>Information and resources to help you get started using <ph keyref="product"/> as
        quickly as possible</shortdesc>
    </topicmeta>


so basically we define the shortdesc in the DITA Map instead of placing it inside the topic.
Or you could leave the shortdesc in the topic and maybe write a custom CSS selector to hide it.

Regards,
Radu

Re: Hide short description in topic file

Posted: Thu Dec 21, 2017 3:37 am
by catherine
Great! Thanks. Radu!