Projects/Nepomuk: Difference between revisions

Latest revision as of 06:44, 16 November 2023

Warning

The Nepomuk project no longer exists in modern day KDE software. From KDE Applications 4.13 onwards, the ' Baloo' file indexing and file search framework replaces Nepomuk. Read details on the changes for Applications 4.13 here.

About Nepomuk

Nepomuk serves as a cross application semantic storage backend. It aims at collecting data from various sources - file indexing, the web, applications, etc, and linking them all together to form a cohesive map of data.

This page is dedicated to third party documentation for Nepomuk. To know more about Nepomuk from a user's point of view, head over to the Nepomuk page on UserBase. Or to know more about the Nepomuk community and getting involved in Nepomuk, head over to the Nepomuk Community Page.

Documentation

Any new project is intimidating and jumping right into the API Documentation can be scary. So, we have prepared some articles which explain the different aspects of Nepomuk and even touch on some advanced features.

The documentation of any project is always in progress as the code base is always evolving. If you feel that the documentation is lacking in some regard, please come talk to us. We'd love to hear your feedback, and the documentation might just get improved in the process.

Nepomuk Mailing List: [email protected]
IRC Channel: #nepomuk-kde on freenode

Introductory Material

If you're just getting started with Nepomuk and want to know a quick way to fetch some data.

Managing Data

This section includes more in-depth articles on how manage the data in Nepomuk. As a starting point you should probably open up the Nepomuk API Documentation. It is generally more up to date than the articles mentioned below.

File Indexing

With 4.10, the file indexing architecture has substantially changed. We no longer rely on strigi, and have our own plugin based interface.

Writing an Indexing Plugin

Querying

As you advance into Nepomuk, you'll want to move beyond just fetching and pushing data and will want to query Nepomuk for specialized data. One can query Nepomuk in many different ways, the important part is to optimize your queries and make sure they run well on production systems where the database sizes may way very large.

Architectural Overview

If you're looking to get more involved with Nepomuk development process, you should probably need to need to figure out our basic architecture and where you can find all the relevant code.

Nepomuk Internals

When you decide to dig even deeper.

Miscellaneous

Outdated links

The following links provide good reads for getting used to the Nepomuk system and its APIs. <br\> They are slightly outdated, but still has some useful material.

@@ Line 1: / Line 1: @@
-{{Template:I18n/Language Navigation Bar|Projects/Nepomuk}}
 [[Image:Nepomuk_logo_big.png|center|300px]]
+''{{Warning|The Nepomuk project no longer exists in modern day KDE software. From KDE Applications 4.13 onwards, the '[[community:Baloo | Baloo]]' file indexing and file search framework replaces Nepomuk. Read [http://dot.kde.org/2014/02/24/kdes-next-generation-semantic-search details on the changes for Applications 4.13 here].}}
 == About Nepomuk ==
-This page is dedicated to Nepomuk development ideas, progress, experiments, and is a general starting point for new developers.
+'''Nepomuk''' serves as a cross application semantic storage backend. It aims at collecting data from various sources - file indexing, the web, applications, etc, and linking them all together to form a cohesive map of data.
-For general information about the Nepomuk project see the [http://nepomuk.kde.org/ dedicated Nepomuk homepage].
-== Contact ==
-The Nepomuk project is maintained by [mailto:[email protected] Sebastian Trueg] of Mandriva.
-The "official" IRC channel is '''#nepomuk-kde''' on freenode.
-All development questions should be discussed on the [https://mail.kde.org/mailman/listinfo/nepomuk Nepomuk mailing list].
+This page is dedicated to third party documentation for '''Nepomuk'''. To know more about '''Nepomuk''' from a user's point of view, head over to the [http://userbase.kde.org/Special:myLanguage/Nepomuk Nepomuk page on UserBase]. Or to know more about the Nepomuk community and getting involved in '''Nepomuk''', head over to the [http://community.kde.org/Projects/Nepomuk Nepomuk Community Page].
 == Documentation ==
-The [http://userbase.kde.org/Nepomuk Nepomuk page on UserBase] has information and troubleshooting for users.
-The following links provide good reads for getting used to the Nepomuk system and its APIs.
-* [[Development/Tutorials/Metadata/Nepomuk|Development Tutorials]]
-*'''[[Development/Tutorials/Metadata/Nepomuk/TipsAndTricks|Nepomuk Tips and Tricks]]'''
-* [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk/html/index.html Nepomuk API Documentation]
-* [http://soprano.sourceforge.net/apidox/trunk/index.html Soprano (RDF storage) API]
-* [http://trueg.wordpress.com/2009/06/02/nepomuk-and-some-cmake-magic/ Using the Nepomuk Resource Code generator and the Soprano Ontology class generator in cmake]
-As Nepomuk is highly dependent on its data in the RDF store and the used ontologies, one might consider to read up on RDF and the Nepomuk ontogies:
-* [http://www.w3.org/TR/REC-rdf-syntax/ RDF Primer]
-* [http://www.semanticdesktop.org/ontologies Nepomuk Ontologies]
-* [http://dev.nepomuk.semanticdesktop.org/wiki/OntologyMaintenance Experimental Nepomuk Ontologies and Ideas for new ones]
-== Events ==
-[[Projects/Nepomuk/CodingSprint2009|June 19-21, 2009 - Coding Sprint 2009 Freiburg, Germany]]
-[[Projects/Nepomuk/OpenSocialSemanticDesktopWorkshop2009|Open Social Semantic Desktop Workshop 2009 Freiburg, Germany]]
-== ToDo  ==
-Nepomuk is a rather young project with a notorious shortage in developers. There are many tasks and subprojects to get ones hands dirty on. Unlike other projects like Plasma, however, developing for Nepomuk is not easy. One has to read up on a lot of things and fight some day-to-day annoyances. But: helping with the development will improve the situation in any case.
-If you are interested in working on a task in this list, please contact [mailto:[email protected] Sebastian Trueg].
-=== Junior Jobs ===
-If you want to get into Nepomuk development quickly by taking over a small task have a look at our [[Projects/Nepomuk/JuniorJobs|Junior Job page]].
-=== Low level Nepomuk Development Tasks  ===
-The low-level development tasks are those that are not directly reflected in the GUI or even in the API used by most developers. However, they are important in terms of performance, scalability, and compatibility.
-==== Add Inference Configuration to the Virtuoso Soprano Backend ====
-Virtuoso 5 provides inference on rdfs:subClassOf and rdfs:subPropertyOf. These are the most important ones and for now all we need in Nepomuk.
-The current implementation of the Virtuoso Soprano backend does not enable inference. We need a configuration option to do exactly that. It could happen along the lines of the [http://soprano.sourceforge.net/apidox/trunk/soprano_backend_virtuoso.html existing config options] or with the introduction of dedicated inference configuration options on the Soprano::Backend level.
+Any new project is intimidating and jumping right into the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/index.html API Documentation] can be scary. So, we have prepared some articles which explain the different aspects of '''Nepomuk''' and even touch on some advanced features.
+The documentation of any project is always in progress as the code base is always evolving. If you feel that the documentation is lacking in some regard, please come talk to us. We'd love to hear your feedback, and the documentation might just get improved in the process.
-==== Soprano Transaction Support  ====
+'''Nepomuk Mailing List: ''' [email protected] <br/>
+'''IRC Channel:''' #nepomuk-kde on freenode
-[http://soprano.sf.net/ Soprano] is the RDF database framework used in Nepomuk. Currently Soprano does not support transactions, i.e. sets of commands that can be rolled back. An [http://websvn.kde.org/branches/soprano/experimental experimental development] branch exists which already contains new API for transaction support (while keeping BC).
+=== Introductory Material ===
-It still misses an implementation of the transaction support in Soprano backends (Sesame2 and Virtuoso) and in the client/server architecture.
+If you're just getting started with '''Nepomuk''' and want to know a quick way to fetch some data.
-Another idea is to create a new API based on the design that Sesame2 follows: Repository and RepositoryConnection classes. The former creates instances of the latter which then has all the actual data handling methods and acts as one transaction object.
+* [[Special:myLanguage/Projects/Nepomuk/QuickStart| Quick Start]]
+* [[Special:myLanguage/Projects/Nepomuk/OntologyBasics| Basic Ontology concepts]]
+* [[Special:myLanguage/Projects/Nepomuk/Uris| Questions about URIs]]
+=== Managing Data ===
-=== General Nepomuk  ===
+This section includes more in-depth articles on how manage the data in '''Nepomuk'''. As a starting point you should probably open up the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/index.html Nepomuk API Documentation]. It is generally more up to date than the articles mentioned below.
-==== Handling of external storage  ====
+* [[Special:myLanguage/Projects/Nepomuk/Resources| Using Resources]]
+* [[Special:myLanguage/Projects/Nepomuk/ResourceWatcher| Monitoring Changes]]
+* [[Special:myLanguage/Projects/Nepomuk/BulkChanges| Bulk Changes]]
+* [[Special:myLanguage/Projects/Nepomuk/DataFeeders| Data Feeders]]
-'''We already have the removablestorage service in kdebase which handles USB keys and such to a degree.'''
+=== File Indexing ===
-A typical problem with the way Nepomuk handles files and file metadata are removable storage devices. They can be mounted at different paths on different systems. But still one wants to keep the metadata stored in Nepomuk. If possible one would even want to be able to search for files saved on an USB stick even if it is not plugged in.
+With 4.10, the file indexing architecture has substantially changed. We no longer rely on strigi, and have our own plugin based interface.
-The [http://trueg.wordpress.com/2009/04/15/portable-meta-information-yet-again-only-this-time-there-is-code/ blog entry about removable storage in Nepomuk] already discusses this problem and shows some existing code in KDE's [http://websvn.kde.org/trunk/playground/base/removablestorageservice/ playground] which tries to tackle this problem.
+* [[Special:myLanguage/Projects/Nepomuk/IndexingPlugin| Writing an Indexing Plugin]]
-However, one actually needs more. The system would have to be embedded into KIO to make sure the metadata cache on the removable storage device is always up-to-date. Also it is directly related to the problem of relative vs. absolute file URLs.
+=== Querying ===
+As you advance into '''Nepomuk''', you'll want to move beyond just fetching and pushing data and will want to query '''Nepomuk''' for specialized data. One can query '''Nepomuk''' in many different ways, the important part is to optimize your queries and make sure they run well on production systems where the database sizes may way very large.
-==== Nepomuk Backup Service  ====
+* [[Special:myLanguage/Projects/Nepomuk/QueryingMethods| Different ways to Query Nepomuk]]
+* [[Special:myLanguage/Projects/Nepomuk/QueryLibrary| Nepomuk Query Library]]
+* [[Special:myLanguage/Projects/Nepomuk/SparqlQueries| Sparql Queries]]
-Implementation details are discussed in [[Projects/Nepomuk/MetadataSharing]]
+=== Architectural Overview ===
-We need a backup solution. The idea is the typical one: have a Nepomuk service that allows to specify update intervals and manual updates.
+If you're looking to get more involved with '''Nepomuk''' development process, you should probably need to need to figure out our basic architecture and where you can find all the relevant code.
-The service should ignore all data extracted by Strigi, i.e. data that can be recreated deterministically. This can easy be determined by checking the context/named graph the data statements are stored in. Strigi stores all extracted data in one context which is marked as the ''http://www.strigi.org/fields#indexGraphFor'' for the file in question. Thus, a query along the lines of the following would work:
+* [[Special:myLanguage/Projects/Nepomuk/Repositories| Nepomuk Repositories]]
-<pre>select ?s ?p ?o ?g where {
+* [[Special:myLanguage/Projects/Nepomuk/ComponentOverview| Nepomuk Architectural Overview]]
-     graph ?g { ?s ?p ?o . } .
+* [[Special:myLanguage/Projects/Nepomuk/kioslaves| Nepomuk KIO Slaves]]
-     OPTIONAL { ?g strigi:indexGraphFor ?x . } .
-     FILTER(!BOUND(?x)) .
-}</pre>
-Other features could include replacement of the home directory like it is done in KConfig. This way the data could be re-imported in another user account.
+=== Nepomuk Internals ===
+When you decide to dig even deeper.
-==== Nepomuk Toolbox ====
+* [[Special:myLanguage/Projects/Nepomuk/GraphConcepts| Graph handling]]
-Provide a GUI that allows to call methods such as ''optimize'' and ''rebuildIndex'' on the storage service. The latter method is not commited yet due to the KDE 4.3 feature freeze but will be afterwards.
+* [[Special:myLanguage/Projects/Nepomuk/VirtuosoInternal| Virtuoso Internals]]
+* [[Special:myLanguage/Projects/Nepomuk/OntologyExtention| Extending the Ontologies]]
-It would also be useful to have Nepomuk register such operations (including the data conversion when changing backends) via the notification system.
+=== Miscellaneous ===
-== Development status ==
+* [[Special:myLanguage/Projects/Nepomuk/Nepomuk2Port| Porting to Nepomuk2]]
+* [[Special:myLanguage/Projects/Nepomuk/ManagingNepomukProcesses| Managing Nepomuk Processes]]
+* [[Special:myLanguage/Projects/Nepomuk/TestEnvironment| Nepomuk Test Environment]]
+* [[Special:myLanguage/Development/Tutorials/Metadata/Nepomuk/TipsAndTricks| Nepomuk Tips and Tricks]]
+* [[Special:myLanguage/Projects/Nepomuk/NepomukShow| Debugging Nepomuk Data]]
-See [[Projects/Nepomuk/DevelopmentStatus]].
+==== Outdated links ====
-http://techbase.kde.org/Projects/Nepomuk/Ideas
+The following links provide good reads for getting used to the '''Nepomuk''' system and its APIs. <br\>
+They are slightly outdated, but still has some useful material.
+* [[Special:myLanguage/Development/Tutorials/Metadata/Nepomuk|Development Tutorials]]
+* [[Special:myLanguage/Projects/Nepomuk/Ideas|Random Ideas]]
+* [[Special:myLanguage/Projects/Nepomuk/Qualified_Relations_Idea| Qualified Relations Idea]]
+* [[Special:myLanguage/Projects/Nepomuk/ScenarioExamples| Scenario Examples]]
-== Subpages of {{FULLPAGENAME}}==
+[[Category:Documentation]]
-{{Special:PrefixIndex/{{FULLPAGENAME}}/}}