The KDE Documentation PrimerRevision 0.02 (2005-05-21)
Copyright © 2004 The KDE Documentation Team
Copyright © 2004 Carlos Woelz
This document tells you everything (hopefully!) you need to know to start
writing documentation for KDE. Please report any errors or omissions to
(kde-doc-english AT kde.org).
Table of Contents
- 1. Introduction
- 2. Getting Started
- 3. KDE Writing Recommendations and Guidelines
- 4. Writing Documentation: Procedures and Tools
- 5. DocBook Introduction
- 6. Sending the New Documents and Changes to KDE
- 7. Leveraging your Newly Acquired Knowledge
- 8. Credits and License
- A. KDE DocBook Reference
- General KDE markup style guide
- Purpose of this document
- The Prologue
bookand thebookinfosection- Chapters and Sections
- The linking elements
- Lists
- Tables
- The GUI elements, menus, toolbars and shortcuts.
- Describing actions and commands
- Questions and Answers
- Images and Examples
- General markup (not covered elsewhere)
- Admonitions: Tips, hints, and Warnings.
- The synopsis elements
- Markup for programming
- Making Callouts
- References, indexes, and glossaries
- Tags we do not use
- Alphabetical List of all elements
- Credits and License
- B. Widget Names
List of Examples
- A.1. Managing translatable entities
- A.2. Setting up the global “kappname” entity
- A.3. A KDE User Manual Prolog
- A.4. The bookinfo section from the KDE template
- A.5. A Segmented List
- A.6. An
<informaltable>template - A.7. A
<table>template - A.8. An example from a menu reference entry
- A.9.
<qandaset>Template - A.10. A screenshot example
- A.11. How to markup a command synopsis
- A.12. How to markup a function synopsis
- A.13. Marking up callouts with
<screenco>. - A.14. Marking up callouts by embedding directly in text
- A.15. How to markup a glossary
- A.16. Index