Difference between revisions of "Documentation Primer/Manual/en"

Jump to: navigation, search
(Updating to match new version of source page)
 
(Updating to match new version of source page)
 
(One intermediate revision by one user not shown)
Line 3: Line 3:
 
== The KDE Documentation Primer ==
 
== The KDE Documentation Primer ==
  
Revision 0.02
+
Revision 0.03
  
Date: 2005-05-21
+
Date: 2013-05-01
  
 
This document tells you everything (hopefully!) you need to know to start
 
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@kde.org]
+
writing documentation for KDE. Please report any errors or omissions to [mailto:kde-doc-english@kde.org kde-doc-english@kde.org]
  
 
== Table of Contents ==
 
== Table of Contents ==
  
# [[Documentation Primer/Manual/Introduction|Introduction]]
+
# [[Special:myLanguage/Documentation Primer/Manual/Introduction|Introduction]]
# [[Documentation Primer/Manual/Getting Started|Getting Started]]
+
# [[Special:myLanguage/Documentation Primer/Manual/Getting Started|Getting Started]]
## [[Documentation Primer/Manual/Getting Started#Things You'll Need|Things You'll Need]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Getting Started#Things You'll Need|Things You'll Need]]
# [[Documentation Primer/Manual/Guidelines|KDE Writing Recommendations and Guidelines]]
+
# [[Special:myLanguage/Documentation Primer/Manual/Guidelines|KDE Writing Recommendations and Guidelines]]
## [[Documentation Primer/Manual/Guidelines#Writing for your Audience|Writing for your Audience]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Guidelines#Writing for your Audience|Writing for your Audience]]
## [[Documentation Primer/Manual/Guidelines#English Usage Guidelines and Recommendations|English Usage Guidelines and Recommendations]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Guidelines#English Usage Guidelines and Recommendations|English Usage Guidelines and Recommendations]]
## [[Documentation Primer/Manual/Guidelines#What to Include|What to Include]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Guidelines#What to Include|What to Include]]
# [[Documentation Primer/Manual/Writing|Writing Documentation: Procedures and Tools]]
+
# [[Special:myLanguage/Documentation Primer/Manual/Writing|Writing Documentation: Procedures and Tools]]
## [[Documentation Primer/Manual/Writing#Getting the Documentation Sources|Getting the Documentation Sources]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Writing#Getting the Documentation Sources|Getting the Documentation Sources]]
## [[Documentation Primer/Manual/Writing#Kate|Kate]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Writing#Kate|Kate]]
## [[Documentation Primer/Manual/Writing#Emacs and PsgmlEmacs and Psgml|Emacs and PsgmlEmacs and Psgml]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Writing#Emacs and PsgmlEmacs and Psgml|Emacs and PsgmlEmacs and Psgml]]
## [[Documentation Primer/Manual/Writing#Checking and Viewing the Documents|Checking and Viewing the Documents]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Writing#Checking and Viewing the Documents|Checking and Viewing the Documents]]
# [[Documentation Primer/Manual/DocBook|DocBook Introduction]]
+
# [[Special:myLanguage/Documentation Primer/Manual/DocBook|DocBook Introduction]]
## [[Documentation Primer/Manual/DocBook#Overview|Overview]]
+
## [[Special:myLanguage/Documentation Primer/Manual/DocBook#Overview|Overview]]
## [[Documentation Primer/Manual/DocBook#Content and Presentation|Content and Presentation]]
+
## [[Special:myLanguage/Documentation Primer/Manual/DocBook#Content and Presentation|Content and Presentation]]
## [[Documentation Primer/Manual/DocBook#KDE Specialities|KDE Specialities]]
+
## [[Special:myLanguage/Documentation Primer/Manual/DocBook#KDE Specialities|KDE Specialities]]
# [[Documentation Primer/Manual/Publishing|Sending the New Documents and Changes to KDE]]
+
# [[Special:myLanguage/Documentation Primer/Manual/Publishing|Sending the New Documents and Changes to KDE]]
## [[Documentation Primer/Manual/Publishing#Respecting the Release Schedule|Respecting the Release Schedule]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Publishing#Respecting the Release Schedule|Respecting the Release Schedule]]
## [[Documentation Primer/Manual/Publishing#Working With Other Documenters and Developers|Working With Other Documenters and Developers]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Publishing#Working With Other Documenters and Developers|Working With Other Documenters and Developers]]
## [[Documentation Primer/Manual/Publishing#Updating Documentation|Updating Documentation]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Publishing#Updating Documentation|Updating Documentation]]
## [[Documentation Primer/Manual/Publishing#Licenses for KDE Documentation|Licenses for KDE Documentation]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Publishing#Licenses for KDE Documentation|Licenses for KDE Documentation]]
## [[Documentation Primer/Manual/Publishing#Using bugs.kde.org|Using bugs.kde.org]]
+
## [[Special:myLanguage/Documentation Primer/Manual/Publishing#Using bugs.kde.org|Using bugs.kde.org]]
#[[Documentation Primer/Manual/DocBook Reference|Appendix A. DocBook Reference]]
+
#[[Special:myLanguage/Documentation Primer/Manual/DocBook Reference|Appendix A. DocBook Reference]]
#[[Documentation Primer/Manual/Visual Guide|Appendix B. The KDE Visual Guide]]
+
#[[Special:myLanguage/Documentation Primer/Manual/Visual Guide|Appendix B. The KDE Visual Guide]]
  
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Latest revision as of 19:11, 1 June 2013

Other languages:English 100%

[edit] The KDE Documentation Primer

Revision 0.03

Date: 2013-05-01

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@kde.org

[edit] Table of Contents

  1. Introduction
  2. Getting Started
    1. Things You'll Need
  3. KDE Writing Recommendations and Guidelines
    1. Writing for your Audience
    2. English Usage Guidelines and Recommendations
    3. What to Include
  4. Writing Documentation: Procedures and Tools
    1. Getting the Documentation Sources
    2. Kate
    3. Emacs and PsgmlEmacs and Psgml
    4. Checking and Viewing the Documents
  5. DocBook Introduction
    1. Overview
    2. Content and Presentation
    3. KDE Specialities
  6. Sending the New Documents and Changes to KDE
    1. Respecting the Release Schedule
    2. Working With Other Documenters and Developers
    3. Updating Documentation
    4. Licenses for KDE Documentation
    5. Using bugs.kde.org
  7. Appendix A. DocBook Reference
  8. Appendix B. The KDE Visual Guide

This page was last modified on 1 June 2013, at 19:11. This page has been accessed 615 times. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal