Difference between revisions of "Projects/Documentation/KDE4"

Jump to: navigation, search
(System Settings)
(Kalzium)
(32 intermediate revisions by 10 users 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 is are 2 utilities which will make your work easier:
+
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:
 
# [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://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://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://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.
 
=== KGet ===
 
* '''Location:''' trunk/KDE/kdenetwork
 
* '''Status:''' Needs updating
 
* '''Info:''' KGet documentation is currently written for the KDE 3 release. The documentation needs to be updated to match the KDE 4 release.
 
* '''Document writer:''' ''jjesse (jjesse at gmail dot com) Jonathan Jesse''
 
  
 
=== KColorEdit ===
 
=== KColorEdit ===
Line 25: Line 19:
 
* '''Info:''' Should be a fairly straight forward process with the updating and new material addition.
 
* '''Info:''' Should be a fairly straight forward process with the updating and new material addition.
 
* '''Document writer:''' ''TimS on IRC, or via the mailing list.''
 
* '''Document writer:''' ''TimS on IRC, or via the mailing list.''
 
=== Gwenview ===
 
* '''Location:''' trunk/KDE/kdegraphics
 
* '''Status:''' Needs updating
 
* '''Info:''' Documentation is based on the KDE 3 release, needs to be updated to match the KDE 4 release.
 
* '''Document writer:''' ''Henry de Valence: hdevalence (at) gmail (dot) com''
 
  
 
== Intermediate ==
 
== Intermediate ==
=== Dolphin ===
 
* '''Location:''' trunk/KDE/kdebase/apps
 
* '''Status:''' Needs updating and new material
 
* '''Info:''' Dolphin documentation hasn't been updated since 2006. This would require quite a bit of work.
 
* '''Document writer:''' ''insert your contact information here''
 
 
=== Kalzium ===
 
* '''Location:''' trunk/KDE/kdeedu
 
* '''Status:''' Needs updating and new material
 
* '''Info:''' Many parts of the Kalzium document needs to be updated and there are yet many parts that haven't been documented.
 
* '''Document writer:''' ''insert your contact information here''
 
 
=== Parley ===
 
* '''Location:''' trunk/KDE/kdeedu
 
* '''Status:''' Needs updating and new material
 
* '''Info:''' There are quite a bit of KDE 3 and KVocTrain references still in the documentation.
 
* '''Document writer:''' ''insert your contact information here''
 
  
 
=== Step ===
 
=== Step ===
Line 55: Line 26:
 
* '''Status:''' Examples need to be documented, a template is started as examples.docbook - Index.docbook can be improved.
 
* '''Status:''' Examples need to be documented, a template is started as examples.docbook - Index.docbook can be improved.
 
* '''Info:''' You need to be good in Physics - coordinate with annma
 
* '''Info:''' You need to be good in Physics - coordinate with annma
* '''Document writer:''' ''insert your contact information here''
+
* '''Document writer:'''
 +
** Object Info: [[User:JLP|Jure Repinc]]
  
 
== Advanced ==
 
== Advanced ==
Line 65: Line 37:
  
 
=== System Settings ===
 
=== System Settings ===
* '''Location:''' trunk/KDE/kdebase/workspace
+
* '''Location:''' usually in subdir doc/kcontrol of a module (kdeadmin, kdebase/workspace, kdebase/runtime, kdegraphics, kdepimlibs, kdeutils, exceptions of that rule are dolphin/kxkb/kscd/kdm and some more). Drafts for missing/outdated kcm docs you find in branches/work/doc/ subdirs.
* '''Status:''' Needs a lot of work
+
* '''Status:''' 100 % up to date in 4.5
* '''Info:''' Refer to http://lists.kde.org/?l=kde-devel&m=120612209307666&w=2 for the work that needs to be completed.
+
* '''Info:''' Missing docs:
 +
** Service Discovery (kcmshell4 kcm_kdnssd) - missing, draft in kdnssd
 +
** Network Setting (kcmshell4 kcm_knetworkconfmodule) - outdated
 +
** Size & Orientation (kcmshell4 randr) - outdated, draft in kcmdisplay
 +
** Input Actions (kcmshell4 khotkeys) - missing
 +
** Printer Configuration (kcmshell4 system-config-printer-kde) - missing
 +
** Audio CDs (kcmshell4 audiocd) - opens kioslave/audiocd - wrong, draft in audiocd
 +
** Samba (kcmshell4 kcmsambaconf) - missing
 
* '''Document writer:''' ''Richard Johnson (nixternal) <nixternal AT kubuntu DOT org>''
 
* '''Document writer:''' ''Richard Johnson (nixternal) <nixternal AT kubuntu DOT org>''
* '''Joystick:''' nosrednaekim on IRC
 
  
 
=== KMail ===
 
=== KMail ===
 
* '''Location:''' trunk/KDE/kdepim
 
* '''Location:''' trunk/KDE/kdepim
 
* '''Status:''' Needs a lot of updating and new material
 
* '''Status:''' Needs a lot of updating and new material
* '''Info:''' Check with Allen Winter (winterz) on IRC
+
* '''Info:''' Check with Allen Winter (winterz) on IRC and [[Projects/Documentation/KDE4/kdepim/kmail]]
* '''Document writer:''' ''insert your contact information here''
+
* '''Document writer:''' Manfred Mislik (tictric) on IRC
  
 
=== KOrganizer ===
 
=== KOrganizer ===
Line 81: Line 59:
 
* '''Status:''' Needs a lot of updating and new material
 
* '''Status:''' Needs a lot of updating and new material
 
* '''Info:''' Check with Allen Winter (winterz) on IRC
 
* '''Info:''' Check with Allen Winter (winterz) on IRC
* '''Document writer:''' ''insert your contact information here''
+
* '''Document writer:''' ''Vikram Dhillon <dhillonv10 AT lavabit DOT com>''

Revision as of 22:13, 25 July 2012

Contents

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 https://mail.kde.org/mailman/listinfo/kde-doc-english and say hello. Maybe provide a little bit of information as well as your experience.

NOTE: Please use the English Breakfast Network while working on documentation.

Beginner

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.

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: TimS on IRC, or via the mailing list.

Intermediate

Step

  • Location: trunk/KDE/kdeedu/doc/step
  • Status: Examples need to be documented, a template is started as examples.docbook - Index.docbook can be improved.
  • Info: You need to be good in Physics - coordinate with annma
  • Document writer:

Advanced

kdelibs

  • Location: trunk/KDE/kdelibs
  • Status: Needs a lot of work
  • Info: There is a TODO file located in trunk/KDE/kdelibs/doc/ - refer to this for more information.
  • Document writer: Richard Johnson (nixternal) <nixternal AT kubuntu DOT org>

System Settings

  • Location: usually in subdir doc/kcontrol of a module (kdeadmin, kdebase/workspace, kdebase/runtime, kdegraphics, kdepimlibs, kdeutils, exceptions of that rule are dolphin/kxkb/kscd/kdm and some more). Drafts for missing/outdated kcm docs you find in branches/work/doc/ subdirs.
  • Status: 100 % up to date in 4.5
  • Info: Missing docs:
    • Service Discovery (kcmshell4 kcm_kdnssd) - missing, draft in kdnssd
    • Network Setting (kcmshell4 kcm_knetworkconfmodule) - outdated
    • Size & Orientation (kcmshell4 randr) - outdated, draft in kcmdisplay
    • Input Actions (kcmshell4 khotkeys) - missing
    • Printer Configuration (kcmshell4 system-config-printer-kde) - missing
    • Audio CDs (kcmshell4 audiocd) - opens kioslave/audiocd - wrong, draft in audiocd
    • Samba (kcmshell4 kcmsambaconf) - missing
  • Document writer: Richard Johnson (nixternal) <nixternal AT kubuntu DOT org>

KMail

  • Location: trunk/KDE/kdepim
  • Status: Needs a lot of updating and new material
  • Info: Check with Allen Winter (winterz) on IRC and Projects/Documentation/KDE4/kdepim/kmail
  • Document writer: Manfred Mislik (tictric) on IRC

KOrganizer

  • Location: trunk/KDE/kdepim
  • Status: Needs a lot of updating and new material
  • Info: Check with Allen Winter (winterz) on IRC
  • Document writer: Vikram Dhillon <dhillonv10 AT lavabit DOT com>

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal