https://techbase.kde.org/api.php?action=feedcontributions&user=Mistrynitesh&feedformat=atomKDE TechBase - User contributions [en]2024-03-28T10:35:14ZUser contributionsMediaWiki 1.40.2https://techbase.kde.org/index.php?title=Projects/Documentation/KDE&diff=55622Projects/Documentation/KDE2010-11-15T16:57:20Z<p>Mistrynitesh: /* EBN */</p>
<hr />
<div>= KDE 4 Documentation Tasks =<br />
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.<br />
<br />
If you choose to work on any of the following documents, please add your name, IRC name, and email address for communication purposes.<br />
<br />
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.<br />
<br />
'''NOTE:''' Please use the [[#EBN|English Breakfast Network]] while working on documentation.<br />
<br />
== Beginner ==<br />
=== EBN ===<br />
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:<br />
# [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.<br />
# [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.<br />
<br />
=== KColorEdit ===<br />
* '''Location:''' trunk/extragear/graphics<br />
* '''Status:''' Needs updating and new material<br />
* '''Info:''' Should be a fairly straight forward process with the updating and new material addition.<br />
* '''Document writer:''' ''TimS on IRC, or via the mailing list.''<br />
<br />
=== Gwenview ===<br />
* '''Location:''' trunk/KDE/kdegraphics<br />
* '''Status:''' Needs updating<br />
* '''Info:''' Documentation is based on the KDE 3 release, needs to be updated to match the KDE 4 release.<br />
* '''Document writer:''' ''Henry de Valence: hdevalence (at) gmail (dot) com''<br />
<br />
== Intermediate ==<br />
<br />
=== Kalzium ===<br />
* '''Location:''' trunk/KDE/kdeedu<br />
* '''Status:''' Needs updating and new material<br />
* '''Info:''' Many parts of the Kalzium document needs to be updated and there are yet many parts that haven't been documented.<br />
* '''Document writer:''' ''Karthik Periagaram (karthikp on IRC, karthikp AT gatech DOT edu)''<br />
<br />
=== Step ===<br />
* '''Location:''' trunk/KDE/kdeedu/doc/step<br />
* '''Status:''' Examples need to be documented, a template is started as examples.docbook - Index.docbook can be improved.<br />
* '''Info:''' You need to be good in Physics - coordinate with annma<br />
* '''Document writer:'''<br />
** Object Info: [[User:JLP|Jure Repinc]]<br />
<br />
== Advanced ==<br />
=== kdelibs ===<br />
* '''Location:''' trunk/KDE/kdelibs<br />
* '''Status:''' Needs a lot of work<br />
* '''Info:''' There is a TODO file located in trunk/KDE/kdelibs/doc/ - refer to this for more information.<br />
* '''Document writer:''' ''Richard Johnson (nixternal) <nixternal AT kubuntu DOT org>''<br />
<br />
=== System Settings ===<br />
* '''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.<br />
* '''Status:''' 100 % up to date in 4.5<br />
* '''Info:''' Missing docs:<br />
** Service Discovery (kcmshell4 kcm_kdnssd) - missing, draft in kdnssd<br />
** Network Setting (kcmshell4 kcm_knetworkconfmodule) - outdated<br />
** Size & Orientation (kcmshell4 randr) - outdated, draft in kcmdisplay<br />
** Multiple Monitors (kcmshell4 xinerama) - missing, draft in multiplemonitors<br />
** Input Actions (kcmshell4 khotkeys) - missing<br />
** Printer Configuration (kcmshell4 system-config-printer-kde) - missing<br />
** Audio CDs (kcmshell4 audiocd) - opens kioslave/audiocd - wrong, draft in audiocd <br />
** Samba (kcmshell4 kcmsambaconf) - missing<br />
* '''Document writer:''' ''Richard Johnson (nixternal) <nixternal AT kubuntu DOT org>''<br />
<br />
=== KMail ===<br />
* '''Location:''' trunk/KDE/kdepim<br />
* '''Status:''' Needs a lot of updating and new material<br />
* '''Info:''' Check with Allen Winter (winterz) on IRC and [[Projects/Documentation/KDE4/kdepim/kmail]]<br />
* '''Document writer:''' Manfred Mislik (tictric) on IRC<br />
<br />
=== KOrganizer ===<br />
* '''Location:''' trunk/KDE/kdepim<br />
* '''Status:''' Needs a lot of updating and new material<br />
* '''Info:''' Check with Allen Winter (winterz) on IRC<br />
* '''Document writer:''' ''Vikram Dhillon <dhillonv10 AT lavabit DOT com>''</div>Mistrynitesh