http://www.mediawiki.org/wiki/Special:Code/MediaWiki/88569
Revision: 88569
Author: mkroetzsch
Date: 2011-05-22 11:33:41 +0000 (Sun, 22 May 2011)
Log Message:
-----------
updated INSTALL and upgrade instructions for SMW 1.6
Modified Paths:
--------------
trunk/extensions/SemanticMediaWiki/INSTALL
Modified: trunk/extensions/SemanticMediaWiki/INSTALL
===================================================================
--- trunk/extensions/SemanticMediaWiki/INSTALL 2011-05-22 10:40:57 UTC (rev
88568)
+++ trunk/extensions/SemanticMediaWiki/INSTALL 2011-05-22 11:33:41 UTC (rev
88569)
@@ -1,4 +1,4 @@
-[[Semantic MediaWiki 1.5.6]]
+[[Semantic MediaWiki 1.6-beta]]
Install instructions for the latest SMW version are also online in a more
convenient format for reading:
@@ -52,10 +52,10 @@
SMW was set up. The script SMW_setup.php can use the DB credentials from
AdminSettings.php for this purpose, avoiding the need of extra rights for
the wiki DB user.
-* SMW creates and alters temporary tables for certain semantic queries. To do
- this, your wikidb user must have privileges for CREATE TEMPORARY TABLES. The
- according features can be disabled by adding the following to
- Localsettings.php:
+* When using SMWSQLStore2 (default data store for SMW), SMW creates and alters
+ temporary tables for certain semantic queries. To do this, your wikidb user
+ must have privileges for CREATE TEMPORARY TABLES. The according features can
+ be disabled by adding the following to Localsettings.php:
$smwgQSubcategoryDepth=0;
$smwgQPropertyDepth=0;
@@ -63,7 +63,10 @@
$smwgQConceptFeatures = SMW_ANY_QUERY & ~SMW_DISJUNCTION_QUERY &
~SMW_CONCEPT_QUERY;
+* When using SMWSparqlStore (RDF store connector), SMW uses the CURL functions
+ of PHP. These functions may have to be enabled/installed to be available.
+
== Installation ==
If you upgrade an existing installation of Semantic MediaWiki, also read the
@@ -88,21 +91,23 @@
Afterwards, activate the automatic data update ("Data repair and upgrade").
Note that the first step requires permissions to alter/create database
tables, as explained in the above note. The second step takes some time;
- go to Special:SMWAdmin to follow its progress. SMW can be used before
this
- completes, but will not have access to all data yet (e.g. page
categories).
+ go to Special:SMWAdmin to follow its progress. SMW can be used before this
+ completes, but will not have access to all data yet (e.g. page categories).
- Both of those actions can also be accomplished with the command-line PHP
- scripts SMW_setup.php and SMW_refreshData.php. Read the documentation in
- [SMW_path]/maintenance/README for details on how to run such scripts.
+ Both of those actions can also be accomplished with the command-line PHP
+ scripts SMW_setup.php and SMW_refreshData.php. Read the documentation in
+ [SMW_path]/maintenance/README for details on how to run such scripts.
'''Remark:''' Semantic MediaWiki uses ten additional namespace indexes (see
http://www.mediawiki.org/wiki/Manual:Using_custom_namespaces), in the range
from
-100 to 109. 100 and 101 are not used (they were used in early beta versions).
-106 and 107 are reserved for the SemanticForms extension. If you have your own
-custom namespaces, you have to set the parameter $smwgNamespaceIndex before
-including SemanticMediaWiki.php. See the documentation $within
SMW_Settings.php for
-details. If you add more namespaces later on, then you have to assign them to
-higher numbers than those used by Semantic MediaWiki.
+100 to 109. 100 and 101 are not used (they were used in early beta versions),
+104 and 105 are not used by default (they were used for the Type namespace in
+SMW up to 1.5.*). 106 and 107 are reserved for the SemanticForms extension. If
+you have your own custom namespaces, you have to set the parameter
+$smwgNamespaceIndex before including SemanticMediaWiki.php. See the
+documentation $within SMW_Settings.php for details. If you add more namespaces
+later on, then you have to assign them to higher numbers than those used by
+Semantic MediaWiki.
=== Testing your Installation ===
@@ -143,11 +148,19 @@
(Please read all of this before upgrading)
-Installations of SMW 1.5.* can be upgraded by just replacing the files, and all
-extensions compatible with SMW 1.5.1 should work without modification. If
-problems occur, it is possible to go back to 1.5.1 by simply using the old
-files, waiting with the upgrade until the relevant extensions provide updates.
+Installations of SMW 1.5.* and can be upgraded by replacing the files, and by
+running the database update (Special:SMWAdmin or SMW_setup.php script) as
usual.
+Moreover, it is strongly suggested to enable the refresh process to update all
+data on Special:SMWAdmin. Older versions of SMW can be upgraded in the same
way,
+but there can be more feature chagnes that require changes of wiki pages. See
+the current documentation for details on using the current version.
+Extensions for SMW versions up to 1.5.* should not be assumed to work
+with SMW 1.6 out of the box. All SMW extensions should be upgraded to versions
+that are compatible with SMW 1.6. Moreover, some functions changed and pages
+might need updates (see sbelow). Additional remarks on upgrading older SMW
+versions are given below.
+
If not done already, it is suggested to change the inclusion of SMW in
LocalSettings.php to the following as described in the installation
instructions above:
@@ -157,74 +170,67 @@
Including SMW_Settings.php as in earlier versions will continue to work, but
may
be disabled in some future version.
-Existing SMW 1.4.* installations and all SMW installations that already use the
-default store (SMWSQLStore2) can basically follow the above installation steps.
-The latter covers all sites with SMW 1.2 to 1.3 that do not use a special
-setting to switch back to the old store ("SMWSQLStore" or "SMWRAPStore").
-Older versions of SMW can be upgrade in a similar fashion, but must ensure that
-they do not depend on now peculiarities of the old version. Please read the
-upgrade instructions for SMW version 1.2 and 1.3 for details. Moreover,
-SMW 1.5.0 finally removed all backwards compatibility to SMW beta versions
-below SMW 1.0. If your wiki still uses the setting $smwgSMWBetaCompatible=true
-then you should not upgrade until you find that disabling this setting works
-properly and without complications.
+The main user-visible changes in SMW 1.6 concern the Type namespace, the use of
+custom units of measurement (with custom conversion factors), and the
+declaration of Type:Record properties. Moreover, the support for the RAP was
+replaced by general RDF store support. Please see the documentation for details
+on how to configure this.
-There are two changes in SMW functionality that may affect some sites that used
-earlier versions. Additional steps are required if the wiki uses n-ary
-(multivalued) properties or properties of type Geographic coordinate and the
-required upgrade steps are described in separate sections below.
+Users who update from SMW 1.4 or earlier hould note that "n-ary" properties now
+are declared by properties of Type:Record as explained below, and that support
+for geographic coordinates has moved to the Semantic Maps extension. For
+upgrading earlier SMW versions, users should have a look at upgrade
instructions
+released with SMW 1.5.
-Directly after enabling SMW 1.5.1, it could potentially happen that the site
-shows SQL errors due to background jobs trying to access the new DB structure
-even before you initialised it. This can even block you from reaching SMWAdmin.
-In this case, either use the script SMW_setup.php from the command-line, or
-access your database and delete all entries in the table "job". After this, no
-errors should show up while accessing the special page for initialisation.
-When upgrading from SMW 1.4.* or older, extensions of SMW (e.g. Semantic Forms)
-need to be updated to a version that is compatible with SMW 1.5.1. See your
-extension's homepage for details. If used, it is also necessary to update to a
-more recent version of SemanticResultFormats (SRF).
+=== Type namespace ===
-=== Upgrading geographic coordinates ===
+SMW no longer uses namespaces "Type" and "Type talk." All types are now
built-in
+and there is no good reason to keep a namespace just for documenting them. A
new
+function of Special:Types allows viewing all properties of a type, like the
Type
+pages did before.
-The datatype Geographic coordinate has been moved from SMW to the Semantic Maps
-extension. Wikis that use this type should install Semantic Maps version 0.6
-or above. No other changes are needed, but it is recommended to install
-Semantic Maps before upgrading SMW so as to avoid problems at any time. The
-move has been done to concentrate geo-related features in one extension for
-better maintenance and ease of use.
+If you still want to use Type (for example to access pages that existed there),
+you should set $smwgHistoricTypeNamespace = true; before including SMW in
+LocalSettings.php. This should only be used to move old content to a better
+place. The old namespaces will not be kept indefinitely.
-=== Upgrading n-ary (multivalued) properties ===
-The way how these properties are declared on their property pages has changed
-since SMW 1.4.3, and it is necessary to change the pages of all such properties
-to use them again as before. Until SMW 1.4.*, such properties were declared by
-type declarations as in the following example:
+=== Custom units ===
- <nowiki>[[has type::Page; Number; String]]</nowiki>
+The only use of Type pages was the declaration of custom types that would allow
+unit conversion. The declaration of properties with custom units of measurement
+has changed in two ways:
-In this case, a property with three fields of the specified types was declared.
-You can use the inline query {{#ask: [[has type::~ *;*]] }} to obtain a list of
-all properties in your wiki that are of this form at all. Since SMW 1.5.0, two
-property assignments must be made on the property page instead:
+(1) The type of these properties is now "Quantity" (not a "custom" type page)
+(2) The conversion factors that used to be on the Type page are not given on
the
+ property page. So one can simply move this text (Type must be activated for
+ this as described above).
- <nowiki>[[has type::Record]]</nowiki>
+The internal data format of SMW has not changed for custom units, so stored
data
+will be accessible immediately after the change.
+
+
+=== Type:Record ===
+
+The fields declaration of Type:Record properties now refer to properties, not
to
+types. If you have a property with [[has type::Record]] that uses a setting
like
+
<nowiki>[[has fields::Page; Number; String]]</nowiki>
-In other words, all "n-ary" properties are now of the new datatype Record, and
-the information about their fields is stated independently. This change allowed
-for many improvements in SMW, and makes it possible to create new (better)
-extensions for supporting compound property values in the future.
+then you should now replace it with something like
-To upgrade, ''first'' install the new version of SMW, then use the above inline
-query to efficiently find all properties that need to be changed. After
-updating the pages as required, all values should be accessible as before
-(possibly some repair jobs need to finish before this is really the case; check
-your job queue). If you change the pages before the upgrade to SMW 1.5.1, then
-it will be necessary to start a repair cycle of SMW to ensure that all affected
-page are indeed updated.
+ <nowiki>[[has fields::my page; my number; my string]]</nowiki>
+where "my page", "my number", and "my string" are properties in your wiki that
+have the right types. The use of properties instead of types is better since it
+allows custom settings beyond the datatype of a field (e.g. conversion
factors).
+
+The new method also involves internal changes in the data format, and it is not
+possible to make the update without tmporarily loosing access to the stored
data
+for Type:Record properties (until SMW's self repair has fixed all data
entries).
+
+
=== Changed configuration options ===
Some configuration options (used in LocalSettings.php) have changed since SMW
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
