marmotta-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sschaff...@apache.org
Subject svn commit: r1450753 - in /incubator/marmotta/site/trunk/content: ./ markdown/ markdown/ldclient/ markdown/platform/
Date Wed, 27 Feb 2013 11:45:19 GMT
Author: sschaffert
Date: Wed Feb 27 11:45:19 2013
New Revision: 1450753

URL: http://svn.apache.org/r1450753
Log:
updated documentation, added platform menu and subdirectory

Added:
    incubator/marmotta/site/trunk/content/markdown/platform/
    incubator/marmotta/site/trunk/content/markdown/platform/client-library.md
      - copied unchanged from r1450699, incubator/marmotta/site/trunk/content/markdown/client-library.md
    incubator/marmotta/site/trunk/content/markdown/platform/core-module.md.vm
    incubator/marmotta/site/trunk/content/markdown/platform/introduction.md.vm
    incubator/marmotta/site/trunk/content/markdown/platform/ldcache-module.md.vm
    incubator/marmotta/site/trunk/content/markdown/platform/ldpath-module.md.vm
    incubator/marmotta/site/trunk/content/markdown/platform/reasoner-module.md.vm
    incubator/marmotta/site/trunk/content/markdown/platform/security-module.md.vm
    incubator/marmotta/site/trunk/content/markdown/platform/sesame.md
      - copied unchanged from r1450699, incubator/marmotta/site/trunk/content/markdown/sesame.md
    incubator/marmotta/site/trunk/content/markdown/platform/sparql-module.md.vm
    incubator/marmotta/site/trunk/content/markdown/platform/user-module.md.vm
    incubator/marmotta/site/trunk/content/markdown/platform/versioning-module.md.vm
Removed:
    incubator/marmotta/site/trunk/content/markdown/client-library.md
    incubator/marmotta/site/trunk/content/markdown/sesame.md
Modified:
    incubator/marmotta/site/trunk/content/markdown/ldclient/modules.md.vm
    incubator/marmotta/site/trunk/content/site.xml

Modified: incubator/marmotta/site/trunk/content/markdown/ldclient/modules.md.vm
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/ldclient/modules.md.vm?rev=1450753&r1=1450752&r2=1450753&view=diff
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/ldclient/modules.md.vm (original)
+++ incubator/marmotta/site/trunk/content/markdown/ldclient/modules.md.vm Wed Feb 27 11:45:19
2013
@@ -105,6 +105,12 @@ Similarly, channels and playlists are re
 Vimeo Module
 ------------
 
+Similar to the YouTube module, the Vimeo module allows you to access Vimeo videos and groups
(including channels) as
+if they were Linked Data resources. When requesting metadata about a resource, it redirects
the request to the Vimeo
+API, processes the result, and maps the proprietary properties to RDF using the [Ontology
for Media Resources][1]. It is
+thus possible to access Vimeo and YouTube videos in the same way. To use the Vimeo module
in your project, add the
+following dependency to your build:
+
 
     <dependency>
         <groupId>org.apache.marmotta</groupId>
@@ -113,9 +119,39 @@ Vimeo Module
     </dependency>
 
 
+The library will automatically register endpoints with default configurations for Vimeo videos,
groups and channels
+accessible via the main Vimeo website (http://vimeo.com). With this configuration you can
directly retrieve metadata
+about Vimeo resources using the LDClient, no further configuration is needed.
+
+Using the [Ontology for Media Resources][1], the module will create the following triples
when requesting a video
+resource. Note that the Vimeo API provides significantly less details than the YouTube API:
+
+* `rdf:type` will be `ma:MediaResource` and `ma:VideoTrack`
+* `ma:title` will be the title of the video on Vimeo
+* `ma:locator` will be the URL of the actual video on the platform
+* `ma:hasCreator` and `ma:hasPublisher` will point to the resource URI of the user who uploaded
the video
+* `ma:date` will be set to the publication date of the video
+* `ma:description` will contain the textual description provided by the publisher
+* `ma:hasKeyword` will contain the keywords the publisher associated with the video
+* `ma:duration` will contain the duration of the video in seconds
+* `foaf:thumbnail` will contain references to thumbnail images of the video
+* `sioc:num_views` will contain the number of views of the video at the time of retrieval
+* `sioc:num_replies` will contain the number of comments on the video at the time of retrieval
+
+Similarly, channels and playlists are represented using the Media Collections offered by
the Ontology for Media Resources:
+
+* `rdf:type` will be `ma:Collection`
+* `ma:hasMember` points to the resource URIs of all videos contained in the channel or group
+
+
 MediaWiki Module
 ----------------
 
+The MediaWiki module allows accessing content and metadata of wiki articles managed by a
[MediaWiki](http://wwww.mediawiki.org)
+system (the most prominent being Wikipedia). When requesting a resource that represents a
wiki article, this module
+will instead retrieve the article from the MediaWiki API offered by the wiki installation
and provide access to
+many metadata properties otherwise not accessible. To use the MediaWiki module in your own
project, add the following
+dependency to your project build:
 
     <dependency>
         <groupId>org.apache.marmotta</groupId>
@@ -123,11 +159,30 @@ MediaWiki Module
         <version>${projectVersion}</version>
     </dependency>
 
+The module auto-registers endpoints that map requests to all language versions of Wikipedia
to the respective API
+service endpoint, so if you want to request only Wikipedia articles, no further action is
needed. For any other
+MediaWiki installation, it is necessary to create an endpoint configuration and add it to
the LDClient instance
+you are using (see the WikipediaPageEndpoint source code as an example).
+
+The MediaWiki provider creates triples for a wiki page using SIOC and Dublin Core as follows:
+
+* `rdf:type` will be `sioc:WikiArticle`
+* `dct:title` will be the title of the wiki page
+* `dct:identifier` will be the page identifier in the MediaWiki database
+* `dct:modified` will be the last modification date of the page
+* `dct:created` will be the creation date of the page
+* `content:encoded` will be the content of the page in MediaWiki syntax
+* `sioc:topic` will be references to all resource URIs of MediaWiki categories used by the
wiki page
+* `sioc:links_to` will be references to all resource URIs of wiki pages the page links to
 
 
 PHPBB Module
 ------------
 
+The PHPBB module tries to parse the HTML pages generated by a PHPBB discussion forum and
extract posts and threads
+from the content. Since PHPBB does not offer an RSS feed or service API, this extraction
is unreliable at best,
+because it depends heavily on the layout and theming of the page. We tried to make it as
generic as possible, though.
+If you want to try out the module, include the following dependency to your project build:
 
     <dependency>
         <groupId>org.apache.marmotta</groupId>
@@ -135,6 +190,16 @@ PHPBB Module
         <version>${projectVersion}</version>
     </dependency>
 
+The module does not auto-register any endpoints, but it offers simplified endpoint classes
that allow a more convenient
+configuration of endpoints. If you want to configure all endpoints for a PHPBB site, simply
use
+
+    PHPBBEndpoints.getEndpoints("http://www.carving-ski.de/phpBB/,"Carving Ski Forum");
+
+where the first argument is the URL of the PHPBB installation and the second argument gives
a human-readable name
+to the endpoint configuration. The method returns a set of endpoints that can be directly
added to an LDClient instance.
+
+
+
 
 LDAP Module
 -----------

Added: incubator/marmotta/site/trunk/content/markdown/platform/core-module.md.vm
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/platform/core-module.md.vm?rev=1450753&view=auto
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/platform/core-module.md.vm (added)
+++ incubator/marmotta/site/trunk/content/markdown/platform/core-module.md.vm Wed Feb 27 11:45:19
2013
@@ -0,0 +1,3 @@
+# Apache Marmotta Platform: Core
+
+@TODO@
\ No newline at end of file

Added: incubator/marmotta/site/trunk/content/markdown/platform/introduction.md.vm
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/platform/introduction.md.vm?rev=1450753&view=auto
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/platform/introduction.md.vm (added)
+++ incubator/marmotta/site/trunk/content/markdown/platform/introduction.md.vm Wed Feb 27
11:45:19 2013
@@ -0,0 +1,4 @@
+# Introduction
+
+@TODO@
+

Added: incubator/marmotta/site/trunk/content/markdown/platform/ldcache-module.md.vm
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/platform/ldcache-module.md.vm?rev=1450753&view=auto
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/platform/ldcache-module.md.vm (added)
+++ incubator/marmotta/site/trunk/content/markdown/platform/ldcache-module.md.vm Wed Feb 27
11:45:19 2013
@@ -0,0 +1,3 @@
+# Apache Marmotta Platform: LDCache
+
+@TODO@

Added: incubator/marmotta/site/trunk/content/markdown/platform/ldpath-module.md.vm
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/platform/ldpath-module.md.vm?rev=1450753&view=auto
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/platform/ldpath-module.md.vm (added)
+++ incubator/marmotta/site/trunk/content/markdown/platform/ldpath-module.md.vm Wed Feb 27
11:45:19 2013
@@ -0,0 +1,3 @@
+# Apache Marmotta Platform: LDPath
+
+@TODO@

Added: incubator/marmotta/site/trunk/content/markdown/platform/reasoner-module.md.vm
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/platform/reasoner-module.md.vm?rev=1450753&view=auto
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/platform/reasoner-module.md.vm (added)
+++ incubator/marmotta/site/trunk/content/markdown/platform/reasoner-module.md.vm Wed Feb
27 11:45:19 2013
@@ -0,0 +1,3 @@
+# Apache Marmotta Platform: Reasoner
+
+@TODO@

Added: incubator/marmotta/site/trunk/content/markdown/platform/security-module.md.vm
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/platform/security-module.md.vm?rev=1450753&view=auto
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/platform/security-module.md.vm (added)
+++ incubator/marmotta/site/trunk/content/markdown/platform/security-module.md.vm Wed Feb
27 11:45:19 2013
@@ -0,0 +1,3 @@
+# Apache Marmotta Platform: Security
+
+@TODO@

Added: incubator/marmotta/site/trunk/content/markdown/platform/sparql-module.md.vm
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/platform/sparql-module.md.vm?rev=1450753&view=auto
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/platform/sparql-module.md.vm (added)
+++ incubator/marmotta/site/trunk/content/markdown/platform/sparql-module.md.vm Wed Feb 27
11:45:19 2013
@@ -0,0 +1,3 @@
+# Apache Marmotta Platform: SPARQL
+
+@TODO@

Added: incubator/marmotta/site/trunk/content/markdown/platform/user-module.md.vm
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/platform/user-module.md.vm?rev=1450753&view=auto
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/platform/user-module.md.vm (added)
+++ incubator/marmotta/site/trunk/content/markdown/platform/user-module.md.vm Wed Feb 27 11:45:19
2013
@@ -0,0 +1 @@
+# Apache Marmotta Platform: User Management
\ No newline at end of file

Added: incubator/marmotta/site/trunk/content/markdown/platform/versioning-module.md.vm
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/platform/versioning-module.md.vm?rev=1450753&view=auto
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/platform/versioning-module.md.vm (added)
+++ incubator/marmotta/site/trunk/content/markdown/platform/versioning-module.md.vm Wed Feb
27 11:45:19 2013
@@ -0,0 +1,3 @@
+# Apache Marmotta Platform: Versioning
+
+@TODO@

Modified: incubator/marmotta/site/trunk/content/site.xml
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/site.xml?rev=1450753&r1=1450752&r2=1450753&view=diff
==============================================================================
--- incubator/marmotta/site/trunk/content/site.xml (original)
+++ incubator/marmotta/site/trunk/content/site.xml Wed Feb 27 11:45:19 2013
@@ -67,6 +67,19 @@
             <item name="Privacy" href="privacy.html" />
         </menu>    
         <!--<menu ref="parent" inherit="bottom" />-->
+        <menu name="Platform">
+            <item name="Introduction" href="platform/introduction.html" />
+            <item name="Core Module" href="platform/core-module.html" />
+            <item name="LDCache Module" href="platform/ldcache-module.html" />
+            <item name="LDPath Module" href="platform/ldpath-module.html" />
+            <item name="Reasoner Module" href="platform/reasoner-module.html" />
+            <item name="Security Module" href="platform/security-module.html" />
+            <item name="SPARQL Module" href="platform/sparql-module.html" />
+            <item name="User Module" href="platform/user-module.html" />
+            <item name="Versioning Module" href="platform/versioning-module.html" />
+            <item name="Client Library" href="client-library.html" />
+            <item name="Sesame Tools" href="sesame.html" />
+        </menu>
         <menu name="KiWi Triple Store">
             <item name="Introduction" href="kiwi/introduction.html"/>
             <item name="Store" href="kiwi/triplestore.html"/>
@@ -90,10 +103,12 @@
             <item name="Usage" href="ldpath/usage.html"/>
             <item name="Backends" href="ldpath/backends.html"/>
         </menu>
+<!--
         <menu name="Commons">
             <item name="Client Library" href="client-library.html" />
             <item name="Sesame Tools" href="sesame.html" />
         </menu>
+-->
         <menu name="Reports" ref="reports" inherit="top" />
         <menu name="The ASF">
             <item name="The Apache Software Foundation" href="http://www.apache.org" />



Mime
View raw message