Difference between revisions of "Guidelines and HOWTOs"

Jump to: navigation, search
(Add links to #kde-welcome channels)
(48 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
{{ Info |1= All tutorials are to be found here. If you create a new page, create it at  <code>Guidelines_and_HOWTOs/newpage</code>. Do not use a too nested tree, as it is difficult to reorganize. Think of '''adding a link to the new page''' at a relevant place (in the ''Development '' or ''Debugging'' page or what not). }}
 +
[[File:Mascot konqi-support-document.png|thumbnail|right|[[Konqi]] is looking up HOWTOs for you!]]
 +
== Before everything else ==
 +
Before anything, if you want to contribute, you need to [https://community.kde.org/Get_Involved  know the various ways to contribute].
  
 +
Also, you can join us at #kde-welcome on [http://webchat.freenode.net/?channels=kde-welcome Freenode] or on [https://webchat.kde.org/#/room/#kde-welcome:kde.org Matrix]. We're always welcoming more contributors!
  
 +
== Development ==
 
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
 
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
 
|-
 
|-
 
| style="padding-left: 50px;" |[[File:Run-build.png |noframe|left|50px|]] ||
 
| style="padding-left: 50px;" |[[File:Run-build.png |noframe|left|50px|]] ||
 
; [[/Development | For development]]
 
; [[/Development | For development]]
: Guides and HOW TOs for compiling the sources, sending patches,...
+
: Guides and HOW TOs for compiling the sources, creating new programs, sending patches,...
 
|-
 
|-
 
| style="padding-left: 50px;" |[[File:Debug-step-out.png|noframe|left|50px|]] ||
 
| style="padding-left: 50px;" |[[File:Debug-step-out.png|noframe|left|50px|]] ||
 
; [[/Debugging | For debugging]]
 
; [[/Debugging | For debugging]]
 
: Guides and HOW TOs to debug applications.
 
: Guides and HOW TOs to debug applications.
 +
|-
 +
| style="padding-left: 50px;" |[[File:layer-new.png|noframe|left|50px|]] ||
 +
; Other
 +
: Other guides: [[/Relicensing| Relicensing]], [[/Application Versioning|Versioning scheme]], [[/AppStream|AppStream]]
 
|-
 
|-
 
|}
 
|}
  
== Internationalization (i18n) Tools ==
+
== Quality, Internationalization, Documentation ==
 +
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
 +
|-
 +
| style="padding-left: 50px;" |[[File:Internet-amarok.png |noframe|left|50px|]] ||
 +
; [[/Internationalization | To internationalize]]
 +
: Guides and HOWTOs concerning the internationalization
 +
|-
 +
|}
 +
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
 +
|-
 +
| style="padding-left: 50px;" |[[File:Presentation.png |noframe|left|50px|]] ||
 +
; [https://hig.kde.org Human Interface Guidelines]
 +
: Recommendations for designing and developing user interfaces
 +
|-
 +
|}
  
; Lokalize
+
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
: [http://userbase.kde.org/Lokalize Lokalize] is a computer-aided translation system that focuses on productivity and quality assurance. It has components usual for CAT tools: translation memory, glossary, and also a unique translation merging (synchronization) capability. It is targeted for software translation and also integrates external conversion tools for freelance office document translation.
+
|-
 +
| style="padding-left: 50px;" |[[File:Quality.png |noframe|left|50px|]] ||
 +
; [[/Quality | Quality and Documentation]]
 +
: Guides and HOWTOs concerning the quality: documentation, [[/Bug_triaging | bug triaging]]...
 +
|-
 +
|}
  
; Dr. Klash
+
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
: This little utility, once activated, can present a report about conflicting shortcuts in menus. Not only is this helpful for translators but also for developers. A little hand editing of {{path|`kde-config --localprefix`/share/config/kdeglobals}} activates this feature:
+
|-
 
+
| style="padding-left: 50px;" |[[File:kstars-satellite.png |noframe|left|50px|]] ||
<syntaxhighlight lang="ini">
+
; [[/Release | Release]]
[Development]
+
: Guides and HOWTOs concerning the releasing process.
CheckAccelerators=F12
+
|-
AutoCheckAccelerators=false
+
|}
AlwaysShowCheckAccelerators=false
 
</syntaxhighlight>
 
 
 
: Pressing F12 will show a dialog containing which accelerators in the currently focussed interface conflict and provide suggestions for new accelerators. If no accelerators conflict or Dr. Klash has nothing to suggest, no popup dialog will be displayed.
 
 
 
: With <tt>AutoCheckAccelerators</tt> enabled the dialog will popup automatically if a conflict exists and <tt>AlwaysShowCheckAccelerators</tt> can force the dialog to always popup even if there are no conflicts to report.
 
 
 
; The x-test language
 
: This helper language serves as a debugging aid for people finding untranslated strings in applications. If you start your application with the "x-test" locale, all translated strings will appear with trailing and leading xx's. First you have to check out these "translations" from l10n-kde4/x-test and install them.
 
 
 
: After you've built l10n-kde4/x-test and installed it, run your application using the "x-test" locale. This can be done by launching it from the command line like this:
 
<pre>
 
> KDE_LANG=x-test kspread
 
</pre>
 
: This will start KSpread using the "x-test" locale no matter what your current language setting is. Look for strings that do not have the xx's. If xx's are missing from a string, it could be due to missing i18n calls or even missing or incorrectly generated .pot files. Consult the i18n tutorials for further information.
 
 
 
: When checking for untranslated strings, be sure to check all the WhatsThis help and tooltips.
 
 
 
=== Examining .po files ===
 
 
 
You can look at the translated .po files to see if a string is present and has been translated. For example, here's a portion of {{path|l10n/de/messages/kdebase/konqueror.po}}:  
 
 
 
<pre>
 
#: konq_mainwindow.cc:3707 konq_tabs.cc:84
 
msgid "&New Tab"
 
msgstr "Neues &Unterfenster"
 
</pre>
 
 
 
The string to be translated is given on the msgid line. The translated string is on the msgstr line. Notice that the exact same string to translate came from {{path|konq_mainwindow.cc}} and also from {{path|konq_tabs.cc}}. This saves the translators from having to translate the same identical string twice.
 
 
 
You can also use Lokalize to examine {{path|.po}} files. Lokalize is part of the kdesdk module.
 
 
 
{{note|More information on writing and translating documentation can be found on [http://l10n.kde.org/ the l10n project site].}}
 
 
 
== Helper Tools ==
 
 
 
;[[Development/Tools/Using kde-config|Get information about KDE's installation - kde-config]]  
 
: The tool kde-config helps to find out more about a KDE installation.
 
 
 
;[[Development/Tools/Using kfmclient|Driving Konqueror From Scripts - kfmclient]]
 
: kfmclient is a small tool to communicate with Konqueror.
 
 
 
;[[Development/Tools/Using kconf_update|Updating User Configuration Files - kconf_update]]
 
: kconf_update is a tool designed to update config files.
 
 
 
;[[Development/Tools/apidox|Generating apidox]]
 
: tools that help develop and generate API documentation for your code.
 
 
 
;[[Development/Tools/svnmerge.py|svnmerge.py]]
 
: This tool helps keeping track of merges between different SVN branches
 
 
 
== Quality Assurance ==
 
 
 
;Project Management
 
: KDE is transitioning to [phabricator.org Phabricator] for project management.  You can get started with Phabricator on the [https://techbase.kde.org/Development/Phabricator  getting started page].  The older [http://www.reviewboard.org/ Review Board] is limited to code reviews only: see [[Development/Review_Board|here]] for more details.
 
 
 
;Continuous Building - Jenkins
 
: [http://build.kde.org Jenkins]
 
: [http://public.kitware.com/dashboard.php?name=kde kdelibs on kitware]
 
 
 
;[http://englishbreakfastnetwork.org/ English Breakfast Network] - Static Analysis
 
: [http://www.englishbreakfastnetwork.org/krazy/ Krazy ] - Code Analysis, [[Development/Tutorials/Code_Checking|Usage Tutorial]]
 
: [http://www.englishbreakfastnetwork.org/apidocs/ APIDOX] - API Documentation Statistics
 
: [http://www.englishbreakfastnetwork.org/sanitizer/ Sanitizer] - DocBook Checker
 
: [http://www.englishbreakfastnetwork.org/usability/ Usability Checks]
 
 
 
== HOWTOs ==
 
=== Development ===
 
* [[/Git| Use Git]]
 
* [[/Build_from_source| Build from source]]
 
* [[/CMake| Use CMake]]
 
* [[/Debug | Debug a program]]
 
* [[Infrastructure/Get a Contributor Account|Get a Contributor Account]]
 
 
 
== Localization ==
 
 
 
== To move here ==
 
[[Applications/Versioning]]
 
  
 
== Further resources ==
 
== Further resources ==
* [[/Further resources | Further resources]]
+
* [[/Further resources | Books, websites, resources]]

Revision as of 13:49, 4 June 2019

Dialog-information.png
Information
All tutorials are to be found here. If you create a new page, create it at Guidelines_and_HOWTOs/newpage. Do not use a too nested tree, as it is difficult to reorganize. Think of adding a link to the new page at a relevant place (in the Development or Debugging page or what not).
Konqi is looking up HOWTOs for you!

Before everything else

Before anything, if you want to contribute, you need to know the various ways to contribute.

Also, you can join us at #kde-welcome on Freenode or on Matrix. We're always welcoming more contributors!

Development

Run-build.png
For development
Guides and HOW TOs for compiling the sources, creating new programs, sending patches,...
Debug-step-out.png
For debugging
Guides and HOW TOs to debug applications.
Layer-new.png
Other
Other guides: Relicensing, Versioning scheme, AppStream

Quality, Internationalization, Documentation

Internet-amarok.png
To internationalize
Guides and HOWTOs concerning the internationalization
Presentation.png
Human Interface Guidelines
Recommendations for designing and developing user interfaces
Quality.png
Quality and Documentation
Guides and HOWTOs concerning the quality: documentation, bug triaging...
Kstars-satellite.png
Release
Guides and HOWTOs concerning the releasing process.

Further resources


Content is available under Creative Commons License SA 4.0 unless otherwise noted.