Updated for SMW 1.9 and new SB location
← Older revision
Revision as of 14:43, 28 April 2014
Line 1:
Line 1:
−
'''Semantic Bundle''' (abbreviated as SB) is a pre-packaged bundle of extensions for use with wikis that are based around the [[Extension:Semantic MediaWiki|Semantic MediaWiki]] extension. It can be obtained either through Git or by downloading a single
.7z,
.tgz or .zip file.
+
'''Semantic Bundle''' (abbreviated as SB) is a pre-packaged bundle of extensions for use with wikis that are based around the [[Extension:Semantic MediaWiki|Semantic MediaWiki]] extension. It can be obtained either through Git or by downloading a single .tgz or .zip file.
==Contents==
==Contents==
−
Semantic Bundle contains a large number of MediaWiki extensions
; chief among them is
,
of
course,
[[Extension:Semantic
MediaWiki|Semantic
MediaWiki]],
an
extension
that
enables semantic storage and querying
of
data. Other SMW-based extensions included in this bundle are
:
+
Semantic Bundle contains a large number of MediaWiki extensions,
and
several
other
PHP
libraries.
Chief
among
them
is
of
course
:
+
* [[Extension:Semantic MediaWiki|Semantic MediaWiki]], an extension that enables semantic storage and querying of data
+
+
There are also libraries and extensions required by Semantic MediaWiki:
+
* The DataValues extensions: [[Extension:DataValues|DataValues]], [[Extension:DataValuesCommon|DataValuesCommon]], [[Extension:DataValuesInterfaces|DataValuesInterfaces]], [https://github.com/DataValues/Geo Geo], [https://github.com/DataValues/Time Time] and [https://github.com/DataValues/Validators Validators]
+
* [[Extension:Validator|Validator]] - a parameter-handling framework for MediaWiki and extensions
+
* [https://github.com/JeroenDeDauw/ParamProcessor ParamProcessor] - a PHP library used by Validator
+
+
Other SMW-based extensions included in this bundle are:
* [[Extension:Semantic Result Formats|Semantic Result Formats]] - defines many additional formats for SMW queries
* [[Extension:Semantic Result Formats|Semantic Result Formats]] - defines many additional formats for SMW queries
* [[Extension:Semantic Forms|Semantic Forms]] - allows wiki administrators to create easy-to-use editing and querying interfaces for their wiki
* [[Extension:Semantic Forms|Semantic Forms]] - allows wiki administrators to create easy-to-use editing and querying interfaces for their wiki
Line 14:
Line 14:
* [[Extension:Semantic Image Input|Semantic Image Input]] - allows for automatic adding of images from Wikipedia pages via a Semantic Forms input
* [[Extension:Semantic Image Input|Semantic Image Input]] - allows for automatic adding of images from Wikipedia pages via a Semantic Forms input
−
There
are other extensions included in Semantic Bundle that, though they do not use Semantic MediaWiki directly, are often used in conjunction with SMW. These are:
+
Finally, there
are other extensions included in Semantic Bundle that, though they do not use Semantic MediaWiki directly, are often used in conjunction with SMW. These are:
* [[Extension:Admin Links|Admin Links]] - defines a special page that serves as a "control panel" for administrative tasks
* [[Extension:Admin Links|Admin Links]] - defines a special page that serves as a "control panel" for administrative tasks
* [[Extension:Approved Revs|Approved Revs]] - allows for setting a single revision of any page as the "approved" one; if the page contains any SMW data, it's the approved revision's version that is stored
* [[Extension:Approved Revs|Approved Revs]] - allows for setting a single revision of any page as the "approved" one; if the page contains any SMW data, it's the approved revision's version that is stored
Line 24:
Line 24:
* [[Extension:Page Schemas|Page Schemas]] - lets users define a schema for each category that can be used to automatically generate templates, forms, etc. for that category
* [[Extension:Page Schemas|Page Schemas]] - lets users define a schema for each category that can be used to automatically generate templates, forms, etc. for that category
* [[Extension:Replace Text|Replace Text]] - provides a form for administrators to do a text search-and-replace across the wiki
* [[Extension:Replace Text|Replace Text]] - provides a form for administrators to do a text search-and-replace across the wiki
−
* [[Extension:Validator|Validator]] - parameter-handling framework for MediaWiki and extensions; required by Semantic MediaWiki
* [[Extension:Widgets|Widgets]] - allows adding widgets to the wiki by simply creating pages in the "Widget:" namespace
* [[Extension:Widgets|Widgets]] - allows adding widgets to the wiki by simply creating pages in the "Widget:" namespace
+
+
+
--------------------------------
+
Semantic Bundle is not at all meant to be a comprehensive set of useful extensions, and there are many other extensions that are also quite useful, either in conjunction with SMW or in general, that were not included in the bundle. Most notably, there are various extensions that are bundled into MediaWiki, and thus don't need to be included in SB:
Semantic Bundle is not at all meant to be a comprehensive set of useful extensions, and there are many other extensions that are also quite useful, either in conjunction with SMW or in general, that were not included in the bundle. Most notably, there are various extensions that are bundled into MediaWiki, and thus don't need to be included in SB:
Line 34:
Line 37:
== Download ==
== Download ==
−
Semantic Bundle is available either as a downloadable .zip
, 7z
or .tgz file, or via
SVN
.
+
Semantic Bundle is available either as a downloadable .zip or .tgz file, or via
Git
.
=== Package download ===
=== Package download ===
−
You can
get these files at
the
[https://code.google.com/p/semantic-mediawiki-bundle/downloads/list '''download
page''']
of
the [https://code.google.com/p/semantic-mediawiki-bundle/
Semantic Bundle
Google
Code
project].
Once you have the
.
zip, 7z or
.
tgz file
,
you
should
move it to
the
/extensions
directory and extract it there.
+
You can
download
the
current
version
of Semantic Bundle
,
corresponding
to
Semantic
MediaWiki
1
.
9
.
2
,
at
either
of
the
following
URLs:
+
* [https://docs.google.com/file/d/0B3i-pfyNssSZUmV1ZGhWSF9HSmc/edit SemanticBundle-20140428.zip]
+
* [https://docs.google.com/file/d/0B3i-pfyNssSZb1VEOGpsekM2bnM/edit SemanticBundle-20140428.tgz]
+
+
At either page, select "File > Download" or hit "Ctrl + s" to download the file.
+
+
Once you have the .zip or .tgz file, you should move it to the /extensions directory and extract it there.
+
+
Until 2014, Semantic Bundle was available at [https://code.google.com/p/semantic-mediawiki-bundle/ Google Code]. Unfortunately, in early 2014 Google Code stopped allowing downloaded files, which is why the location moved. However, old downloads can still be found at that site.
=== Downloading using Git (experimental) ===
=== Downloading using Git (experimental) ===
Line 49:
Line 52:
make
make
−
this will create
[http://svnbook.red-bean.com/en/1.0/ch07s03.html SVN
externals
]
in your <code>/extensions</code> folder for all the extensions in the bundle and will automatically run svn update to fetch all the components of the bundle.
+
this will create externals in your <code>/extensions</code> folder for all the extensions in the bundle and will automatically run svn update to fetch all the components of the bundle.
To check out development releases (trunks) of all the extensions in the bundle instead, run:
To check out development releases (trunks) of all the extensions in the bundle instead, run:
Line 56:
Line 59:
this will modify the externals and run update again switching over to trunk releases.
this will modify the externals and run update again switching over to trunk releases.
−
'''Note:''' if your MediaWiki is not managed using
SVN
, you can get the latest version of Semantic Bundle using the
SVN
command above, then type:
+
'''Note:''' if your MediaWiki is not managed using
Git
, you can get the latest version of Semantic Bundle using the
Git
command above, then type:
make all
make all
Line 64:
Line 67:
Extracting the files will create directories under <code>/extensions</code> for each of the extensions contained in Semantic Bundle.
Extracting the files will create directories under <code>/extensions</code> for each of the extensions contained in Semantic Bundle.
−
If you enter the
"<code>semantic-bundle</code>" or
"<code>SemanticBundle</code>" directory, you will see
<code>SemanticBundleSettings.sample.php</code> and <code>SemanticBundle.php</code>, among several other files.
<code>SemanticBundleSettings.sample.php</code> contains calls to include all the extensions that Semantic Bundle contains. By default, the calls to all extensions but Semantic MediaWiki are commented out
;
''
don
't un-comment until after
Initializing
Semantic MediaWiki
,
see below.''
+
If you enter the "<code>SemanticBundle</code>" directory, you will see <code>SemanticBundleSettings.sample.php</code> and <code>SemanticBundle.php</code>, among several other files. <code>SemanticBundleSettings.sample.php</code> contains calls to include all the extensions that Semantic Bundle contains. By default, the calls to all extensions but Semantic MediaWiki are commented out
.
''
Don
't un-comment
these
until after
initializing
Semantic MediaWiki
;
see below.''
Copy the existing <code>SemanticBundleSettings.sample.php</code> file to a new file, named <code>SemanticBundleSettings.php</code>. You shouldn't directly use <code>SemanticBundleSettings.sample.php</code> (even though it's possible), because any changes you make to the file <code>SemanticBundleSettings.sample.php</code> will be lost if you ever upgrade to a new version of Semantic Bundle.
Copy the existing <code>SemanticBundleSettings.sample.php</code> file to a new file, named <code>SemanticBundleSettings.php</code>. You shouldn't directly use <code>SemanticBundleSettings.sample.php</code> (even though it's possible), because any changes you make to the file <code>SemanticBundleSettings.sample.php</code> will be lost if you ever upgrade to a new version of Semantic Bundle.
Line 74:
Line 77:
require_once( "$IP/extensions/SemanticBundle/SemanticBundle.php" );
require_once( "$IP/extensions/SemanticBundle/SemanticBundle.php" );
</source>
</source>
−
−
If you got the code from git or a recent release, replace "semantic-bundle" with "SemanticBundle".
It should be noted that <code>SemanticBundle.php</code> isn't actually required - but it holds version information for Semantic Bundle, which can help with debugging; and it's also good marketing for the Semantic Bundle project - so we ask you to please consider including it.
It should be noted that <code>SemanticBundle.php</code> isn't actually required - but it holds version information for Semantic Bundle, which can help with debugging; and it's also good marketing for the Semantic Bundle project - so we ask you to please consider including it.
Line 99:
Line 100:
==Authors==
==Authors==
−
Semantic Bundle was initially created by [[User:Sergey Chernyshev|Sergey Chernyshev]] and [[User:Yaron Koren|Yaron Koren]] in May 2008. It
is
currently
maintained by Yaron Koren and [[User:Jeroen De Dauw|Jeroen De Dauw]].
+
Semantic Bundle was initially created by [[User:Sergey Chernyshev|Sergey Chernyshev]] and [[User:Yaron Koren|Yaron Koren]] in May 2008. It
was
later
maintained by Yaron Koren and [[User:Jeroen De Dauw|Jeroen De Dauw]]
. It is currently maintained by Yaron Koren
.
==License==
==License==
Line 105:
Line 106:
Each extension in the bundle uses its own license, however: please consult extension pages for licensing details.
Each extension in the bundle uses its own license, however: please consult extension pages for licensing details.
−
−
==More information==
−
More information, and bug reporting, is available at the [http://code.google.com/p/semantic-mediawiki-bundle/ Semantic Bundle Google Code page].
[[Category:MediaWiki Development]]
[[Category:MediaWiki Development]]