Difference between revisions of "Projects/Documentation/KDE4"

Jump to: navigation, search
m
(4.11 -> 4.12)
 
(One intermediate revision by one user not shown)
Line 10: Line 10:
 
== Beginner ==
 
== Beginner ==
 
=== EBN ===
 
=== EBN ===
EBN, or the [http://www.englishbreakfastnetwork.org English Breakfast Network], is a utility that both developers and documentation writers use to make sure they have created perfection for KDE. For documentation, there are 2 utilities which will make your work easier:
+
EBN, or the [http://ebn.kde.org English Breakfast Network], is a utility that both developers and documentation writers use to make sure they have created perfection for KDE. For documentation, there are 2 utilities which will make your work easier:
# [http://www.englishbreakfastnetwork.org/sanitizer/?component=kde-4.x Documentation Sanitizer] - this utility within the EBN scours the trunk of the subversion repository checking the format of the documentation, discovering typos, grammar, markup, and more. This is a perfect utility for beginners looking to contribute as this tool pretty much tells you how to fix the issues.
+
# [http://ebn.kde.org/sanitizer/?component=kde-4.x Documentation Sanitizer] - this utility within the EBN scours the trunk of the subversion repository checking the format of the documentation, discovering typos, grammar, markup, and more. This is a perfect utility for beginners looking to contribute as this tool pretty much tells you how to fix the issues.
# [http://www.englishbreakfastnetwork.org/sanitizer/just-in-time.php Just In Time] - this utility allows you to check your code/documentation and it will provide the same information that the sanitizer above produces. Use this before committing your patches or committing to subversion.
+
# [http://ebn.kde.org/sanitizer/just-in-time.php Just In Time] - this utility allows you to check your code/documentation and it will provide the same information that the sanitizer above produces. Use this before committing your patches or committing to subversion.
  
 
=== Documentation Primer ===
 
=== Documentation Primer ===
Line 21: Line 21:
  
 
* [[Projects/Documentation/KDE4_(health_table)|Health Table]]. Please do not hesitate to improve it.
 
* [[Projects/Documentation/KDE4_(health_table)|Health Table]]. Please do not hesitate to improve it.
* [[Schedules/KDE4/4.11_Release_Schedule|Current release schedule]]
+
* [[Schedules/KDE4/4.12_Release_Schedule|Current release schedule]]
* [[Schedules/KDE4/4.11_Feature_Plan|Feature plan of the current release]]
+
* [[Schedules/KDE4/4.12_Feature_Plan|Feature plan of the current release]]
  
 
=== KColorEdit ===
 
=== KColorEdit ===

Latest revision as of 06:41, 28 November 2013

Contents

[edit] KDE 4 Documentation Tasks

The following task list is broken down by experience as closely as possible. It is recommended that you join #kde-docs on IRC (Freenode) and coordinate with the other members as to not create any problems or duplicate work. Currently the channel is quite slow and quiet.

If you choose to work on any of the following documents, please add your name, IRC name, and email address for communication purposes.

If you haven't yet subscribed to the KDE Documentation mailing list, please do so now at this page and say hello. Maybe provide a little bit of information as well as your experience.

noframe
 
Note
Please use the English Breakfast Network while working on documentation.

[edit] Beginner

[edit] EBN

EBN, or the English Breakfast Network, is a utility that both developers and documentation writers use to make sure they have created perfection for KDE. For documentation, there are 2 utilities which will make your work easier:

  1. Documentation Sanitizer - this utility within the EBN scours the trunk of the subversion repository checking the format of the documentation, discovering typos, grammar, markup, and more. This is a perfect utility for beginners looking to contribute as this tool pretty much tells you how to fix the issues.
  2. Just In Time - this utility allows you to check your code/documentation and it will provide the same information that the sanitizer above produces. Use this before committing your patches or committing to subversion.

[edit] Documentation Primer

Here is a comprehensive manual about KDE DocBooks creating.

[edit] Useful Links on Wikis

[edit] KColorEdit

  • Location: trunk/extragear/graphics
  • Status: Needs updating and new material
  • Info: Should be a fairly straight forward process with the updating and new material addition.
  • Document writer: kde-doc-english mailing list, #kde-docs

[edit] Intermediate

[edit] Advanced

[edit] KMail

[edit] KOrganizer

  • Location: KDE/kdepim
  • Status: Needs a lot of updating and new material
  • Info: Check with Allen Winter (winterz) on IRC
  • Document writer: kde-doc-english mailing list, #kde-docs

This page was last modified on 28 November 2013, at 06:41. This page has been accessed 12,155 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