Projects/Nepomuk: Difference between revisions

    From KDE TechBase
    (Removed Contact information)
    (38 intermediate revisions by the same user not shown)
    Line 7: Line 7:
    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.
    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.


    To know more about Nepomuk from a user's point of view, head over to the [http://userbase.kde.org/Nepomuk Nepomuk page on UserBase]. To know more about the Nepomuk community and getting involved in Nepomuk, head over to [http://community.kde.org/Projects/Nepomuk Nepomuk page on Community]. This page is dedicated to 3rd party documentation for Nepomuk.
    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/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 ==
    == Documentation ==
    The [http://userbase.kde.org/Nepomuk Nepomuk page on UserBase] has information and troubleshooting for users.
    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 following links provide good reads for getting used to the Nepomuk system and its APIs.
    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.
    * [[Development/Tutorials/Metadata/Nepomuk|Development Tutorials]]
     
    *'''[[Development/Tutorials/Metadata/Nepomuk/TipsAndTricks|Nepomuk Tips and Tricks]]'''
    '''Nepomuk Mailing List: ''' [email protected] <br/>
    * [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/index.html Nepomuk API Documentation]
    '''IRC Channel:''' #nepomuk-kde on freenode
    * [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]
    === Introductory Material ===
    If you're just getting started with Nepomuk and want to know a quick way to fetch some data.
     
    * [[Projects/Nepomuk/QuickStart| Quick Start]]
    * [[Projects/Nepomuk/OntologyBasics| Basic Ontology concepts]]
    * [[Projects/Nepomuk/Uris| Questions about URIs]]
     
    === 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 [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.
     
    * [[Projects/Nepomuk/Resources| Using Resources]]
    * [[Projects/Nepomuk/ResourceWatcher| Monitoring Changes]]
    * [[Projects/Nepomuk/BulkChanges| Bulk Changes]]
    * [[Projects/Nepomuk/DataFeeders| Data Feeders]]


    === 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.


    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:
    * [[Projects/Nepomuk/IndexingPlugin| Writing an Indexing Plugin]]
    * [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]


    == ToDo  ==
    === 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 is 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 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.
    * [[Projects/Nepomuk/QueryingMethods| Different ways to Query Nepomuk]]
    * [[Projects/Nepomuk/QueryLibrary| Nepomuk Query Library]]
    * [[Projects/Nepomuk/SparqlQueries| Sparql Queries]]


    If you are interested in working on a task in this list, please contact [mailto:[email protected] Sebastian Trueg].  
    === 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.


    === Low level Nepomuk Development Tasks  ===
    * [[Projects/Nepomuk/Repositories| Nepomuk Repositories]]
    * [[Projects/Nepomuk/ComponentOverview| Nepomuk Architectural Overview]]
    * [[Projects/Nepomuk/kioslaves| Nepomuk KIO Slaves]]


    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.
    === Nepomuk Internals ===
    When you decide to dig even deeper.


    == Development status ==
    * [[Projects/Nepomuk/GraphConcepts| Graph handling]]
    * [[Projects/Nepomuk/VirtuosoInternal| Virtuoso Internals]]
    * [[Projects/Nepomuk/OntologyExtention| Extending the Ontologies]]


    See [[Projects/Nepomuk/DevelopmentStatus]].
    === Miscellaneous ===
    * [[Projects/Nepomuk/Nepomuk2Port| Porting to Nepomuk2]]
    * [[Projects/Nepomuk/ManagingNepomukProcesses| Managing Nepomuk Processes]]
    * [[Projects/Nepomuk/TestEnvironment| Nepomuk Test Environment]]
    * [[Development/Tutorials/Metadata/Nepomuk/TipsAndTricks|Nepomuk Tips and Tricks]]
    * [[Projects/Nepomuk/NepomukShow| Debugging Nepomuk Data]]


    http://techbase.kde.org/Projects/Nepomuk/Ideas
    ==== Outdated links ====


    == Subpages of {{FULLPAGENAME}}==
    The following links provide good reads for getting used to the Nepomuk system and its APIs. <br\>
    {{Special:PrefixIndex/{{FULLPAGENAME}}/}}
    They are slightly outdated, but still has some useful material.
    * [[Development/Tutorials/Metadata/Nepomuk|Development Tutorials]]
    * [[Projects/Nepomuk/Ideas|Random Ideas]]
    * [[Projects/Nepomuk/Qualified_Relations_Idea| Qualified Relations Idea]]
    * [[Projects/Nepomuk/ScenarioExamples| Scenario Examples]]

    Revision as of 16:26, 7 November 2012


    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.

    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 is 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.