The TDE Documentation Primer
Next

The TDE Documentation Primer

The KDE Documentation Team

Carlos Woelz

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".

This document provides information to start writing documentation for TDE. Please report any errors or omissions to .


Table of Contents

1. Introduction
2. Getting Started
Things You'll Need
English Knowledge
Deciding What to Write About
Access to a Recent Version
3. TDE Writing Recommendations and Guidelines
Writing for your Audience
English Usage Guidelines and Recommendations
What to Include
4. Writing Documentation: Procedures and Tools
Getting the Documentation Sources
Working with plain text sources
Retrieving the DocBook sources
Quanta
Kate
Emacs and Psgml
Checking and Viewing the Documents
Using checkXML
Using meinproc
5. DocBook Introduction
Overview
Content and Presentation
Structure
TDE Specialities
Entities
Necessary Sections
6. Sending the New Documents and Changes to TDE
Respecting the Release Schedule
Managing the Sources with Subversion
Working With Other Documenters and Developers
Updating Documentation
Licenses for TDE Documentation
Using bugs.trinitydesktop.org
7. Leveraging your Newly Acquired Knowledge
8. Credits and License
A. Widget Names
Next
 


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