The TDE DocBook Markup Guide
Next

The TDE DocBook Markup Guide

Lauri Watts

The TDE Team

Revision R14.0.12 (April 21, 2022)

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

A reference guide to TDE DocBook markup standards. Please report any errors or omissions to .


Table of Contents

1. General TDE markup style guide
2. Purpose of this document
Other reference material
3. The Prologue
book and the bookinfo section
4. Chapters and Sections
5. The linking elements
6. Lists
7. Tables
8. The GUI elements, menus, toolbars and shortcuts.
9. Describing actions and commands
10. Questions and Answers
11. Images and Examples
12. General markup (not covered elsewhere)
13. Admonitions: Tips, hints, and Warnings.
14. The synopsis elements
15. Markup for programming
16. Making Callouts
17. References, indexes, and glossaries
Making a glossary
Making an Index
Other Reference Sections
18. Tags we do not use
19. Alphabetical List of all elements
20. Credits and License
A. Entities

List of Examples

1.1. Managing translatable entities
3.1. Setting up the global “kappname” entity
3.2. A TDE User Manual Prolog
3.3. The bookinfo section from the TDE template
6.1. A Segmented List
7.1. An <informaltable> template
7.2. A <table> template
8.1. An example from a menu reference entry
10.1. <qandaset> Template
11.1. A screenshot example
14.1. How to markup a command synopsis
14.2. How to markup a function synopsis
16.1. Marking up callouts with <screenco>.
16.2. Marking up callouts by embedding directly in text
17.1. How to markup a glossary
17.2. Index
Next
 


Would you like to comment or contribute an update to this page?
Send feedback to the TDE Development Team