May 2010
Intermediate to advanced
552 pages
13h 37m
English
Content preview from DocBook 5: The Definitive GuideBecome 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.
Name
refnamediv — The name, purpose, and classification of a reference page
Synopsis
refnamediv ::=
(refdescriptor?,
refname+, refpurpose,
refclass*)
Attribute synopsis
Description
A refnamediv is the first mandatory section in
a refentry. It is a peer to
refsynopsisdiv and
refsect1.
The elements in refnamediv identify the topic
of the reference page (refdescriptor or
refname), provide a concise summary
(refpurpose), and classify the page
(refclass).
Processing expectations
Formatted as a displayed block. A refnamediv
usually generates a section heading, in the same typographic style as
a refsect1 title, called
“Name.”
The content of this section is traditionally the
refdescriptor or refname, and
the refpurpose, separated by
an em dash.
The refclass may be presented, or it may be
suppressed and used only to select a group of reference pages to
process. You might use the value of refclass to
print all the reference pages appropriate to Solaris
UNIX, for example.
Formatting reference pages may require a fairly sophisticated
processing system. Much of the meta-information about a reference page
(its name, type, purpose, title, and classification) is stored in
wrappers near the beginning of the refentry.
Common presentational features, such as titles and running headers, may require data from several of these wrappers plus some generated text. Other formatting often requires that these elements be reordered.
See Also
refsect1, refsect2, refsect3,
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.