Help:Configuration

From semantic-mediawiki.org
Jump to: navigation, search
SMW admin manual
Installation
Configuration
Concept caching
Pretty URIs
Using SPARQL and RDF stores
Troubleshooting
Repairing SMW's data
Extensions
Basic extensions
Semantic extensions
SMW user manual

Semantic MediaWiki offers a number of configuration options that site administrators may modify according to the particular needs of their wiki. This page explains all options of SMW 1.7.0 and higher. All available options can also be found in the file "SemanticMediaWiki.settings.php" of your current version. To change any configuration setting, copy the according assignment into your "LocalSettings.php" file, after including SMW as described in installation. Do not change the "SemanticMediaWiki.settings.php" file directly, as your changes would be overwritten in software upgrades.

Installation settings

The following settings relate to the basic installation of SMW.

ParameterDescriptionDefaultSinceUntil
$smwgDefaultNumRecurringEventsSets the default number of recurring events if no end date is set1001.4.3
$smwgDefaultStoreSets the storage backend to be used for the semantic data.SMWSQLStore31.0
$smwgEnableUpdateJobsDefers some tasks until after a page was edited by using the job queue.true1.2.0
$smwgEnabledSpecialPageEnables SMW specific annotation and content processing for special pagesarray( 'Ask' );1.9.0
$smwgFixedPropertiesSets user defined properties having a dedicated table for them.array();1.9.0
$smwgLinksInValuesSets whether internal links may be stored within property values.false1.3.0
$smwgMaxNumRecurringEventsSets the maximum number of recurring events that can be defined regardless of a given end date5001.4.3
$smwgNamespaceIndexSets the first namespace index to be used.1000.7
$smwgNamespacesWithSemanticLinksDefines for which namespaces the semantic links and annotations are to be evaluated.array( … );0.7
$smwgOnDeleteActionMoves the update process for when a page / property and its value assignments are deleted to the job queue.array( … );1.9.0.1
$smwgPageSpecialPropertiesSets the page related special properties to be used.array( '_MDAT' );1.7.0
$smwgPropertyLowUsageThresholdSets a threshold value for when a property is being highlighted as "hardly being used" on Special:Properties51.9.0
$smwgPropertyZeroCountDisplayShows properties where the usage count is zero on Special:Propertiestrue1.9.0
$smwgQEnabledActivates or deactivates all query related features and interfacestrue1.0
$smwgQueryProfilerEnables/Disables specific monitorable profile dataarray( … );1.9.0
$smwgShowHiddenCategoriesSets whether or not to omit categories (marked with ) from the annotation process.true1.9.0
$smwgSparqlDatabaseConnectorIdentifies a database connector that ought to be used together with the semantic data store.custom1.9.3

Cache settings

The following settings are relevant for the caching behaviour of SMW, such as special pages, factboxes etc.

ParameterDescriptionDefaultSinceUntil
$smwgAutoRefreshOnPageMoveSets whether or not to refresh semantic data in the store when a page was moved.true1.9.0
$smwgAutoRefreshOnPurgeSets whether or not to refresh semantic data in the store when a page is manually purged.true1.9.0
$smwgCacheTypeSets Semantic MediaWiki object cache and is used to track temporary changes.CACHE_ANYTHING1.9.0
$smwgCacheUsageControls the caching behaviour or special pages related to Semantic MediaWiki.array( … );1.9.0
$smwgFactboxCacheRefreshOnPurgeSets whether or not a cached factbox should be invalidated on an action=purge event.true1.9.0
$smwgFactboxUseCacheSets whether or not a factbox content should be stored in cache.true1.9.0

Interface settings

The following settings are relevant for the general appearance of various wiki pages in SMW, as well as for browsing interfaces such as Special:Browse.

ParameterDescriptionDefaultSinceUntil
$smwgBrowseShowAllShould the browse view always show the incoming links as well, and more of the incoming values?true1.0
$smwgBrowseShowInverseShould the browse view for incoming links show the incoming links via its inverses, or shall they be displayed on the other side?false1.0
Parameter Description
$smwgShowFactbox This setting allows you to select in which cases you want to have a factbox appear below an article. Note that the Magic Words __SHOWFACTBOX__ and __NOFACTBOX__ can be used to control Factbox display for individual pages. Other options for this setting include:
  • $smwgShowFactbox = SMW_FACTBOX_NONEMPTY; show only those factboxes that have some content
  • $smwgShowFactbox = SMW_FACTBOX_SPECIAL; show only if special properties were set
  • $smwgShowFactbox = SMW_FACTBOX_HIDDEN; hide always
  • $smwgShowFactbox = SMW_FACTBOX_SHOWN; show always, buggy and not recommended

Default: SMW_FACTBOX_HIDDEN

$smwgShowFactboxEdit Same as $smwgShowFactbox but for edit mode and same possible values.

Default: SMW_FACTBOX_NONEMPTY

$smwgToolboxBrowseLink Should the toolbox of each content page show a link to browse the properties of that page using Special:Browse? This is a useful way to access properties and it is somewhat more subtle than showing a Factbox on every page.

Default: true

$smwgInlineErrors Should warnings be displayed in wikitexts right after the problematic input? This affects only semantic annotations, not warnings that are displayed by inline queries or other features.

Default: true

$smwgSearchByPropertyFuzzy Should the search by property special page display nearby results when there are only few results with the exact value? Switch this off if this page has performance problems.

Default: true

$smwgTypePagingLimit Number of results shown in the listings on pages in the namespace Type.

Default: 200

$smwgConceptPagingLimit Number of results shown in the listings on pages in the namespace Concept.

Default: 200

$smwgPropertyPagingLimit Number of results shown in the listings on pages in the namespace Property. Uses a smaller value since these lists need more space.

Default: 25

$smwgMaxPropertyValues Number of values that are shown for each page in the listing on property pages. If increased to higher values, it might be useful to reduce $smwgPropertyPagingLimit to avoid performance impacts when showing property pages.

Default: 3

$smwgMaxNonExpNumber The maximal number that SMW will normally display without using scientific exp notation. The default is rather large since some users have problems understanding exponents. Scientific applications may prefer a smaller value for concise display.

Default: 1000000000000000

Query settings

Settings for inline queries and for semantic queries in general. This can especially be used to prevent overly high server-load by complex queries. The following settings affect all queries, wherever they occur.

ParameterDescriptionDefaultSinceUntil
$smwgAutoRefreshSubjectWhether to automatically refresh pages after they stored semantic data, so queries for their own data immediately show the desired results.true1.0
$smwgCategoriesAsInstancesSets whether a category statement should be treated as an element of the category.true1.5.0
$smwgQEqualitySupportShould redirects between page names be considered as equality between the described objects? This is usually appropriate for cases where data is given for a page at all.SMW_EQ_SOME1.0
$smwgQFeaturesThis setting defines which query features should be available by default.1.0
$smwgQMaxDepthMaximal property depth of queries41.0
$smwgQMaxInlineLimitMaximal number of rows ever printed in a single inline query on a single page, even if a setting limit=... is given.5001.0
$smwgQMaxLimitMaximal number of results ever retrieved, even when using special query pages.100001.0
$smwgQMaxSizeMaximal number of conditions in queries.121.0
$smwgQPrintoutLimitMaximal number of supported printouts (added columns in result table, ?-statements).1001.0
$smwgQSubcategoryDepthSets the maximum level of sub-category inclusion (steps within category hierarchy).101.0
$smwgQuerySourcesUse another query back-end for Semantic MediaWiki.empty1.8.0
$smwgUseCategoryHierarchySets whether Semantic MediaWiki should consider MediaWiki's subcategory hierarchy in querying.true1.5.0
Parameter Description
$smwgQSubpropertyDepth Restrict level of sub-property inclusion (steps within property hierarchy). Use 0 to disable hierarchy-inferencing in queries.

Default: 10

$smwgQSortingSupport Should sorting of query results be possible?

Default: true

$smwgQRandSortingSupport Enables or disables the random sorting of query results.

Default: true

$smwgQDefaultNamespaces Which namespaces should be searched by default? A value of NULL switches off default restrictions on searching, which is faster. An example value with namespaces would be array(NS_MAIN, NS_IMAGE).

Default: NULL

$smwgQComparators List of comparator characters supported by queries, separated by '|'. Possible entries for this list are
  • < (smaller than or equal)
  • > (greater than or equal)
  • << (smaller than)
  • >> (greater than)
  • ≤ (smaller than or equal - note that this is an extended ASCII character and may show up differently, e.g. as â¤)
  • ≥ (greater than or equal - note that this also is an extended ASCII character and may show up like â¥)
  •  ! (unequal to)
  • ~ (matching a pattern with '*' as wildcard, only for datatype String)
  •  !~ (not matching a pattern with '*' as wildcard, only for datatype String)

If unsupported comparators are used, they are treated as part of the queried value. The behaviour of the comparators < and > varies depending on the setting for $smwStrictComparators.

Default: '<|>|!~|!|~|≤|≥|<<|>>'

$smwStrictComparators Enables or disables strict treatment of comparator symbols.

Default: false

$smwgIgnoreQueryErrors Should queries be executed even if some errors were detected? A hint that points out errors is shown in any case.

Default: true

Settings for inline queries

The following settings affect inline queries and querying special pages, in particular Special:Ask. Essentially they should mirror the kind of queries that should immediately be answered by the wiki, using whatever computations are needed.

ParameterDescriptionDefaultSinceUntil
$smwgAutoRefreshSubjectWhether to automatically refresh pages after they stored semantic data, so queries for their own data immediately show the desired results.true1.0
$smwgQFeaturesThis setting defines which query features should be available by default.1.0
$smwgQMaxDepthMaximal property depth of queries41.0
$smwgQMaxInlineLimitMaximal number of rows ever printed in a single inline query on a single page, even if a setting limit=... is given.5001.0
$smwgQMaxSizeMaximal number of conditions in queries.121.0
$smwgQPrintoutLimitMaximal number of supported printouts (added columns in result table, ?-statements).1001.0
$smwgRSSEnabledShould RSS be enabled at all? RSS as such does not cause more load than Special:Ask, but it might attract more users.true1.01.8.0
$smwgRSSWithPagesShould RSS feeds deliver whole pages or just link to them?true1.01.8.0

Settings for Special:Ask

The following settings affect querying special pages, in particular Special:Ask. The settings for inline queries mentioned above also affect queries on special pages.

ParameterDescriptionDefaultSinceUntil
$smwgAutocompleteInSpecialAskSets whether or not the 'printouts' textarea should have autocompletion on property names.true1.5.2

Settings for concept queries

Further settings for queries. The following settings affect queries that are part of concept pages. These are usually chosen to be less restricted than inline queries, since there are two other means for controlling their use:

  1. Concept queries that would not be allowed as normal queries will not be executed directly, but can use pre-computed results instead. This is the default. See Concept caching for details on how to exploit this.
  2. The whole Concept: namespace can be restricted (using some suitable MediaWiki extension) to an experienced user group that may create more complex queries resonably. Other users can employ thus defined concepts in their queries.
Parameter Description
$smwgQConceptCaching Which concepts should be displayed only if available from cache? Possible values are:
  • CONCEPT_CACHE_ALL show concept elements anywhere only if they are cached,
  • CONCEPT_CACHE_HARD show without cache if concept is not harder than permitted inline queries, or
  • CONCEPT_CACHE_NONE show all concepts even without any cache.

In any case, caches will always be used if available (but see $smwgQConceptCacheLifetime).

Default: CONCEPT_CACHE_HARD

$smwgQConceptMaxSize Same as $smwgQMaxSize but for concepts.

Default: 20

$smwgQConceptMaxDepth Same as $smwgQMaxDepth but for concepts.

Default: 8

$smwgQConceptFeatures Same as $smwgQFeatures but for concepts. Note that using concepts in concepts is currently not supported – do not enable it!

Default: SMW_PROPERTY_QUERY | SMW_CATEGORY_QUERY | SMW_NAMESPACE_QUERY | SMW_CONJUNCTION_QUERY | SMW_DISJUNCTION_QUERY

$smwgQConceptCacheLifetime This setting defines the cache life time in minutes. If a concept cache exists but is older than this, SMW tries to recompute it, and will only use the cache if this is not allowed due to settings above.

Default: 24 * 60 (= 1 day)

Settings for query formatting/display

Parameter Description
$smwgQDefaultLinking Which result columns in an inline query should be linked if not specified otherwise. Possible values are 'none', 'subject' (links only in first column), 'all'.

Default: 'all'

$smwgQDefaultLimit Default number of rows returned in a query. Can be increased with limit=... in #ask.

Default: 50

$smwgResultFormats This setting contains an array of all query result formats that the wiki supports. It is normally extended automatically by extensions that supply additional formats. However, it is also possible to set this array manually, e.g. to disable some formats. To disable a format, do unset($smwgResultFormats['template']); Disabled formats will be treated like if the format parameter had been omitted. The formats 'table' and 'list' are defaults that cannot be disabled. The format 'broadtable' should not be disabled either in order not to break Special:Ask.

Default:

array(
	'table' => 'SMWTableResultPrinter',
	'list' => 'SMWListResultPrinter',
	'ol' => 'SMWListResultPrinter',
	'ul' => 'SMWListResultPrinter',
	'broadtable' => 'SMWTableResultPrinter',
	'category' => 'SMWCategoryResultPrinter',
	'embedded' => 'SMWEmbeddedResultPrinter',
	'template' => 'SMWListResultPrinter',
	'count' => 'SMWListResultPrinter',
	'debug' => 'SMWListResultPrinter',
	'rss' => 'SMWRSSResultPrinter',
	'csv' => 'SMWCsvResultPrinter',
	'dsv' => 'SMWDSVResultPrinter',
	'json' => 'SMWJSONResultPrinter',
	'rdf' => 'SMWRDFResultPrinter'
);

Export settings

RSS export

ParameterDescriptionDefaultSinceUntil
$smwgRSSEnabledShould RSS be enabled at all? RSS as such does not cause more load than Special:Ask, but it might attract more users.true1.01.8.0
$smwgRSSWithPagesShould RSS feeds deliver whole pages or just link to them?true1.01.8.0

OWL/RDF export

Parameter Description
$smwgAllowRecursiveExport Can normal users request recursive export, i.e. an OWL/RDF export that includes a full export of all mentioned pages, and of all pages they mention, and so on. Recommended only for very small wikis.

Default: false

$smwgExportBacklinks Should incoming properties be part of OWL/RDF export?

Default: true

$smwgNamespace The URI-namespace of exported URIs. Will be set automatically if nothing is given, using the base URL provided to enableSemantics(). But in order to make pretty URIs you will need to set this to something nice and adapt your Apache configuration appropriately. This is done, e.g., on semanticweb.org, where URIs are of the form http://semanticweb.org/wiki/FOAF. An example setting would be
$smwgNamespace = 'http://example.org/id/';

Default: unset

Other settings

The following settings usually need no modification.

SPARQL and RDF store stettings

See also the help page on configuring SWM for use with SPARQL and RDF stores.

ParameterDescriptionDefaultSinceUntil
$smwgSparqlDatabaseConnectorIdentifies a database connector that ought to be used together with the semantic data store.custom1.9.3
Parameter Description
$smwgSparqlDatabase Configure SPARQL database connection for Semantic MediaWiki. This is used when SPARQL-based features are enabled, e.g. when using 'SMWSparqlStore' as the $smwgDefaultStore. The default setting uses a generic SPARQL connector that is based on recent SPARQL documents. However there are settings available for use with specific connectors:
  • 'SMWSparqlDatabase4Store' for use with 4Store
  • 'SMWSparqlDatabaseVirtuoso' for use with Virtuoso

Default: 'SMWSparqlDatabase'

$smwgSparqlQueryEndpoint Configure SPARQL database connection for Semantic MediaWiki. This is used when SPARQL-based features are enabled. Endpoint (service URL) for queries (reading queries like SELECT). This endpoint is neccessary.

Default: 'http://localhost:8080/sparql/'

$smwgSparqlUpdateEndpoint Configure SPARQL database connection for Semantic MediaWiki. This is used when SPARQL-based features are enabled. Endpoint (service URL) for updates (SPARQL Update queries). Can be omitted if not supported.

Default: 'http://localhost:8080/update/'

$smwgSparqlDataEndpoint Configure SPARQL database connection for Semantic MediaWiki. This is used when SPARQL-based features are enabled. Endpoint (service URL) for data (SPARQL HTTP Protocol for Graph Management) Can be omitted if not supported.

Default: 'http://localhost:8080/data/'

$smwgSparqlDefaultGraph The default graph is similar to a database name in relational databases. It can be set to any URI (e.g. the main page URI of your wiki with "#graph" appended). Leaving the default graph URI empty only works if the store is configured to use some default graph or if it generally supports this. Different wikis should normally use different default graphs unless there is a good reason to share one graph.

Default: ''

Miscellaneous settings

Parameter Description
$smwgPDefaultType Default property type. Undefined properties (those without pages or whose pages have no "has type" statement) will be assumed to be of this type. This is an internal type id. See the file languages/SMW_LanguageXX.php to find what IDs to use for datatypes in your language. The default corresponds to "Type:Page". The English ids are as follows:
  • '_wpg' → Page
  • '_str' → String
  • '_txt' → Text
  • '_cod' → Code
  • '_boo' → Boolean
  • '_num' → Number
  • '_geo' → Geographic coordinates
  • '_tem' → Temperature
  • '_dat' → Date
  • '_ema' → Email
  • '_uri' → URL
  • '_anu' → Annotation URI
  • '_tel' → Telephone number
  • '_rec' → Record
  • '_qty' → Quantity

Default: '_wpg' (corresponds to datatype Page)

$smwgTranslate Setting this to true allows to translate all the labels within Special:Browse given that they have interwiki links. This feature is currently disabled and cannot be activated with this setting.

Default: false

$smwgAdminRefreshStore If the following is set to true, the wiki data can be repaired using the interface on the page Special:SMWAdmin. Setting this option to false does not stop ongoing repair processes.

Default: true

$smwgHistoricTypeNamespace If the following is set to true, you can still access the old namespaces Type (104) and Type_talk (105) which have been replaced by Special:Types and are thus obsolete starting with SMW 1.6.0.

Default: false


,

This documentation page applies to all SMW versions from 1.7.0 to the most current version.
Other versions: 1.6.0 – 1.6.21.5.6 – 1.5.61.5.1 – 1.5.5 […]       Other languages: frukzh-hans

Help:Configuration en 1.7.0