Difference between revisions of "Guidelines and HOWTOs"

Jump to: navigation, search
m (Alignment and dark theme support)
 
(58 intermediate revisions by 7 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].
  
This section contains information about tools for KDE development.
+
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" class="icon-dark-invert"
 +
|-
 +
||[[File:Run-build.png |noframe|left|50px|]] ||
 
; [[/Development | For development]]
 
; [[/Development | For development]]
; For
+
: Guides and HOW TOs for compiling the sources, creating new programs, sending patches,...
== Core Tools ==
+
|-
These are the tools that are absolutely required to build and develop KDE software.  On Linux, they will typically be provided by your distribution.  On other platforms, packages should normally be available, often for download directly from the home page for the tool.  Of course, the standard development tools, such as a C/C++ compiler and some sort of text editor, are also required.
+
||[[File:Debug-step-out.png|noframe|left|50px|]] ||
 
+
; [[/Debugging | For debugging]]
; CMake
+
: Guides and HOW TOs to debug applications.
: [[/CMake|CMake]] is KDE's build system of choice. Once you have this, you can use it to configure a software project for building, and that process will tell you of any other requirements you are missing.
+
|-
 
+
||[[File:layer-new.png|noframe|left|50px|]] ||
; Git
+
; Other
: Most KDE projects are developed in [[Infrastructure/Git| Git]], and so you will need it to get the source code in the first place.  You can find the relevant Git URLs at the [http://projects.kde.org/ KDE projects directory].  It will be helpful to follow the [[/Git|git how to]].
+
: Other guides: [[/Relicensing| Relicensing]], [[/Application Versioning|Versioning scheme]], [[/AppStream|AppStream]]
 
+
|-
; Subversion
+
|}
: KDE still uses [[Infrastructure/Subversion|Subversion]] for some things, notably translations.
 
 
 
== Debugging and Analysis ==
 
A list of tools which are used to analyze a program. This includes debuggers and profilers, for instance.
 
 
 
; Valgrind
 
: [[/Valgrind|Valgrind]] helps to find memory leaks and uninitialized memory blocks. Additional features are a profiler and more. Valgrind is one of the most important development tools!
 
 
 
; The GNU Project Debugger (GDB)
 
: [http://sources.redhat.com/gdb/ GDB] helps in debugging source code. As GDB evolved over time it is recommended to use version 6.x. Graphical frontends are available (see below). See also the debugging tutorial [[../Tutorials/Debugging/Debugging with GDB|Debugging with GDB]].
 
 
 
; KDbg and DDD
 
: [http://www.kdbg.org/ KDbg] and [http://www.gnu.org/software/ddd/ DDD] are graphical user interfaces to GDB, which are able to set breakpoints, step through the code etc.
 
 
 
; MS Windows tools (Process Explorer, Console, WinDbg, DebugView...)
 
: More info on the [[Projects/KDE_on_Windows/Tools|KDE on Windows page]].
 
 
 
== Development Tools ==
 
; Qt Creator
 
: With Qt Creator it is easy to write new KDE based programs and to integrate existing ones into an IDE. Further details can be found in the tutorial [[/Using_Qt_Creator|Using Qt Creator]].
 
 
 
; KDevelop
 
: [http://www.kdevelop.org KDevelop] is an IDE for developing KDE and Qt C++ applications. It includes a an integrated debugger, a powerful editor with syntax highlighting, a ''Project wizard'' to create applications from templates, the automake/autoconf gunk, and even the class documentation. Further details can also be found in the [http://userbase.kde.org/KDevelop4 wiki].
 
 
 
; Eclipse
 
: It is possible to develop C++, Qt and KDE software using Eclipse as your IDE. Further details can be found on the [[/Using Eclipse|Eclipse page]].
 
 
 
; MS Visual Studio® Express IDE (Windows only)
 
: [http://www.microsoft.com/exPress/ Visual C++® Express] is the free version of the Microsoft Visual Studio compiler from Microsoft, which is officially supported by Nokia. It is a choice for compiling Qt and KDE applications on Windows. [[Projects/KDE_on_Windows/Issues/MSVC|more info...]]
 
 
 
== Internationalization (i18n) Tools ==
 
 
 
; Lokalize
 
: [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.
 
 
 
; Dr. Klash
 
: 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:
 
 
 
<syntaxhighlight lang="ini">
 
[Development]
 
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]]
 
 
 
== Localization ==
 
  
== To move here ==
+
== Quality, Internationalization, Documentation ==
[[Applications/Versioning]]
+
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5" class="icon-dark-invert"
 +
|-
 +
||[[File:Internet-amarok.png |noframe|left|50px|]] ||
 +
; [[/Internationalization | To internationalize]]
 +
: Guides and HOWTOs concerning the internationalization
 +
|-
 +
||[[File:Presentation.png |noframe|left|50px|]] ||
 +
; [https://hig.kde.org Human Interface Guidelines]
 +
: Recommendations for designing and developing user interfaces
 +
|-
 +
||[[File:Quality.png |noframe|left|50px|]] ||
 +
; [[/Quality | Quality and Documentation]]
 +
: Guides and HOWTOs concerning the quality: documentation, [[/Bug_triaging | bug triaging]]...
 +
|-
 +
||[[File:kstars-satellite.png |noframe|left|50px|]] ||
 +
; [[/Release | Release]]
 +
: Guides and HOWTOs concerning the releasing process.
 +
|-
 +
|}
  
 
== Further resources ==
 
== Further resources ==
* [[/Further resources | Further resources]]
+
* [[/Further resources | Books, websites, resources]]

Latest revision as of 11:10, 27 July 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


This page was last edited on 27 July 2019, at 11:10. Content is available under Creative Commons License SA 4.0 unless otherwise noted.