The KDE Documentation PrimerRevision Frameworks 5.61 (2019-08-04)
Copyright © 2004 Carlos Woelz
Copyright © 2004, 2005, 2010, 2016, 2019, 2020, 2021, 2023 The KDE Documentation Team
This document tells you everything 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. 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, Videos, 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
List of Examples
- A.1. Managing translatable entities
- A.2. A KDE User Manual Prolog
- A.3. A Segmented List
- A.4. An
<informaltable>template - A.5. A
<table>template - A.6. An example from a menu reference entry
- A.7.
<qandaset>Template - A.8. A screenshot example
- A.9. A video example
- A.10. How to markup a command synopsis
- A.11. How to markup a function synopsis
- A.12. Marking up callouts with
<screenco>. - A.13. Marking up callouts by embedding directly in text
- A.14. How to markup a glossary
- A.15. Index