Ex Novelldtd

7/29/2019 Ex Novelldtd

http://slidepdf.com/reader/full/ex-novelldtd 1/32

Novell

www . n o v e l l . c om

The Novell DTD

Documentation

A p r i l 2 8 , 2 0 0 6

T H E N O V E L L D T D



Legal Notices

Novell, Inc. makes no representations or warranties with respect to the contents or use of this documentation, and

specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose.

Further, Novell, Inc. reserves the right to revise this publication and to make changes to its content, at any time,

without obligation to notify any person or entity of such revisions or changes.

Further, Novell, Inc. makes no representations or warranties with respect to any software, and specifically disclaimsany express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc.

reserves the right to make changes to any and all parts of Novell software, at any time, without any obligation to

notify any person or entity of such changes.

Any products or technical information provided under this Agreement may be subject to U.S. export controls and the

trade laws of other countries. You agree to comply with all export control regulations and to obtain any required

licenses or classification to export, re-export or import deliverables. You agree not to export or re-export to entities on

the current U.S. export exclusion lists or to any embargoed or terrorist countries as specified in the U.S. export laws.

You agree to not use deliverables for prohibited nuclear, missile, or chemical biological weaponry end uses. Please

refer to www.novell.com/info/exports/ for more information on exporting Novell software. Novell assumes no

responsibility for your failure to obtain any necessary export approvals.

Copyright © 2006 Novell, Inc. All rights reserved. No part of this publication may be reproduced, photocopied,stored on a retrieval system, or transmitted without the express written consent of the publisher.

Novell, Inc. has intellectual property rights relating to technology embodied in the product that is described in this

document. In particular, and without limitation, these intellectual property rights may include one or more of the U.S.

patents listed at http://www.novell.com/company/legal/patents/ and one or more additional patents or pending patent

applications in the U.S. and in other countries.

Novell, Inc.

404 Wyman Street, Suite 500

Waltham, MA 02451

U.S.A.

www.novell.com

To access the online documentation for this and other Novell products, and to get updates, see www.novell.com/

documentation.



Novell Trademarks

Novell is a registered trademark of Novell, Inc., in the United States and other countries.

SUSE is a registered trademark of Novell, Inc., in the United States and other countries.

Third-Party Materials

All third-party trademarks are the property of their respective owners.





5

Contents

About This Guide 9

1 The Novell DTD 11

1.1 Elements Listed by Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.2 Elements Listed Alphabetically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.2.1 abstract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.2.2 appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.2.3 application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.2.4 author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.2.5 authorgroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.2.6 book. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.2.7 bookinfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.2.8 bridgehead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.2.9 callout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.2.10 calloutlist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131.2.11 chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.2.12 citetitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.2.13 co. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.2.14 colspec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.2.15 command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.2.16 emphasis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1.2.17 entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1.2.18 envar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1.2.19 example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1.2.20 figure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1.2.21 filename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.2.22 firstname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.2.23 formalpara . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.2.24 glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161.2.25 glossdef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.2.26 glossdiv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.2.27 glossentry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

1.2.28 glossterm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

1.2.29 guimenu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

1.2.30 imagedata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

1.2.31 imageobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

1.2.32 important . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

1.2.33 index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.2.34 indexterm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.2.35 informalfigure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.2.36 informaltable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.2.37 inlinemediaobject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.2.38 invpartnumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.2.39 itemizedlist. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

1.2.40 keycap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

1.2.41 keycombo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

1.2.42 legalnotice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

1.2.43 link. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

1.2.44 listitem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.2.45 literal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.2.46 mediaobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.2.47 member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20



6 The Novell DTD

1.2.48 menuchoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.2.49 msgexplan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.2.50 msgset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.2.51 msgtext. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.2.52 note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.2.53 option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.2.54 orderedlist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.2.55 para . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221.2.56 part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

1.2.57 partintro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

1.2.58 phrase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

1.2.59 preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

1.2.60 primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

1.2.61 procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

1.2.62 productname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

1.2.63 productnumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

1.2.64 quote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

1.2.65 refclass. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

1.2.66 refentry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

1.2.67 refentrytitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

1.2.68 refmeta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

1.2.69 refname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241.2.70 refnamediv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

1.2.71 refpurpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

1.2.72 refsect1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

1.2.73 refsect2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

1.2.74 refsect3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

1.2.75 remark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

1.2.76 replaceable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

1.2.77 row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

1.2.78 screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

1.2.79 secondary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

1.2.80 sect1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

1.2.81 sect2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

1.2.82 sect3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

1.2.83 sect4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271.2.84 see . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

1.2.85 seealso. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

1.2.86 shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

1.2.87 simplelist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

1.2.88 simplemsgentry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

1.2.89 spanspec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

1.2.90 step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

1.2.91 subscript. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

1.2.92 substeps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

1.2.93 superscript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

1.2.94 surname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

1.2.95 systemitem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

1.2.96 table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

1.2.97 tbody . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291.2.98 term . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

1.2.99 tertiary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

1.2.100 textobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

1.2.101 tgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

1.2.102 thead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

1.2.103 tip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

1.2.104 title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

1.2.105 titleabbrev. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

1.2.106 trademark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31



7

1.2.107 ulink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

1.2.108 variablelist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

1.2.109 varlistentry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

1.2.110 warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

1.2.111 xref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32



8 The Novell DTD



9

About This Guide

Novell® documentation uses NovDocX.dtd, which is a subset of docbook. This book lists and

describes the NovDocX elements.

• Chapter 1, “The Novell DTD,” on page 11

Audience

This document is intended for volunteer writers and editors who contribute product and developer

documentation for open source projects that are sponsored by Novell and supported by Novell

Product and Developer Documentation.

Feedback

We want to hear your comments and suggestions about this manual and the other documentation

prepared for volunteers to open source documentation projects. Please use the User Commentsfeature at the bottom of each page of the online documentation, or go to www.novell.com/

documentation/feedback.html and enter your comments there.

Documentation Updates

For the most recent version of the Novell DTD guide, visit the Contributing to Novell Open Source

Documentation Web site (http://www.novell.com/documentation/osauthoring/).

Additional Documentation

For information about preparing Open Source Documentation, see the following:

• Style Quick Start (http://www.novell.com/documentation/osauthoring/ex_osstyle/data/ex_osstyle.html)

• Graphics Style Quick Start (http://www.novell.com/documentation/osauthoring/ex_osgraphics/

data/ex_osgraphics.html)

• Authoring Quick Start (http://www.novell.com/documentation/osauthoring/ex_osauth/data/

ex_osauth.html)

Documentation Conventions

In Novell documentation, a greater-than symbol (>) is used to separate actions within a step and

items in a cross-reference path.

A trademark symbol (®

,TM

, etc.) denotes a Novell trademark. An asterisk (*) denotes a third-partytrademark.

http://www.novell.com/documentation/osauthoring/



http://www.novell.com/documentation/osauthoring/ex_osstyle/data/ex_osstyle.html

http://www.novell.com/documentation/osauthoring/ex_osgraphics/data/ex_osgraphics.html

http://www.novell.com/documentation/osauthoring/ex_osauth/data/ex_osauth.html













10 The Novell DTD



The Novell DTD

1

11

1The Novell DTD

Novell prepares documents using a structured authoring framework that is based on DocBook

document type definitions (DTDs) for XML (Extensible Markup Language). Novell®

documentation uses NovDocX.dtd, which is a subset of the docbook DTD. These DocBook-based

XML elements define the role of the various content, but do not specify presentation information.

Presentation is controled with separate specifications and style sheets, which enable the document to

be output to multiple formats and purposes.

• “Elements Listed by Category” on page 11

• “Elements Listed Alphabetically” on page 11

For more information about DocBook, see DocBook: The Definitive Guide (http://docbook.org/tdg/

en/html/docbook.html) by Norman Walsh and Leonard Muellner, which is available online at

DocBook.org (http://www.docbook.org) .

1.1 Elements Listed by Category

1.2 Elements Listed Alphabetically

This section lists the NovDocX elements in alphabetical order, and gives a brief description of each,

along with a list of parent elements and child elements.

No indication is given about whether an element is required or whether more than one can be used ata given level, because those relationships can change depending on the presence or absence of other

elements. If you need additional information about required elements, check the actual NovDocX

DTD at (http://www.novell.com/documentation/osauthoring).

The “Children” paragraph under each element does not list all the “Grandchildren” elements that

could be available at deeper levels. For example, the only heading level listed under sect1is sect2.

However, sect3 is available as a child of sect2, and sect4 is available as a child of sect3.

Category Elements

Admonition Elements important, note, tip, warning.

Common Elements example, screen, remark, para, formalpara, indexterm.

Figure Elements figure, informalfigure.

Inline Elements cross-reference inline elements: xref , link, ulink.

basic inline elements: command, envar , literal, emphasis, option, replaceable,

remark, filename, indexterm, citetitle, quote, phrase.

GUI inline elements: keycombo, keycap, menuchoice.

List Elements itemizedlist, orderedlist, simplelist, variablelist, callout.

Table Elements table, informaltable.

http://docbook.org/tdg/en/html/docbook.html


http://www.docbook.org/

http://www.novell.com/documentation/osauthoring







http://www.docbook.org/





12 The Novell DTD

If you are using the FrameMaker structured authoring tool, many of these elements are

automatically inserted when you insert an element that has additional required elements.

1.2.1 abstract

A summary of the content with which it is associated.

Parents: chapter

Children: para

Comment: Provided for backward compatibility with SUSE documentation. Don’t use it in Novell

Provo documentation.

1.2.2 appendix

An appendix in a book.

Parents: book, part.

Children: callout, citetitle, command, emphasis, envar, example, figure, filename, formalpara,

important, indexterm, indexterm, informalfigure, informaltable, itemizedlist, keycap, keycombo,

link, literal, menuchoice, msgset, note, option, orderedlist, para, phrase, procedure, quote, refentry,

remark, remark, replaceable, screen, sect1, simplelist, table, tip, title, ulink, variablelist, warning,

xref.

1.2.3 application

The name of a software program.

Parents: refclass

Children: Contains text only (no additional inlines).



1.2.4 author

Holds information about the author of the document in which it occurs.

Parents: authorgroup

Children: firstname, surname

Comment: Provided for backward compatibility with SUSE documentation. Don’t use it in NovellProvo documentation.

1.2.5 authorgroup

Wrapper for author information when a document has multiple authors or collaborators.

Parents: bookinfo



The Novell DTD 13

Children: author



1.2.6 book

A complete book.

Children: appendix, bookinfo, chapter, glossary, index, part, preface

Comment: A book can also contain a Table of Contents or an Index. However, because the content

of these files is generated, they are not specifically listed as child elements.

1.2.7 bookinfo

In NovDocX.dtd, this element is used to create the front matter for a book. For information about the

content and order of information in the bookinfo file, see “Required Content for Guides” in the

Deliverable Content Guidelines book.

Parents: book

Children: invpartnumber, productname, productnumber, titleabbrev

Comment: In the Frame tool, creating a bookinfo file brings in all the required elements and the

standard boilerplate content.

1.2.8 bridgehead

A free-floating heading

Parents: sect1, sect2, sect3, sect4

Children: command, envar, productname, literal, emphasis, option, replaceable, remark, filename,

indexterm, citetitle, quote, phrase, systemitem, guimenu, subscript, superscript, trademark

1.2.9 callout

A visual device for associating annotations with an image, program listing, or similar figure.

Parents: calloutlist.

Children: para

Comments: This element, along with co and calloutlist, allows you to cross-reference from running

text to a line within a code sample that uses the screen element. It is not the same thing as a graphiccallout.

1.2.10 calloutlist

A list of annotations or descriptions.

Parents: Under discussion. Will include a subset of the following: appendix, callout, chapter,

example, glossary, glossdef, glossdiv, important, legalnotice, listitem, msgexplan, msgtext, note,



14 The Novell DTD

para, partintro, preface, procedure, refsect1, refsect2, refsect3, refsection, sect1, sect2, sect3, sect4,

step, textobject, tip, warning

Children: callout

Comments: This element, along with co and callout, allows you to cross-reference from running

text to a line within a code sample that uses the screen element. It is not the same thing as a graphic

callout.

1.2.11 chapter

Chapter of a book.

Parents: book, part

Children: abstract, callout, citetitle, command, emphasis, envar, example, figure, filename,

formalpara, important, indexterm, informalfigure, informaltable, itemizedlist, keycap, keycombo,

link, literal, menuchoice, msgset, note, option, orderedlist, para, phrase, procedure, quote, refentry,

remark, replaceable, screen, sect1, simplelist, table, tip, title, ulink, variablelist, warning, xref.

1.2.12 citetitle

Provides inline markup for the title of a cited work.

Parents: command, envar, literal, emphasis, option, replaceable, remark, filename, indexterm,

citetitle, quote, phrase.

Children: ulink, xref, link

1.2.13 co

The location of a callout embedded in text.

Parents: Under discussion. Will include the following: replaceable, screen.

Comments: This element, along with calloutlist and callout, allows you to cross-reference from

running text to a line within a code sample that uses the screen element. It is not the same thing as a

graphic callout.

1.2.14 colspec

Specifications for a column in a table.

Parents: tfoot, tgroup, thead.

1.2.15 command

The name of an executable program or other software command

Parents: envar, literal, emphasis, option, refname, replaceable, remark, filename, indexterm,

citetitle, quote, phrase, screen

Children: text, option, replaceable



The Novell DTD 15

Comment: For Novell Provo writers, this is not the same Command element used in previous

versions of NovDoc. The old Command element was used to identify information that users were

expected to type, and produced bold body text. This element identifies an executable name or a

command name, and produces a monospaced font.

1.2.16 emphasis

Emphasized text.

Parents: command, envar, literal, emphasis, option, replaceable, remark, filename, indexterm,

citetitle, quote, phrase, screen

Children: Contains only text (no inline elements).

Comment: This element produces italicized text.

1.2.17 entry

A cell in a table.

Parents: row

Children: figure, formalpara, important, informalfigure, itemizedlist, note, orderedlist, para, screen,

simplelist, tip, warning

1.2.18 envar

A software environment variable.

Parents: command, envar, literal, emphasis, option, refname, replaceable, remark, filename,

indexterm, citetitle, quote, phrase.

Children: Contains only text (no additional inline elements).

1.2.19 example

A formal example, with a title.

Parents: appendix, chapter, listitem, partintro, preface, procedure, refsect1, refsect2, refsect3, sect1,

sect2, sect3, step

Children: calloutlist, formalpara, glosslist, indexterm, itemizedlist, orderedlist, para, screen,

simplelist, title, variablelist

Comments: Novell Provo writers shouldn’t use this element until the managers have created

guidelines for using it.

1.2.20 figure

A figure with a title.

Parents: appendix, chapter, entry, listitem, partintro, procedure, sect1, sect2, sect3, step

Children: mediaobject, title



16 The Novell DTD

1.2.21 filename

The name of a file. It can be a simple name or can include a path or other elements specific to the

operating system.

Parents: glossterm, link, member, para, refname, refpurpose, term, title, ulink

Children: text, replaceable

1.2.22 firstname

The first name of a person.

Parents: author




1.2.23 formalpara

A paragraph with a run-in title.

Parents: appendix, chapter, entry, example, glossary, legalnotice, listitem, partintro, preface,

procedure, refsect1, refsect2, refsect3, sect1, sect2, sect3, step

Children: para, title

1.2.24 glossary

A glossary containing a collection of terms and brief descriptions or definitions of those terms.

Parents: book

Children: formalpara, glossdiv, glossentry, para, remark, title

1.2.25 glossdef

A definition in a glossentry, containing the description or definition of a glossterm.

Parents: glossentry

Children: para

1.2.26 glossdiv

A division in a glossary, such as an alphabetical division. A glossary can contain any number of

glossentry or glossdiv elements, but it cannot contain a mixture of both at the same level.

Parents: glossary

Children: glossentry



The Novell DTD 17

1.2.27 glossentry

A wrapper around a glossary term and its definition.

Parents: glossary, glossdiv

Children: glossdef, glossterm

1.2.28 glossterm

Identifies a term that appears in a glossary.

Parents: glossentry

Children: command, envar, literal, emphasis, option, replaceable, remark, filename, indexterm,

citetitle, quote, phrase

1.2.29 guimenu

The name of a menu in a graphical user interface.

Parents: menuchoice


Comments: In the Frame tool, used to identify all graphical user interface items.

1.2.30 imagedata

Points to an external entity containing graphical image data.

Parents: imageobject

1.2.31 imageobject

A wrapper for image data and its associated meta-information.

Parents: inlinemediaobject, mediaobject

Children: imagedata

1.2.32 important

An admonition set off from the text.

Parents: appendix, chapter, entry, listitem, msgexplan, partintro, preface, procedure, refsect1,refsect2, refsect3, sect1, sect2, sect3, step

Children: title, para, remark, simplelist, itemizedlist, screen



18 The Novell DTD

1.2.33 index

An index.

Comment: No “content” in terms of elements, because the content is generated.

1.2.34 indexterm

A wrapper for terms to be indexed.

Parents: appendix, chapter, example, listitem, partintro, preface, procedure, refsect1, refsect2,

refsect3, screen, sect1, sect2, sect3

Children: primary, secondary, see, seealso, tertiary

Comment: Because indexes are generated, there is no need for a separate Index element.

1.2.35 informalfigure

A figure without a title.

Parents: appendix, chapter, entry, listitem, partintro, preface, procedure, refsect1, refsect2, refsect3,

sect1, sect2, sect3, step

Children: mediaobject

1.2.36 informaltable

A table without a title.


sect2, sect3, step

Children: tgroup

1.2.37 inlinemediaobject

An inline media object (video, audio, image, and so on).

Parents: member, para, term

Children: imageobject, textobject

1.2.38 invpartnumber

An inventory part number.

Parents: bookinfo

Children: Contains only text (no inline elements)



The Novell DTD 19

1.2.39 itemizedlist

A list in which each entry is marked with a bullet, dash, or other symbol.

Parents: appendix, chapter, entry, important, listitem, note, partintro, preface, procedure, refsect1,

refsect2, refsect3, sect1, sect2, sect3, step, tip

Children: listitem

Comment: This can be a bulleted list or a checklist, depending on the character you select.

1.2.40 keycap

The text printed on a key on a keyboard.

Parents: keycombo, member, para, refname, refpurpose, shortcut, term


Comments: Provided for backward compatibility with SUSE documentation. Don’t use it in Novell


1.2.41 keycombo

For actions that require multiple keystrokes, mouse actions, or other physical input selections, the

KeyCombo element provides a wrapper for the entire set of events.

Parents: member, para, refname, refpurpose, shortcut, term

Children: keycap

Comments: Provided for backward compatibility with SUSE documentation. Don’t use it in Novell


1.2.42 legalnotice

A statement of legal obligations or requirements.

Parents: bookinfo

Children: formalpara, para, remark, simplelist, title

1.2.43 link

A hypertext link. Usually, link surrounds the text that should be made “hot” (unlike xref, which must

generate the text).

Parents: citetitle, member, para, refentry, refnamediv, refpurpose, term





20 The Novell DTD

1.2.44 listitem

A wrapper for the elements of a list item.

Parents: itemizedlist, orderedlist, varlistentry


important, indexterm, informalfigure, informaltable, itemizedlist, keycap, keycombo, link, literal,menuchoice, note, option, orderedlist, para, phrase, quote, remark, replaceable, screen, sect4,

simplelist, table, tip, ulink, variablelist, warning, xref

1.2.45 literal

Inline text that is a specific piece of data, taken literally from a computer system.

Parents: glossterm, member, para, refname, refpurpose, term, title

Children: replaceable

Comment: The inline equivalent of the screen element.

1.2.46 mediaobject

A displayed media object (video, audio, image, etc.)

Parents: figure, informalfigure

Children: imageobject, textobject

1.2.47 member

An element of a simple list.

Parents: simplelist

Children: citetitle, command, emphasis, envar, filename, indexterm, keycap, keycombo, link,

literal, menuchoice, option, phrase, quote, remark, replaceable, ulink, xref

1.2.48 menuchoice

A selection or series of selections from a menu.

Parents: member, para, refname, refpurpose, term

Children: guimenu, shortcut

1.2.49 msgexplan

Explanatory material relating to a message in a message set. Contains a headword such as Source,

Severity, Problem, Possible Cause, Explanation, or Action, followed by explanatory material.

Parents: msgentry



The Novell DTD 21

Children: bridgehead, calloutlist, example, figure, formalpara, glosslist, important, indexterm,

informalfigure, informaltable, itemizedlist, mediaobject, msgset, note, orderedlist, para, procedure,

screen, simplelist, table, tip, title, variablelist, warning

1.2.50 msgset

A detailed set of messages, usually error messages.

Parents: appendix, callout, chapter, glossary, glossdiv, index, listitem, msgexplan, msgtext,

partintro, preface, procedure, refsect1, refsect2, refsect3, sect1, sect2, sect3, sect4, sect5, section,

step

Children: msgentry, title.

1.2.51 msgtext

The actual text of a message component in a message setA detailed set of messages, usually error

messages.

Parents: bridgehead, citation, citetitle, command, emphasis, entry, filename, glossterm, hardware,

keycap, literal, para, refentrytitle, refname, refpurpose, screen, secondary, see, seealso, term,

tertiary, title, ulink, userinput.

Children: bridgehead, calloutlist, example, figure, formalpara, glosslist, important, indexterm,

informalfigure, informaltable, itemizedlist, mediaobject, msgset, note, orderedlist, para, procedure,

screen, simplelist, table, tip, variablelist, warning.

1.2.52 note

A message set off from the text.

Parents: appendix, chapter, entry, listitem, msgexplan, partintro, preface, procedure, refsect1,refsect2, refsect3, sect1, sect2, sect3, step


1.2.53 option

An an optional argument to a software command.

Parents: link, member, para, term, ulink


1.2.54 orderedlist

A list in which each entry is marked with a sequentially incremented label, such as a numeral, letter,

or other sequential symbol (for example, roman numerals).

Parents: appendix, chapter, entry, example, listitem, para, partintro, preface, procedure, refsect1,

refsect2, refsect3, sect1, sect2, sect3, step

Children: listitem



22 The Novell DTD

Comment: Usually a numbered list.

1.2.55 para

A paragraph.

Parents: abstract, appendix, callout, chapter, entry, example, formalpara, glossary, glossdef,important, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, partintro, preface, procedure,

refsect1, refsect2, refsect3, sect1, sect2, sect3, step, tip, warning



1.2.56 part

A division in a book.

Parents: book

Children: appendix, chapter, partintro, title

1.2.57 partintro

Introductory text, often an overview of the content of the Part.

Parents: part


important, indexterm, informalfigure, informaltable, itemizedlist, keycap, keycombo, link, literal,

menuchoice, note, option, orderedlist, para, phrase, quote, remark, replaceable, screen, sect1,

simplelist, table, tip, ulink, variablelist, warning, xref

1.2.58 phrase

A span of text used as the content in a text object.

Parents: glossterm, link, member, para, refpurpose, term, textobject, title, ulink


1.2.59 preface

Introductory matter preceding the first chapter of a book.

Parents: book


important, indexterm, indexterm, informalfigure, informaltable, itemizedlist, keycap, keycombo,

link, literal, menuchoice, note, option, orderedlist, para, phrase, procedure, quote, remark,

replaceable, sect1, screen, simplelist, table, tip, title, ulink, variablelist, warning, xref



The Novell DTD 23

1.2.60 primary

The primary word or phrase under which an index term should be sorted.

Parents: indexterm


1.2.61 procedure

Encapsulates a task composed of steps.

Parents: appendix, chapter, preface, refsect1, refsect2, refsect3, sect1, sect2, sect3, step



menuchoice, note, option, orderedlist, para, phrase, quote, remark, replaceable, screen, simplelist,

step, table, tip, title, ulink, variablelist, warning, xref

1.2.62 productname

The formal name of a product.

Parents: bookinfo


1.2.63 productnumber

A number assigned to a product.

Parents: bookinfo


1.2.64 quote

An inline quotation.

Parents: glossterm, member, para, term, ulink


1.2.65 refclass

The scope or other indication of applicability of a reference entry.

Parents: refnamediv


Comment: An NDK element.



24 The Novell DTD

1.2.66 refentry

A wrapper for any small unit of reference documentation describing a single topic. Canonical

examples are programming language functions and user commands (one refentry per function or

command).

Parents: appendix, chapter

Children: link, refmeta, refnamedive, refsect1, ulink, xref


1.2.67 refentrytitle

The title of a reference page.

Parents: refmeta

Children: refentrytitle


1.2.68 refmeta

Meta-information for a reference entry, including the title of the reference page, the number of the

volume in which this reference page occurs, and possibly other miscellaneous information.

Parents: refentry

Children: refentrytitle


1.2.69 refname

The name of one of the subjects of a reference page.

Parents: refnamediv

Children: command, emphasis, envar, filename, keycap, keycombo, literal, menuchoice, option,

replaceable


1.2.70 refnamediv

The name, purpose, and classification of a reference page. Usually a section heading in the same

typographic style as a refsect1 Title.

Parents: refentry

Children: link, refclass, refname, refpurpose, ulink, xref




The Novell DTD 25

1.2.71 refpurpose

A short (one sentence) synopsis of the topic of a reference page.

Parents: refnamediv




1.2.72 refsect1

A major subsection of a reference entry.

Parents: refentry



menuchoice, note, option, orderedlist, para, phrase, procedure, quote, refsect2, remark, replaceable,

screen, simplelist, table, tip, title, ulink, variablelist, warning, xref


1.2.73 refsect2

A subsection of a refsect1.

Parents: refsect1



menuchoice, note, option, orderedlist, para, phrase, procedure, quote, remark, refsect3, replaceable,

screen, simplelist, table, tip, title, ulink, variablelist, warning, xref


1.2.74 refsect3

A subsection of a RefSect2.

Parents: refsect2



menuchoice, note, option, orderedlist, para, phrase, quote, procedure, remark, replaceable, screen,simplelist, table, title, tip, ulink, variablelist, warning, xref


1.2.75 remark

A remark (or comment) intended for presentation in a draft manuscript.



26 The Novell DTD

Parents: appendix, chapter, glossary, important, link, listitem, member, note, para, partintro,

preface, procedure, refsect1, refsect2, refsect3, sect1, sect2, sect3, step, term, tertiary, tip, title, ulink,

warning


indexterm, citetitle, quote, phrase, systemitem, guimenu, subscript, superscript, trademark,

keycombo, keycap, menuchoice, inlinemediaobject

1.2.76 replaceable

Content that can or must be replaced by the user.

Parents: glossterm, link, literal, member, para, refname, refpurpose, title, ulink


1.2.77 row

A row in a table.

Parents: tbody, tfoot, thead

Children: entry

1.2.78 screen

Text that a user sees or might see on a computer screen.

Parents: appendix, chapter, entry, example, important, listitem, note, orderedlist, partintro, preface,

procedure, refsect1, refsect2, refsect3, sect1, sect2, sect3, step, tip, warning

Children: co

Comment: The standalone equivalent of the literal element.

1.2.79 secondary

A secondary word or phrase in an index term.

Parents: indexterm


1.2.80 sect1

A top-level section of document. (Sometimes called a “first-level heading”)

Parents: appendix, chapter, partintro, preface



menuchoice, note, option, orderedlist, para, phrase, quote, procedure, refentry, remark, replaceable,

screen, sect2, simplelist, table, tip, title, ulink, variablelist, warning, xref



The Novell DTD 27

1.2.81 sect2

A subsection within a sect1. (Sometimes called a “second-level heading”)

Parents: sect1


important, indexterm, informalfigure, informaltable, itemizedlist, keycap, keycombo, link, literal,menuchoice, note, option, orderedlist, para, phrase, procedure, quote, remark, replaceable, screen,

sect3, simplelist, table, tip, title, ulink, variablelist, warning, xref

1.2.82 sect3

A subsection within a Sect2. (Sometimes called a “third-level heading”)

Parents: sect2



menuchoice, note, option, orderedlist, para, phrase, procedure, quote, remark, replaceable, screen,sect4, simplelist, table, tip, title, ulink, variablelist, warning, xref

1.2.83 sect4

A subsection within a Sect3. Sometimes called a “fourth-level heading”

Parents: sect3



menuchoice, note, option, orderedlist, para, phrase, quote, remark, replaceable, screen, simplelist,

table, tip, ulink, variablelist, warning, xref

1.2.84 see

Part of an index term directing the reader to another entry in the index.

Parents: indexterm


1.2.85 seealso

Part of an index term directing the reader also to another entry in the index.

Parents: indexterm


1.2.86 shortcut

A key combination for an action that is also accessible through a menu.



28 The Novell DTD

Parents: menuchoice

Children: keycap, keycombo

1.2.87 simplelist

A list, without bullets or numbers, made up of single words or short phrases.

Parents: appendix, chapter, entry, example, important, legalnotice, listitem, note, partintro, preface,

procedure, refsect1, refsect2, refsect3, sect1, sect2, sect3, step, tip, warning

Children: member

1.2.88 simplemsgentry

A wrapper for a simple entry in a message set.

Parents: msgset

Children:msgexplan, msgtext

1.2.89 spanspec

Formatting information for a spanned column in a table.

Parents: tgroup

1.2.90 step

A unit of action in a procedure.

Parents: procedure



menuchoice, note, option, orderedlist, para, phrase, procedure, quote, remark, replaceable, screen,

sect4, simplelist, table, tip, ulink, variablelist, warning, xref.

1.2.91 subscript

A subscript (as in H2O).


1.2.92 substeps

A wrapper for steps that occur within steps in a procedure

Parents: step

Children: step



The Novell DTD 29

1.2.93 superscript

A superscript (as in x2).


1.2.94 surname

A family name; in western cultures, the “last name.”

Parents: author




1.2.95 systemitem

A system-related item or term.



Provo documentation, except on the term root in Linux documentation.

1.2.96 table

A table with a title.


sect2, sect3, step

Children: tgroup, title

1.2.97 tbody

A wrapper for the rows of a table or informal table.

Parents: tgroup

Children: row

1.2.98 term

The word or phrase being defined or described in a variable list.

Parents: varlistentry





30 The Novell DTD

1.2.99 tertiary

A tertiary word or phrase in an index term.

Parents: indexterm


1.2.100 textobject

A wrapper for a text description of an object and its associated meta-information.

Parents: informaltable, inlinemediaobject, mediaobject, screen, table

Children: phrase

Comment: Used to describe the contents of a graphic that doesn’t have a title. The description

doesn’t appear in the text, but is voiced in a screen reader.

1.2.101 tgroupA wrapper for the main content of a table, or part of a table.

Parents: informaltable, table

Children: colspec, spanspec, tbody, tfoot, thead

1.2.102 thead

A table header consisting of one or more rows.

Parents: tgroup

Children: colspec, row

1.2.103 tip

A suggestion to the user, set off from the text.

Parents: appendix, chapter, entry, listitem, msgexplan, partintro, preface, procedure, refsect1,



1.2.104 title

The text of the title of a section of a document.

Parents: appendix, chapter, example, figure, formalpara, glossary, important, legalnotice, msgset,

note, part, preface, procedure, refsect1, refsect2, refsect3, sect1, sect2, sect3, table, tip, warning





The Novell DTD 31

1.2.105 titleabbrev

The abbreviation of a title.

Parents: bookinfo


indexterm, citetitle, quote, phrase, systemitem, guimenu, subscript, superscript, trademark

1.2.106 trademark

A trademark.

Parents: envar, literal, emphasis, option, replaceable, remark, filename, indexterm, citetitle, quote,

phrase.


Comment: Provided for compatibility with SUSE documentation. The Frame implementation of

the DTD handles trademarks differently, so Novell Provo documentation doesn’t use this element.

1.2.107 ulink

A link that addresses its target by means of a URL.

Parents: citetitle, member, para, refentry, refnamediv, refpurpose, term



1.2.108 variablelist

A list in which each entry is composed of a set of one or more terms and an associated description.

Parents: appendix, chapter, example, listitem, para, partintro, preface, procedure, refsect1, refsect2,

refsect3, sect1, sect2, sect3, step

Children: varlistentry

1.2.109 varlistentry

A wrapper for a set of terms and the associated description in a variable list.

Parents: variablelist

Children: listitem, term

1.2.110 warning

An admonition set off from the text.

Parents: appendix, chapter, entry, listitem, msgexplan, partintro, preface, procedure, refsect1,





1.2.111 xref

A cross-reference to another part of the document.

Parents: citetitle, member, para, phrase, refentry, refnamediv, refpurpose, term

Children: Contains generated text

Ex Novelldtd

Documents