KDE TechBase - User contributions [en]

Translator Account/2013

2013-05-25T14:24:01Z

AnneW:

{|class="wikitable sortable"
!User Name
!Language
!width="25"|Lang.Code
!Comment
!Off-line?
!Date added
|-
|vgezer||Turkish||tr|| ||Yes||20130122
|-
|marguerite||Chinese||zh-cn|| ||Yes||20130307
|-
|baalkor||French||fr|| ||No||20130314
|-
|ogdhekne||Marathi||mr|| ||Sometimes||20130411
|-
|ogdhekne||Sanskrit||sa|| ||Sometimes||20130411
|-
|ogdhekne||Hindi||hi|| ||Sometimes||20130411
|-
|ogdhekne||Urdu||ur|| ||Sometimes||20130411
|-
|prabodhcp||Kannada||kn|| ||Yes||20130412
|-
|maidis||Turkish||tr|| ||Yes||20130515
|-
|pinqui||Russian||ru|| ||Yes||20130525
|}

Translator Account/2013

2013-05-25T14:23:44Z

AnneW:

Translator Account

2013-05-25T14:22:41Z

AnneW:

{{Info|1=The list of translators registered in 2012 is now archived at [[Translator_Account/2012]]}}

{{Tip|1=''Example (please add your details to the bottom of the list)''

User Name: Hans

Language(s): Swedish

(Optional) Do you expect to work off-line?: No}}

----
----

User Name: vgezer

Language(s): Turkish

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] ([[User talk:Neverendingo|talk]]) 17:09, 22 January 2013 (UTC)
----

User Name: marguerite

Language(s): Simplified Chinese

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 11:29, 7 March 2013 (UTC)
----

User Name: baalkor

Language(s): French

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 11:32, 14 March 2013 (UTC)
----
User Name: ogdhekne

Language(s): Marathi,Sanskrit,Hindi,Urdu

(Optional) Do you expect to work off-line?: Sometimes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 18:52, 11 April 2013 (BST)
----

User Name: prabodhcp

Language(s): Kannada

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 17:10, 12 April 2013 (BST)
----

User Name: maidis

Language(s): Turkish

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:10, 15 May 2013 (BST)
----

User Name: pinqui

Language(s): Russian

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 15:22, 25 May 2013 (BST)
----

User talk:Pinqui

2013-05-25T14:22:06Z

AnneW: Talk page autocreated when first thread was posted

Thread:User talk:Pinqui/Welcome to the Translator group.

2013-05-25T14:22:05Z

AnneW: New thread: Welcome to the Translator group.

Welcome to the Translator group. You will lots of help in the pages listed in the side-panel. If you have any questions, please ask.

Enjoy!

Anne

Translator Account/2013

2013-05-15T09:12:00Z

AnneW:

Translator Account

2013-05-15T09:10:49Z

AnneW:

User talk:Maidis

2013-05-15T09:10:07Z

AnneW: Talk page autocreated when first thread was posted

Thread:User talk:Maidis/Welcome to the Translator group

2013-05-15T09:10:06Z

AnneW: New thread: Welcome to the Translator group

Welcome to the Translator group. You will find lots of help in the pages linked in the sidebar. If you have any questions, please ask.

Getting Started/Build/Distributions/Linux From Scratch

2013-04-24T07:23:49Z

AnneW:

{{TutorialBrowser|

series=Getting Started|

name=Building KDE4 From Source (Linux From Scratch requirements)

----

'''NOTE: This page was a totally out of date. The instructions in the BLFS book are now what I would recommend you use. So, the old material has been deleted and will be replaced with notes on going beyond the BLFS book organized by minor KDE release number starting with KDE-4.10'''|

----

pre=[[Getting_Started/Build|Build KDE]], [[Getting_Started/Tutorials/D-Bus/Configuration|D-Bus Configuration]]|
next=[[Getting_Started/Build|Build KDE]]|

reading=[[Development/Tutorials/CMake |Introduction to CMake]]|
}}

==KDE-4.10.x==
===What to build===

I will presume that you are at: '''Further KDE packages'''

The first thing to note is that KDE is being broken up into individual packages. At least part of it is. BLFS from scratch hasn't quite kept up with that. So, you will find that there are no monolithic packages for:

:: Kdeaccessability
:: Kdeartwork
:: Kdeedu
:: Kdegames
:: Kdegraphics
:: Kdemultimedia
:: Kdeutils

So, you are going to be installing individual packages based on what you want.

====Dependencies that BLFS missed====

=====XDG User Dirs=====

=====PyXDG=====

Thread:User talk:JRT/Linux from Scratch/reply (4)

2013-04-17T11:30:00Z

AnneW: Reply to Linux from Scratch

I'll leave it to you to do what's necessary - safer than me doing it and getting it wrong :-)

Thread:User talk:Ogdhekne/Your entry on Translator Account/2012

2013-04-17T11:01:16Z

AnneW: New thread: Your entry on Translator_Account/2012

I removed your entry (and your second attempt at this) because that page is for people who registered a Translator account in 2012. If you look at [[Translator_Account/2013]] you'll find that you have been added there.

Translator Account/2012

2013-04-17T10:59:25Z

AnneW: Removed entry for wrong year

{{Info|1=The list of translators registered in 2011 is now archived at [[Translator_Account/2011]] }}

{|class="wikitable sortable"
!User Name
!Language
!width="25"|Lang.Code
!Comment
!Off-line?
!Date added
|-
|phoenixlzx||Simplified Chinese||zh-cn|| ||Yes||20120213
|-
|Latif||Indonesian||id|| ||No||20120213
|-
|Mitsakoz1989 ||Greek||el|| ||No||20120311
|-
|Amachu||Tamil||ta|| ||Sometimes||20120322
|-
|Aracele||Brazilian Portuguese||pt-br|| ||No||20120326
|-
|Torbjoern|| German ||de|| || Sometimes|| 20120407
|-
|Airon90 ||Esperanto||eo|| ||No|| 20120517
|-
|RoEn||German||de|| ||Yes||20120604
|-
|RoEn||Russian||ru|| ||Yes||20120604
|-
|Polix||German||de|| ||No||20120604
|-
|Polix||Russian||ru|| ||No||20120604
|-
|Polix||Ukrainian||uk|| ||No||20120604
|-
|dburgoyn||German||de|| ||Yes||20120625
|-
|dburgoyn||French||fr|| ||Yes||20120625
|-
|Libertypo||Romanian||ro|| ||Yes||20120627
|-
|Libertypo||Italian||it|| ||Yes||20120627
|-
|Gallaecio||Galician||gl|| ||Yes||20120722
|-
|shantha||Tamil||ta|| ||Sometimes||20120810
|-
|Freetznightsoul||Russian||ru|| ||Yes||20120812
|-
|naveenmtp||Tamil||ta|| ||Sometimes||20120816
|-
|Abella||Catalan||ca|| ||No||20120918
|-
|Olegkuksa||Russian||ru|| ||No||20121104
|-
| Inzuiqiang||Chinese||zh-cn|| ||No||20121104
|-
|Fredtantini||French||fr|| ||Yes||201211104
|-
|PanchoS||German||de|| ||No||20121104
|-
|Kirebyte||Spanish||es|| ||Yes||20121107
|-
|Accumulator||Dutch||nl|| ||Yes||20121112
|-
| Berryboy2012||Chinese||zh-cn|| ||Yes||20121118
|-
| 6ahodir||Uzbek||uz|| ||Yes||20121118
|-
|Aroshni||Spanish||es|| ||Yes||20121127
|}

Thread:User talk:JRT/Linux from Scratch/reply (2)

2013-04-15T12:15:50Z

AnneW: Reply to Linux from Scratch

No, you misunderstand me. I'm proposing to delete all the obsolete material and replace it with your recommendation of the BLFS book.

Thread:User talk:JRT/Linux from Scratch

2013-04-15T10:45:51Z

AnneW: New thread: Linux from Scratch

Considering what you have written in [[Getting_Started/Build]] should we simply delete the existing content of [[Getting_Started/Build/Distributions/Linux_From_Scratch]] and replace it with your message on [[Getting_Started/Build]] ?

User talk:JRT

2013-04-15T10:42:06Z

AnneW: Deleted very old messages

Translator Account/2013

2013-04-12T16:11:28Z

AnneW:

Translator Account

2013-04-12T16:10:15Z

AnneW:

Thread:User talk:Prabodhcp/Welcome to the Translator group

2013-04-12T16:08:11Z

AnneW: New thread: Welcome to the Translator group

Welcome to the Translator group. You will find lots of help from the links in the sidebar. Please ask if you need any help.

User talk:Prabodhcp

2013-04-12T16:08:11Z

AnneW: Talk page autocreated when first thread was posted

Translator Account/2012

2013-04-11T17:58:03Z

AnneW: Moved one entry to 2013

Translator Account/2013

2013-04-11T17:57:18Z

AnneW:

Translator Account

2013-04-11T17:52:49Z

AnneW:

Thread:User talk:Ogdhekne/Welcome to the Translator group

2013-04-11T17:51:57Z

AnneW: New thread: Welcome to the Translator group

Welcome to the Translator group. You will find lots of help on the Translator pages linked in the sidebar. If there is anything you need help with, please ask.

User talk:Ogdhekne

2013-04-11T17:51:57Z

AnneW: Talk page autocreated when first thread was posted

Projects/Nepomuk/Repositories

2013-04-07T18:24:40Z

AnneW: Marked this version for translation

<languages />
<translate>

== Nepomuk Repositories == 


The '''Nepomuk''' development is split across many different repositories across KDE. The page attempts to list out most of the known Nepomuk code, and its development location. The list has been split according to importance.

== Main Repositories == 


These are the official repositories which the core Nepomuk team focuses on.

=== NepomukCore === 


NepomukCore, which is the main repository for Nepomuk development, was released with KDE 4.9. It is a combination of both the Nepomuk libraries present in kdelibs, and certain run time components present in kde-runtime.


All Nepomuk enabled applications must depend on NepomukCore. It utilizes the Nepomuk2 namespace.


* '''Repository:''' [https://projects.kde.org/projects/kde/kdelibs/nepomuk-core kde:nepomuk-core]
* '''Category:''' Core
* '''Activity:''' High
* '''Developers:''' Sebastian Trueg <trueg@kde.org>, Vishesh Handa <me@vhanda.in>

=== NepomukWidgets === 


NepomukWidget, is the repository which contains all the widgets which applications use. It will be released with KDE 4.10. Before this the widgets were present in kdelibs/nepomuk.


* '''Repository:''' [https://projects.kde.org/projects/kde/kdelibs/nepomuk-widgets kde:nepomuk-widgets]
* '''Category:''' User Interface
* '''Activity:''' High
* '''Developers:''' Sebastian Trueg <trueg@kde.org>, Vishesh Handa <me@vhanda.in>

=== KIO slaves === 


Nepomuk currently consists of 3 kio-slaves - nepomuk, nepomuksearch, and timeline. Out of these 3, nepomuksearch and timeline are the most visible. The nepomuk kioslave is an internal kioslave which redirects to the physical location or to the nepomuksearch kioslave. For a more in depth discussion of their working, please read [[Projects/Nepomuk/kioslaves| this]].


'''Repository:''' kde-runtime/nepomuk/kioslaves

=== KCM === 


Nepomuk consists of 2 main user visible components. The Nepomuk KCM and the controller, which is uses to pause/resume indexing. The plan is to eventually move these out of kde-runtime, but that will probably only happen with KDE Frameworks 5.


'''Repository:''' kde-runtime/nepomuk/kcm

=== Nepomuk Shell === 


Nepomuk consists of a development tool called 'nepomukshell' which can be used to browse the Nepomuk database, and to run SPARQL queries. It has served as a simple starting ground for people wishing to contribute to Nepomuk.


* '''Repository:''' [https://projects.kde.org/projects/extragear/utils/nepomukshell/ kde:nepomukshell]
* '''Category:''' Development Tools
* '''Activity:''' Low

== Dependencies == 

=== Soprano === 


Soprano provides a Qt based wrapper over virtuoso, and additional serializing and parsing features which are used to load the ontologies. It follows an independent release schedule.


* '''Repository:''' [https://projects.kde.org/projects/kdesupport/soprano kde:soprano]
* '''Category:''' Core
* '''Activity:''' As per Nepomuk's requirements

=== Strigi === 


From KDE SC 4.10, Strigi is no longer used in Nepomuk. We have our own file indexer which is present in nepomuk-core.

== Other Repositories == 

=== Nepomuk-WebMiner === 


The Nepomuk WebMiner is an independent project that was started by Jörg Ehrichs. It provides rich features for extracting additional information from the web as well as from the files.


* '''Repository:''' [https://projects.kde.org/projects/extragear/base/nepomuk-webminer kde:nepomuk-webminer]
* '''Developers:''' Jörg Ehrichs <joerg.ehrichs@gmx.de>

=== Tag Manager === 


A fairly random project that was done in less than a day. Its purpose was to provide a user visible way to rename, delete and merge tags. It is currently not shipped by any distributions, and should ideally be cleanup up and properly released. For more information read [http://vhanda.in/blog/2012/01/nepomuk-tag-manager/| this].


* '''Repository:''' [http://quickgit.kde.org/index.php?p=scratch%2Fvhanda%2Fnepomuktagmanager.git&a=summary kde:scratch/vhanda/nepomuktagmanager.git]
* '''Category:''' Usability
* '''Activity:''' Low

=== TV Namer === 


It fetches information from http://thetvdb.com. For more information, please read the original blogs posts -
* http://trueg.wordpress.com/2012/02/11/a-fun-release-nepomuk-tv-namer-0-2/
* http://trueg.wordpress.com/2012/01/28/something-way-less-dry-tv-shows/


* '''Repository:''' [http://quickgit.kde.org/index.php?p=scratch%2Ftrueg%2Fnepomuktvnamer.git&a=summary kde:scratch/trueg/nepomuktvnamer]
* '''Category:''' Web-extractor
* '''Developers:''' Sebastian Trueg <trueg@kde.org>

=== Music === 


This provides a music kio slave which allows one to browse through the music indexed by Nepomuk. For more information please read [http://trueg.wordpress.com/2012/02/10/just-for-the-fun-of-it-browsing-music-with-nepomuk/ the original blog post]


* '''Repository:''' [http://quickgit.kde.org/index.php?p=scratch%2Ftrueg%2Fnepomuk-music-kio-slave.git&a=summary kde:scratch/trueg/nepomuk-music-kio-slave]
* '''Category:''' Usability
* '''Activity:''' Low
* '''Developers:''' Sebastian Trueg <trueg@kde.com>

=== Web Extractor === 


The Nepomuk web-extractor was originally a 2010 GSOC Project (Add link). The project was completed, but the architecture is extremely complicated. Additionally, most of the user visible parts were missing. It requires a complete rewrite.


* '''Repository:''' [https://projects.kde.org/projects/playground/base/nepomuk-web-extractor kde:nepomuk-web-extrator]
* '''Category:''' Core
* '''Activity:''' Non Existent
* '''Developers:''' Artem Serebriyskiy <v.for.vandal@gmail.com>


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/Nepomuk2Port

2013-04-07T18:23:50Z

AnneW: Marked this version for translation

<languages />
<translate>

== Maintaining Source Compatibility == 


With KDE 4.9, '''Nepomuk''' moved out out kdelibs into its own repository. KDE libs is required to maintain source compatibility with earlier releases, and therefore we could not just remove the nepomuk components from kdelibs.


A new repository called [https://projects.kde.org/projects/kde/kdelibs/nepomuk-core nepomuk-core] was introduced which contains all the main components of nepomuk. This included vasts parts of kdelibs/nepomuk and kde-runtime/nepomuk. Another repository called [https://projects.kde.org/projects/kde/kdelibs/nepomuk-widgets nepomuk-widgets] has also been introduced for 4.10.

== Porting to Nepomuk2 == 


Nepomuk2 is predominantly just a namespace change from Nepomuk to Nepomuk2. Additionally, the deprecated components of '''Nepomuk''' have been removed. In order to make porting easier, a simple script has been provided -


<syntaxhighlight lang='bash'>
#!/bin/sh
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/Nepomuk::/Nepomuk2::/g'
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/#include <Nepomuk\//#include <Nepomuk2\//'
egrep -lRZ "nepomuk" . | xargs -0 -l sed -i -e 's/#include <nepomuk\//#include <nepomuk2\//'
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/namespace Nepomuk/namespace Nepomuk2/g'
egrep -lRZ "resourceType" . | xargs -0 -l sed -i -e 's/\.resourceType/\.type/g'
egrep -lRZ "resourceUri" . | xargs -0 -l sed -i -e 's/\.resourceUri/\.uri/g'
egrep -lRZ "NEPOMUK_INCLUDE_DIR" . | xargs -0 -l sed -i -e 's/NEPOMUK_INCLUDE_DIR/NEPOMUK_CORE_INCLUDE_DIR/g'
egrep -lRZ "NEPOMUK_LIBRARIES" . | xargs -0 -l sed -i -e 's/NEPOMUK_LIBRARIES/NEPOMUK_CORE_LIBRARY/g'
egrep -lRZ "NEPOMUK_QUERY_LIBRARIES" . | xargs -0 -l sed -i -e 's/${NEPOMUK_QUERY_LIBRARIES}//g'
</syntaxhighlight>


This script should cover all the source code changes, and most of the cmake changes.

== CMake Changes == 


Depending on whether you require the GUI components you'll require the following includes


<syntaxhighlight lang="cmake">
find_package(NepomukCore)
find_package(NepomukWidgets)
</syntaxhighlight>


With NepomukCore, the following CMake variables are declared -


<syntaxhighlight lang='cmake'>
#
# NEPOMUK_CORE_LIB_DIR : The nepomuk-core library directory
# NEPOMUK_CORE_INCLUDE_DIR : The nepomuk-core include directory
# NEPOMUK_CORE_VERSION : The nepomuk-core version
# NEPOMUK_CORE_ONTOLOGY_DIR : The nepomuk-core ontologies location
# NEPOMUK_CORE_DBUS_INTERFACES_DIR : The nepomuk-core DBUS Interfaces dir
# NEPOMUK_CORE_LIBRARY : The nepomukcore library
#
</syntaxhighlight>


With NepomukWidgets, the following CMake variables are declared -


<syntaxhighlight lang="cmake">
#
# NEPOMUK_WIDGETS_LIB_DIR : The nepomuk-widgets library directory
# NEPOMUK_WIDGETS_INCLUDE_DIR : The nepomuk-widgets include directory
# NEPOMUK_WIDGETS_VERSION : The nepomuk-widgets version
# NEPOMUK_WIDGETS_LIBRARY : The nepomuk-widgets library
#
</syntaxhighlight>


Notice that, previously, <code>find_package(Nepomuk)</code> would internally call <code>find_package(Soprano)</code>, but since <code>find_package(NepomukCore)</code> does not, you would additionally have to find Soprano explicitly to be able to use Soprano CMake macros, e.g., <code>include(SopranoAddOntology)</code>.

== Migration Notes == 
=== Thing vs Resource ===
The ''Thing'' is an abstract concept in the ontologies that certain real-world stuff is derived from. We used to have special handling for it in Nepomuk, but since we never used it in anything that was shipped, we decided to remove it, and in Nepomuk2, any previous instance of it can be replaced with a ''Resource''.


The Vocabularies stay the same, e.g. <code>Nepomuk2::Vocabulary::PIMO::Thing()</code> , so they shouldn't be removed.


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/ManagingNepomukProcesses

2013-04-07T18:23:32Z

AnneW: Marked this version for translation

<languages />
<translate>


{{Info|1=This page contains some useful commands for managing the different Nepomuk processes}}

== Restarting Nepomuk == 
<syntaxhighlight lang="bash">
$ qdbus org.kde.NepomukServer /nepomukserver quit
wait for it to quit
$ nepomukserver
</syntaxhighlight>

== Restarting any service == 
If you need to restart any particular service -


<syntaxhighlight lang="bash">
$ qdbus org.kde.nepomuk.services.$SERVICE /servicecontrol shutdown
wait for it to quit
$ nepomukservicestub $SERVICE
</syntaxhighlight>


Just killing the service won't work, cause the 'nepomukserver' automatically restarts crashed services.

== Useful commands == 
<syntaxhighlight lang="bash">


# THis function is iused to find the PID of the various nepomuk processes
function ps-nepomuk-fast() {
echo $(pgrep -l -u $USER '(nepomukserver|nepomukservicestub|nepomukindexer|virtuoso-t)')
}


#This function restarts the Nepomuk server
function nepomuk-restart() {
nepomuk-quit


ps -A | grep nepomukserver --silent
while [ $? -eq 0 ]
do
sleep 0.5
ps -A | grep nepomukserver --silent
done
cd $KDEDIR
echo "Starting Nepomuk Server ..."
nepomukserver
cd $OLDPWD
}


function nepomuk-quit() {
qdbus org.kde.NepomukServer /nepomukserver quit
echo $?
}


function nepomuk-service-quit() {
SERVICE=
qdbus org.kde.nepomuk.services.$SERVICE /servicecontrol shutdown
echo $?
}
function nepomuk-service-restart() {
SERVICE=
nepomuk-service-quit $SERVICE


ps-nepomuk-fast | grep --silent $SERVICE
while [ $? -eq 0 ]
do
sleep 0.25
ps-nepomuk-fast | grep --silent $SERVICE
done


nepomukservicestub $SERVICE &
}


#
# Useful aliases to control Nepomuk and its services
#
alias nepomuk-indexer-quit='nepomuk-service-quit "nepomukfileindexer"'
alias nepomuk-filewatch-quit='nepomuk-service-quit "nepomukfilewatch"'
alias nepomuk-storage-quit='nepomuk-service-quit "nepomukstorage"'


alias nepomuk-indexer-restart='nepomuk-service-restart "nepomukfileindexer"'
alias nepomuk-filewatch-restart='nepomuk-service-restart "nepomukfilewatch"'
alias nepomuk-storage-restart='nepomuk-service-restart "nepomukstorage"'


alias nepomukcmd="sopranocmd --socket `kde4-config --path socket`nepomuk-socket --model main --nrl"
</syntaxhighlight>


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Policies/Kdelibs Coding Style

2013-04-07T18:22:45Z

AnneW: Marked this version for translation

<languages />
<translate>

This document describes the recommended coding style for kdelibs. Nobody is forced to use this style, but to have consistent formatting of the source code files it is recommended to make use of it.


'''In short: Kdelibs coding style follows the [http://wiki.qt-project.org/Coding_Style Qt 4 coding style].'''

== Indentation == 
* No tabs
* 4 Spaces instead of one tab

== Variable declaration == 
* Each variable declaration on a new line
* Each new word in a variable name starts with a capital letter (so-called camelCase)
* Avoid abbreviations
* Take useful names. No short names, except:
** Single character variable names can denote counters and temporary variables whose purpose is obvious
* Variables and functions start with a lowercase letter


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
<translate>
// wrong</translate>
KProgressBar *prbar;
QString prtxt, errstr;

<translate>
// correct</translate>
KProgressBar *downloadProgressBar;
QString progressText;
QString errorString;
</syntaxhighlight>

<translate>

== Whitespace == 
* Use blank lines to group statements
* Use only one empty line
* Use one space after each keyword
* For pointers or references, use a single space before '*' or '&', but not after
* No space after a cast


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
<translate>
// wrong</translate>
QString* myString;
if(true){
}

<translate>
// correct</translate>
QString *myString;
if (true) {
}
</syntaxhighlight>

<translate>
== Braces == 
As a base rule, the left curly brace goes on the same line as the start of the statement.


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
<translate>
// wrong</translate>
if (true)
{
}

<translate>
// correct</translate>
if (true) {
}
</syntaxhighlight>

<translate>

Exception: Function implementations, class, struct and namespace declarations always have the opening brace on the start of a line.


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
void debug(int i)
{
qDebug("foo: %i", i);
}

class Debug
{
};
</syntaxhighlight>

<translate>

Use curly braces even when the body of a conditional statement contains only one line.


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
<translate>
// wrong</translate>
if (true)
return true;

for (int i = 0; i < 10; ++i)
qDebug("%i", i);

<translate>
// correct</translate>
if (true) {
return true;
}

for (int i = 0; i < 10; ++i) {
qDebug("%i", i);
}
</syntaxhighlight>

<translate>
== Switch statements == 
Case labels are on the same column as the switch


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
switch (myEnum) {
case Value1:
doSomething();
break;
case Value2:
doSomethingElse();
// fall through
default:
defaultHandling();
break;
}
</syntaxhighlight>

<translate>
== Line breaks == 
Try to keep lines shorter than 100 characters, inserting line breaks as necessary.

== Qt Includes == 
* If you add #includes for Qt classes, use both the module and class name. This allows library code to be used by applications without excessive compiler include paths.


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
<translate>
// wrong</translate>
#include <QString>

<translate>
// correct</translate>
#include <QtCore/QString>
</syntaxhighlight>

<translate>
== Artistic Style (astyle) automatic code formatting == 
You can use [http://astyle.sourceforge.net/ astyle] (>=1.23) to format code or to test if you have followed this document. Run the following command:
</translate>
<syntaxhighlight lang="text">
astyle --indent=spaces=4 --brackets=linux \
--indent-labels --pad=oper --unpad=paren \
--one-line=keep-statements --convert-tabs \
--indent-preprocessor \
`find -type f -name '*.cpp'-or -name '*.cc' -or -name '*.h'`
</syntaxhighlight>

<translate>

With astyle (>=2.01) you need to run the following command:
</translate>
<syntaxhighlight lang="text">
astyle --indent=spaces=4 --brackets=linux \
--indent-labels --pad-oper --unpad-paren --pad-header \
--keep-one-line-statements --convert-tabs \
--indent-preprocessor \
`find -type f -name '*.cpp' -or -name '*.cc' -or -name '*.h'`
</syntaxhighlight>

<translate>

You can find a shell script to run this command in:


* [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts/repository/revisions/master/raw/astyle-kdelibs kde-dev-scripts/astyle-kdelibs] (POSIX)
* [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts/repository/revisions/master/raw/astyle-kdelibs.bat kde-dev-scripts/astyle-kdelibs.bat] (Windows)

== Emacs and Vim scripts == 
The [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts/repository/revisions/master/show kde-dev-scripts] directory in the kdesdk module contains, among other useful things, some useful additions to the Emacs and Vim text editors that make it easier to edit KDE code with them.

=== Emacs ===
The [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts/repository/revisions/master/show/kde-emacs kde-emacs] directory contains a set of key bindings, macros and general useful code. It is compatible with both GNU Emacs and XEmacs.


To start using kde-emacs, add the following to your .emacs:
</translate>

<syntaxhighlight lang="text">
(add-to-list 'load-path "/path/to/kde-emacs")
(require 'kde-emacs)
</syntaxhighlight>

<translate>

Many settings can be changed by editing the "kde-emacs" group via <tt>M-x customize-group</tt>.


For more information, including what the key bindings are and what additional settings you could add to your .emacs, please check <tt>kde-emacs.el</tt> itself.

=== Vim === 
You can find a vim script in [https://projects.kde.org/projects/kde/kdesdk/kde-dev-scripts/repository/revisions/master/raw/kde-devel-vim.vim kde-devel-vim.vim] that helps you to keep the coding style correct. In addition to defaulting to the kdelibs coding style it will automatically use the correct style for Solid and kdepim code. If you want to add rules for other projects feel free to add them in the SetCodingStyle function.


To use the script, include it in your {{path|~/.vimrc}} like this:
</translate>
<syntaxhighlight lang="text">
source /path/to/kde/sources/kdesdk/scripts/kde-devel-vim.vim
</syntaxhighlight>

<translate>

Document started by Urs Wolfer. Some parts of this document have been adopted from the Qt Coding Style document posted by Zack Rusin on kde-core-devel.


[[Category:Policies]] [[Category:C++]]
</translate>

Development/Tutorials/Using Qt Creator

2013-04-07T18:21:46Z

AnneW:

<languages />
<translate>

__TOC__


QtCreator is an IDE from Nokia for Qt. It contains QtDesigner for UI design. This article describes:
* why to use Qt Creator
* how to create a new application
* how to load an existing application

== Why use Qt Creator == 


{|align="right"
|[[image:Snapshot-qtcreator.png|right|thumb|200px|KDE4's ktimetracker loaded as QtCreator project]]
|}
To create your C++ applications you can use any text editor. But life will be much easier if you gain QtCreator's features. That means
* you can get your source code saved, built and run with one click
* you get code-completion
* you can find all places in your source code where you call a function (e.g. "where do I call refresh()")
* you can go back to a more recent cursor position with your editor, even if this is in another file
* you can checkout and commit to Subversion or Git repositories without leaving your workflow

== Creating a new program == 


Here is a short example of how you can create a "hello world" application. For more information read the [http://qt.nokia.com/doc/designer-manual.html user documentation].


;Step 0:
Call QtCreator
<syntaxhighlight lang="bash">
qtcreator
</syntaxhighlight>
Then select New File or Project -> Qt C++ Project -> Qt Gui Application -> name = helloworld -> Next -> Next -> Finish


;Step 1:
Select Edit -> Forms -> mainwindow.ui. Add the widgets you want by drag-and-drop:


[[File:Designer-step1.png|200px]]


;Step 2:
Select the mainwindow. This is the one un-intuitive step. To lay out the objects in the mainwindow, you do not select the objects in the mainwindow, but the mainwindow itself.


[[File:Designer-step2.png|200px]]


;Step 3:
Select Form -> Lay Out in a Grid


[[File:Designer-step3.png|200px]]


;Result:
You get a decent look, and if you resize the window, the widgets resize as well.


[[File:Designer-result.png|200px]]

=== Using KDE libraries === 


To use KDE classes like KMessageBox, you need to tell QtCreator to use the KDE libraries when building. Go to your home directory, change into ''yourproject'' and modify ''yourproject.pro''. Add the line
<syntaxhighlight lang="make">
LIBS += -lkdeui
</syntaxhighlight>
Then you can start using KDE classes in your code.

=== Adding a toolbar === 


To add a toolbar, right-click on the UI and choose "Add Toolbar". Then you can set icons and text in your mainwindow's constructor with code like this:
<syntaxhighlight lang="cpp-qt">
ui->toolBar->addAction(QIcon("/usr/share/icons/oxygen/22x22/apps/ktip.png"),"hello world");
</syntaxhighlight>
[[Development/Tutorials/Using_Qt_Designer|More Info...]]

== Load an existing project == 


This describes how to use QtCreator to integrate existing KDE 4 applications. It has been tested with QtCreator 1.2.80 and SUSE Linux 11.1 but should work same or similar with every combination. As an example KDE application we use [http://userbase.kde.org/ktimetracker ktimetracker] from the kdepim module, other applications should work likewise.


You can either work with code on your disk or have QtCreator do the repository checkout.

=== use code from your disk === 


* import the CMakeLists.txt file (File -> Open -> kdepim/CMakeLists.txt)
* as build directory choose kdepim
* you will automatically come to a screen where you can run CMake
* continue with the step "Run cmake"

=== have QtCreator do the git checkout === 


* choose File -> New File or Project -> Project from Version Control -> Git Repository Clone.
* enter a Git URL like git@git.kde.org:/kdepim
* accept kdepim as checkout directory
* type finish, see how the checkout starts
{{Note|1= If the checkout fails with the message "remote host hung up unexpectedly" do a checkout from konsole. You may have to accept git.kde.org's fingerprint.}}
* you will automatically come to a screen where you can run CMake
* continue with the step "Run cmake"

=== have QtCreator do the subversion checkout === 


* choose File -> New File or Project -> Version Control -> Subversion Checkout.
* enter a Subversion URL like svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepim
* enter a checkout directory, i.e. the local directory where the code will be checked-out to
* type finish, see how the checkout starts
* you will automatically come to a screen where you can run CMake
* continue with the step "Run cmake"

=== Run cmake === 


* enter arguments for CMake like
<syntaxhighlight lang="bash">
/root/kdepim -DCMAKE_INSTALL_PREFIX=/usr/local -DLIB_SUFFIX=64 -DCMAKE_BUILD_TYPE=debugfull
</syntaxhighlight>
<tt>DLIB_SUFFIX=64</tt> means that you want to install your libraries into directories named <tt>lib64</tt>, not <tt>lib</tt>. ''/root/kdepim'' is where your source code is.
* click "Run cmake"
* note: a .cbp file is created containing many information about the build
* click "Finish"

=== Build it === 


* configure QtCreator to build only ktimetracker:
Projects -> Active run configuration=ktimetracker -> build settings -> build steps -> make -> show details -> activate ktimetracker.
* configure QtCreator to use 8 logical processors:
Projects -> Active run configuration=ktimetracker -> build settings -> build steps -> make -> show details -> addtional Arguments = -j8
* choose Build -> Build All

== See also == 


* [[Development/Tutorials/Using Qt Designer]]
* [[Getting_Started/Using_an_IDE_with_KDE4#QtCreator]]
</translate>
[[Category:KDE4]]

Policies/Kdepim Coding Style

2013-03-14T13:22:01Z

AnneW:

{{Construction}}

== Purpose of this document ==

This document describes the recommended coding style for kdepim. Nobody is
forced to use this style, but to have consistent formatting of the source code
files it is strongly recommended to make use of it.

''In short: Kdepim coding style follows the''
[http://techbase.kde.org/Policies/Kdelibs_Coding_Style Kdelibs coding style].

== The rules for Kdepim ==

*don't use any <TAB>s
*Trim the lines
*Only single empty lines should be used
*The first line, the last line(s) may not be empty

== Migration ==

As discussed at the KDEPIM meeting, Berlin, 3 March 2013, all the files of KDEPIM will
be reviewed to follow the coding style. This will be done over a long time,
directory after directory, for each of the
rules defined above. For each rule, one can find one or two script(s).

The first script is to check a single file or a complete directory for all .h and
.cpp files.

If present, the second script makes the changes for a single file or a complete
directory for all .h and .cpp files. For some complicated situations, the
script makes no change.

One can use the scripts for own work.It is recommanded to use them in this order.
=== The scripts ===

==== don't use any <TAB>s ====
*coding-style-check-Tabs.sh
*coding-style-change-Tabs.sh

The output of the '''check''' script is:
{{Output|1=check the file /home/guy-kde/projects/kdepimlibs/ktnef/ktnefparser.cpp
1->308: Tab at 16: stream_ >> i; // i <- attribute type & name
2->311: Tab at 16: stream_ >> i; // i <- data length
3->326: Tab at 22: case attATTACHMENT: // try to get attachment info
4->367: Tab at 16: stream_ >> u; // u <- checksum
a b c d}}

This shows:
* the name of the file which is under test.
* the number of occurence('''a'''), the line number('''b'''), the position found('''c''') and the line itself('''d''').

The '''change''' script:
*makes a substitution of any <TAB> with eight spaces,
*The change works for the complete source, even within comments and strings,
*That might be too much and changes the vertical alignment of the code.

==== Trim the lines ====

*coding-style-check-Trim.sh
*coding-style-change-Trim.sh
The output of the '''check''' script is:
{{Output|1=check the file /home/guy-kde/Software/coding-style-check/trim.cpp
1->51: Space(s) at end of line (28): QVariant m_matchData;}}

This shows:
* the name of the file which is under test.
* the number of occurence, the line number, the position found and the line itself.

The '''change''' script:
*remove all trailing space(s).

==== Only single empty lines should be used ====

*coding-style-check-Twice.sh
*coding-style-change-Twice.sh

The output of the '''check''' script is:
{{Output|1=check the file /home/guy-kde/projects/kdepimlibs/syndication/rss2/enclosure.cpp
1->25: next empty line found
2->26: next empty line found
3->30: next empty line found}}

This shows:
* the name of the file which is under test.
* the number of occurrences and the line numbers.

The '''change''' script:
*removes all the next empty line(s).

==== First line, last line(s) may not be empty ====

Some of the sources have a first empty lines, some have one or more empty last line(s).
*coding-style-check-First-Last.sh
*coding-style-change-First-Last.sh

The output of the '''check''' script is:
{{Output|1=check the file /home/guy-kde/Software/coding-style-check/trim.cpp
The first line is empty
The last line is empty}}

The '''change''' script:
*removes the first line if empty, all the last empty line(s).

Translator Account

2013-03-14T11:37:47Z

AnneW:

Translator Account/2013

2013-03-14T11:33:53Z

AnneW:

Translator Account

2013-03-14T11:32:43Z

AnneW:

{{Tip|1=''Example (please add your details to the bottom of the list)''

User Name: Hans

Language(s): Swedish

(Optional) Do you expect to work off-line?: No}}

----
----

User Name: Droetker

Language(s): German

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] 16:32, 29 January 2012 (UTC)
----
User Name: Prototik

Language(s): Russian

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] 16:32, 29 January 2012 (UTC)
----
User Name: phoenixlzx

Language(s): Simplified Chinese

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] 11:57, 13 February 2012 (UTC)
----

User Name: Latif

Language(s): Indonesian

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] 11:57, 13 February 2012 (UTC)
----

User Name: Mitsakoz1989

Language(s): Greek

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] 19:05, 11 March 2012 (UTC)
----

User Name: Amachu

Language(s): Tamil

(Optional) Do you expect to work off-line?: Some times.

Welcome to the Translator group [[User:AnneW|Annew]] 15:52, 22 March 2012 (UTC)
----

User Name: Aracele

Language(s): Brazilian Portuguese

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] 12:07, 26 March 2012 (BST)
----

User Name: Torbjoern

Language(s): German

(Optional) Do you expect to work off-line?: Sometimes

Welcome to the Translator group [[User:AnneW|Annew]] 14:06, 7 April 2012 (BST)
----
User Name: Diogoleal

Language(s): Brazilian Portuguese

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] 11:20, 29 April 2012 (BST)
----

User Name: Camilaraw

Language(s): Brazilian Portuguese

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] 11:20, 29 April 2012 (BST)
----

User Name: vitorboschi

Language(s): Brazilian Portuguese

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] 11:20, 29 April 2012 (BST)
----

User Name: Airon90

Language(s): Esperanto

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] 10:02, 17 May 2012 (BST)
----

User Name: RoEn

Language(s): German, Russian

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] 18:45, 4 June 2012 (BST)
----

User Name: polix

Language(s) German,Russian, Ukrainian

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] 18:45, 4 June 2012 (BST)
----

User Name: TOUDIdel

Language(s) Polish

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] 18:25, 20 June 2012 (BST)
----

User Name: dburgoyn

Language(s) German, French

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] 18:25, 25 June 2012 (BST)
----
User Name: Libertypo

Languages: Romanian, Italian

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] 09:59, 27 June 2012 (BST)
----

User Name: Gallaecio

Language(s): Galician

(Optional) Do you expect to work off-line?: Indeed

Welcome to the Translator group [[User:AnneW|Annew]] 09:48, 22 July 2012 (BST)
----

User Name: shantha

Language(s): Tamil

(Optional) Do you expect to work off-line?: Some times.

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 09:42, 10 August 2012 (BST)
----

User Name: Freetznightsoul

Language(s): Russian

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 12:21, 12 August 2012 (BST)
----
User Name: naveenmtp

Language(s): Tamil

(Optional) Do you expect to work off-line?: Some times.

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 19:40, 16 August 2012 (BST)
----
User Name: Abella

Language(s): Catalan

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 17:57, 18 September 2012 (BST)
----
User Name: Olegkuksa

Language(s): Russian

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:09, 4 November 2012 (UTC)
----
User Name: Inzuiqiang

Language(s): 简体中文

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:09, 4 November 2012 (UTC)
----
User Name: Fredtantini

Language(s): French

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:09, 4 November 2012 (UTC)
----
User Name: PanchoS

Language(s): German

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:09, 4 November 2012 (UTC)
----
User Name: KireByte

Language(s): Spanish

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 09:52, 7 November 2012 (UTC)
----
User Name: accumulator

Language(s): Dutch

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 14:08, 12 November 2012 (UTC)
----
User Name: Berryboy2012

Language(s): Chinese

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:44, 18 November 2012 (UTC)
----
User Name: 6ahodir

Language(s): Uzbek

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:44, 18 November 2012 (UTC)
----
User Name: Aroshni

Language(s): Spanish

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 07:42, 27 November 2012 (UTC)
----

User Name: vgezer

Language(s): Turkish

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] ([[User talk:Neverendingo|talk]]) 17:09, 22 January 2013 (UTC)
----

User Name: marguerite

Language(s): Simplified Chinese

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 11:29, 7 March 2013 (UTC)
----

User Name: baalkor

Language(s): French

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 11:32, 14 March 2013 (UTC)
----

Thread:User talk:Baalkor/Welcome to the Translator group

2013-03-14T11:32:11Z

AnneW:

Thread:User talk:Baalkor/Welcome to the Translator group

2013-03-14T11:29:05Z

AnneW: New thread: Welcome to the Translator group

Welcome to the Translator group. Please read [[Tasks_and_Tools]], [[Translate_a_Page]] and [[Translation_Workflow]] before starting work. You will find lots of help linked from those pages, but please ask if there is anything you don't understand. You will notice that [[Translation_Workflow]] has a link to a language specific page, where the Team Leader for your language is named. He/She will always help with language-specific questions.

Please be aware of the category translations that have been agreed for your language. You should find it linked from [[Translation_Help_Needed]]. If your language is missing, please request a column to be inserted (or insert it yourself). If your column is incomplete, (sometimes extra categories are added) please complete it.

Enjoy!

User talk:Baalkor

2013-03-14T11:29:05Z

AnneW: Talk page autocreated when first thread was posted

Policies/Kdepim Coding Style

2013-03-11T09:56:46Z

AnneW:

{{Construction}}

== Purpose of this document ==

This document describes the recommended coding style for kdepim. Nobody is
forced to use this style, but to have consistent formatting of the source code
files it is strongly recommended to make use of it.

''In short: Kdepim coding style follows the''
[http://techbase.kde.org/Policies/Kdelibs_Coding_Style Kdelibs coding style].

== The rules for Kdepim ==

*don't use any <TAB>s
*Trim the lines
*Only single empty lines should be used
*The first line, the last line(s) may not be empty

== Migration ==

As discussed at the KDEPIM meeting, Berlin, 3 March 2013, all the files of KDEPIM will
be reviewed to follow the coding style. This will be done over a long time,
directory after directory, for each of the
rules defined above. For each rule, one can find one or two script(s).

The first script is to check a single file or a complete directory for all .h and
.cpp files.

If present, the second script makes the changes for a single file or a complete
directory for all .h and .cpp files. For some complicated situations, the
script makes no change.

One can use the scripts for own work.It is recommanded to use them in this order.

=== The scripts ===

==== don't use any <TAB>s ====
*coding-style-check-Tabs.sh
*coding-style-change-Tabs.sh

The output of the '''check''' script is:
{{Output|1=check the file /home/guy-kde/projects/kdepimlibs/ktnef/ktnefparser.cpp
1->308: Tab at 16: stream_ >> i; // i <- attribute type & name
2->311: Tab at 16: stream_ >> i; // i <- data length
3->326: Tab at 22: case attATTACHMENT: // try to get attachment info
4->367: Tab at 16: stream_ >> u; // u <- checksum
a b c d}}

This shows:
* the name of the file which is under test.
* the number of occurence('''a'''), the line number('''b'''), the position found('''c''') and the line itself('''d''').

The '''change''' script:
*makes a substitution of any <TAB> with eight spaces,
*The change works for the complete source, even within comments and strings,
*That might be too much and changes the vertical alignment of the code.

==== Trim the lines ====

*coding-style-check-Trim.sh
*coding-style-change-Trim.sh
The output of the '''check''' script is:
{{Output|1=check the file /home/guy-kde/Software/coding-style-check/trim.cpp
1->51: Space(s) at end of line (28): QVariant m_matchData;}}

This shows:
* the name of the file which is under test.
* the number of occurence, the line number, the position found and the line itself.

The '''change''' script:
*remove all trailing space(s).

==== Only single empty lines should be used ====

*coding-style-check-Twice.sh
*coding-style-change-Twice.sh

The output of the '''check''' script is:
{{Output|1=check the file /home/guy-kde/projects/kdepimlibs/syndication/rss2/enclosure.cpp
1->25: next empty line found
2->26: next empty line found
3->30: next empty line found}}

This shows:
* the name of the file which is under test.
* the number of occurrences and the line numbers.

The '''change''' script:
*removes all the next empty line(s).

==== First line, last line(s) may not be empty ====

Some of the sources have a first empty lines, some have one or more empty last line(s).
*coding-style-check-First-Last.sh
*coding-style-change-First-Last.sh

The output of the '''check''' script is:
{{Output|1=check the file /home/guy-kde/Software/coding-style-check/trim.cpp
The first line is empty
The last line is empty}}

The '''change''' script:
*removes the first line if empty, all the last empty line(s).

Translator Account/2013

2013-03-07T11:33:48Z

AnneW: Created page with "{|class="wikitable sortable" !User Name !Language !width="25"|Lang.Code !Comment !Off-line? !Date added |- |vgezer||Turkish||tr|| ||Yes||20130122 |- |marguerite||Chinese||zh-c..."

{|class="wikitable sortable"
!User Name
!Language
!width="25"|Lang.Code
!Comment
!Off-line?
!Date added
|-
|vgezer||Turkish||tr|| ||Yes||20130122
|-
|marguerite||Chinese||zh-cn|| ||Yes||20130307
|}

Translator Account

2013-03-07T11:29:23Z

AnneW:

{{Tip|1=''Example (please add your details to the bottom of the list)''

----

User Name: Hans

Language(s): Swedish

(Optional) Do you expect to work off-line?: No}}

----
----

User Name: Droetker

Language(s): German

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] 16:32, 29 January 2012 (UTC)
----
User Name: Prototik

Language(s): Russian

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] 16:32, 29 January 2012 (UTC)
----
User Name: phoenixlzx

Language(s): Simplified Chinese

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] 11:57, 13 February 2012 (UTC)
----

User Name: Latif

Language(s): Indonesian

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] 11:57, 13 February 2012 (UTC)
----

User Name: Mitsakoz1989

Language(s): Greek

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] 19:05, 11 March 2012 (UTC)
----

User Name: Amachu

Language(s): Tamil

(Optional) Do you expect to work off-line?: Some times.

Welcome to the Translator group [[User:AnneW|Annew]] 15:52, 22 March 2012 (UTC)
----

User Name: Aracele

Language(s): Brazilian Portuguese

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] 12:07, 26 March 2012 (BST)
----

User Name: Torbjoern

Language(s): German

(Optional) Do you expect to work off-line?: Sometimes

Welcome to the Translator group [[User:AnneW|Annew]] 14:06, 7 April 2012 (BST)
----
User Name: Diogoleal

Language(s): Brazilian Portuguese

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] 11:20, 29 April 2012 (BST)
----

User Name: Camilaraw

Language(s): Brazilian Portuguese

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] 11:20, 29 April 2012 (BST)
----

User Name: vitorboschi

Language(s): Brazilian Portuguese

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] 11:20, 29 April 2012 (BST)
----

User Name: Airon90

Language(s): Esperanto

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] 10:02, 17 May 2012 (BST)
----

User Name: RoEn

Language(s): German, Russian

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] 18:45, 4 June 2012 (BST)
----

User Name: polix

Language(s) German,Russian, Ukrainian

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] 18:45, 4 June 2012 (BST)
----

User Name: TOUDIdel

Language(s) Polish

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] 18:25, 20 June 2012 (BST)
----

User Name: dburgoyn

Language(s) German, French

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] 18:25, 25 June 2012 (BST)
----
User Name: Libertypo

Languages: Romanian, Italian

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] 09:59, 27 June 2012 (BST)
----

User Name: Gallaecio

Language(s): Galician

(Optional) Do you expect to work off-line?: Indeed

Welcome to the Translator group [[User:AnneW|Annew]] 09:48, 22 July 2012 (BST)
----

User Name: shantha

Language(s): Tamil

(Optional) Do you expect to work off-line?: Some times.

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 09:42, 10 August 2012 (BST)
----

User Name: Freetznightsoul

Language(s): Russian

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 12:21, 12 August 2012 (BST)
----
User Name: naveenmtp

Language(s): Tamil

(Optional) Do you expect to work off-line?: Some times.

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 19:40, 16 August 2012 (BST)
----
User Name: Abella

Language(s): Catalan

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 17:57, 18 September 2012 (BST)
----
User Name: Olegkuksa

Language(s): Russian

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:09, 4 November 2012 (UTC)
----
User Name: Inzuiqiang

Language(s): 简体中文

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:09, 4 November 2012 (UTC)
----
User Name: Fredtantini

Language(s): French

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:09, 4 November 2012 (UTC)
----
User Name: PanchoS

Language(s): German

(Optional) Do you expect to work off-line?: No

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:09, 4 November 2012 (UTC)
----
User Name: KireByte

Language(s): Spanish

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 09:52, 7 November 2012 (UTC)
----
User Name: accumulator

Language(s): Dutch

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 14:08, 12 November 2012 (UTC)
----
User Name: Berryboy2012

Language(s): Chinese

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:44, 18 November 2012 (UTC)
----
User Name: 6ahodir

Language(s): Uzbek

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 10:44, 18 November 2012 (UTC)
----
User Name: Aroshni

Language(s): Spanish

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 07:42, 27 November 2012 (UTC)
----

User Name: vgezer

Language(s): Turkish

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group --[[User:Neverendingo|Neverendingo]] ([[User talk:Neverendingo|talk]]) 17:09, 22 January 2013 (UTC)

----

User Name: marguerite

Language(s): Simplified Chinese

(Optional) Do you expect to work off-line?: Yes

Welcome to the Translator group [[User:AnneW|Annew]] ([[User talk:AnneW|talk]]) 11:29, 7 March 2013 (UTC)
----

User talk:Marguerite

2013-03-07T11:28:44Z

AnneW: Talk page autocreated when first thread was posted

Thread:User talk:Marguerite/Welcome to the Translator group

2013-03-07T11:28:43Z

AnneW: New thread: Welcome to the Translator group

Welcome to the Translator group. You will find the links in the navigation panel, section "Translator Help Pages", quite useful. Please ask if you have any problems.

Talk:Policies/Kdepim Coding Style

2013-03-06T18:48:24Z

AnneW: Talk page autocreated when first thread was posted

Thread:Talk:Policies/Kdepim Coding Style/Changing bold to italic

2013-03-06T18:48:23Z

AnneW: New thread: Changing bold to italic

This change was to bring the page into line with [[Typographical_Guidelines]]. It's debatable whether the link should be included in the italics - my opinion is that it should. You may think differently. On the whole we say that we won't use bold or italics in heading or links, but where the link is part of a sentence, as this is, it may be wise to "bend the rules". What do you think?

Policies/Kdepim Coding Style

2013-03-06T18:45:47Z

AnneW: change bold to italic in line with Typographical_Guidelines

Template:Input

2013-03-06T16:44:18Z

AnneW:

<noinclude>
This template should be used whenever you are indicating input commands.

==Usage==

<nowiki>{{Input|1=your code, single line or block}}</nowiki>

which displays
{{Input|1=your code, single line or block}}

== See also ==

* [[Template:Output]] - similar box for outlining some output
[[Category:Template]]
----
</noinclude><pre<includeonly></includeonly> style="margin-left: 0em; background-color:lemonchiffon; ">{{{1}}}</pre>

Template:Input

2013-03-06T16:41:41Z

AnneW:

Template:Output

2013-03-06T16:39:38Z

AnneW:

<noinclude>
This template should be used whenever you are indicating terminal output.

==Usage==

<nowiki>{{Output|1=output code, single line or block}}</nowiki>

which displays
{{Output|1=output code, single line or block}}

==See also==

* [[Template:Input]] - similar box for inputs
[[Category:Template]]
----
</noinclude><pre<includeonly></includeonly> style="margin-left: 0em; >{{{1}}}</pre>

Policies/Kdepim Coding Style

2013-03-06T15:56:57Z

AnneW:

Policies/Kdepim Coding Style

2013-03-06T15:55:00Z

AnneW: /* The scripts */

{{Construction}}

== Purpose of this document ==

This document describes the recommended coding style for kdepim. Nobody is
forced to use this style, but to have consistent formatting of the source code
files it is strongly recommended to make use of it.

{{Remember|1=In short: Kdepim coding style follows the
[http://techbase.kde.org/Policies/Kdelibs_Coding_Style Kdelibs coding style].}}

== Rules with test and automatic changes ==

*don't use any <TAB>s
*The change script makes a substitution of any <TAB> with eight spaces.
*The change works for the complete source, even within comments and strings.
*That might be too much and change the vertical alignment of the code.
*Trim the lines
*Only single empty lines should be used.

== Migration ==

As discussed at KDEPIM-Treff, Berlin, 3 March 2013, all the files of KDEPIM will
be reviewed to follow the coding style. This will be done over a long time,
directory after directory, for each of the
rules defined above. For each rule, one can find one or two script(s). The
first script is to check a single file or a complete directory for all .h and
.cpp files.

If present, the second script makes the changes for a single file or a complete
directory for all .h and .cpp files. For some complicated situations, the
script makes no change.

=== The scripts ===

*don't use any <TAB>s
*coding-style-check-Tabs.sh
*coding-style-change-Tabs.sh
*The output of the check is:
{{Output|1=/home/guy-kde/projects/kdepimlibs/ktnef/ktnefparser.cpp
1->308: Tab at 16: stream_ >> i; // i <- attribute type & name
2->311: Tab at 16: stream_ >> i; // i <- data length
3->326: Tab at 22: case attATTACHMENT: // try to get attachment info
4->367: Tab at 16: stream_ >> u; // u <- checksum}}

This shows:
* the name of the file which is under test.
* the number of occurence, the line number, the position found and the line
itself.

=== Trim the lines ===

{{Input| <syntaxhighlight lang="bash" line>
coding-style-check-Trim.sh
coding-style-change-Trim.sh
</syntaxhighlight>}}

=== Check for multiple empty lines ===

{{Input| <syntaxhighlight lang="bash" line>
coding-style-check-Twice.sh
coding-style-change-Twice.sh
</syntaxhighlight>}}

The output of the check is:
{{Output| <syntaxhighlight lang="bash" line>
/home/guy-kde/projects/kdepimlibs/syndication/rss2/enclosure.cpp
1->25: next empty line found
2->26: next empty line found
3->30: next empty line found
</syntaxhighlight>}}

This shows:
* the name of the file which is under test.
* the number of occurrences and the line numbers.

Policies/Kdepim Coding Style

2013-03-06T15:42:35Z

AnneW:

{{Construction}}

== Purpose of this document ==

This document describes the recommended coding style for kdepim. Nobody is
forced to use this style, but to have consistent formatting of the source code
files it is strongly recommended to make use of it.

{{Remember|1=In short: Kdepim coding style follows the
[http://techbase.kde.org/Policies/Kdelibs_Coding_Style Kdelibs coding style].}}

== Rules with test and automatic changes ==

*don't use any <TAB>s
*The change script makes a substitution of any <TAB> with eight spaces.
*The change works for the complete source, even within comments and strings.
*That might be too much and change the vertical alignment of the code.
*Trim the lines
*Only single empty lines should be used.

== Migration ==

As discussed at KDEPIM-Treff, Berlin, 3 March 2013, all the files of KDEPIM will
be reviewed to follow the coding style. This will be done over a long time,
directory after directory, for each of the
rules defined above. For each rule, one can find one or two script(s). The
first script is to check a single file or a complete directory for all .h and
.cpp files.

If present, the second script makes the changes for a single file or a complete
directory for all .h and .cpp files. For some complicated situations, the
script makes no change.

=== The scripts ===
*don't use any <TAB>s
*coding-style-check-Tabs.sh
*coding-style-change-Tabs.sh
*The output of the check is:
{{Output|<syntaxhighlight lang="php" line>
/home/guy-kde/projects/kdepimlibs/ktnef/ktnefparser.cpp
1->308: Tab at 16: stream_ >> i; // i <- attribute type & name
2->311: Tab at 16: stream_ >> i; // i <- data length
3->326: Tab at 22: case attATTACHMENT: // try to get attachment info
4->367: Tab at 16: stream_ >> u; // u <- checksum
</syntaxhighlight>}}

This shows:
* the name of the file which is under test.
* the number of occurence, the line number, the position found and the line
itself.

=== Trim the lines ===

{{Input| <syntaxhighlight lang="php" line>
coding-style-check-Trim.sh
coding-style-change-Trim.sh
</syntaxhighlight>}}

=== Check for multiple empty lines ===

{{Input| <syntaxhighlight lang="php" line>
coding-style-check-Twice.sh
coding-style-change-Twice.sh
</syntaxhighlight>}}

The output of the check is:
{{Output| <syntaxhighlight lang="php" line>
/home/guy-kde/projects/kdepimlibs/syndication/rss2/enclosure.cpp
1->25: next empty line found
2->26: next empty line found
3->30: next empty line found
</syntaxhighlight>}}

This shows:
* the name of the file which is under test.
* the number of occurrences and the line numbers.

Policies

2013-03-06T15:09:57Z

AnneW: Marked this version for translation

<languages />
<translate>

== Introduction to Policies == 


There are a couple of written and unwritten rules KDE developers usually adhere to. The following documents summarize some of these policies. The list is still incomplete. If you are interested in helping out with formulating the KDE policies or would like to discuss them please use the [https://mail.kde.org/mailman/listinfo/kde-policies kde-policies mailing list] which was created for this purpose.

== Policies for Developers == 


These policies apply to KDE developers and it is expected that all persons with a KDE SVN account follow these policies. The SVN commit policy is the most important one. Persons working on libraries (kdelibs mostly, but central libraries in other SVN modules fall under this as well) should read the library documentation policy (and the apidox howto as well).


;[[/SVN Commit Policy|SVN Commit Policy]]
:Rules for commits to the KDE SVN repository. The three golden rules (make sure it compiles, follow existing coding style, use descriptive log messages) and 18 more rules to follow to make sure that your SVN commits are the best they can be.


;[[/SVN Guidelines|Application Life Cycle]]
:Learn all about the Life Cycle of a KDE Application. Where you can upload new application, how to get in one of the main KDE modules and what to do when you give up maintainership of your application.


;[[/Licensing Policy|Licensing Policy]]
:Files in KDE SVN cannot be arbitrarily licensed. This policy explains what licenses are allowed where in the repository. In short: use LGPL for libraries, GPL or BSD for everything else.


;[[/Library Documentation Policy|Library Documentation Policy]]
:Libraries for (re)use should be completely documented. This policy explains why as well as how to document things, and what style to follow. The [[Development/Tutorials/API Documentation|apidox howto]] contains more technical information on writing documentation for libraries.


;[[/Library Code Policy|Library Code Policy]]
:KDE Library API and Code should follow some conventions that are explained in this policy.


;[[/Kdelibs Coding Style|Kdelibs Coding Style]]
:This document describes the recommended coding style for kdelibs. Nobody is forced to use this style, but to have consistent formating of the source code files it is recommended to make use of it.


;[[/Kdepim Coding Style|Kdepim Coding Style]]
:This document describes the recommended coding style for kdepim. Nobody is forced to use this style, but to have consistent formating of the source code files it is strengly recommended to make use of it.


;[[/New_KDE_Library_API_Policy|Adding New Classes to kdelibs]]
:Recommendations on how to add new classes or libraries to kdelibs.


;[[/CMake Coding Style|CMake Coding Style]]
:This document describes the recommended coding style for CMake files in KDE.


;[[/CMake and Source Compatibility|CMake and Source Compatibility]]
:Keeping future KDE releases CMake-compatible.


;[[/CMake Commit Policy|CMake Commit Policies]]
:Rules to follow when considering a change to the CMake buildsystem.


;[[/Binary Compatibility Issues With C++|Binary Compatibility Issues With C++]] ([http://developer.kde.org/documentation/other/binarycompatibility.html Original])
:A quick overview of issues with binary compatibility with C++. Keep this in mind while altering the API of kdelibs.


;[[/URI & XML Namespaces Policy|URI & XML Namespaces Policy]]
:Sometimes KDE technologies and applications needs URIs, such as for XML formats. This policy describes practices for that, and how to allocate URIs.


;[[/API to Avoid|API to Avoid]]
:There are classes and functions in Qt or other places that should be avoided by KDE applications.

== Procedures == 


Whereas policies are normative for individual developers -- that is, they describe how developers must behave -- procedures describe how 'the KDE project' as a whole has chosen to behave. We describe what we will do under certain circumstances and why.


;[[/Security Policy|Security Policy]]
:How security problems can be reported to [mailto:security@kde.org security@kde.org] and how the security team responds to security issues.


;[[/Packaging Policy|Packaging Policy]]
:This describes KDE's viewpoint on binary packages and elaborates the statement 'KDE provides source.'


;[[/Minor_Point_Release_Policy|Point Release Policy]]
:Discusses KDE policies for minor point releases.


[[Category:Policies]]
</translate>

Policies

2013-03-06T15:09:45Z

AnneW:

<languages />
<translate>

== Introduction to Policies ==

There are a couple of written and unwritten rules KDE developers usually adhere to. The following documents summarize some of these policies. The list is still incomplete. If you are interested in helping out with formulating the KDE policies or would like to discuss them please use the [https://mail.kde.org/mailman/listinfo/kde-policies kde-policies mailing list] which was created for this purpose.

== Policies for Developers ==

These policies apply to KDE developers and it is expected that all persons with a KDE SVN account follow these policies. The SVN commit policy is the most important one. Persons working on libraries (kdelibs mostly, but central libraries in other SVN modules fall under this as well) should read the library documentation policy (and the apidox howto as well).

;[[/SVN Commit Policy|SVN Commit Policy]]
:Rules for commits to the KDE SVN repository. The three golden rules (make sure it compiles, follow existing coding style, use descriptive log messages) and 18 more rules to follow to make sure that your SVN commits are the best they can be.

;[[/SVN Guidelines|Application Life Cycle]]
:Learn all about the Life Cycle of a KDE Application. Where you can upload new application, how to get in one of the main KDE modules and what to do when you give up maintainership of your application.

;[[/Licensing Policy|Licensing Policy]]
:Files in KDE SVN cannot be arbitrarily licensed. This policy explains what licenses are allowed where in the repository. In short: use LGPL for libraries, GPL or BSD for everything else.

;[[/Library Documentation Policy|Library Documentation Policy]]
:Libraries for (re)use should be completely documented. This policy explains why as well as how to document things, and what style to follow. The [[Development/Tutorials/API Documentation|apidox howto]] contains more technical information on writing documentation for libraries.

;[[/Library Code Policy|Library Code Policy]]
:KDE Library API and Code should follow some conventions that are explained in this policy.

;[[/Kdelibs Coding Style|Kdelibs Coding Style]]
:This document describes the recommended coding style for kdelibs. Nobody is forced to use this style, but to have consistent formating of the source code files it is recommended to make use of it.

;[[/Kdepim Coding Style|Kdepim Coding Style]]
:This document describes the recommended coding style for kdepim. Nobody is forced to use this style, but to have consistent formating of the source code files it is strengly recommended to make use of it.

;[[/New_KDE_Library_API_Policy|Adding New Classes to kdelibs]]
:Recommendations on how to add new classes or libraries to kdelibs.

;[[/CMake Coding Style|CMake Coding Style]]
:This document describes the recommended coding style for CMake files in KDE.

;[[/CMake and Source Compatibility|CMake and Source Compatibility]]
:Keeping future KDE releases CMake-compatible.

;[[/CMake Commit Policy|CMake Commit Policies]]
:Rules to follow when considering a change to the CMake buildsystem.

;[[/Binary Compatibility Issues With C++|Binary Compatibility Issues With C++]] ([http://developer.kde.org/documentation/other/binarycompatibility.html Original])
:A quick overview of issues with binary compatibility with C++. Keep this in mind while altering the API of kdelibs.

;[[/URI & XML Namespaces Policy|URI & XML Namespaces Policy]]
:Sometimes KDE technologies and applications needs URIs, such as for XML formats. This policy describes practices for that, and how to allocate URIs.

;[[/API to Avoid|API to Avoid]]
:There are classes and functions in Qt or other places that should be avoided by KDE applications.

== Procedures ==

Whereas policies are normative for individual developers -- that is, they describe how developers must behave -- procedures describe how 'the KDE project' as a whole has chosen to behave. We describe what we will do under certain circumstances and why.

;[[/Security Policy|Security Policy]]
:How security problems can be reported to [mailto:security@kde.org security@kde.org] and how the security team responds to security issues.

;[[/Packaging Policy|Packaging Policy]]
:This describes KDE's viewpoint on binary packages and elaborates the statement 'KDE provides source.'

;[[/Minor_Point_Release_Policy|Point Release Policy]]
:Discusses KDE policies for minor point releases.

[[Category:Policies]]
</translate>

User:AnneW/Stats

2012-12-31T17:43:55Z

AnneW: Created page with "{{Special:ContributionScores/10/7}} Edits over the past 4 days: {{Special:TranslationStats/scale=hours;days=4;width=900}} ---- Daily Edits, for the past month: {{Special:Tran..."

{{Special:ContributionScores/10/7}}

Edits over the past 4 days:
{{Special:TranslationStats/scale=hours;days=4;width=900}}
----
Daily Edits, for the past month:
{{Special:TranslationStats/scale=days;days=30;width=900}}
----
Active translators:
{{Special:TranslationStats/count=users;width=900;height=200}}
----
New registrations, by month, over 1 year:
{{Special:TranslationStats/count=registrations;scale=months;days=365;width=900;height=200}}
----

Projects/Nepomuk/TestEnvironment

2012-12-24T10:08:35Z

AnneW: Marked this version for translation

<languages />
<translate>

== Testing == 


Testing changes in '''Nepomuk''' can be a little hard because it often requires the entire Nepomuk stack to be running. This includes all the Nepomuk Services along with the virtuoso database. Additionally, one often might want to test some risky changes, and not mess around with your own precious database. In those cases, it would be nice to have a virtual Nepomuk environment to run these tests on.


That is where the Nepomuk Test Environment comes in.


It is currently present in nepomuk-core.

== Usage == 


<syntaxhighlight lang="bash">
$ cd nepomuk-core/autotests/lib/tools/
$ cb # Change to the build directory
$ source nepomuk-sandbox-begin.sh
$
$ # A mock KDE Nepomuk session will be started
$ # Here you can run whatever tests you want
$ source nepomuk-sandbox-end.sh
</syntaxhighlight>


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/TestEnvironment

2012-12-24T10:08:20Z

AnneW:

<languages />
<translate>

== Testing ==

Testing changes in '''Nepomuk''' can be a little hard because it often requires the entire Nepomuk stack to be running. This includes all the Nepomuk Services along with the virtuoso database. Additionally, one often might want to test some risky changes, and not mess around with your own precious database. In those cases, it would be nice to have a virtual Nepomuk environment to run these tests on.

That is where the Nepomuk Test Environment comes in.

It is currently present in nepomuk-core.

== Usage ==

<syntaxhighlight lang="bash">
$ cd nepomuk-core/autotests/lib/tools/
$ cb # Change to the build directory
$ source nepomuk-sandbox-begin.sh
$
$ # A mock KDE Nepomuk session will be started
$ # Here you can run whatever tests you want
$ source nepomuk-sandbox-end.sh
</syntaxhighlight>

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Thread:Talk:Development/Guidelines/HCI/Checklists/Configuration/Link to paged configuration dialog - 404/reply (2)

2012-12-20T10:38:18Z

AnneW: Reply to Link to >>paged configuration dialog<< - 404

It has proved impossible to locate the original file/example. I have therefore removed the links.

Development/Guidelines/HCI/Checklists/Configuration

2012-12-20T10:37:31Z

AnneW:

1. Dialog navigation

* A paged configuration dialog should be used when there is more than one category of options.
* Tabs should be used as second-level navigation.
* Tree views shouldn't be used in the paged dialog's sidebar.

2. Grouping of options

* The number of categories (pages) should be between 3 and 6.
* The number of tabs on a page should be between 2 and 4.
* The options should be in the visible space so the user doesn't need to scroll. (otherwise it's an indicator that options might be moved to advanced sections or dialogs)
* There shouldn't be "orphaned options" - options which are not related to any other ones.

3. Dialog layout

* The dialog should be resizable. (the latter is important for accessibility)
* The overall size of the dialog shouldn't be bigger than 800x600.
* The dialog should have scrollbars which appear when not all options are visible.

4. Wording

* Keywords used in page title and the label in the left navigation bar should correspond. (for example, the page title may "Here you can personalize kopete"” while the label is "Behavior". This should be reported and the acceptable change would be Behavior -> "Here you can change the behavior of Kopete" OR Personalize -> "Here you can personalize Kopete")

* Obviously technical or otherwise hard to understand wording should be avoided.

Thread:Talk:Development/Guidelines/HCI/Checklists/Configuration/Link to paged configuration dialog - 404/reply

2012-12-18T12:39:32Z

AnneW: Reply to Link to >>paged configuration dialog<< - 404

Thank you for reporting this. We now have a template for reporting such issues, which should help get them noticed. You might look to take a look at the code of the page, to see how we are using it {{smiley}}

Development/Guidelines/HCI/Checklists/Configuration

2012-12-17T19:12:17Z

AnneW:

{{Review|1=
* The link in the first paragraph appears to be broken
* The same broken link appears in section 4
* Also in section 4, the typeface is tiny and grey, almost invisible in some browsers }}

1. Dialog navigation

* A [http://wiki.openusability.org/guidelines/index.php/Image:Grouping.png paged configuration dialog] should be used when there is more than one category of options.
* Tabs should be used as second-level navigation.
* Tree views shouldn't be used in the paged dialog's sidebar.

2. Grouping of options

* The number of categories (pages) should be between 3 and 6.
* The number of tabs on a page should be between 2 and 4.
* The options should be in the visible space so the user doesn't need to scroll. (otherwise it's an indicator that options might be moved to advanced sections or dialogs)
* There shouldn't be "orphaned options" - options which are not related to any other ones.

3. Dialog layout

* The dialog should be resizable. (the latter is important for accessibility)
* The overall size of the dialog shouldn't be bigger than 800x600.
* The dialog should have scrollbars which appear when not all options are visible.

4. Wording

* Keywords used in page title and the label in the left navigation bar should correspond.
(In [http://wiki.openusability.org/guidelines/index.php/Image:Grouping.png this example], page title is "Here you can personalize kopete"” while the label is "Behavior". This should be reported and acceptable change would be Behavior -> "Here you can change the behavior of Kopete" OR Personalize -> "Here you can personalize Kopete")

* Obviously technical or otherwise hard to understand wording should be avoided.

Development/Guidelines/HCI/Checklists/Configuration

2012-12-17T18:46:21Z

AnneW:

{{Review|1=* The link in the first paragraph appears to be broken}}

1. Dialog navigation

* A [http://wiki.openusability.org/guidelines/index.php/Image:Grouping.png paged configuration dialog] should be used when there is more than one category of options.
* Tabs should be used as second-level navigation.
* Tree views shouldn't be used in the paged dialog's sidebar.

2. Grouping of options

* The number of categories (pages) should be between 3 and 6.
* The number of tabs on a page should be between 2 and 4.
* The options should be in the visible space so the user doesn't need to scroll. (otherwise it's an indicator that options might be moved to advanced sections or dialogs)
* There shouldn't be "orphaned options" - options which are not related to any other ones.

3. Dialog layout

* The dialog should be resizable. (the latter is important for accessibility)
* The overall size of the dialog shouldn't be bigger than 800x600.
* The dialog should have scrollbars which appear when not all options are visible.

4. Wording

* Keywords used in page title and the label in the left navigation bar should correspond.
(In [http://wiki.openusability.org/guidelines/index.php/Image:Grouping.png this example], page title is "Here you can personalize kopete"” while the label is "Behavior". This should be reported and acceptable change would be Behavior -> "Here you can change the behavior of Kopete" OR Personalize -> "Here you can personalize Kopete")

* Obviously technical or otherwise hard to understand wording should be avoided.

Development/Guidelines/HCI/Checklists/Configuration

2012-12-17T16:32:31Z

AnneW: Broken link warning

1. Dialog navigation

* A [http://wiki.openusability.org/guidelines/index.php/Image:Grouping.png paged configuration dialog] should be used when there is more than one category of options.
{{Warning|1=This link is currently broken. We are requesting a new one.}}
* Tabs should be used as second-level navigation.
* Tree views shouldn't be used in the paged dialog's sidebar.

2. Grouping of options

* The number of categories (pages) should be between 3 and 6.
* The number of tabs on a page should be between 2 and 4.
* The options should be in the visible space so the user doesn't need to scroll. (otherwise it's an indicator that options might be moved to advanced sections or dialogs)
* There shouldn't be "orphaned options" - options which are not related to any other ones.

3. Dialog layout

* The dialog should be resizable. (the latter is important for accessibility)
* The overall size of the dialog shouldn't be bigger than 800x600.
* The dialog should have scrollbars which appear when not all options are visible.

4. Wording

* Keywords used in page title and the label in the left navigation bar should correspond.
(In [http://wiki.openusability.org/guidelines/index.php/Image:Grouping.png this example], page title is "Here you can personalize kopete"” while the label is "Behavior". This should be reported and acceptable change would be Behavior -> "Here you can change the behavior of Kopete" OR Personalize -> "Here you can personalize Kopete")

* Obviously technical or otherwise hard to understand wording should be avoided.

User:AnneW/Tests

2012-12-14T19:28:12Z

AnneW: /* Counting translations */

== Counting translations ==
<DPL>
titlematch = %/ca
notnamespace = Translations
columns = 3
format = ,\n* [[%PAGE%|%TITLE%]],,
resultsheader = There are %TOTALPAGES% pages (partly) translated to Catalan. These are:\n
</DPL>

User:AnneW/Tests

2012-12-14T19:02:45Z

AnneW: /* Counting translations */

Http://techbase.kde.org/Projects/Nepomuk/OntologyExtension

2012-12-14T16:24:03Z

AnneW: AnneW moved page Projects/Nepomuk/OntologyExtention to Http://techbase.kde.org/Projects/Nepomuk/OntologyExtension without leaving a redirect

<languages />
<translate>

== Introducing Ontologies == 


The [http://oscaf.sourceforge.net/ Shared Desktop Ontologies] were written with a very broad purpose in mind. That being said, they are still cases that are often not covered by it. In that case there are two possible options for extending the ontologies

== Contributing to SDO == 


The Shared Desktop Ontologies project follows a strict review policy. In order for any changes to be made, a [http://sourceforge.net/apps/trac/oscaf/newticket new ticket] must first be filed stating the changes that you wish to be made, and the rationale behind them.


Here is a [http://sourceforge.net/apps/trac/oscaf/report/1 list] of all the currently open tickets.


Most discussions happen in the [https://mail.kde.org/mailman/listinfo/nepomuk nepomuk mailing list]. Feel free to email us about any changes.

== Creating a custom ontology == 


Most of the ontologies are written in the [http://www4.wiwiss.fu-berlin.de/bizer/trig/ trig syntax].


In order to install an ontology, the follow files are required -


* <tt>ontology-name.trig</tt> The TriG file containing the ontology
* <tt>ontology-name.ontology.in</tt> A file describing the ontology


In order to ease the process of creating custom ontologies a template ontology is provided in [http://quickgit.kde.org/index.php?p=kdeexamples.git&a=tree&h=44b1d8b2b6d2d140437ca03102fa56279232227b&hb=80a322af2bc5975c01c704173e937ccb8df605e3&f=nepomuk%2Fontology kdeexamples/nepomuk/ontology]

=== Ontology C++ files === 


In order to easily access the ontology in your code. It is recommended to generate ontology headers. This can be done using some cmake magic provided by '''Soprano'''.


<syntaxhighlight lang=cmake>
include(SopranoAddOntology)


# Generating headers for the nie ontology
soprano_add_ontology(SRCS "${SHAREDDESKTOPONTOLOGIES_ROOT_DIR}/nie/nie.trig" "NIE" "Nepomuk2::Vocabulary" "trig")
</syntaxhighlight>


The Nepomuk-Core repository already provides ontology headers for the most commonly used ontologies.


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

User:Amachu

2012-12-14T12:00:06Z

AnneW: Remove external link

User:AnneW/Tests

2012-12-14T11:50:36Z

AnneW: /* Counting translations */

== Counting translations ==
<DPL>
titlematch = %/zh-cn
notnamespace = Translations
columns = 3
format = ,\n* [[%PAGE%|%TITLE%]],,
resultsheader = There are %TOTALPAGES% pages (partly) translated to Chinese. These are:\n
</DPL>

User:AnneW/Tests

2012-12-14T11:40:48Z

AnneW: Created page with "== Counting translations == <DPL> titlematch = %/el notnamespace = Translations columns = 3 format = ,\n* %TITLE%,, resultsheader = There are %TOTALPAGES%..."

== Counting translations ==
<DPL>
titlematch = %/el
notnamespace = Translations
columns = 3
format = ,\n* [[%PAGE%|%TITLE%]],,
resultsheader = There are %TOTALPAGES% pages (partly) translated to Georgian. These are:\n
</DPL>

Projects/Nepomuk/NepomukShow

2012-12-14T10:35:29Z

AnneW: Marked this version for translation

<languages />
<translate>

== Introducing NepomukShow == 


NepomukShow is a debugging tool which can be used to easily view nepomuk data. It currently resides in a scratch repo - git://anongit.kde.org/scratch/vhanda/nepomukshow


Using nepomukshow is fairly straightforward.
<syntaxhighlight lang="text">
$ nepomukshow fileUrl


<nepomuk:/res/b353bf46-bee3-4efd-8178-9306104d7061>
rdf:type nmm:MusicPiece
rdf:type nfo:FileDataObject
rdf:type nfo:Audio
rdf:type nie:InformationElement
nao:created 2012-10-20T22:41:32.349Z
nao:lastModified 2012-11-07T16:39:56.198Z
nie:url file:///home/vishesh/Music/thelionsleepstonight1.mp3
nie:mimeType audio/mpeg
nie:title The Lion Sleeps Tonight
nie:lastModified 2010-08-25T13:09:05Z
nie:created 2012-06-08T23:40:08Z
nfo:averageBitrate 1.2800000000e+02
nfo:sampleRate 4.4100000000e+04
nfo:fileSize 2547712
nfo:fileName thelionsleepstonight1.mp3
nfo:channels 2
nfo:duration 159
nmm:performer nepomuk:/res/d54cbabc-9d14-4a60-8c5f-e85a5401df68
nmm:genre Pop
kext:indexingLevel 2
kext:unixFileMode 33188
kext:unixFileOwner vishesh
kext:unixFileGroup users
</syntaxhighlight>


It has a bunch of additional options, which can be used to show extra info.


'''TODO: Improve this page!'''


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/NepomukShow

2012-12-14T10:35:17Z

AnneW: Prepare for translation

<languages />
<translate>

== Introducing NepomukShow ==

NepomukShow is a debugging tool which can be used to easily view nepomuk data. It currently resides in a scratch repo - git://anongit.kde.org/scratch/vhanda/nepomukshow

Using nepomukshow is fairly straightforward.
<syntaxhighlight lang="text">
$ nepomukshow fileUrl

<nepomuk:/res/b353bf46-bee3-4efd-8178-9306104d7061>
rdf:type nmm:MusicPiece
rdf:type nfo:FileDataObject
rdf:type nfo:Audio
rdf:type nie:InformationElement
nao:created 2012-10-20T22:41:32.349Z
nao:lastModified 2012-11-07T16:39:56.198Z
nie:url file:///home/vishesh/Music/thelionsleepstonight1.mp3
nie:mimeType audio/mpeg
nie:title The Lion Sleeps Tonight
nie:lastModified 2010-08-25T13:09:05Z
nie:created 2012-06-08T23:40:08Z
nfo:averageBitrate 1.2800000000e+02
nfo:sampleRate 4.4100000000e+04
nfo:fileSize 2547712
nfo:fileName thelionsleepstonight1.mp3
nfo:channels 2
nfo:duration 159
nmm:performer nepomuk:/res/d54cbabc-9d14-4a60-8c5f-e85a5401df68
nmm:genre Pop
kext:indexingLevel 2
kext:unixFileMode 33188
kext:unixFileOwner vishesh
kext:unixFileGroup users
</syntaxhighlight>

It has a bunch of additional options, which can be used to show extra info.

'''TODO: Improve this page!'''

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Development/Tutorials/Metadata/Nepomuk/TipsAndTricks

2012-12-14T10:30:14Z

AnneW: Marked this version for translation

<languages />
<translate>

== Using ontology URIs in your code == 


One often needs the URI of a specific class or a specific property in ones code. And not all ontologies are provided by the very convenient [http://soprano.sourceforge.net/apidox/stable/namespaceSoprano_1_1Vocabulary.html Soprano::Vocabulary] namespace.


The solution is rather simple: create your own vocabulary namespaces by using Soprano's own onto2vocabularyclass command line tool. It can generate convenient vocabulary namespaces for you. The Soprano documentation shows how to [http://soprano.sourceforge.net/apidox/trunk/soprano_devel_tools.html use it manually] or even simpler with a [http://soprano.sourceforge.net/apidox/trunk/soprano_howto.html#cmake_magic simple CMake macro].


 

== Mind the Difference between QString and QUrl == 


[http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk/html/classNepomuk_1_1Resource.html Nepomuk::Resource] provides two constructors: one taking a {{qt|QString}} as identifier or URI and one taking a {{qt|QUrl}}.


The latter one is really simple: the given URI is used as the resource URI. If the resource exists, its data is used, otherwise it will be created with exactly that URI.


The {{qt|QString}} one is a bit trickier. It will try to be clever about the parameter and see if it is a URI. If no resource with that URI (if it is a URI) exists, it is interpreted as an identifier ([http://www.semanticdesktop.org/ontologies/nao/#mozTocId802441 nao:identifier]). Resource checks if a resource with that identifier exists. If so, its data is loaded, if not, a new resource with a random URI and that string as identifier is created.


However, '''be aware that nothing is written to '''Nepomuk''' until the first writing call to Resource such as setProperty or addType.'''


 

== Debugging the created data == 


Soprano provides a command line client to connect to the storage service. It's called <tt>sopranocmd</tt>. It provides all the features one needs to debug data. It is recommended that you only use sopranocmd for running queries.


Running sopranocmd is cumbersome because of the large number of arguments it requires. This can be made simpler by adding the following alias -
<syntaxhighlight lang="bash">alias nepomukcmd="sopranocmd --socket `kde4-config --path socket`nepomuk-socket --model main --nrl"</syntaxhighlight>


For example -
<syntaxhighlight lang="text">
# nepomukcmd query \
"select ?r where { ?r nao:hasTag ?tag . \
?tag nao:prefLabel 'foobar'^^xsd:string . }"
</syntaxhighlight>

=== Using Konqueror === 


In the [http://websvn.kde.org:80/trunk/playground/base/nepomuk-kde/kioslaves/nepomuk/ Nepomuk playground] repository lives a KIO slave which can handle the ''nepomuk:/'' protocol. It will display all properties of a Nepomuk resource including its links to other resources and the backlinks. This is a convenient way of looking at the Nepomuk data. The KIO slave even support removal of resources.


[[Image:Nepomuk kio slave.png|560px]]


 

=== Using NepomukShell === 


NepomukShell is a maintenance and debugging tool, which lives in its own git repository at [https://projects.kde.org/projects/extragear/utils/nepomukshell nepomukshell]. It is a simple tool that let's one browse all resources in '''Nepomuk'''. Additionally it allows to create subclasses and properties and remove resources.
{{Remember|2='''Caution'''|1=Do only create subclasses and properties from PIMO classes and properties!}}


[[Image:Pimoshell.png|560px]]

== Constructing SPARQL queries == 


{{Tip|1= In most cases the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk/html/namespaceNepomuk_1_1Query.html Nepomuk Query API] should be enough and prevent you from writing your own SPARQL which is hard to debug.}}


Whenever doing something a bit fancier with '''Nepomuk''' one has to use SPARQL queries via <syntaxhighlight lang="cpp-qt">
Nepomuk::ResourceManager::instance()->mainModel()
->executeQuery( myQueryString,
Soprano::Query::QueryLanguageSparql );
</syntaxhighlight>


Constructing these queries can be a bit cumbersome since one has to use a lot of class and property URIs from different ontologies. Also literals have to be formatted according to the N3 syntax used in SPARQL. Luckily Soprano provides the necessary tools to do exactly that: [http://soprano.sourceforge.net/apidox/trunk/classSoprano_1_1Node.html#ad4c8ab988ae7d9fd587027087b593e4 Soprano::Node::toN3], [http://soprano.sourceforge.net/apidox/trunk/classSoprano_1_1Node.html#d1c2618a28a13c6eac042ddccbf78e6a Soprano::Node::resourceToN3], and [http://soprano.sourceforge.net/apidox/trunk/classSoprano_1_1Node.html#a66acf156e82b866114d90cd0c9ce13c Soprano::Node::literalToN3] take care of all formatting and percent-encoding you need. Using those methods the code to create queries might look ugly but the resulting queries are more likely to be correctly encoded and introduce less code duplication.


Typically one would use QString::arg like so (be aware that the standard prefixes are NOT supported out-of-the-box as with sopranocmd):


<syntaxhighlight lang="cpp-qt">
using namespace Soprano;


QString myQuery
= QString("select ?r where { "
"?r %1 ?v . "
"?v %2 %3 . }")
.arg(Node::resourceToN3(Vocabulary::NAO::hasTag()))
.arg(Node::resourceToN3(Vocabulary::NAO::prefLabel()))
.arg(Node::literalToN3("foobar")));


</syntaxhighlight>


This will create the same query we used above only using no hard-coded components whatsoever.

== Debugging virtuoso-t == 


If virtuoso-t consumes a lot of CPU resources but there are no active queries analysis has to go a bit deeper. Virtuoso is started through Soprano with certain parameters which are set in a temporary ini-file (/tmp/virtuoso_XXXX.ini). Soprano needs to be modified manually to start Virtuoso with different parameters in the ini-file, e.g. to improve virtuoso-t's behaviour by modifying backends/virtuoso/virtuosocontroller.cpp (Soprano) and setting NumberOfBuffers to 40000 (line 344) and SchedulerInterval to 0 (line 350).


After re-compiling soprano one has to attach gdb to virtuoso-t as soon as it starts consuming CPU and create a full threaded backtrace:


<syntaxhighlight lang="cpp-qt">
set logging file /tmp/virtuoso-t.out
set logging on
thread apply all bt full
</syntaxhighlight>


Note: The above settings should only be used for debugging!


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Development/Tutorials/Metadata/Nepomuk/TipsAndTricks

2012-12-14T10:29:59Z

AnneW: Prepare for translation

<languages />
<translate>

== Using ontology URIs in your code ==

One often needs the URI of a specific class or a specific property in ones code. And not all ontologies are provided by the very convenient [http://soprano.sourceforge.net/apidox/stable/namespaceSoprano_1_1Vocabulary.html Soprano::Vocabulary] namespace.

The solution is rather simple: create your own vocabulary namespaces by using Soprano's own onto2vocabularyclass command line tool. It can generate convenient vocabulary namespaces for you. The Soprano documentation shows how to [http://soprano.sourceforge.net/apidox/trunk/soprano_devel_tools.html use it manually] or even simpler with a [http://soprano.sourceforge.net/apidox/trunk/soprano_howto.html#cmake_magic simple CMake macro].

 

== Mind the Difference between QString and QUrl ==

[http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk/html/classNepomuk_1_1Resource.html Nepomuk::Resource] provides two constructors: one taking a {{qt|QString}} as identifier or URI and one taking a {{qt|QUrl}}.

The latter one is really simple: the given URI is used as the resource URI. If the resource exists, its data is used, otherwise it will be created with exactly that URI.

The {{qt|QString}} one is a bit trickier. It will try to be clever about the parameter and see if it is a URI. If no resource with that URI (if it is a URI) exists, it is interpreted as an identifier ([http://www.semanticdesktop.org/ontologies/nao/#mozTocId802441 nao:identifier]). Resource checks if a resource with that identifier exists. If so, its data is loaded, if not, a new resource with a random URI and that string as identifier is created.

However, '''be aware that nothing is written to '''Nepomuk''' until the first writing call to Resource such as setProperty or addType.'''

 

== Debugging the created data ==

Soprano provides a command line client to connect to the storage service. It's called <tt>sopranocmd</tt>. It provides all the features one needs to debug data. It is recommended that you only use sopranocmd for running queries.

Running sopranocmd is cumbersome because of the large number of arguments it requires. This can be made simpler by adding the following alias -
<syntaxhighlight lang="bash">alias nepomukcmd="sopranocmd --socket `kde4-config --path socket`nepomuk-socket --model main --nrl"</syntaxhighlight>

For example -
<syntaxhighlight lang="text">
# nepomukcmd query \
"select ?r where { ?r nao:hasTag ?tag . \
?tag nao:prefLabel 'foobar'^^xsd:string . }"
</syntaxhighlight>

=== Using Konqueror ===

In the [http://websvn.kde.org:80/trunk/playground/base/nepomuk-kde/kioslaves/nepomuk/ Nepomuk playground] repository lives a KIO slave which can handle the ''nepomuk:/'' protocol. It will display all properties of a Nepomuk resource including its links to other resources and the backlinks. This is a convenient way of looking at the Nepomuk data. The KIO slave even support removal of resources.

[[Image:Nepomuk kio slave.png|560px]]

 

=== Using NepomukShell ===

NepomukShell is a maintenance and debugging tool, which lives in its own git repository at [https://projects.kde.org/projects/extragear/utils/nepomukshell nepomukshell]. It is a simple tool that let's one browse all resources in '''Nepomuk'''. Additionally it allows to create subclasses and properties and remove resources.
{{Remember|2='''Caution'''|1=Do only create subclasses and properties from PIMO classes and properties!}}

[[Image:Pimoshell.png|560px]]

== Constructing SPARQL queries ==

{{Tip|1= In most cases the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk/html/namespaceNepomuk_1_1Query.html Nepomuk Query API] should be enough and prevent you from writing your own SPARQL which is hard to debug.}}

Whenever doing something a bit fancier with '''Nepomuk''' one has to use SPARQL queries via <syntaxhighlight lang="cpp-qt">
Nepomuk::ResourceManager::instance()->mainModel()
->executeQuery( myQueryString,
Soprano::Query::QueryLanguageSparql );
</syntaxhighlight>

Constructing these queries can be a bit cumbersome since one has to use a lot of class and property URIs from different ontologies. Also literals have to be formatted according to the N3 syntax used in SPARQL. Luckily Soprano provides the necessary tools to do exactly that: [http://soprano.sourceforge.net/apidox/trunk/classSoprano_1_1Node.html#ad4c8ab988ae7d9fd587027087b593e4 Soprano::Node::toN3], [http://soprano.sourceforge.net/apidox/trunk/classSoprano_1_1Node.html#d1c2618a28a13c6eac042ddccbf78e6a Soprano::Node::resourceToN3], and [http://soprano.sourceforge.net/apidox/trunk/classSoprano_1_1Node.html#a66acf156e82b866114d90cd0c9ce13c Soprano::Node::literalToN3] take care of all formatting and percent-encoding you need. Using those methods the code to create queries might look ugly but the resulting queries are more likely to be correctly encoded and introduce less code duplication.

Typically one would use QString::arg like so (be aware that the standard prefixes are NOT supported out-of-the-box as with sopranocmd):

<syntaxhighlight lang="cpp-qt">
using namespace Soprano;

QString myQuery
= QString("select ?r where { "
"?r %1 ?v . "
"?v %2 %3 . }")
.arg(Node::resourceToN3(Vocabulary::NAO::hasTag()))
.arg(Node::resourceToN3(Vocabulary::NAO::prefLabel()))
.arg(Node::literalToN3("foobar")));

</syntaxhighlight>

This will create the same query we used above only using no hard-coded components whatsoever.

== Debugging virtuoso-t ==

If virtuoso-t consumes a lot of CPU resources but there are no active queries analysis has to go a bit deeper. Virtuoso is started through Soprano with certain parameters which are set in a temporary ini-file (/tmp/virtuoso_XXXX.ini). Soprano needs to be modified manually to start Virtuoso with different parameters in the ini-file, e.g. to improve virtuoso-t's behaviour by modifying backends/virtuoso/virtuosocontroller.cpp (Soprano) and setting NumberOfBuffers to 40000 (line 344) and SchedulerInterval to 0 (line 350).

After re-compiling soprano one has to attach gdb to virtuoso-t as soon as it starts consuming CPU and create a full threaded backtrace:

<syntaxhighlight lang="cpp-qt">
set logging file /tmp/virtuoso-t.out
set logging on
thread apply all bt full
</syntaxhighlight>

Note: The above settings should only be used for debugging!

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/TestEnvironment

2012-12-14T10:14:55Z

AnneW: Prepare for translation

<languages />
<translate>

== Testing ==

Testing changes in '''Nepomuk''' can be a little hard because it often requires the entire Nepomuk stack to be running. This includes all the Nepomuk Services along with the virtuoso database. Additionally, one often might want to test some risky changes, and not mess around with your own precious database. In those cases, it would be nice to have a virtual Nepomuk environment to run these tests on.

That is where the Nepomuk Test Environment comes in.

It is currently present in nepomuk-core.

== Usage ==
<syntaxhighlight lang="bash">
$ cd nepomuk-core/autotests/lib/tools/
$ cb # Change to the build directory
$ source nepomuk-sandbox-begin.sh
$
$ # A mock KDE Nepomuk session will be started
$ # Here you can run whatever tests you want
$ source nepomuk-sandbox-end.sh
</syntaxhighlight>

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/ManagingNepomukProcesses

2012-12-14T10:12:46Z

AnneW: Marked this version for translation

<languages />
<translate>


{{Info|1=This page contains some useful commands for managing the different Nepomuk processes}}

== Restarting Nepomuk == 
<syntaxhighlight lang="bash">
$ qdbus org.kde.NepomukServer /nepomukserver quit
wait for it to quit
$ nepomukserver
</syntaxhighlight>

== Restarting any service == 
If you need to restart any particular service -


<syntaxhighlight lang="bash">
$ qdbus org.kde.nepomuk.services.$SERVICE /servicecontrol shutdown
wait for it to quit
$ nepomukservicestub $SERVICE
</syntaxhighlight>


Just killing the service won't work, cause the 'nepomukserver' automatically restarts crashed services.

== Useful commands == 
<syntaxhighlight lang="bash">


#This function restarts the Nepomuk server
function nepomuk-restart() {
nepomuk-quit


ps -A | grep nepomukserver --silent
while [ $? -eq 0 ]
do
sleep 0.5
ps -A | grep nepomukserver --silent
done
cd $KDEDIR
echo "Starting Nepomuk Server ..."
nepomukserver
cd $OLDPWD
}


function nepomuk-quit() {
qdbus org.kde.NepomukServer /nepomukserver quit
return $?
}


function nepomuk-service-quit() {
SERVICE=
qdbus org.kde.nepomuk.services.$SERVICE /servicecontrol shutdown
return $?
}
function nepomuk-service-restart() {
SERVICE=
nepomuk-service-quit $SERVICE


ps-nepomuk-fast | grep --silent $SERVICE
while [ $? -eq 0 ]
do
sleep 0.25
ps-nepomuk-fast | grep --silent $SERVICE
done


nepomukservicestub $SERVICE &
}


#
# Useful aliases to control Nepomuk and its services
#
alias nepomuk-indexer-quit='nepomuk-service-quit "nepomukfileindexer"'
alias nepomuk-filewatch-quit='nepomuk-service-quit "nepomukfilewatch"'
alias nepomuk-storage-quit='nepomuk-service-quit "nepomukstorage"'


alias nepomuk-indexer-restart='nepomuk-service-restart "nepomukfileindexer"'
alias nepomuk-filewatch-restart='nepomuk-service-restart "nepomukfilewatch"'
alias nepomuk-storage-restart='nepomuk-service-restart "nepomukstorage"'


alias nepomukcmd="sopranocmd --socket `kde4-config --path socket`nepomuk-socket --model main --nrl"
</syntaxhighlight>


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/ManagingNepomukProcesses

2012-12-14T10:12:36Z

AnneW: Prepare for translation

<languages />
<translate>

{{Info|1=This page contains some useful commands for managing the different Nepomuk processes}}

== Restarting Nepomuk ==
<syntaxhighlight lang="bash">
$ qdbus org.kde.NepomukServer /nepomukserver quit
wait for it to quit
$ nepomukserver
</syntaxhighlight>

== Restarting any service ==
If you need to restart any particular service -

<syntaxhighlight lang="bash">
$ qdbus org.kde.nepomuk.services.$SERVICE /servicecontrol shutdown
wait for it to quit
$ nepomukservicestub $SERVICE
</syntaxhighlight>

Just killing the service won't work, cause the 'nepomukserver' automatically restarts crashed services.

== Useful commands ==
<syntaxhighlight lang="bash">

#This function restarts the Nepomuk server
function nepomuk-restart() {
nepomuk-quit

ps -A | grep nepomukserver --silent
while [ $? -eq 0 ]
do
sleep 0.5
ps -A | grep nepomukserver --silent
done
cd $KDEDIR
echo "Starting Nepomuk Server ..."
nepomukserver
cd $OLDPWD
}

function nepomuk-quit() {
qdbus org.kde.NepomukServer /nepomukserver quit
return $?
}

function nepomuk-service-quit() {
SERVICE=
qdbus org.kde.nepomuk.services.$SERVICE /servicecontrol shutdown
return $?
}
function nepomuk-service-restart() {
SERVICE=
nepomuk-service-quit $SERVICE

ps-nepomuk-fast | grep --silent $SERVICE
while [ $? -eq 0 ]
do
sleep 0.25
ps-nepomuk-fast | grep --silent $SERVICE
done

nepomukservicestub $SERVICE &
}

#
# Useful aliases to control Nepomuk and its services
#
alias nepomuk-indexer-quit='nepomuk-service-quit "nepomukfileindexer"'
alias nepomuk-filewatch-quit='nepomuk-service-quit "nepomukfilewatch"'
alias nepomuk-storage-quit='nepomuk-service-quit "nepomukstorage"'

alias nepomuk-indexer-restart='nepomuk-service-restart "nepomukfileindexer"'
alias nepomuk-filewatch-restart='nepomuk-service-restart "nepomukfilewatch"'
alias nepomuk-storage-restart='nepomuk-service-restart "nepomukstorage"'

alias nepomukcmd="sopranocmd --socket `kde4-config --path socket`nepomuk-socket --model main --nrl"
</syntaxhighlight>

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/Nepomuk2Port

2012-12-14T10:08:31Z

AnneW: Marked this version for translation

<languages />
<translate>

== Maintaining Source Compatibility == 


With KDE 4.9, '''Nepomuk''' moved out out kdelibs into its own repository. KDE libs is required to maintain source compatibility with earlier releases, and therefore we could not just remove the nepomuk components from kdelibs.


A new repository called [https://projects.kde.org/projects/kde/kdelibs/nepomuk-core nepomuk-core] was introduced which contains all the main components of nepomuk. This included vasts parts of kdelibs/nepomuk and kde-runtime/nepomuk. Another repository called [https://projects.kde.org/projects/kde/kdelibs/nepomuk-widgets nepomuk-widgets] has also been introduced for 4.10.

== Porting to Nepomuk2 == 


Nepomuk2 is predominantly just a namespace change from Nepomuk to Nepomuk2. Additionally, the deprecated components of '''Nepomuk''' have been removed. In order to make porting easier, a simple script has been provided -


<syntaxhighlight lang='bash'>
#!/bin/sh
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/Nepomuk::/Nepomuk2::/g'
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/#include <Nepomuk\//#include <Nepomuk2\//'
egrep -lRZ "nepomuk" . | xargs -0 -l sed -i -e 's/#include <nepomuk\//#include <nepomuk2\//'
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/namespace Nepomuk/namespace Nepomuk2/g'
egrep -lRZ "resourceType" . | xargs -0 -l sed -i -e 's/\.resourceType/\.type/g'
egrep -lRZ "resourceUri" . | xargs -0 -l sed -i -e 's/\.resourceUri/\.uri/g'
egrep -lRZ "NEPOMUK_INCLUDE_DIR" . | xargs -0 -l sed -i -e 's/NEPOMUK_INCLUDE_DIR/NEPOMUK_CORE_INCLUDE_DIR/g'
egrep -lRZ "NEPOMUK_LIBRARIES" . | xargs -0 -l sed -i -e 's/NEPOMUK_LIBRARIES/NEPOMUK_CORE_LIBRARY/g'
egrep -lRZ "NEPOMUK_QUERY_LIBRARIES" . | xargs -0 -l sed -i -e 's/${NEPOMUK_QUERY_LIBRARIES}//g'
</syntaxhighlight>


This script should cover all the source code changes, and most of the cmake changes.

== CMake Changes == 


Depending on whether you require the GUI components you'll require the following includes


<syntaxhighlight lang="cmake">
find_package(NepomukCore)
find_package(NepomukWidgets)
</syntaxhighlight>


With NepomukCore, the following CMake variables are declared -


<syntaxhighlight lang='cmake'>
#
# NEPOMUK_CORE_LIB_DIR : The nepomuk-core library directory
# NEPOMUK_CORE_INCLUDE_DIR : The nepomuk-core include directory
# NEPOMUK_CORE_VERSION : The nepomuk-core version
# NEPOMUK_CORE_ONTOLOGY_DIR : The nepomuk-core ontologies location
# NEPOMUK_CORE_DBUS_INTERFACES_DIR : The nepomuk-core DBUS Interfaces dir
# NEPOMUK_CORE_LIBRARY : The nepomukcore library
#
</syntaxhighlight>


With NepomukWidgets, the following CMake variables are declared -


<syntaxhighlight lang="cmake">
#
# NEPOMUK_WIDGETS_LIB_DIR : The nepomuk-widgets library directory
# NEPOMUK_WIDGETS_INCLUDE_DIR : The nepomuk-widgets include directory
# NEPOMUK_WIDGETS_VERSION : The nepomuk-widgets version
# NEPOMUK_WIDGETS_LIBRARY : The nepomuk-widgets library
#
</syntaxhighlight>


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/Nepomuk2Port

2012-12-14T10:08:23Z

AnneW:

<languages />
<translate>

== Maintaining Source Compatibility ==

With KDE 4.9, '''Nepomuk''' moved out out kdelibs into its own repository. KDE libs is required to maintain source compatibility with earlier releases, and therefore we could not just remove the nepomuk components from kdelibs.

A new repository called [https://projects.kde.org/projects/kde/kdelibs/nepomuk-core nepomuk-core] was introduced which contains all the main components of nepomuk. This included vasts parts of kdelibs/nepomuk and kde-runtime/nepomuk. Another repository called [https://projects.kde.org/projects/kde/kdelibs/nepomuk-widgets nepomuk-widgets] has also been introduced for 4.10.

== Porting to Nepomuk2 ==

Nepomuk2 is predominantly just a namespace change from Nepomuk to Nepomuk2. Additionally, the deprecated components of '''Nepomuk''' have been removed. In order to make porting easier, a simple script has been provided -

<syntaxhighlight lang='bash'>
#!/bin/sh
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/Nepomuk::/Nepomuk2::/g'
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/#include <Nepomuk\//#include <Nepomuk2\//'
egrep -lRZ "nepomuk" . | xargs -0 -l sed -i -e 's/#include <nepomuk\//#include <nepomuk2\//'
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/namespace Nepomuk/namespace Nepomuk2/g'
egrep -lRZ "resourceType" . | xargs -0 -l sed -i -e 's/\.resourceType/\.type/g'
egrep -lRZ "resourceUri" . | xargs -0 -l sed -i -e 's/\.resourceUri/\.uri/g'
egrep -lRZ "NEPOMUK_INCLUDE_DIR" . | xargs -0 -l sed -i -e 's/NEPOMUK_INCLUDE_DIR/NEPOMUK_CORE_INCLUDE_DIR/g'
egrep -lRZ "NEPOMUK_LIBRARIES" . | xargs -0 -l sed -i -e 's/NEPOMUK_LIBRARIES/NEPOMUK_CORE_LIBRARY/g'
egrep -lRZ "NEPOMUK_QUERY_LIBRARIES" . | xargs -0 -l sed -i -e 's/${NEPOMUK_QUERY_LIBRARIES}//g'
</syntaxhighlight>

This script should cover all the source code changes, and most of the cmake changes.

== CMake Changes ==

Depending on whether you require the GUI components you'll require the following includes

<syntaxhighlight lang="cmake">
find_package(NepomukCore)
find_package(NepomukWidgets)
</syntaxhighlight>

With NepomukCore, the following CMake variables are declared -

<syntaxhighlight lang='cmake'>
#
# NEPOMUK_CORE_LIB_DIR : The nepomuk-core library directory
# NEPOMUK_CORE_INCLUDE_DIR : The nepomuk-core include directory
# NEPOMUK_CORE_VERSION : The nepomuk-core version
# NEPOMUK_CORE_ONTOLOGY_DIR : The nepomuk-core ontologies location
# NEPOMUK_CORE_DBUS_INTERFACES_DIR : The nepomuk-core DBUS Interfaces dir
# NEPOMUK_CORE_LIBRARY : The nepomukcore library
#
</syntaxhighlight>

With NepomukWidgets, the following CMake variables are declared -

<syntaxhighlight lang="cmake">
#
# NEPOMUK_WIDGETS_LIB_DIR : The nepomuk-widgets library directory
# NEPOMUK_WIDGETS_INCLUDE_DIR : The nepomuk-widgets include directory
# NEPOMUK_WIDGETS_VERSION : The nepomuk-widgets version
# NEPOMUK_WIDGETS_LIBRARY : The nepomuk-widgets library
#
</syntaxhighlight>

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/Nepomuk2Port

2012-12-14T10:08:00Z

AnneW: Prepare for translation

<languages />
<translate>

== Maintaining Source Compatibility ===

With KDE 4.9, '''Nepomuk''' moved out out kdelibs into its own repository. KDE libs is required to maintain source compatibility with earlier releases, and therefore we could not just remove the nepomuk components from kdelibs.

A new repository called [https://projects.kde.org/projects/kde/kdelibs/nepomuk-core nepomuk-core] was introduced which contains all the main components of nepomuk. This included vasts parts of kdelibs/nepomuk and kde-runtime/nepomuk. Another repository called [https://projects.kde.org/projects/kde/kdelibs/nepomuk-widgets nepomuk-widgets] has also been introduced for 4.10.

== Porting to Nepomuk2 ==

Nepomuk2 is predominantly just a namespace change from Nepomuk to Nepomuk2. Additionally, the deprecated components of '''Nepomuk''' have been removed. In order to make porting easier, a simple script has been provided -

<syntaxhighlight lang='bash'>
#!/bin/sh
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/Nepomuk::/Nepomuk2::/g'
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/#include <Nepomuk\//#include <Nepomuk2\//'
egrep -lRZ "nepomuk" . | xargs -0 -l sed -i -e 's/#include <nepomuk\//#include <nepomuk2\//'
egrep -lRZ "Nepomuk" . | xargs -0 -l sed -i -e 's/namespace Nepomuk/namespace Nepomuk2/g'
egrep -lRZ "resourceType" . | xargs -0 -l sed -i -e 's/\.resourceType/\.type/g'
egrep -lRZ "resourceUri" . | xargs -0 -l sed -i -e 's/\.resourceUri/\.uri/g'
egrep -lRZ "NEPOMUK_INCLUDE_DIR" . | xargs -0 -l sed -i -e 's/NEPOMUK_INCLUDE_DIR/NEPOMUK_CORE_INCLUDE_DIR/g'
egrep -lRZ "NEPOMUK_LIBRARIES" . | xargs -0 -l sed -i -e 's/NEPOMUK_LIBRARIES/NEPOMUK_CORE_LIBRARY/g'
egrep -lRZ "NEPOMUK_QUERY_LIBRARIES" . | xargs -0 -l sed -i -e 's/${NEPOMUK_QUERY_LIBRARIES}//g'
</syntaxhighlight>

This script should cover all the source code changes, and most of the cmake changes.

== CMake Changes ==

Depending on whether you require the GUI components you'll require the following includes

<syntaxhighlight lang="cmake">
find_package(NepomukCore)
find_package(NepomukWidgets)
</syntaxhighlight>

With NepomukCore, the following CMake variables are declared -

<syntaxhighlight lang='cmake'>
#
# NEPOMUK_CORE_LIB_DIR : The nepomuk-core library directory
# NEPOMUK_CORE_INCLUDE_DIR : The nepomuk-core include directory
# NEPOMUK_CORE_VERSION : The nepomuk-core version
# NEPOMUK_CORE_ONTOLOGY_DIR : The nepomuk-core ontologies location
# NEPOMUK_CORE_DBUS_INTERFACES_DIR : The nepomuk-core DBUS Interfaces dir
# NEPOMUK_CORE_LIBRARY : The nepomukcore library
#
</syntaxhighlight>

With NepomukWidgets, the following CMake variables are declared -

<syntaxhighlight lang="cmake">
#
# NEPOMUK_WIDGETS_LIB_DIR : The nepomuk-widgets library directory
# NEPOMUK_WIDGETS_INCLUDE_DIR : The nepomuk-widgets include directory
# NEPOMUK_WIDGETS_VERSION : The nepomuk-widgets version
# NEPOMUK_WIDGETS_LIBRARY : The nepomuk-widgets library
#
</syntaxhighlight>

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Http://techbase.kde.org/Projects/Nepomuk/OntologyExtension

2012-12-14T10:04:40Z

AnneW: Marked this version for translation

Http://techbase.kde.org/Projects/Nepomuk/OntologyExtension

2012-12-14T10:04:29Z

AnneW: Prepare for translation

<languages />
<translate>

== Introducing Ontologies ==

The [http://oscaf.sourceforge.net/ Shared Desktop Ontologies] were written with a very broad purpose in mind. That being said, they are still cases that are often not covered by it. In that case there are two possible options for extending the ontologies

== Contributing to SDO ==

The Shared Desktop Ontologies project follows a strict review policy. In order for any changes to be made, a [http://sourceforge.net/apps/trac/oscaf/newticket new ticket] must first be filed stating the changes that you wish to be made, and the rationale behind them.

Here is a [http://sourceforge.net/apps/trac/oscaf/report/1 list] of all the currently open tickets.

Most discussions happen in the [https://mail.kde.org/mailman/listinfo/nepomuk nepomuk mailing list]. Feel free to email us about any changes.

== Creating a custom ontology ==

Most of the ontologies are written in the [http://www4.wiwiss.fu-berlin.de/bizer/trig/ trig syntax].

In order to install an ontology, the follow files are required -

* <tt>ontology-name.trig</tt> The TriG file containing the ontology
* <tt>ontology-name.ontology.in</tt> A file describing the ontology

In order to ease the process of creating custom ontologies a template ontology is provided in [http://quickgit.kde.org/index.php?p=kdeexamples.git&a=tree&h=44b1d8b2b6d2d140437ca03102fa56279232227b&hb=80a322af2bc5975c01c704173e937ccb8df605e3&f=nepomuk%2Fontology kdeexamples/nepomuk/ontology]

=== Ontology C++ files ===

In order to easily access the ontology in your code. It is recommended to generate ontology headers. This can be done using some cmake magic provided by '''Soprano'''.

<syntaxhighlight lang=cmake>
include(SopranoAddOntology)

# Generating headers for the nie ontology
soprano_add_ontology(SRCS "${SHAREDDESKTOPONTOLOGIES_ROOT_DIR}/nie/nie.trig" "NIE" "Nepomuk2::Vocabulary" "trig")
</syntaxhighlight>

The Nepomuk-Core repository already provides ontology headers for the most commonly used ontologies.

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/VirtuosoInternal

2012-12-13T16:34:55Z

AnneW: Marked this version for translation

<languages />
<translate>

== Connecting directly to virtuoso == 


Virtuoso ships with an executable called <tt>isql-vt</tt>. Just running that executable should connect you to virtuoso.


If you distribution does not provide the corresponding executable or if it doesn't work for you. Try this script -
<syntaxhighlight lang="bash">
#!/bin/bash
filename=`ps aux | grep virtuoso-t | grep -v grep | sed -e 's/.*\/tmp\///;s/ini.*/ini/'`
port=$(grep ServerPort /tmp/$filename | sed -e 's/.*=//')
exec isql-vt -S $port
</syntaxhighlight>

== Running queries directly == 


If for some reason you want to run queries directly on virtuoso, you'll need to connect to virtuoso via <tt>isql-vt</tt> and then type in the query. From 4.10, we use virtuoso's inbuilt prefix expansion, so you don't need to care about the prefixes.

=== Example === 


<syntaxhighlight lang="sql">
SQL> sparql select ?r ?name where { ?r nco:fullname ?name . };
</syntaxhighlight>

== List of tables == 


Virtuoso internally uses a relational database to store the triples. It contains the following tables -


* DB.DBA.RDF_QUAD -- The main table which contains all the statements. It contains four rows "S", "P", "O" and "G" for the subject, predicate, object and graph.
* DB.DBA.RDF_IRI
* DB.DBA.RDF_DATATYPE - Contains all the literal data types which are stored.
* DB.DBA.RDF_PREFIX
* DB.DBA.RDF_OBJ
* DB.DBA.RDF_LANGUAGE


Read http://docs.openlinksw.com/virtuoso/rdfdatarepresentation.html to properly understand how virtuoso stores the data internally.


Virtuoso has 2 main types - IRI_ID, which is the data type of the graph, subject and predicate. IRI_ID are of the form "#i25". In order to convert an integer to an IRI_ID, use the '''iri_id_from_num( int )''' function, and the '''iri_id_num( iri_id )''' to convert an IRI_ID to an integer. In order to convert an IRI_ID to its string representation use the following functions '''id_to_iri( iri_id, int )''', and '''iri_to_id( string, int )'''. The second integer option should be 0, unless you want the iri/id to be created if it doesn't exist.

== Default Indexes == 

== Common Commands == 


Apart from directly running SQL and SPARQL queries, virtuoso also provides some additional commands, which are listed over here.

=== status === 
The [http://docs.openlinksw.com/virtuoso/fn_status.html status()] function can be used to return the current running queries on virtuoso.

=== sparql_to_sql_text === 


The [http://docs.openlinksw.com/virtuoso/fn_sparql_to_sql_text.html sparql_to_sql_text()] function can be used to convert a SPARQL query directly to the SQL it would be executed as.


<syntaxhighlight lang="sql">
varchar sparql_to_sql_text
( in squery varchar );
</syntaxhighlight>


Example -
<syntaxhighlight lang="sql">
SQL> select sparql_to_sql_text('prefix nco: <http://www.semanticdesktop.org/ontologies/2007/03/22/nco#> select ?r ?name where { ?r nco:fullname ?name . }');
SPARQL_TO_SQL_TEXT
VARCHAR
_______________________________________________________________________________


SELECT __id2i ( "s_1_0-t0"."S" ) AS "r",
__ro2sq ( "s_1_0-t0"."O" ) AS "name"
FROM DB.DBA.RDF_QUAD AS "s_1_0-t0"
WHERE "s_1_0-t0"."P" = __i2idn ( __bft( 'http://www.semanticdesktop.org/ontologies/2007/03/22/nco#fullname' , 1))
OPTION (QUIETCAST)


1 Rows. -- 1 msec.
</syntaxhighlight>


It's very useful in debugging why many sparql queries are taking so long.


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/VirtuosoInternal

2012-12-13T16:34:45Z

AnneW: Prepare for translation

<languages />
<translate>

== Connecting directly to virtuoso ==

Virtuoso ships with an executable called <tt>isql-vt</tt>. Just running that executable should connect you to virtuoso.

If you distribution does not provide the corresponding executable or if it doesn't work for you. Try this script -
<syntaxhighlight lang="bash">
#!/bin/bash
filename=`ps aux | grep virtuoso-t | grep -v grep | sed -e 's/.*\/tmp\///;s/ini.*/ini/'`
port=$(grep ServerPort /tmp/$filename | sed -e 's/.*=//')
exec isql-vt -S $port
</syntaxhighlight>

== Running queries directly ==

If for some reason you want to run queries directly on virtuoso, you'll need to connect to virtuoso via <tt>isql-vt</tt> and then type in the query. From 4.10, we use virtuoso's inbuilt prefix expansion, so you don't need to care about the prefixes.

=== Example ===

<syntaxhighlight lang="sql">
SQL> sparql select ?r ?name where { ?r nco:fullname ?name . };
</syntaxhighlight>

== List of tables ==

Virtuoso internally uses a relational database to store the triples. It contains the following tables -

* DB.DBA.RDF_QUAD -- The main table which contains all the statements. It contains four rows "S", "P", "O" and "G" for the subject, predicate, object and graph.
* DB.DBA.RDF_IRI
* DB.DBA.RDF_DATATYPE - Contains all the literal data types which are stored.
* DB.DBA.RDF_PREFIX
* DB.DBA.RDF_OBJ
* DB.DBA.RDF_LANGUAGE

Read http://docs.openlinksw.com/virtuoso/rdfdatarepresentation.html to properly understand how virtuoso stores the data internally.

Virtuoso has 2 main types - IRI_ID, which is the data type of the graph, subject and predicate. IRI_ID are of the form "#i25". In order to convert an integer to an IRI_ID, use the '''iri_id_from_num( int )''' function, and the '''iri_id_num( iri_id )''' to convert an IRI_ID to an integer. In order to convert an IRI_ID to its string representation use the following functions '''id_to_iri( iri_id, int )''', and '''iri_to_id( string, int )'''. The second integer option should be 0, unless you want the iri/id to be created if it doesn't exist.

== Default Indexes ==

== Common Commands ==

Apart from directly running SQL and SPARQL queries, virtuoso also provides some additional commands, which are listed over here.

=== status ===
The [http://docs.openlinksw.com/virtuoso/fn_status.html status()] function can be used to return the current running queries on virtuoso.

=== sparql_to_sql_text ===

The [http://docs.openlinksw.com/virtuoso/fn_sparql_to_sql_text.html sparql_to_sql_text()] function can be used to convert a SPARQL query directly to the SQL it would be executed as.

<syntaxhighlight lang="sql">
varchar sparql_to_sql_text
( in squery varchar );
</syntaxhighlight>

Example -
<syntaxhighlight lang="sql">
SQL> select sparql_to_sql_text('prefix nco: <http://www.semanticdesktop.org/ontologies/2007/03/22/nco#> select ?r ?name where { ?r nco:fullname ?name . }');
SPARQL_TO_SQL_TEXT
VARCHAR
_______________________________________________________________________________

SELECT __id2i ( "s_1_0-t0"."S" ) AS "r",
__ro2sq ( "s_1_0-t0"."O" ) AS "name"
FROM DB.DBA.RDF_QUAD AS "s_1_0-t0"
WHERE "s_1_0-t0"."P" = __i2idn ( __bft( 'http://www.semanticdesktop.org/ontologies/2007/03/22/nco#fullname' , 1))
OPTION (QUIETCAST)

1 Rows. -- 1 msec.
</syntaxhighlight>

It's very useful in debugging why many sparql queries are taking so long.

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/GraphConcepts

2012-12-13T16:29:35Z

AnneW: Marked this version for translation

<languages />
<translate>

== The Semantic Web - with quadruples == 


'''Nepomuk''' is based on the Semantic Web, and even though the Semantic Web is largely advertised as a triple store, Nepomuk is NOT a triple store. We in fact store quadruples -> <tt>Subject - Predicate - Object - Graph</tt>. The <tt>Graph</tt> part of these quadruples is always automatically managed by Nepomuk. Clients rarely (if ever) need to care about the graph.


However, if you still want to know why they are present. Read on.


The <tt>graph</tt> is also called the context of the statement. It is used to store some information about each triple

== Graph Naming == 


Every graph in '''Nepomuk''' is given a unique uri which is of the form <tt>nepomuk:/ctx/uuid</tt>. The <tt>ctx</tt> over here is an abbreviation for context.

== Graph Creation == 


The first obvious question is - When are graphs created? Is everything just added into one big graph?


'''Nepomuk''' works by creating new graphs for each atomic operation. These operations are the ones defined by the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/datamanagement_8h.html DataManagement functions] -


* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#gafb8a64e1fb9e8339ff87be1b7a370a57 addProperty]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#gaa86c603d624d55703b0e41bbec77d2ec setProperty]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#gad731308a74b75a1a2bb20b1676eda2ed createResource]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#gac094511c6157fb1f96f3a3344d48128d storeResources]


Each time any of these operations is called and new data is being pushed, a new graph with the current date time is created.

== Graph contents == 


Graphs in '''Nepomuk''' store the following information -


* Graph Type
* Creation Date
* Modification Date
* Graph Maintainer


Example -
<syntaxhighlight lang="text">
<nepomuk:/ctx/c4d93812-7d8c-4c8f-b8a7-e1d4dbc5fed5>
rdf:type nrl:InstanceBase
nao:created 2011-07-30T11:34:19.587Z
nao:modified 2011-07-30T11:34:19.587Z
nao:maintainedBy nepomuk:/res/e2eb2efb-14ee-4038-ac24-698f916289b0
</syntaxhighlight>


The <tt>nao:created</tt> and <tt>nao:lastModified</tt> properties are identical to those used in resources. Except for the fact that graphs are generally never modified. They are only created or destroyed.

=== Graph Type === 


Each graph has a type which depends on the type of data it holds. The 3 most commonly used types are -
* <tt>nrl:Ontology</tt> - Used to hold ontology data.
* <tt>nrl:InstanceBase</tt> - Used for normal data
* <tt>nrl:DiscardableInstanceBase</tt> - Used for data which can be reproduced and should not be backed up. This type is generally reserved for data created during indexing of files.

=== Agents === 


Each graph contains a property called <tt>nao:maintainedBy</tt> which specifies which application created that data -


<syntaxhighlight lang="text">
<nepomuk:/ctx/c4d93812-7d8c-4c8f-b8a7-e1d4dbc5fed5>
rdf:type nrl:DiscardableInstanceBase
nao:created 2011-07-30T11:34:19.587Z
nao:modified 2011-07-30T11:34:19.587Z
nao:maintainedBy nepomuk:/res/e2eb2efb-14ee-4038-ac24-698f916289b0


<nepomuk:/res/e2eb2efb-14ee-4038-ac24-698f916289b0>
rdf:type nao:Agent
rdf:type rdfs:Resource
nao:identifier nepomukindexer
</syntaxhighlight>


Each application is represented as a <tt>nao:Agent</tt> with the application name specified as the nao:identifier. This name is automatically determined via <tt>KComponentData</tt> and can be spoofed. Security was not one of our concerns.


Each triple may be maintained by a number of different applications. This information is valuable for the advanced DataManagement functions such as [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#ga0fbf22be4b581afd0b5bcd1f203e934f <tt>removeDataByApplication</tt>].


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/GraphConcepts

2012-12-13T16:29:24Z

AnneW: Prepare for translation

<languages />
<translate>

== The Semantic Web - with quadruples ==

'''Nepomuk''' is based on the Semantic Web, and even though the Semantic Web is largely advertised as a triple store, Nepomuk is NOT a triple store. We in fact store quadruples -> <tt>Subject - Predicate - Object - Graph</tt>. The <tt>Graph</tt> part of these quadruples is always automatically managed by Nepomuk. Clients rarely (if ever) need to care about the graph.

However, if you still want to know why they are present. Read on.

The <tt>graph</tt> is also called the context of the statement. It is used to store some information about each triple

== Graph Naming ==

Every graph in '''Nepomuk''' is given a unique uri which is of the form <tt>nepomuk:/ctx/uuid</tt>. The <tt>ctx</tt> over here is an abbreviation for context.

== Graph Creation ==

The first obvious question is - When are graphs created? Is everything just added into one big graph?

'''Nepomuk''' works by creating new graphs for each atomic operation. These operations are the ones defined by the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/datamanagement_8h.html DataManagement functions] -

* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#gafb8a64e1fb9e8339ff87be1b7a370a57 addProperty]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#gaa86c603d624d55703b0e41bbec77d2ec setProperty]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#gad731308a74b75a1a2bb20b1676eda2ed createResource]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#gac094511c6157fb1f96f3a3344d48128d storeResources]

Each time any of these operations is called and new data is being pushed, a new graph with the current date time is created.

== Graph contents ==

Graphs in '''Nepomuk''' store the following information -

* Graph Type
* Creation Date
* Modification Date
* Graph Maintainer

Example -
<syntaxhighlight lang="text">
<nepomuk:/ctx/c4d93812-7d8c-4c8f-b8a7-e1d4dbc5fed5>
rdf:type nrl:InstanceBase
nao:created 2011-07-30T11:34:19.587Z
nao:modified 2011-07-30T11:34:19.587Z
nao:maintainedBy nepomuk:/res/e2eb2efb-14ee-4038-ac24-698f916289b0
</syntaxhighlight>

The <tt>nao:created</tt> and <tt>nao:lastModified</tt> properties are identical to those used in resources. Except for the fact that graphs are generally never modified. They are only created or destroyed.

=== Graph Type ===

Each graph has a type which depends on the type of data it holds. The 3 most commonly used types are -
* <tt>nrl:Ontology</tt> - Used to hold ontology data.
* <tt>nrl:InstanceBase</tt> - Used for normal data
* <tt>nrl:DiscardableInstanceBase</tt> - Used for data which can be reproduced and should not be backed up. This type is generally reserved for data created during indexing of files.

=== Agents ===

Each graph contains a property called <tt>nao:maintainedBy</tt> which specifies which application created that data -

<syntaxhighlight lang="text">
<nepomuk:/ctx/c4d93812-7d8c-4c8f-b8a7-e1d4dbc5fed5>
rdf:type nrl:DiscardableInstanceBase
nao:created 2011-07-30T11:34:19.587Z
nao:modified 2011-07-30T11:34:19.587Z
nao:maintainedBy nepomuk:/res/e2eb2efb-14ee-4038-ac24-698f916289b0

<nepomuk:/res/e2eb2efb-14ee-4038-ac24-698f916289b0>
rdf:type nao:Agent
rdf:type rdfs:Resource
nao:identifier nepomukindexer
</syntaxhighlight>

Each application is represented as a <tt>nao:Agent</tt> with the application name specified as the nao:identifier. This name is automatically determined via <tt>KComponentData</tt> and can be spoofed. Security was not one of our concerns.

Each triple may be maintained by a number of different applications. This information is valuable for the advanced DataManagement functions such as [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#ga0fbf22be4b581afd0b5bcd1f203e934f <tt>removeDataByApplication</tt>].

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Thread:Talk:Projects/Nepomuk/GraphConcepts/Security was not one of our concerns

2012-12-13T16:28:45Z

AnneW: New thread: Security was not one of our concerns

Maybe you could explain why you thought this unnecessary?

Talk:Projects/Nepomuk/GraphConcepts

2012-12-13T16:28:45Z

AnneW: Talk page autocreated when first thread was posted

Projects/Nepomuk/kioslaves

2012-12-13T16:19:29Z

AnneW: Marked this version for translation

<languages />
<translate>

== Introducing kioslaves == 
'''Nepomuk''' provides a number of kioslaves in order to integrate better with KDE.


'''Relevant Code:''' kde-runtime/nepomuk/kioslaves/

== NepomukSearch == 


The NepomukSearch kio-slave is the most prominent kio-slave. It's main job is to answer search queries.

== Nepomuk == 
The Nepomuk KIO slave is responsible for the <tt>nepomuk</tt> protocol, and is a simple forwarding slave. It's main purpose is to analyze the relevant resource and either return the resource (if possible) or construct a query, and forward it to the nepomuksearch kio slave.

== Timeline == 


The timeline KIO slave shows file which have been modified in a specific date range.


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/kioslaves

2012-12-13T16:19:21Z

AnneW: Prepare for translation

<languages />
<translate>

== Introducing kioslaves ==
'''Nepomuk''' provides a number of kioslaves in order to integrate better with KDE.

'''Relevant Code:''' kde-runtime/nepomuk/kioslaves/

== NepomukSearch ==

The NepomukSearch kio-slave is the most prominent kio-slave. It's main job is to answer search queries.

== Nepomuk ==
The Nepomuk KIO slave is responsible for the <tt>nepomuk</tt> protocol, and is a simple forwarding slave. It's main purpose is to analyze the relevant resource and either return the resource (if possible) or construct a query, and forward it to the nepomuksearch kio slave.

== Timeline ==

The timeline KIO slave shows file which have been modified in a specific date range.

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/ComponentOverview

2012-12-13T16:07:26Z

AnneW: Marked this version for translation

<languages />
<translate>

== Introducing Technical Terms == 


The '''Nepomuk''' world uses some jargon which may be slightly intimidating to new comers. This page attempts to list down the commonly used '''Nepomuk''' development terms, and what they mean.

=== Nepomuk === 


'''Nepomuk''' is actually an abbreviation for a very long and obtuse name. That however, does not really matter.


'''Nepomuk''' is the underlying semantic technology that is used by KDE. It provides an API for software developers, and provides all the glue to index all of the file metadata. Whenever anyone is talking about using "semantic" technologies in KDE, they generally mean '''Nepomuk'''.


It is the top-most component of the entire ''Semantic Stack''.

=== Soprano === 


Soprano is a Qt abstraction over databases. It provides a friendly Qt-based API for accessing different RDF stores. It currently supports 3 database backends - Sesame, Redland and Virtuoso. The KDE Semantic Stack only works with Virtuoso. Soprano also provides additional features such as serializing, parsing rdf data, and a client server architecture that is heavily used in '''Nepomuk'''.

=== Virtuoso === 


'''Virtuoso''' is the only supported RDF database in KDE. It's a very powerful database that powers massive projects such as dbpedia. It is currently controlled by OpenLink, and is available under commercial and an open source license.


Internally, virtuoso may be looked at as a relational database, with some added RDF features.

=== Strigi === 


The Strigi project is divided into 5 sub-projects, and can be used for a full file indexing framework. However, KDE only uses some parts of it. '''Nepomuk''' uses the libstreams and libstream analyzer to pass it the filecontents. In returns it gives metadata about the file, which '''Nepomuk''' reads and then pushes into virtuoso.

== Nepomuk Components == 


[[File:NepomukSimpleArchitecture.png]]


'''Nepomuk''' has been split into a number of components for stability reasons. Many of these components communicate with each other, using a combination of dbus and local sockets.

=== Nepomuk Server === 


The Nepomuk server is the central process that is responsible for spawning and controlling all other nepomuk processes. In reality it is not a server since none the Nepomuk components actual connect to it, or try to communicate with it.


On starting up, it checks if Nepomuk is enabled, and accordingly, either kills itself, or starts spawning the other nepomuk processes. All other nepomuk processes go by the name of 'nepomukservicestub'.

=== Nepomuk Service Stub === 


The <tt>nepomukservicestub</tt> is a generic process that is used to run any of the Nepomuk services. It reads the nepomuk service name as an argument, and loads the plugin for that service.


<syntaxhighlight lang="bash">
$ nepomukservicestub "nepomukfileindexer"
$ nepomukservicestub "nepomukwatch"
</syntaxhighlight>

=== Nepomuk Storage Service === 


The Storage Service is the central nepomuk service, on which all other services depend. This service is responsible for launching virtuoso, monitoring the ontologies. Recently the Nepomuk Query Service was merged into the storage service for performance reasons. So, now the storage service is also responsible for running queries.


The Storage service also acts as a hard dependency for all other services. These services communicate with the storage service either via dbus or via a local socket.


'''Relevant Code:''' nepomuk-core/services/storage

=== Nepomuk File Watch Service === 


The File Watch service is responsible for hooking up to the kernel and listening for file move, deletion, and creation events. On receiving any of these events, it updates the metadata present in virtuoso. It is also responsible for calling the file indexer service to index new files.


'''Relevant Code:''' nepomuk-core/services/filewatch/

=== Nepomuk File Indexing Service === 


The File Indexing service is responsible for indexing all the files. It relies on a helper process called <tt>nepomukindexer</tt> which actually performs the indexing and pushing to '''Nepomuk'''. This service merely schedules the indexing, and decides which files should be indexed.


'''Relevant Code:''' nepomuk-core/services/fileindexer

=== Ontologies === 


Relational databases have database schemas which are fixed. RDF databases instead use ontologies which are less static. They define how the data should be stored in the database. The ontologies are provided by Shared Desktop Ontologies package, that is also maintained by the Nepomuk developers.


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/ComponentOverview

2012-12-13T16:07:12Z

AnneW: Prepare for translation

<languages />
<translate>

== Introducing Technical Terms ==

The '''Nepomuk''' world uses some jargon which may be slightly intimidating to new comers. This page attempts to list down the commonly used '''Nepomuk''' development terms, and what they mean.

=== Nepomuk ===

'''Nepomuk''' is actually an abbreviation for a very long and obtuse name. That however, does not really matter.

'''Nepomuk''' is the underlying semantic technology that is used by KDE. It provides an API for software developers, and provides all the glue to index all of the file metadata. Whenever anyone is talking about using "semantic" technologies in KDE, they generally mean '''Nepomuk'''.

It is the top-most component of the entire ''Semantic Stack''.

=== Soprano ===

Soprano is a Qt abstraction over databases. It provides a friendly Qt-based API for accessing different RDF stores. It currently supports 3 database backends - Sesame, Redland and Virtuoso. The KDE Semantic Stack only works with Virtuoso. Soprano also provides additional features such as serializing, parsing rdf data, and a client server architecture that is heavily used in '''Nepomuk'''.

=== Virtuoso ===

'''Virtuoso''' is the only supported RDF database in KDE. It's a very powerful database that powers massive projects such as dbpedia. It is currently controlled by OpenLink, and is available under commercial and an open source license.

Internally, virtuoso may be looked at as a relational database, with some added RDF features.

=== Strigi ===

The Strigi project is divided into 5 sub-projects, and can be used for a full file indexing framework. However, KDE only uses some parts of it. '''Nepomuk''' uses the libstreams and libstream analyzer to pass it the filecontents. In returns it gives metadata about the file, which '''Nepomuk''' reads and then pushes into virtuoso.

== Nepomuk Components ==

[[File:NepomukSimpleArchitecture.png]]

'''Nepomuk''' has been split into a number of components for stability reasons. Many of these components communicate with each other, using a combination of dbus and local sockets.

=== Nepomuk Server ===

The Nepomuk server is the central process that is responsible for spawning and controlling all other nepomuk processes. In reality it is not a server since none the Nepomuk components actual connect to it, or try to communicate with it.

On starting up, it checks if Nepomuk is enabled, and accordingly, either kills itself, or starts spawning the other nepomuk processes. All other nepomuk processes go by the name of 'nepomukservicestub'.

=== Nepomuk Service Stub ===

The <tt>nepomukservicestub</tt> is a generic process that is used to run any of the Nepomuk services. It reads the nepomuk service name as an argument, and loads the plugin for that service.

<syntaxhighlight lang="bash">
$ nepomukservicestub "nepomukfileindexer"
$ nepomukservicestub "nepomukwatch"
</syntaxhighlight>

=== Nepomuk Storage Service ===

The Storage Service is the central nepomuk service, on which all other services depend. This service is responsible for launching virtuoso, monitoring the ontologies. Recently the Nepomuk Query Service was merged into the storage service for performance reasons. So, now the storage service is also responsible for running queries.

The Storage service also acts as a hard dependency for all other services. These services communicate with the storage service either via dbus or via a local socket.

'''Relevant Code:''' nepomuk-core/services/storage

=== Nepomuk File Watch Service ===

The File Watch service is responsible for hooking up to the kernel and listening for file move, deletion, and creation events. On receiving any of these events, it updates the metadata present in virtuoso. It is also responsible for calling the file indexer service to index new files.

'''Relevant Code:''' nepomuk-core/services/filewatch/

=== Nepomuk File Indexing Service ===

The File Indexing service is responsible for indexing all the files. It relies on a helper process called <tt>nepomukindexer</tt> which actually performs the indexing and pushing to '''Nepomuk'''. This service merely schedules the indexing, and decides which files should be indexed.

'''Relevant Code:''' nepomuk-core/services/fileindexer

=== Ontologies ===

Relational databases have database schemas which are fixed. RDF databases instead use ontologies which are less static. They define how the data should be stored in the database. The ontologies are provided by Shared Desktop Ontologies package, that is also maintained by the Nepomuk developers.

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/Repositories

2012-12-12T14:01:38Z

AnneW: Marked this version for translation

<languages />
<translate>

== Nepomuk Repositories == 


The '''Nepomuk''' development is split across many different repositories across KDE. The page attempts to list out most of the known Nepomuk code, and its development location. The list has been split according to importance.

== Main Repositories == 


These are the official repositories which the core Nepomuk team focuses on.

=== NepomukCore === 


NepomukCore, which is the main repository for Nepomuk development, was released with KDE 4.9. It is a combination of both the Nepomuk libraries present in kdelibs, and certain run time components present in kde-runtime.


All Nepomuk enabled applications must depend on NepomukCore. It utilizes the Nepomuk2 namespace.


* '''Repository:''' [https://projects.kde.org/projects/kde/kdelibs/nepomuk-core kde:nepomuk-core]
* '''Category:''' Core
* '''Activity:''' High
* '''Developers:''' Sebastian Trueg <trueg@kde.org>, Vishesh Handa <me@vhanda.in>

=== NepomukWidgets === 


NepomukWidget, is the repository which contains all the widgets which applications use. It will be released with KDE 4.10. Before this the widgets were present in kdelibs/nepomuk.


* '''Repository:''' [https://projects.kde.org/projects/kde/kdelibs/nepomuk-widgets kde:nepomuk-widgets]
* '''Category:''' User Interface
* '''Activity:''' High
* '''Developers:''' Sebastian Trueg <trueg@kde.org>, Vishesh Handa <me@vhanda.in>

=== KIO slaves === 


Nepomuk currently consists of 3 kio-slaves - nepomuk, nepomuksearch, and timeline. Out of these 3, nepomuksearch and timeline are the most visible. The nepomuk kioslave is an internal kioslave which redirects to the physical location or to the nepomuksearch kioslave. For a more in depth discussion of their working, please read [[Projects/Nepomuk/kioslaves| this]].


'''Repository:''' kde-runtime/nepomuk/kioslaves

=== KCM === 


Nepomuk consists of 2 main user visible components. The Nepomuk KCM and the controller, which is uses to pause/resume indexing. The plan is to eventually move these out of kde-runtime, but that will probably only happen with KDE Frameworks 5.


'''Repository:''' kde-runtime/nepomuk/kcm

=== Nepomuk Shell === 


Nepomuk consists of a development tool called 'nepomukshell' which can be used to browse the Nepomuk database, and to run SPARQL queries. It has served as a simple starting ground for people wishing to contribute to Nepomuk.


* '''Repository:''' [https://projects.kde.org/projects/extragear/utils/nepomukshell/ kde:nepomukshell]
* '''Category:''' Development Tools
* '''Activity:''' Low

== Dependencies == 

=== Soprano === 


Soprano provides a Qt based wrapper over virtuoso, and additional serializing and parsing features which are used to load the ontologies. It follows an independent release schedule.


* '''Repository:''' [https://projects.kde.org/projects/kdesupport/soprano kde:soprano]
* '''Category:''' Core
* '''Activity:''' As per Nepomuk's requirements

=== Strigi === 


The Strigi project provides libraries to extract metadata from file. The project is divided into 5 sub-proejcts. Nepomuk only requires libstreams and libstreamanalyzer.


The overall development of Strigi has been stagnant for a couple of years now. However there are no viable alternatives present. And the cost of moving would be risking stability.


Strigi requires a lot of work where all the file formats can be listed, and the compatibility for every file can be checked.


From KDE/4.7, Nepomuk has started enforcing the ontologies - Either the data follows the ontologies or it is rejected. Since this move many bugs and inconsistencies have come to light. Unfortunately, while earlier they were just an minor inconvenience to the user, now those files are not indexed.

==== Lib Streams ==== 


* '''Repository:''' [https://projects.kde.org/projects/kdesupport/strigi/libstreams kde:libstreams]
* '''Category:''' File Indexer
* '''Activity:''' Non Existent

==== Lib Stream Analyzer ==== 


* '''Repository:''' [https://projects.kde.org/projects/kdesupport/strigi/libstreamanalyzer kde:libstreamanalyzer]
* '''Category:''' File Indexer
* '''Activity:''' Bug fixes

== Other Repositories == 

=== Metadata Extractor === 


The Nepomuk Metadata Extractor is an independent project that was started by Jörg Ehrichs. It provides rich features for extracting additional information from the web as well as from the files.


* '''Repository:''' [https://projects.kde.org/projects/playground/base/nepomuk-metadata-extractor kde:nepomuk-metadata-extrator]
* '''Developers:''' Jörg Ehrichs <joerg.ehrichs@gmx.de>

=== Tag Manager === 


A fairly random project that was done in less than a day. Its purpose was to provide a user visible way to rename, delete and merge tags. It is currently not shipped by any distributions, and should ideally be cleanup up and properly released. For more information read [http://vhanda.in/blog/2012/01/nepomuk-tag-manager/| this].


* '''Repository:''' [http://quickgit.kde.org/index.php?p=scratch%2Fvhanda%2Fnepomuktagmanager.git&a=summary kde:scratch/vhanda/nepomuktagmanager.git]
* '''Category:''' Usability
* '''Activity:''' Low

=== TV Namer === 


It fetches information from http://thetvdb.com. For more information, please read the original blogs posts -
* http://trueg.wordpress.com/2012/02/11/a-fun-release-nepomuk-tv-namer-0-2/
* http://trueg.wordpress.com/2012/01/28/something-way-less-dry-tv-shows/


* '''Repository:''' [http://quickgit.kde.org/index.php?p=scratch%2Ftrueg%2Fnepomuktvnamer.git&a=summary kde:scratch/trueg/nepomuktvnamer]
* '''Category:''' Web-extractor
* '''Developers:''' Sebastian Trueg <trueg@kde.org>

=== Music === 


This provides a music kio slave which allows one to browse through the music indexed by Nepomuk. For more information please read [http://trueg.wordpress.com/2012/02/10/just-for-the-fun-of-it-browsing-music-with-nepomuk/ the original blog post]


* '''Repository:''' [http://quickgit.kde.org/index.php?p=scratch%2Ftrueg%2Fnepomuk-music-kio-slave.git&a=summary kde:scratch/trueg/nepomuk-music-kio-slave]
* '''Category:''' Usability
* '''Activity:''' Low
* '''Developers:''' Sebastian Trueg <trueg@kde.com>

=== Web Extractor === 


The Nepomuk web-extractor was originally a 2010 GSOC Project (Add link). The project was completed, but the architecture is extremely complicated. Additionally, most of the user visible parts were missing. It requires a complete rewrite.


* '''Repository:''' [https://projects.kde.org/projects/playground/base/nepomuk-web-extractor kde:nepomuk-web-extrator]
* '''Category:''' Core
* '''Activity:''' Non Existent
* '''Developers:''' Artem Serebriyskiy <v.for.vandal@gmail.com>


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/Repositories

2012-12-12T14:01:23Z

AnneW: Prepare for translation

<languages />
<translate>

== Nepomuk Repositories ==

The '''Nepomuk''' development is split across many different repositories across KDE. The page attempts to list out most of the known Nepomuk code, and its development location. The list has been split according to importance.

== Main Repositories ==

These are the official repositories which the core Nepomuk team focuses on.

=== NepomukCore ===

NepomukCore, which is the main repository for Nepomuk development, was released with KDE 4.9. It is a combination of both the Nepomuk libraries present in kdelibs, and certain run time components present in kde-runtime.

All Nepomuk enabled applications must depend on NepomukCore. It utilizes the Nepomuk2 namespace.

* '''Repository:''' [https://projects.kde.org/projects/kde/kdelibs/nepomuk-core kde:nepomuk-core]
* '''Category:''' Core
* '''Activity:''' High
* '''Developers:''' Sebastian Trueg <trueg@kde.org>, Vishesh Handa <me@vhanda.in>

=== NepomukWidgets ===

NepomukWidget, is the repository which contains all the widgets which applications use. It will be released with KDE 4.10. Before this the widgets were present in kdelibs/nepomuk.

* '''Repository:''' [https://projects.kde.org/projects/kde/kdelibs/nepomuk-widgets kde:nepomuk-widgets]
* '''Category:''' User Interface
* '''Activity:''' High
* '''Developers:''' Sebastian Trueg <trueg@kde.org>, Vishesh Handa <me@vhanda.in>

=== KIO slaves ===

Nepomuk currently consists of 3 kio-slaves - nepomuk, nepomuksearch, and timeline. Out of these 3, nepomuksearch and timeline are the most visible. The nepomuk kioslave is an internal kioslave which redirects to the physical location or to the nepomuksearch kioslave. For a more in depth discussion of their working, please read [[Projects/Nepomuk/kioslaves| this]].

'''Repository:''' kde-runtime/nepomuk/kioslaves

=== KCM ===

Nepomuk consists of 2 main user visible components. The Nepomuk KCM and the controller, which is uses to pause/resume indexing. The plan is to eventually move these out of kde-runtime, but that will probably only happen with KDE Frameworks 5.

'''Repository:''' kde-runtime/nepomuk/kcm

=== Nepomuk Shell ===

Nepomuk consists of a development tool called 'nepomukshell' which can be used to browse the Nepomuk database, and to run SPARQL queries. It has served as a simple starting ground for people wishing to contribute to Nepomuk.

* '''Repository:''' [https://projects.kde.org/projects/extragear/utils/nepomukshell/ kde:nepomukshell]
* '''Category:''' Development Tools
* '''Activity:''' Low

== Dependencies ==

=== Soprano ===

Soprano provides a Qt based wrapper over virtuoso, and additional serializing and parsing features which are used to load the ontologies. It follows an independent release schedule.

* '''Repository:''' [https://projects.kde.org/projects/kdesupport/soprano kde:soprano]
* '''Category:''' Core
* '''Activity:''' As per Nepomuk's requirements

=== Strigi ===

The Strigi project provides libraries to extract metadata from file. The project is divided into 5 sub-proejcts. Nepomuk only requires libstreams and libstreamanalyzer.

The overall development of Strigi has been stagnant for a couple of years now. However there are no viable alternatives present. And the cost of moving would be risking stability.

Strigi requires a lot of work where all the file formats can be listed, and the compatibility for every file can be checked.

From KDE/4.7, Nepomuk has started enforcing the ontologies - Either the data follows the ontologies or it is rejected. Since this move many bugs and inconsistencies have come to light. Unfortunately, while earlier they were just an minor inconvenience to the user, now those files are not indexed.

==== Lib Streams ====

* '''Repository:''' [https://projects.kde.org/projects/kdesupport/strigi/libstreams kde:libstreams]
* '''Category:''' File Indexer
* '''Activity:''' Non Existent

==== Lib Stream Analyzer ====

* '''Repository:''' [https://projects.kde.org/projects/kdesupport/strigi/libstreamanalyzer kde:libstreamanalyzer]
* '''Category:''' File Indexer
* '''Activity:''' Bug fixes

== Other Repositories ==

=== Metadata Extractor ===

The Nepomuk Metadata Extractor is an independent project that was started by Jörg Ehrichs. It provides rich features for extracting additional information from the web as well as from the files.

* '''Repository:''' [https://projects.kde.org/projects/playground/base/nepomuk-metadata-extractor kde:nepomuk-metadata-extrator]
* '''Developers:''' Jörg Ehrichs <joerg.ehrichs@gmx.de>

=== Tag Manager ===

A fairly random project that was done in less than a day. Its purpose was to provide a user visible way to rename, delete and merge tags. It is currently not shipped by any distributions, and should ideally be cleanup up and properly released. For more information read [http://vhanda.in/blog/2012/01/nepomuk-tag-manager/| this].

* '''Repository:''' [http://quickgit.kde.org/index.php?p=scratch%2Fvhanda%2Fnepomuktagmanager.git&a=summary kde:scratch/vhanda/nepomuktagmanager.git]
* '''Category:''' Usability
* '''Activity:''' Low

=== TV Namer ===

It fetches information from http://thetvdb.com. For more information, please read the original blogs posts -
* http://trueg.wordpress.com/2012/02/11/a-fun-release-nepomuk-tv-namer-0-2/
* http://trueg.wordpress.com/2012/01/28/something-way-less-dry-tv-shows/

* '''Repository:''' [http://quickgit.kde.org/index.php?p=scratch%2Ftrueg%2Fnepomuktvnamer.git&a=summary kde:scratch/trueg/nepomuktvnamer]
* '''Category:''' Web-extractor
* '''Developers:''' Sebastian Trueg <trueg@kde.org>

=== Music ===

This provides a music kio slave which allows one to browse through the music indexed by Nepomuk. For more information please read [http://trueg.wordpress.com/2012/02/10/just-for-the-fun-of-it-browsing-music-with-nepomuk/ the original blog post]

* '''Repository:''' [http://quickgit.kde.org/index.php?p=scratch%2Ftrueg%2Fnepomuk-music-kio-slave.git&a=summary kde:scratch/trueg/nepomuk-music-kio-slave]
* '''Category:''' Usability
* '''Activity:''' Low
* '''Developers:''' Sebastian Trueg <trueg@kde.com>

=== Web Extractor ===

The Nepomuk web-extractor was originally a 2010 GSOC Project (Add link). The project was completed, but the architecture is extremely complicated. Additionally, most of the user visible parts were missing. It requires a complete rewrite.

* '''Repository:''' [https://projects.kde.org/projects/playground/base/nepomuk-web-extractor kde:nepomuk-web-extrator]
* '''Category:''' Core
* '''Activity:''' Non Existent
* '''Developers:''' Artem Serebriyskiy <v.for.vandal@gmail.com>

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/SparqlQueries

2012-12-12T13:47:19Z

AnneW: Marked this version for translation

<languages />
<translate>

__TOC__
== Running Sparql Queries == 


Depending on the needs of your application you may need to directly run sparql queries.


'''Nepomuk''' uses one main [http://soprano.sourceforge.net/apidox/stable/classSoprano_1_1Model.html Soprano model] which is accessed through the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk_1_1ResourceManager.html ResourceManager]:


<syntaxhighlight lang="cpp-qt">
Soprano::Model* model = Nepomuk::ResourceManager::instance()->mainModel();
</syntaxhighlight>


The queries can be run via this model -
<syntaxhighlight lang="cpp-qt">
QString query = QString::fromLatin1("select ?r where { ?r a nco:Contact . }");
Soprano::Model* model = Nepomuk2::ResourceManager::instance()->mainModel();
Soprano::QueryResultIterator it = model->executeQuery( query, Soprano::Query::QueryLanguageSparql );


while( it.next() ) {
kDebug() << it["r"].uri();
}
</syntaxhighlight>

=== Sparql Prefixes === 


When writing SPARQL queries, according to the standard one needs to prepend the queries with the prefixes that have been used. For example -
<syntaxhighlight lang="text">
PREFIX nco: <http://www.semanticdesktop.org/ontologies/2007/03/22/nco#> .
select ?r ?name where { ?r a nco:Contact . ?r nco:fullname ?name . }
</syntaxhighlight>


When running queries in Nepomuk, you do not need to explicitly add the prefix. The prefix will automatically be added by the storage service. In the future we will try to make virtuoso automatically understand all prefixes.

=== Full Text Indexing === 


'''Nepomuk''' depends on [http://soprano.sourceforge.net/apidox/trunk/soprano_backend_virtuoso.html Virtuoso] for data storage. '''Virtuoso''' brings a lot of nice [http://docs.openlinksw.com/virtuoso/rdfsparql.html#sparqlextensions extensions to SPARQL]. Most importantly the full text search which is used through the artificial ''bif:contains'' property.


This allows to combine graph queries with full text queries in a nice way:


<syntaxhighlight lang="text">
select ?r where { ?r nao:prefLabel ?label .
?label bif:contains 'nepomuk' . }
</syntaxhighlight>


The query above will find any resources that contain ''nepomuk'' in their label.


Of course wildcards are supported, too. However, be aware that when using wildcards the expression itself needs to be enclosed in quotes as follows:


<syntaxhighlight lang="text">
select ?r where { ?r nao:prefLabel ?label .
?label bif:contains "'nepomuk*'" . }
</syntaxhighlight>


Please note the virtuoso '''requires a minimum of 4 leading characters''' in order to use wildcards.


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/SparqlQueries

2012-12-12T13:46:54Z

AnneW: Add ToC

<languages />
<translate>

__TOC__
== Running Sparql Queries ==

Depending on the needs of your application you may need to directly run sparql queries.

'''Nepomuk''' uses one main [http://soprano.sourceforge.net/apidox/stable/classSoprano_1_1Model.html Soprano model] which is accessed through the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk_1_1ResourceManager.html ResourceManager]:

<syntaxhighlight lang="cpp-qt">
Soprano::Model* model = Nepomuk::ResourceManager::instance()->mainModel();
</syntaxhighlight>

The queries can be run via this model -
<syntaxhighlight lang="cpp-qt">
QString query = QString::fromLatin1("select ?r where { ?r a nco:Contact . }");
Soprano::Model* model = Nepomuk2::ResourceManager::instance()->mainModel();
Soprano::QueryResultIterator it = model->executeQuery( query, Soprano::Query::QueryLanguageSparql );

while( it.next() ) {
kDebug() << it["r"].uri();
}
</syntaxhighlight>

=== Sparql Prefixes ===

When writing SPARQL queries, according to the standard one needs to prepend the queries with the prefixes that have been used. For example -
<syntaxhighlight lang="text">
PREFIX nco: <http://www.semanticdesktop.org/ontologies/2007/03/22/nco#> .
select ?r ?name where { ?r a nco:Contact . ?r nco:fullname ?name . }
</syntaxhighlight>

When running queries in Nepomuk, you do not need to explicitly add the prefix. The prefix will automatically be added by the storage service. In the future we will try to make virtuoso automatically understand all prefixes.

=== Full Text Indexing ===

'''Nepomuk''' depends on [http://soprano.sourceforge.net/apidox/trunk/soprano_backend_virtuoso.html Virtuoso] for data storage. '''Virtuoso''' brings a lot of nice [http://docs.openlinksw.com/virtuoso/rdfsparql.html#sparqlextensions extensions to SPARQL]. Most importantly the full text search which is used through the artificial ''bif:contains'' property.

This allows to combine graph queries with full text queries in a nice way:

<syntaxhighlight lang="text">
select ?r where { ?r nao:prefLabel ?label .
?label bif:contains 'nepomuk' . }
</syntaxhighlight>

The query above will find any resources that contain ''nepomuk'' in their label.

Of course wildcards are supported, too. However, be aware that when using wildcards the expression itself needs to be enclosed in quotes as follows:

<syntaxhighlight lang="text">
select ?r where { ?r nao:prefLabel ?label .
?label bif:contains "'nepomuk*'" . }
</syntaxhighlight>

Please note the virtuoso '''requires a minimum of 4 leading characters''' in order to use wildcards.

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/SparqlQueries

2012-12-12T13:42:07Z

AnneW: Prepare for translation

<languages />
<translate>

== Running Sparql Queries ==

Depending on the needs of your application you may need to directly run sparql queries.

'''Nepomuk''' uses one main [http://soprano.sourceforge.net/apidox/stable/classSoprano_1_1Model.html Soprano model] which is accessed through the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk_1_1ResourceManager.html ResourceManager]:

<syntaxhighlight lang="cpp-qt">
Soprano::Model* model = Nepomuk::ResourceManager::instance()->mainModel();
</syntaxhighlight>

The queries can be run via this model -
<syntaxhighlight lang="cpp-qt">
QString query = QString::fromLatin1("select ?r where { ?r a nco:Contact . }");
Soprano::Model* model = Nepomuk2::ResourceManager::instance()->mainModel();
Soprano::QueryResultIterator it = model->executeQuery( query, Soprano::Query::QueryLanguageSparql );

while( it.next() ) {
kDebug() << it["r"].uri();
}
</syntaxhighlight>

=== Sparql Prefixes ===

When writing SPARQL queries, according to the standard one needs to prepend the queries with the prefixes that have been used. For example -
<syntaxhighlight lang="text">
PREFIX nco: <http://www.semanticdesktop.org/ontologies/2007/03/22/nco#> .
select ?r ?name where { ?r a nco:Contact . ?r nco:fullname ?name . }
</syntaxhighlight>

When running queries in Nepomuk, you do not need to explicitly add the prefix. The prefix will automatically be added by the storage service. In the future we will try to make virtuoso automatically understand all prefixes.

=== Full Text Indexing ===

'''Nepomuk''' depends on [http://soprano.sourceforge.net/apidox/trunk/soprano_backend_virtuoso.html Virtuoso] for data storage. '''Virtuoso''' brings a lot of nice [http://docs.openlinksw.com/virtuoso/rdfsparql.html#sparqlextensions extensions to SPARQL]. Most importantly the full text search which is used through the artificial ''bif:contains'' property.

This allows to combine graph queries with full text queries in a nice way:

<syntaxhighlight lang="text">
select ?r where { ?r nao:prefLabel ?label .
?label bif:contains 'nepomuk' . }
</syntaxhighlight>

The query above will find any resources that contain ''nepomuk'' in their label.

Of course wildcards are supported, too. However, be aware that when using wildcards the expression itself needs to be enclosed in quotes as follows:

<syntaxhighlight lang="text">
select ?r where { ?r nao:prefLabel ?label .
?label bif:contains "'nepomuk*'" . }
</syntaxhighlight>

Please note the virtuoso '''requires a minimum of 4 leading characters''' in order to use wildcards.

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/QueryLibrary

2012-12-12T13:38:31Z

AnneW: Marked this version for translation

<languages />
<translate>

== The Query Library == 


'''Nepomuk''' provides a Query Library which is a part of the nepomuk-core library. It can be user to dynamically create queries. This Query Library eventually compiles the queries into Sparql which is then run on our database - virtuoso.


It is recommended that you use the Query Library when you're searching for resources which have some direct properties. If the queries are too complex, maybe you should be directly using SPARQL. It all depends on your use case. The only advantage of using the QueryLibrary is that with improvements in the query library, your queries should get faster.

== Creating Queries == 


The entire Query Library resides in the Nepomuk2::Query namespace. It consists of a number of terms which can be combined together to create larger terms. Eventually when you've have created the final term, you can pass it to <tt>Nepomuk2::Query::Query</tt> and [[Projects/Nepomuk/QueryingMethods| run the query]]


The different kinds of terms are -


* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1AndTerm.html AndTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1OrTerm.html OrTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1NegationTerm.html NegationTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1ComparisonTerm.html ComparisionTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1LiteralTerm.html LiteralTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1ResourceTerm.html ResourceTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1ResourceTypeTerm.html ResourceTypeTerm]

=== Examples === 


Imagine we wanted to find all files that are tagged with a certain tag:


<syntaxhighlight lang="cpp">
Nepomuk::Tag myTag = someFancyMethod();


// term matching the tag
Nepomuk::Query::ResourceTerm tagTerm( myTag );


// term matching tagged resource
Nepomuk::Query::ComparisonTerm term( Soprano::Vocabulary::NAO::hasTag(),
tagTerm,
Nepomuk::Query::ComparisonTerm::Equal );


// build the query
Nepomuk::Query::Query query( term );
</syntaxhighlight>

=== Introspecting Queries === 


The <tt>Query</tt> class provides convenient methods to convert the query into its relevant sparql query, which can then easily be read. Additionally, it also provides a <tt>toSearchUrl</tt> method.


* toSparqlQuery() - Creates a SPARQL query to be used in Soprano::Model::executeQuery
* toSearchUrl() - Creates a URL that can be listed via KIO.


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/QueryLibrary

2012-12-12T13:37:41Z

AnneW: Prepare for translation

<languages />
<translate>

== The Query Library ==

'''Nepomuk''' provides a Query Library which is a part of the nepomuk-core library. It can be user to dynamically create queries. This Query Library eventually compiles the queries into Sparql which is then run on our database - virtuoso.

It is recommended that you use the Query Library when you're searching for resources which have some direct properties. If the queries are too complex, maybe you should be directly using SPARQL. It all depends on your use case. The only advantage of using the QueryLibrary is that with improvements in the query library, your queries should get faster.

== Creating Queries ==

The entire Query Library resides in the Nepomuk2::Query namespace. It consists of a number of terms which can be combined together to create larger terms. Eventually when you've have created the final term, you can pass it to <tt>Nepomuk2::Query::Query</tt> and [[Projects/Nepomuk/QueryingMethods| run the query]]

The different kinds of terms are -

* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1AndTerm.html AndTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1OrTerm.html OrTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1NegationTerm.html NegationTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1ComparisonTerm.html ComparisionTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1LiteralTerm.html LiteralTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1ResourceTerm.html ResourceTerm]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1ResourceTypeTerm.html ResourceTypeTerm]

=== Examples ===

Imagine we wanted to find all files that are tagged with a certain tag:

<syntaxhighlight lang="cpp">
Nepomuk::Tag myTag = someFancyMethod();

// term matching the tag
Nepomuk::Query::ResourceTerm tagTerm( myTag );

// term matching tagged resource
Nepomuk::Query::ComparisonTerm term( Soprano::Vocabulary::NAO::hasTag(),
tagTerm,
Nepomuk::Query::ComparisonTerm::Equal );

// build the query
Nepomuk::Query::Query query( term );
</syntaxhighlight>

=== Introspecting Queries ===

The <tt>Query</tt> class provides convenient methods to convert the query into its relevant sparql query, which can then easily be read. Additionally, it also provides a <tt>toSearchUrl</tt> method.

* toSparqlQuery() - Creates a SPARQL query to be used in Soprano::Model::executeQuery
* toSearchUrl() - Creates a URL that can be listed via KIO.

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/QueryingMethods

2012-12-12T13:33:52Z

AnneW: Marked this version for translation

<languages />
<translate>

== Querying your Data == 


There isn't much point of pushing all your data into Nepomuk, if you cannot query it. This article mentions the different ways you can query Nepomuk and the advantages and disadvantages of each.

== QueryServiceClient == 


The Nepomuk [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1QueryServiceClient.html <tt>QueryServiceClient</tt>] is an asynchronous method of running queries in '''Nepomuk'''. It accepts both Nepomuk Queries and direct SPARQL queries. It provides convenient signal which your application can connect to in order to receive the results.


Please note that the asynchronous nature of the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1QueryServiceClient.html QueryServiceClient] is achieved by transmitting the query over dbus to the storage service, where a new thread is spawned, the query is run on that thread, and the results are returned over dbus. This is fine for casual use, but when you care about high performance, it is recommended that you avoid the QueryServiceClient.


Example -
<syntaxhighlight lang="cpp-qt">
Nepomuk2::Query::Query query( .. build Query .. );
Nepomuk2::Query::QueryServiceClient* client = new Nepomuk2::Query::QueryServiceClient( this );
client->query( query );
connect( client, SIGNAL(newEntries(QList<Nepomuk2::Query::Result>)),
this, SLOT(newEntries(QList<Nepomuk2::Query::Result>)) );

void TestObject::newEntries(const QList< Nepomuk2::Query::Result >& list)
{
foreach( const Nepomuk2::Query::Result &r, list ) {
Nepomuk2::Resource res = r.resource();
QHash<QUrl, Nepomuk2::Variant> prop = res.properties();
QHashIterator<QUrl, Nepomuk2::Variant> it( prop );
while( it.hasNext() ) {
it.next();
kDebug() << it.key() << " " << it.value();
}
kDebug() << "--------------------------";
}
}
</syntaxhighlight>


The [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1QueryServiceClient.html QueryServiceClient] also offers ways of updating the results via [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1QueryServiceClient.html#a1b843e5bf89ddb1a0d5c66eb0193375b entriesRemoved] and [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1QueryServiceClient.html#a6ed2be5579a00e9b8de1f5f23faf1fb6 newEntries]. While these methods may seem very attractive, their implementation is not. They work by running the entire query when some data in the Nepomuk database changes.


In the future the queries will only be re-run when data related to the query changes (heuristics), but until then '''the entire query is re-run every time ANY data changes'''. Therefore it is recommended that you delete the QueryServiceClient when it has finished execution as follows -


<syntaxhighlight lang="cpp-qt">
Nepomuk2::Query::QueryServiceClient* client = new Nepomuk2::Query::QueryServiceClient( this );
connect( client, SIGNAL(finishedListing()), client, SLOT(deleteLater()) );
</syntaxhighlight>

== Result Iterator == 


The <tt>ResultIterator</tt>, which has been introduced in 4.10, can take either a Nepomuk or SPARQL query and provides an iterator which you can use to get the results. The iterator is obviously blocking, so you may want to put it another thread, depending on the kind of query.


Example -
<syntaxhighlight lang="cpp-qt">
Nepomuk2::Query::Query query( .. build Query .. );
Nepomuk::Query::ResultIterator it( query );
while( it.next() ) {
Nepomuk2::Resource res = it.current().resource();
QHash<QUrl, Nepomuk2::Variant> prop = res.properties();
QHashIterator<QUrl, Nepomuk2::Variant> it( prop );


while( it.hasNext() ) {
it.next();
kDebug() << it.key() << " " << it.value();
}
kDebug() << "--------------------------";
}
}
</syntaxhighlight>


The ResultIterator is just a light wrapper over the <tt>Soprano::QueryResultIterator</tt>. It converts the bindings returned by the <tt>QueryResultIterator</tt> into a <tt>Query::Result</tt>.

== Soprano::Model == 


The underlying '''Soprano''' model can also be used to directly run the queries. You can only run [[Projects/Nepomuk/SparqlQueries|SPARQL queries]] on the model. Use this method when you're writing a custom query. The underlying Model also provides an iterator similar to that of the <tt>ResultIterator</tt>.


Example -
<syntaxhighlight lang="cpp-qt">
QString query = QString::fromLatin1("select ?r where { ?r a nco:Contact . }");
Soprano::Model* model = Nepomuk2::ResourceManager::instance()->mainModel();
Soprano::QueryResultIterator it = model->executeQuery( query, Soprano::Query::QueryLanguageSparql );


while( it.next() ) {
kDebug() << it["r"].uri();
}
</syntaxhighlight>


You might want to check out the [http://soprano.sourceforge.net/apidox/trunk/index.html Soprano API] for more information about the lower level details.


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/QueryingMethods

2012-12-12T13:33:40Z

AnneW: Prepare for translation

<languages />
<translate>

== Querying your Data ==

There isn't much point of pushing all your data into Nepomuk, if you cannot query it. This article mentions the different ways you can query Nepomuk and the advantages and disadvantages of each.

== QueryServiceClient ==

The Nepomuk [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1QueryServiceClient.html <tt>QueryServiceClient</tt>] is an asynchronous method of running queries in '''Nepomuk'''. It accepts both Nepomuk Queries and direct SPARQL queries. It provides convenient signal which your application can connect to in order to receive the results.

Please note that the asynchronous nature of the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1QueryServiceClient.html QueryServiceClient] is achieved by transmitting the query over dbus to the storage service, where a new thread is spawned, the query is run on that thread, and the results are returned over dbus. This is fine for casual use, but when you care about high performance, it is recommended that you avoid the QueryServiceClient.

Example -
<syntaxhighlight lang="cpp-qt">
Nepomuk2::Query::Query query( .. build Query .. );
Nepomuk2::Query::QueryServiceClient* client = new Nepomuk2::Query::QueryServiceClient( this );
client->query( query );
connect( client, SIGNAL(newEntries(QList<Nepomuk2::Query::Result>)),
this, SLOT(newEntries(QList<Nepomuk2::Query::Result>)) );

void TestObject::newEntries(const QList< Nepomuk2::Query::Result >& list)
{
foreach( const Nepomuk2::Query::Result &r, list ) {
Nepomuk2::Resource res = r.resource();
QHash<QUrl, Nepomuk2::Variant> prop = res.properties();
QHashIterator<QUrl, Nepomuk2::Variant> it( prop );
while( it.hasNext() ) {
it.next();
kDebug() << it.key() << " " << it.value();
}
kDebug() << "--------------------------";
}
}
</syntaxhighlight>

The [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1QueryServiceClient.html QueryServiceClient] also offers ways of updating the results via [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1QueryServiceClient.html#a1b843e5bf89ddb1a0d5c66eb0193375b entriesRemoved] and [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Query_1_1QueryServiceClient.html#a6ed2be5579a00e9b8de1f5f23faf1fb6 newEntries]. While these methods may seem very attractive, their implementation is not. They work by running the entire query when some data in the Nepomuk database changes.

In the future the queries will only be re-run when data related to the query changes (heuristics), but until then '''the entire query is re-run every time ANY data changes'''. Therefore it is recommended that you delete the QueryServiceClient when it has finished execution as follows -

<syntaxhighlight lang="cpp-qt">
Nepomuk2::Query::QueryServiceClient* client = new Nepomuk2::Query::QueryServiceClient( this );
connect( client, SIGNAL(finishedListing()), client, SLOT(deleteLater()) );
</syntaxhighlight>

== Result Iterator ==

The <tt>ResultIterator</tt>, which has been introduced in 4.10, can take either a Nepomuk or SPARQL query and provides an iterator which you can use to get the results. The iterator is obviously blocking, so you may want to put it another thread, depending on the kind of query.

Example -
<syntaxhighlight lang="cpp-qt">
Nepomuk2::Query::Query query( .. build Query .. );
Nepomuk::Query::ResultIterator it( query );
while( it.next() ) {
Nepomuk2::Resource res = it.current().resource();
QHash<QUrl, Nepomuk2::Variant> prop = res.properties();
QHashIterator<QUrl, Nepomuk2::Variant> it( prop );

while( it.hasNext() ) {
it.next();
kDebug() << it.key() << " " << it.value();
}
kDebug() << "--------------------------";
}
}
</syntaxhighlight>

The ResultIterator is just a light wrapper over the <tt>Soprano::QueryResultIterator</tt>. It converts the bindings returned by the <tt>QueryResultIterator</tt> into a <tt>Query::Result</tt>.

== Soprano::Model ==

The underlying '''Soprano''' model can also be used to directly run the queries. You can only run [[Projects/Nepomuk/SparqlQueries|SPARQL queries]] on the model. Use this method when you're writing a custom query. The underlying Model also provides an iterator similar to that of the <tt>ResultIterator</tt>.

Example -
<syntaxhighlight lang="cpp-qt">
QString query = QString::fromLatin1("select ?r where { ?r a nco:Contact . }");
Soprano::Model* model = Nepomuk2::ResourceManager::instance()->mainModel();
Soprano::QueryResultIterator it = model->executeQuery( query, Soprano::Query::QueryLanguageSparql );

while( it.next() ) {
kDebug() << it["r"].uri();
}
</syntaxhighlight>

You might want to check out the [http://soprano.sourceforge.net/apidox/trunk/index.html Soprano API] for more information about the lower level details.

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/IndexingPlugin

2012-12-12T13:28:35Z

AnneW: Marked this version for translation

<languages />
<translate>

== Status of Indexing == 


File Indexing has gone through a major overhaul in 4.10. We no longer rely on '''strigi'''. This means that we need to write our own file indexer from scratch. However writing a file indexer is very simple.


Currently, there is no public interface for the indexing plugins. There might be one for 4.10, but we aren't sure right now.

== Extractor Plugin == 
In order to write a file indexer, we have to write a plugin derived from <tt>Nepomuk2::ExtractorPlugin</tt>. We are required to implement two simple functions -


<syntaxhighlight lang="cpp-qt">
class NEPOMUK_EXPORT ExtractorPlugin : public QObject
{
Q_OBJECT
public:
ExtractorPlugin(QObject* parent);
virtual ~ExtractorPlugin();


virtual QStringList mimetypes() = 0;
virtual SimpleResourceGraph extract(const QUrl& resUri, const QUrl& fileUrl, const QString& mimeType) = 0;
};
</syntaxhighlight>


These two functions are <tt>mimetypes</tt> and <tt>extract</tt>. Each plugin can act on a certain set of mimetypes. Each plugin simply needs to list out all the mimetypes they support.


The second function <tt>extract</tt> is the heart of the extractor. You are provided with the mimetype and the url of the file. The file can be read and information can be extracted from it.

=== Saving the Extracted Data === 


The Nepomuk Extractors are based around two simple classes <tt>SimpleResource</tt> and <tt>SimpleResourceGraph</tt>. The SimpleResourceGraph is just a collection of <tt>SimpleResource</tt>s. A <tt>SimpleResource</tt> is just a collection of (key, value) pairs which contain the properties of that particular resource.


The main file resource has a resource uri which is passed as a parameter. It can be used as follows -


<syntaxhighlight lang="cpp-qt">
SimpleResource fileRes( resUri );
fileRes.addType( NFO::PlainTextDocument() );
fileRes.addProperty( NIE::plainTextContent(), contents );
fileRes.addProperty( NFO::wordCount(), words );
fileRes.addProperty( NFO::lineCount(), lines );
fileRes.addProperty( NFO::characterCount(), characters );
</syntaxhighlight>


This <tt>fileRes</tt> can then be added to a <tt>SimpleResourceGraph</tt> and returned. It will then be saved in Nepomuk.

== Required Files == 


Since the plugin interface still isn't public. It would be best to directly contribute to nepomuk-core. The relevant code can be found at nepomuk-core/services/fileindexer/indexer/.

== Testing the Indexer == 


The Indexer is generally automatically called when it detects new files should be indexed. It however can also be forcibly called by running <tt>nepomukindexer --debug fileUrl</tt> on a file.


The extra <tt>--debug</tt> is required because normally, the nepomukindexer process only adds details from the plugins. The basic information about the file - It's url, mimetype, etc, and supposed to already exist. The debug option adds that information as well.

=== Viewing the indexed information === 


The most commonly used method is the sidebar in Dolphin. However, one can also use this [[Projects/Nepomuk/NepomukShow| nifty tool]] to view the data.

=== Errors === 


It might be common to get errors that a properties range/domain/cardinality is not being followed. These errors occur when the ontologies are not being properly followed. In that case it would be best to look where you're adding that property and if it actually has the correct domain/range/cardinality.


The ontologies can be found over here - http://oscaf.sourceforge.net/


[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>

Projects/Nepomuk/IndexingPlugin

2012-12-12T13:28:21Z

AnneW: Prepare for translation

<languages />
<translate>

== Status of Indexing ==

File Indexing has gone through a major overhaul in 4.10. We no longer rely on '''strigi'''. This means that we need to write our own file indexer from scratch. However writing a file indexer is very simple.

Currently, there is no public interface for the indexing plugins. There might be one for 4.10, but we aren't sure right now.

== Extractor Plugin ==
In order to write a file indexer, we have to write a plugin derived from <tt>Nepomuk2::ExtractorPlugin</tt>. We are required to implement two simple functions -

<syntaxhighlight lang="cpp-qt">
class NEPOMUK_EXPORT ExtractorPlugin : public QObject
{
Q_OBJECT
public:
ExtractorPlugin(QObject* parent);
virtual ~ExtractorPlugin();

virtual QStringList mimetypes() = 0;
virtual SimpleResourceGraph extract(const QUrl& resUri, const QUrl& fileUrl, const QString& mimeType) = 0;
};
</syntaxhighlight>

These two functions are <tt>mimetypes</tt> and <tt>extract</tt>. Each plugin can act on a certain set of mimetypes. Each plugin simply needs to list out all the mimetypes they support.

The second function <tt>extract</tt> is the heart of the extractor. You are provided with the mimetype and the url of the file. The file can be read and information can be extracted from it.

=== Saving the Extracted Data ===

The Nepomuk Extractors are based around two simple classes <tt>SimpleResource</tt> and <tt>SimpleResourceGraph</tt>. The SimpleResourceGraph is just a collection of <tt>SimpleResource</tt>s. A <tt>SimpleResource</tt> is just a collection of (key, value) pairs which contain the properties of that particular resource.

The main file resource has a resource uri which is passed as a parameter. It can be used as follows -

<syntaxhighlight lang="cpp-qt">
SimpleResource fileRes( resUri );
fileRes.addType( NFO::PlainTextDocument() );
fileRes.addProperty( NIE::plainTextContent(), contents );
fileRes.addProperty( NFO::wordCount(), words );
fileRes.addProperty( NFO::lineCount(), lines );
fileRes.addProperty( NFO::characterCount(), characters );
</syntaxhighlight>

This <tt>fileRes</tt> can then be added to a <tt>SimpleResourceGraph</tt> and returned. It will then be saved in Nepomuk.

== Required Files ==

Since the plugin interface still isn't public. It would be best to directly contribute to nepomuk-core. The relevant code can be found at nepomuk-core/services/fileindexer/indexer/.

== Testing the Indexer ==

The Indexer is generally automatically called when it detects new files should be indexed. It however can also be forcibly called by running <tt>nepomukindexer --debug fileUrl</tt> on a file.

The extra <tt>--debug</tt> is required because normally, the nepomukindexer process only adds details from the plugins. The basic information about the file - It's url, mimetype, etc, and supposed to already exist. The debug option adds that information as well.

=== Viewing the indexed information ===

The most commonly used method is the sidebar in Dolphin. However, one can also use this [[Projects/Nepomuk/NepomukShow| nifty tool]] to view the data.

=== Errors ===

It might be common to get errors that a properties range/domain/cardinality is not being followed. These errors occur when the ontologies are not being properly followed. In that case it would be best to look where you're adding that property and if it actually has the correct domain/range/cardinality.

The ontologies can be found over here - http://oscaf.sourceforge.net/

[[Category:Documentation]]
[[Category:Development]]
[[Category:Tutorials]]
</translate>