| Index: trunk/extensions/SemanticMediaWiki/INSTALL |
| — | — | @@ -1,4 +1,4 @@ |
| 2 | | -[[Semantic MediaWiki 1.0 RC3]] |
| | 2 | +[[Semantic MediaWiki 1.0]] |
| 3 | 3 | |
| 4 | 4 | Contents: |
| 5 | 5 | * Disclaimer |
| — | — | @@ -9,6 +9,7 @@ |
| 10 | 10 | ** Running SMW on older versions of MediaWiki |
| 11 | 11 | * Notes on Upgrading |
| 12 | 12 | ** General Upgrading Instructions |
| | 13 | + ** Upgrading from 1.0 RC1, 1.0 RC2, 1.0 RC3 |
| 13 | 14 | ** Upgrading from version 0.7 |
| 14 | 15 | ** Upgrading from versions 0.6 and 0.5 |
| 15 | 16 | ** Upgrading from 0.4.x |
| — | — | @@ -28,7 +29,7 @@ |
| 29 | 30 | |
| 30 | 31 | == Requirements == |
| 31 | 32 | |
| 32 | | -* MediaWiki 1.11.* or greater (tested from 1.11.0 to 1.12alpha, 1.10.* also may still work to some extent). |
| | 33 | +* MediaWiki 1.11.* or greater (tested from 1.11.0 to 1.12alpha (r29006), 1.10.* works with some restrictions). |
| 33 | 34 | * PHP 5.x or greater installed and working |
| 34 | 35 | * MySQL >= 4.0.14 (version required by MediaWiki) |
| 35 | 36 | |
| — | — | @@ -98,6 +99,42 @@ |
| 99 | 100 | are available are documented in the file SMW_Settings.php. Do not change this |
| 100 | 101 | file directly, but make all adoptions in your LocalSettings.php. |
| 101 | 102 | |
| | 103 | +==== Semantic MediaWiki on small wikis -- extended features ==== |
| | 104 | + |
| | 105 | +Some features of SMW are turned off by default, since they could slow down larger |
| | 106 | +sites. If you run a small site or have a very controlled user base, then you may |
| | 107 | +wish to enable these additional features. Suggested entries for LocalSettings.php |
| | 108 | +are: |
| | 109 | + |
| | 110 | +$smwgQEqualitySupport = SMW_EQ_FULL; // always interpret redirects as equality in queries |
| | 111 | +$smwgQComparators = '<|>|!|~'; // enable the pattern search comparator ~ for strings |
| | 112 | + |
| | 113 | +Further relaxation of default limits e.g. on query size are possible. See SMW_Settings.php. |
| | 114 | + |
| | 115 | +==== Semantic MediaWiki on very large wikis -- improving performance ==== |
| | 116 | + |
| | 117 | +On very large or high traffic sites, further restriction of SMW features might be desirable |
| | 118 | +for performance reasons. Besides setting up the usual external caches and distributed |
| | 119 | +DB-servers, you can also modify some SMW options to increase speed (while switching off |
| | 120 | +features). Try some or all of the below in LocalSettings.php: |
| | 121 | + |
| | 122 | +$smwgQEnabled = false; // most radical -- no more semantic queries, just browsing/display features |
| | 123 | +$smwgQSubcategoryDepth = 0; // disable subcategory reasoning in queries |
| | 124 | +$smwgQSubpropertyDepth = 0; // disable subproperty reasoning in queries |
| | 125 | +$smwgQDisjunctionSupport = false; // completely disable disjunctions in queries |
| | 126 | +$smwgQMaxSize = 5; // allow only queries of 5 or fewer conditions (default 12) |
| | 127 | +$smwgQMaxDepth = 2; // allow only queries of depth 2 or smaller (default 4) |
| | 128 | +$smwgQMaxLimit = 100; // never ever return more than 100 results to a query (default 10000) |
| | 129 | +$smwgQDefaultLimit = 10; // only return 10 query results by default |
| | 130 | +$smwgRSSWithPages = false; // do not include pages into RSS feeds, speeds up feed generation |
| | 131 | +$smwgRSSEnabled = false; // switch off RSS feeds completely, so as not to atttract too many queries |
| | 132 | + |
| | 133 | +These settings have different effects, and their effectiveness depends very much on the |
| | 134 | +usage and content structure of your wiki. You may wich to try out conservative settings |
| | 135 | +first and relax these step by step when things work reliably. If you have continued |
| | 136 | +performance issues on your *large* wiki, please do not hesitate to contact the SMW developers |
| | 137 | +for support. |
| | 138 | + |
| 102 | 139 | === Running SMW on older versions of MediaWiki === |
| 103 | 140 | |
| 104 | 141 | If your site is still running on PHP4, SMW is not supported. It would hardly be |
| — | — | @@ -129,17 +166,22 @@ |
| 130 | 167 | |
| 131 | 168 | Since the databse updates can take a long time, it might be better to perform them |
| 132 | 169 | via an SMW maintenance script as well instead of using Special:SMWAdmin. The according |
| 133 | | -script is called SMW_setup.php. |
| | 170 | +script is called SMW_setup.php. In case of problems, retry the above procedure with |
| | 171 | +the modified command "php SMW_refreshData.php -fpv" in step (4). |
| 134 | 172 | |
| 135 | 173 | Some versions of SMW also introduced incompatibilities in the wiki syntax that |
| 136 | 174 | may need to be fixed. You may want to read this first. |
| 137 | 175 | |
| 138 | | -=== Upgrading from 1.0 RC1 and 1.0 RC2 === |
| | 176 | +=== Upgrading from 1.0 RC1, 1.0 RC2, 1.0 RC3 === |
| 139 | 177 | |
| 140 | | -Following the generaic upgrading instructions above is recommended in any case. Moreover, some |
| | 178 | +Following the generic upgrading instructions above is recommended in any case. Moreover, some |
| 141 | 179 | configuration options have changed slightly between release candidates. Currently these are: |
| 142 | 180 | |
| 143 | 181 | * $smwgQEqualitySupport now is no longer true/false, but one of SMW_EQ_NONE, SMW_EQ_SOME, SMW_EQ_FULL |
| | 182 | +* $smwgQDefaultNamespaces is now NULL by default, so that all namespaces are queried. The old default |
| | 183 | + was "array(NS_MAIN, NS_IMAGE)". |
| | 184 | +* $smwgQDefaultLinking now defaults to 'all' such that all query results are linked. This is not a |
| | 185 | + performance issue any more. The old default was 'subject'. |
| 144 | 186 | |
| 145 | 187 | If you set any of these parameters in your LocalSettings.php, you need to update the config. |
| 146 | 188 | Please see SMW_Settings.php for more documentation on the available parameters. |
| — | — | @@ -154,8 +196,7 @@ |
| 155 | 197 | (a) The concepts (and namespaces) "Relation" and "Attribute" are now unified into "Property" |
| 156 | 198 | (b) The special property "Main display unit" is obsolete, and the property "display unit" |
| 157 | 199 | shows slightly modified behaviour. |
| 158 | | -(c) The Type:Boolean is currently not available. |
| 159 | | -(d) The configuration options in LocalSettings.php have changed. |
| | 200 | +(c) The configuration options in LocalSettings.php have changed. |
| 160 | 201 | |
| 161 | 202 | For (a), the namespace "Attribute:" was renamed into "Property:" -- you will find all your |
| 162 | 203 | former attribute pages in the new place. All SMW-generated property links now point to |
| — | — | @@ -182,10 +223,7 @@ |
| 183 | 224 | online docu for details. Running SMW_refreshData.php again (once) is required to reliably |
| 184 | 225 | propagate the updated property setting to all pages. |
| 185 | 226 | |
| 186 | | -For (c) there is currently no fix. If you need Type:Boolean, you should not upgrade. It is |
| 187 | | -planned to provide a new implementation for this type later. |
| 188 | | - |
| 189 | | -For (d), please consult the file [SMW_path]/includes/SMW_Settings.php to find out about |
| | 227 | +For (c), please consult the file [SMW_path]/includes/SMW_Settings.php to find out about |
| 190 | 228 | the current options, and use only those in your LocalSettings.php (using older options |
| 191 | 229 | will not hurt, but has no effect). Note that some options have just changed labels, while |
| 192 | 230 | others were added or removed. |
| — | — | @@ -200,7 +238,7 @@ |
| 201 | 239 | === Upgrading from 0.4.x === |
| 202 | 240 | |
| 203 | 241 | Upgrading should work like for versions 0.6 and 0.5. The type "Geographic area" and |
| 204 | | -"Geographic length" are no longer built in. But you can easily create them by yourself |
| | 242 | +"Geographic length" are no longer built in. But you can easily create them by yourself |
| 205 | 243 | with the new type customisation features. See the docu at ontoworld.org for details. |
| 206 | 244 | |
| 207 | 245 | |
| — | — | @@ -251,9 +289,11 @@ |
| 252 | 290 | database errors. |
| 253 | 291 | |
| 254 | 292 | Your database was not initialized properly. Go to Special:SMWAdmin for |
| 255 | | - instructions. |
| | 293 | + instructions. If all fails, run the maintenance script |
| | 294 | + "SMW_refreshData -vfp" (followed by "SMW_refreshData -v" if you already |
| | 295 | + stored annotations). |
| 256 | 296 | |
| 257 | | -- Problem: In my non-English installation, properties don't work even when |
| | 297 | +- Problem: In my non-English installation, properties don't work even when |
| 258 | 298 | I follow the examples. |
| 259 | 299 | |
| 260 | 300 | Although SMW normally provides English aliases, you may need to use the |
| — | — | @@ -270,6 +310,19 @@ |
| 271 | 311 | and possibly adjust the value to your needs. More than 100M is harldy useful, |
| 272 | 312 | but values around 50M might be required for large pages in some cases. |
| 273 | 313 | |
| | 314 | +- When issuing semantic queries, I receive database errors that talk about some |
| | 315 | + "illegal collation". Otherwise storing of annotations seems to work. |
| | 316 | + |
| | 317 | + Your database tables for MediaWiki and SMW have been generated with different |
| | 318 | + settings. To fix the problem, first try to run the maintenance script |
| | 319 | + "SMW_refreshData -vfp" followed by "SMW_refreshData -v". If this does not help, |
| | 320 | + you need to investigate the collation/character set settings of your DB. |
| | 321 | + To do that, use a DB frontend tool or the SQL command "SHOW CREATE TABLE tablename;". |
| | 322 | + Look up the collation/charset of, e.g., the table "categorylinks" and change the |
| | 323 | + default collation/charset of your DB to these settings as described in the manual |
| | 324 | + http://dev.mysql.com/doc/refman/5.0/en/charset-syntax.html |
| | 325 | + Finally, run the aforementioned maintenance scripts again. |
| | 326 | + |
| 274 | 327 | - Problem: I have a problem that is not in this list. |
| 275 | 328 | |
| 276 | 329 | Report general bugs at http://bugzilla.wikimedia.org/ where you can also |
| Index: trunk/extensions/SemanticMediaWiki/RELEASE-NOTES |
| — | — | @@ -1,9 +1,93 @@ |
| 2 | 2 | For a documentation of all features, see http://ontoworld.org/wiki/Help:Semantics |
| 3 | 3 | |
| | 4 | +== Changes in SMW1.0 as compared to SMW0.7 == |
| | 5 | + |
| | 6 | +* Simplified semantic annotations: just one kind of annotation ("Property"). |
| | 7 | +* Significant speedup (both server and network load substantially reduced, |
| | 8 | + faster RDF export, more efficient query result formatting). |
| | 9 | +* Prettier and easier to understand interfaces: |
| | 10 | + ** New tooltips for warnings and addtional information. |
| | 11 | + ** Simplified factbox layout, with all properties in alphabetic order. |
| | 12 | + ** Inline warnings to simplify trouble shooting with annotations. |
| | 13 | + ** Improved, more helpful and informative warning and error messages. |
| | 14 | + ** Highlighting for built-in elements. E.g. built-in types are visually |
| | 15 | + distinguished from arbitrary types; useful as visual feedback. |
| | 16 | + ** Error/warning reporting for (inline) queries. |
| | 17 | +* More powerful output formatting for semantic querying: |
| | 18 | + ** new {{#ask:...}} parser function syntax for inline queries, fully |
| | 19 | + compatible with MediaWiki templates, template parameters, and parser |
| | 20 | + functions of other extension |
| | 21 | + ** more readable inline query structure in #ask parser function, |
| | 22 | + printouts separated from query |
| | 23 | + ** semantic RSS feeds making feeds from query results via "format=rss" |
| | 24 | + ** new prinout format "?Category:Name" for #ask |
| | 25 | + ** option to hide main column by setting "mainlabel=-", and reinserting |
| | 26 | + via print request "?" (only for #ask) |
| | 27 | +* More expressivity for semantic querying: |
| | 28 | + ** support for subproperties, |
| | 29 | + ** improved equality resolution (redirects), |
| | 30 | + ** support for disjunctions, |
| | 31 | + ** inequality check for datavalues ("[[property::!value]]") |
| | 32 | + ** optional pattern matching for string values ("[[property::~Semant*]]") |
| | 33 | + ** automatic sorting on sort-parameter (no additional condition needed) |
| | 34 | +* New/improved datatypes: |
| | 35 | + ** Type:Page for explicitly specifying properties that are "relations" |
| | 36 | + ** better media support in Type:Page: special treatment of Image: and Media: |
| | 37 | + ** Type:Number as universal replacement for Type:Integer and Type:Float |
| | 38 | + ** Type:URL as universal replacement for old Type:URL and Type:URI |
| | 39 | + ** Type:Geographic coordinates completely rewritten. More input formats |
| | 40 | + supported, more liberal parsing to accept most inputs |
| | 41 | + ** special property "allows value" works for all types |
| | 42 | + ** display units are now easier to select via property "display units" |
| | 43 | + ** Improved data display: URL-links and tooltips work for queries results |
| | 44 | + and on special pages |
| | 45 | +* Improved special pages: |
| | 46 | + ** simpler interface for Special:Ask, hide query when using "further results" link |
| | 47 | + ** hints and warning for property usage/declaration in Special:Properties |
| | 48 | + ** extra information and warnings for types on Special:Types |
| | 49 | + ** Special:SemanticStatistics as faster replacement for earlier "ExtendedStatistics" |
| | 50 | +* Better internationalisation: |
| | 51 | + ** updates in all translation files |
| | 52 | + ** new translations to Dutch, Chinese (tw/ch), Korean (beta) |
| | 53 | + ** alias strings for all SMW elements; English labels are allowed in all |
| | 54 | + languages, names of old SMW elements still work as aliases for their |
| | 55 | + replacements. |
| | 56 | +* New experimental n-ary properties, allowing property values to consist of |
| | 57 | + a list of entries. |
| | 58 | +* Ontology import re-enabled (simple annotation import) |
| | 59 | +* Maintenance script SMW_refreshData now can rebuild all SMW data structures, fixing |
| | 60 | + even exotic database problems on most sites. |
| | 61 | +* New maintenance script for announcing site to Semantic Web crawlers. |
| | 62 | +* Support for upcoming MediaWiki 1.12 |
| | 63 | +* Improved APIs and various new hooks to simplify the life of SMW extension developers. |
| | 64 | +* Many bugfixes. |
| | 65 | + |
| | 66 | +Other changes for SMW1.0 include: |
| | 67 | +* Type:Enum became obsolete, since all types now suppport "allows value", but it |
| | 68 | + remains an alias for Type:String. |
| | 69 | +* Some configurtation options for LocalSettings.php have changed. Read INSTALL |
| | 70 | + for details on how to upgrade from your old installation. |
| | 71 | + |
| | 72 | + |
| | 73 | +== Semantic MediaWiki post 1.0RC3 == |
| | 74 | + |
| | 75 | +* Support for dynamic, query-generated RSS-feeds via query format "rss". |
| | 76 | +* Optional query feature for pattern matching in Type:String property values. |
| | 77 | +* Correct dynamic sorting of result tables, even for dates and numerical values. |
| | 78 | +* Thumbnail images when displaying property values from Image namespace. |
| | 79 | +* Simplified use of "sort" parameter in queries. |
| | 80 | +* Support for upcoming MediaWiki 1.12 (major parser changes). |
| | 81 | +* More efficient link generation in query results. Link all query results by |
| | 82 | + default now. |
| | 83 | +* Maintenance script SMW_refreshData now can rebuild all SMW data structures, |
| | 84 | + fixing even exotic database problems on most sites. |
| | 85 | +* New maintenance script for announcing site to Semantic Web crawlers. |
| | 86 | +* Various bugfixes. |
| | 87 | + |
| 4 | 88 | == Semantic MediaWiki 1.0RC3 == |
| 5 | 89 | |
| 6 | 90 | * New method for integrating inline queries via #ask parser function, separation of |
| 7 | | - query and printout requests, full compatibility ith templates. |
| | 91 | + query and printout requests, full compatibility with templates. |
| 8 | 92 | * New layout for Special:Ask to reflect #ask structure. |
| 9 | 93 | * New printout option: "?Category:Name" to ask for membership in that category. |
| 10 | 94 | * Re-enabled service links (e.g. use [[provides service::online maps]] on any page of |
| Index: trunk/extensions/SemanticMediaWiki/includes/SMW_GlobalFunctions.php |
| — | — | @@ -3,7 +3,7 @@ |
| 4 | 4 | * Global functions and constants for Semantic MediaWiki. |
| 5 | 5 | */ |
| 6 | 6 | |
| 7 | | -define('SMW_VERSION','1.0-alpha-SVN'); |
| | 7 | +define('SMW_VERSION','1.0'); |
| 8 | 8 | |
| 9 | 9 | // constants for special properties, used for datatype assignment and storage |
| 10 | 10 | define('SMW_SP_HAS_TYPE',1); |
| — | — | @@ -152,7 +152,7 @@ |
| 153 | 153 | $wgHooks['LoadAllMessages'][] = 'smwfLoadAllMessages'; // complete setup of all messages when requested by MW |
| 154 | 154 | |
| 155 | 155 | ///// credits (see "Special:Version") ///// |
| 156 | | - $wgExtensionCredits['parserhook'][]= array('name'=>'Semantic MediaWiki', 'version'=>SMW_VERSION, 'author'=>"Klaus Lassleben, Markus Krötzsch, Denny Vrandecic, S Page, and others. Maintained by [http://www.aifb.uni-karlsruhe.de/Forschungsgruppen/WBS/english AIFB Karlsruhe].", 'url'=>'http://ontoworld.org/wiki/Semantic_MediaWiki', 'description' => 'Making your wiki more accessible – for machines \'\'and\'\' humans. [http://ontoworld.org/wiki/Help:Semantics View online documentation.]'); |
| | 156 | + $wgExtensionCredits['parserhook'][]= array('name'=>'Semantic MediaWiki', 'version'=>SMW_VERSION, 'author'=>"Klaus Lassleben, [http://korrekt.org Markus Krötzsch], [http://simia.net Denny Vrandecic], S Page, and others. Maintained by [http://www.aifb.uni-karlsruhe.de/Forschungsgruppen/WBS/english AIFB Karlsruhe].", 'url'=>'http://ontoworld.org/wiki/Semantic_MediaWiki', 'description' => 'Making your wiki more accessible – for machines \'\'and\'\' humans. [http://semantic-mediawiki.org/index.php/Help:Semantics View online documentation.]'); |
| 157 | 157 | |
| 158 | 158 | wfProfileOut('smwfSetupExtension (SMW)'); |
| 159 | 159 | return true; |
| Index: trunk/extensions/SemanticMediaWiki/README |
| — | — | @@ -2,7 +2,7 @@ |
| 3 | 3 | |
| 4 | 4 | Semantic MediaWiki is a project for extending MediaWiki with "semantic" |
| 5 | 5 | functions that enable machine-reading of wiki-content. For details and |
| 6 | | -further links, see http://ontoworld.org/wiki/SMW |
| | 6 | +further links, see http://semantic-mediawiki.org |
| 7 | 7 | |
| 8 | 8 | Notes on installing Semantic MediaWiki are found in the file INSTALL. |
| 9 | 9 | |
| — | — | @@ -18,24 +18,24 @@ |
| 19 | 19 | People who want to contribute work to the project should subscribe to |
| 20 | 20 | the developers list semediawiki-devel@lists.sourceforge.net. |
| 21 | 21 | |
| 22 | | -Specific inquiries (e.g. for press releases) should go to Markus Krötzsch, |
| | 22 | +Specific inquiries (e.g. for press releases) should go to Markus Krötzsch, |
| 23 | 23 | mak@aifb.uni-karlsruhe.de. Do not contact Markus directly if you just need |
| 24 | 24 | free technical support -- that is what the user list is for. |
| 25 | 25 | |
| 26 | 26 | == Developers == |
| 27 | 27 | |
| 28 | | -Development is coordinated by Markus Krötzsch and Denny Vrandecic. The current |
| 29 | | -core development team further consists of S Page, Daniel Herzig, Nikolas Iwan, and |
| 30 | | -Tobias Matzner. |
| | 28 | +Development is coordinated by Markus Krötzsch and Denny Vrandecic. |
| 31 | 29 | |
| 32 | 30 | Semantic MediaWiki development is funded by Institut AIFB of Universität Karlsruhe, |
| 33 | | -Germany; see http://aifb.uni-karlsruhe.de. |
| | 31 | +Germany; see http://aifb.uni-karlsruhe.de. Specific development tasks have been |
| | 32 | +supported by the European Union under the projects SEKT and NeOn. SMW has also been |
| | 33 | +supported in the Halo project funded by Vulcan Inc., where development is coordinated |
| | 34 | +by ontoprise GmbH, Karlsruhe, Germany. |
| 34 | 35 | |
| 35 | | -SMW has also been supported in the Halo project, where development is coordinated by |
| 36 | | -ontoprise GmbH, Karlsruhe, Germany. |
| 37 | | - |
| 38 | 36 | == Contributors == |
| 39 | 37 | |
| | 38 | +* S Page has contributed code, and currently coordinates user support. |
| | 39 | + |
| 40 | 40 | * Heiko Haller and Max Völkel contributed to the initial design and basic |
| 41 | 41 | architectural decisions. |
| 42 | 42 | |
| — | — | @@ -43,8 +43,9 @@ |
| 44 | 44 | going at the early stages of the project, and set up the first testing wiki. |
| 45 | 45 | The first implementation has been done by Klaus Lassleben. |
| 46 | 46 | |
| 47 | | -* Further code has been contributed by (in no particular order) Kai Hüner, |
| 48 | | - Fernando Correia, Yaron Koren, and Nick Grandy, Jörg Heizmann, . |
| | 47 | +* Code has been contributed by (in no particular order) Kai Hüner, Fernando Correia, |
| | 48 | + Yaron Koren, and Nick Grandy, Jörg Heizmann, Daniel Herzig, Nikolas Iwan, Tobias Matzner, |
| | 49 | + Thomas Bleher. |
| 49 | 50 | |
| 50 | 51 | * The new logo and related artwork for Semantic MediaWiki (see ontoworld.org) |
| 51 | 52 | has been designed and realised by Rozana Vrandecic. |
| — | — | @@ -75,7 +76,7 @@ |
| 76 | 77 | |
| 77 | 78 | == Credits to other projects == |
| 78 | 79 | |
| 79 | | -* Some icons used by Semantic MediaWiki are derived from the "Crystal Clear" |
| | 80 | +* Most icons used by Semantic MediaWiki are derived from the "Crystal Clear" |
| 80 | 81 | icon theme for KDE, which was created by Everaldo (everaldo.com). |
| 81 | 82 | |
| 82 | 83 | * The sorttable java script function was developed by Stuart Langridge, |