September 2011
Intermediate to advanced
288 pages
6h 43m
English
book
DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA
by Laura Bellamy, Michelle Carey, Jenifer Schlotfeldt
Content preview from DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Chapter 5. Short Descriptions
The <shortdesc> element is perhaps the most versatile and yet most challenging element to write for because this element does more than just act as the first paragraph in a topic. The short description text can be seen in links, and in some cases, search engine results.
After you convert content to DITA or when you start writing your first DITA topics, make writing effective short descriptions a priority.
The <shortdesc> Element
The <shortdesc> element contains the first paragraph of a topic and is valid in several locations:
• Between the <title> and body elements of standard topics (concept, task, and reference)
• Inside the <abstract> element, which also goes between the <title> and body elements
• Inside a <topicref> ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.