Projects/Nepomuk: Difference between revisions

    From KDE TechBase
    (33 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.


    This page is dedicated to 3rd 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 [http://community.kde.org/Projects/Nepomuk Nepomuk page on Community].
    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 ==
    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.
     
    '''Nepomuk Mailing List: ''' [email protected] <br/>
    '''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.
     
    * [[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.
     
    * [[Projects/Nepomuk/IndexingPlugin| 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 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.
     
    * [[Projects/Nepomuk/QueryingMethods| Different ways to Query Nepomuk]]
    * [[Projects/Nepomuk/QueryLibrary| Nepomuk Query Library]]
    * [[Projects/Nepomuk/SparqlQueries| Sparql Queries]]
     
    === 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.


    == Basic Overview ==
    * [[Projects/Nepomuk/Repositories| Nepomuk Repositories]]
    * [[Projects/Nepomuk/Repositories| Nepomuk Repositories]]
    * [[Projects/Nepomuk/ComponentOverview| Nepomuk Architecture Overview]]
    * [[Projects/Nepomuk/ComponentOverview| Nepomuk Architectural Overview]]
    * [[Projects/Nepomuk/kioslaves| Nepomuk KIO Slaves]]


    == Documentation ==
    === Nepomuk Internals ===
    When you decide to dig even deeper.


    The following links provide good reads for getting used to the Nepomuk system and its APIs.
    * [[Projects/Nepomuk/GraphConcepts| Graph handling]]
    * [[Development/Tutorials/Metadata/Nepomuk|Development Tutorials]]
    * [[Projects/Nepomuk/VirtuosoInternal| Virtuoso Internals]]
    * [[Development/Tutorials/Metadata/Nepomuk/TipsAndTricks|Nepomuk Tips and Tricks]]
    * [[Projects/Nepomuk/OntologyExtention| Extending the Ontologies]]
    * [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/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]


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


    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:
    ==== Outdated links ====
    * [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]


    == 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 20:30, 3 December 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.