Configuration

From semantic-mediawiki.org
Configuration
Lists configuration parameters that site administrators may modify according to the particular needs of their wiki.
Table of Contents

Semantic MediaWiki offers a number of configuration parameters that site administrators may modify according to the particular needs of their wiki. This page explains all configuration parameters for Semantic MediaWiki. All available configuration parameters can also be found in file Octocat.pngDefaultSettings.php.

To change the setting of any configuration parameter, copy the respective assignment into your "LocalSettings.php" file, after including Semantic MediaWiki as described in installation. Do not change the "DefaultSettings.php" file directly, as your changes would be overwritten in software upgrades. See also the help page on function enableSemantics including configuration preloading.

See also this page for a unordered list of configuration parameters.

Installation settings[edit]

The following settings relate to the basic installation of Semantic MediaWiki.

Parameter Description Default Version
$smwgCompactLinkSupport Sets whether compact links to special query pages should be used
false
3.0.0+
$smwgCompactLinkSupport Sets whether compact links to special query pages should be used
false
3.0.0+
$smwgEnableUpdateJobs Sets whether tasks are deferred until after a page was edited by using the job queue
true
1.2.0+
$smwgEnabledQueryDependencyLinksStore Sets whether tracking and storing of dependencies of embedded queries may be used
false
2.3.0+
$smwgFallbackSearchType Sets the search engine to fall back to in case SMWSearch is used as custom search engine but is unable to interpret the search term as an semantic query.
null
2.1.0+
$smwgIgnoreExtensionRegistrationCheck Sets whether users will be informed about the discrepancy of having Semantic MediaWiki installed but not enabled
false
3.1.0+
$smwgIgnoreUpgradeKeyCheck Allows to disable the upgrade key check
false
4.1.3+
$smwgNamespace Sets the namespace of exported URIs see doc­u­men­ta­tion 1.0+
$smwgNamespaceIndex Sets the index of the first namespace to be used by Semantic MediaWiki
100
0.7+
$smwgNamespacesWithSemanticLinks Defines for which namespaces the semantic links and annotations are to be evaluated see doc­u­men­ta­tion 0.7+
$smwgPlainList Sets whether the list format should provide class attributes to HTML elements
false
3.1.2+
$smwgPropertyInvalidCharacterList Sets a list of invalid characters which are not allowed to be used for property naming see doc­u­men­ta­tion 2.5.0+
$smwgQueryDependencyPropertyExemptionList Sets special properties that should be exempted from embedded queries updates see doc­u­men­ta­tion 2.3.0+
$smwgAdminFeatures Sets which administrative features may be used via special page "SemanticMediaWiki" see doc­u­men­ta­tion 2.5.0+
$smwgAdminRefreshStore Sets whether it is possible to set up the database tables or to initiate the repairing or updating of all semantic data of wiki using the interface on special page "SemanticMediaWiki"
true
1.3.0+
$smwgConfigFileDir Sets the directory for storing the setup information file ensuring database consistency
__DIR__
3.0.1+
$smwgCreateProtectionRight Sets the user right required to create new properties
false
3.0.0+
$smwgDVFeatures Sets the available features regarding property data values see doc­u­men­ta­tion 2.4.0+
$smwgDefaultNumRecurringEvents Sets the default number of recurring events if no end date is set
100
1.4.3+
$smwgDefaultStore Sets the storage backend to be used for the semantic data
SMW\SQLStore\SQLStore
0.7+
$smwgEnabledEditPageHelp Sets whether helpful information is displayed when editing a page
true
2.1.0+
$smwgEnabledInTextAnnotationParserStrictMode Sets whether strictness should be enforced during the annotation parsing process
true
2.3.1+
$smwgEntityCollation Sets which collation entities in Semantic MediaWiki should sort with
identity
3.0.0+
$smwgFieldTypeFeatures Sets relational database specific field type features
false
3.0.0+
$smwgFixedProperties Sets user defined properties to have a dedicated database table for them
[];
1.9.0+
$smwgImportFileDirs Sets the contents import directory for legitimate files to be imported upon installation of Semantic MediaWiki see doc­u­men­ta­tion 2.5.0+
$smwgImportReqVersion Sets the contents import file version for legitimate files to be imported upon installation of Semantic MediaWiki
1
2.5.0+
$smwgLinksInValues Sets whether internal links in values for properties of datatype "Text" may be stored within property values
false
1.3.0+
$smwgLocalConnectionConf Sets the database connection characteristics for providers used see doc­u­men­ta­tion 2.5.3+
$smwgMaxNumRecurringEvents Sets the maximum number of recurring events that can be defined regardless of a given end date
500
1.4.3+
$smwgPageSpecialProperties Sets the page related special properties to be used
[ '_MDAT' ]
1.7.0+
$smwgQueryProfiler Sets whether specific monitorable profile data are recorded
true
1.9.0+
$smwgResultAliases Sets available aliases for result formats see doc­u­men­ta­tion 1.8.0+
$smwgShowHiddenCategories Sets whether to omit categories marked with the HIDDENCAT behaviour switch from the annotation process
true
1.9.0+
$smwgURITypeSchemeList Sets the permissive URI schemes for data values to properties of datatype URL and Annotation URI see doc­u­men­ta­tion 3.0.0+
$smwgLinksInValues Sets whether internal links in values for properties of datatype "Text" may be stored within property values
false
1.3.0+

Cache settings[edit]

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

Parameter Description Default Version
$smwgFactboxCacheRefreshOnPurge Sets whether or not a cached factbox should be invalidated on an "action=purge" event.
true
1.9.0+
$smwgFactboxUseCache Sets whether or not a factbox content should be stored in cache.
true
1.9.0+
$smwgQueryResultNonEmbeddedCacheLifetime Sets the cache lifetime of non-embedded queries and their results fetched from the query engine
60 * 10
2.5.0+
$smwgQueryResultNonEmbeddedCacheLifetime Sets the cache lifetime of non-embedded queries and their results fetched from the query engine
60 * 10
2.5.0+
$smwgAutoRefreshOnPurge Sets whether semantic data are refreshed in the store when a page is manually purged
true
1.9.0+
$smwgCacheType Sets which object cache Semantic MediaWiki should use to track temporary changes
CACHE_ANYTHING
1.9.0+
$smwgCacheUsage Sets how the caching behaviour or special pages related to Semantic MediaWiki is controlled see doc­u­men­ta­tion 1.9.0+
$smwgMainCacheType Sets which object cache Semantic MediaWiki should use to track temporary changes
CACHE_ANYTHING
2.3.0+
$smwgQueryResultCacheLifetime Sets the cache lifetime of embedded queries and their results fetched from the query engine
60 * 60 * 24 * 7
2.5.0+
$smwgQueryResultCacheRefreshOnPurge Sets whether it is possible to manually refresh the query cache by doing a "purge" action
true
2.5.0+
$smwgQueryResultCacheType Sets whether the query result cache may be used
CACHE_NONE
2.5.0+
$smwgCacheUsage Sets how the caching behaviour or special pages related to Semantic MediaWiki is controlled see doc­u­men­ta­tion 1.9.0+

Interface settings[edit]

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

Parameter Description Default Version
$smwgFactboxFeatures Sets the behaviour of features related to the factbox see doc­u­men­ta­tion 3.0.0+
$smwgBrowseByApi Sets whether the display of special page "Browse" will be generated using an API request
true
2.5.0+
$smwgBrowseFeatures Sets the behaviour of the features provided by several browsing interfaces see doc­u­men­ta­tion 3.0.0+
$smwgBrowseShowAll Sets whether the browse view for incoming links on special page special page "Browse" should show the incoming links
true
1.3.0+
$smwgBrowseShowInverse Sets whether the browse view for incoming links on special page special page "Browse" should show the incoming links inverse to the reverse view
false
1.3.0+
$smwgInlineErrors Sets whether warnings should be shown right after problematic annotations
true
1.0+
$smwgPagingLimit Sets the number of results shown in the listings on pages in the namespace "Property", "Concept" as well as on the special pages "Special:Types" and "Special:ProcessingErrorList"
$smwgPagingLimit =  [
   'type' => 200,
   'concept' => 200,
   'property' => 50,
   'errorlist' => 25,
];
3.0+
$smwgParserFeatures Sets the behaviour of features related to text and annotation parsing see doc­u­men­ta­tion 3.0.0+
$smwgRedirectPropertyListLimit Sets the number of redirect results (synonyms) shown in the listings in the "Synonyms" section on pages in namespace "Property"
25
2.5.0+
$smwgSearchByPropertyFuzzy Sets whether special page "Search by property" should display nearby results see doc­u­men­ta­tion 1.1.0+
$smwgShowFactbox Sets in which cases the factbox should be shown below a page see doc­u­men­ta­tion 0.7+
$smwgShowFactboxEdit Sets in which cases the factbox should be shown when editing a page see doc­u­men­ta­tion 1.0+
$smwgSubPropertyListLimit Sets the number of subproperties shown in the listings in the "Subproperties" section on pages in namespace "Property"
25
2.5.0+
$smwgToolboxBrowseLink Sets whether the toolbox in the wiki's sidebar will show a link to special page special page "Browse"
true
1.3.0+
Parameter Description
$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[edit]

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.

Parameter Description Default Version
$maxRecursionDepth Sets the recursion depth for a template output
2
1.4.0+
$smwgEnabledQueryDependencyLinksStore Sets whether tracking and storing of dependencies of embedded queries may be used
false
2.3.0+
$smwgQSortFeatures Sets the behaviour for the sorting features of the semantic search see doc­u­men­ta­tion 3.0.0+
$smwgQUpperbound Sets the upper bound of the offset used for the maximal number of rows ever printed in an embedded query
5000
2.1.0+
$smwgRemoteReqFeatures Sets the behaviour of the features provided for remote requests see doc­u­men­ta­tion 3.0.0+
$smwgRemoteReqFeatures Sets the behaviour of the features provided for remote requests see doc­u­men­ta­tion 3.0.0+
$smwgCategoriesAsInstances Sets whether a category statement should be treated as an element of the category
true
1.5.0+
$smwgCategoryFeatures Sets the behaviour of the query features related to category handling see doc­u­men­ta­tion 3.0.0+
$smwgQFilterDuplicates Sets whether duplicate query conditions should be removed from computing query results
false
2.5.0+
$smwgQMaxDepth Sets the maximum property depth for inline queries
4
1.0+
$smwgQMaxInlineLimit Sets the maximal number of rows ever printed by queries
500
1.0+
$smwgQMaxLimit Sets the maximal number of results ever retrieved by queries
10000
1.0+
$smwgQMaxSize Sets the maximum number of conditions for inline queries
12
1.0+
$smwgQRandSortingSupport Sets whether random sorting of query results should be possible
true
1.0+
$smwgQSortingSupport Sets whether sorting of query results should be possible
true
1.0+
$smwgQStrictComparators Sets whether the ">" and "<" comparators should be strict
false
1.5.3+
$smwgQSubcategoryDepth Sets the maximum level of subcategory inclusion (steps within category hierarchy) when querying
10
1.0+
$smwgQuerySources Sets a list of sources, i.e. query back-ends that can return query results see doc­u­men­ta­tion 1.8.0+
$smwgUseCategoryHierarchy Sets whether elements of the subcategory hierarchy are considered as hierarchy elements in the annotation process
true
1.5.0+
Parameter Description
$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 [ NS_MAIN, NS_FILE ].

Default: NULL

$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[edit]

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.

Parameter Description Default Version
$smwgQFilterDuplicates Sets whether duplicate query conditions should be removed from computing query results
false
2.5.0+

Settings for Special:Ask[edit]

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

Parameter Description Default Version
$smwgResultFormatsFeatures Sets whether features for some result formats should be extended see doc­u­men­ta­tion 2.5.0+
$smwgSpecialAskFormSubmitMethod Sets the HTTP submit method used by Special page "Ask"
SMW_SASK_SUBMIT_POST
3.0.0+

Settings for concept queries[edit]

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 full-text search[edit]

The following settings affect the full-text search.

Parameter Description Default Version
$smwgEnabledFulltextSearch Sets whether full-text search support for properties may be used
false
2.5.0+
$smwgFulltextDeferredUpdate Sets the number of expected full-text search index updates
true
2.5.0+
$smwgFulltextLanguageDetection Sets which languages to detect for the full-text search from an indexable text
[];
2.5.0+
$smwgFulltextSearchIndexableDataTypes Sets which datatypes are allowed to be indexed using the full-text search see doc­u­men­ta­tion 2.5.0+
$smwgFulltextSearchMinTokenSize Sets the minimum word/token length to help to decide whether MATCH or LIKE operators are to be used for a condition statement
3
2.5.0+
$smwgFulltextSearchPropertyExemptionList Sets the property keys for which value assignments are being exempted from the full-text indexing see doc­u­men­ta­tion 2.5.0+
$smwgFulltextSearchTableOptions Sets the full-text search table options to use during installation or update see doc­u­men­ta­tion 2.5.0+

Settings for query formatting/display[edit]

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: 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:

[
	'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[edit]

Parameter Description Default Version
$smwgNamespace Sets the namespace of exported URIs see doc­u­men­ta­tion 1.0+
$smwgExportResourcesAsIri Sets whether resources should be exported as IRIs (Internationalized Resource Identifiers)
true
2.5.0+
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

Other settings[edit]

The following settings usually need no modification.

SPARQL and RDF store stettings[edit]

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

Parameter Description Default Version
$smwgSparqlRepositoryConnectorForcedHttpVersion Sets whether CURLOPT_HTTP_VERSION should explicitly be forced for the endpoint communication
false
2.3.1+
$smwgDefaultStore Sets the storage backend to be used for the semantic data
SMW\SQLStore\SQLStore
0.7+
$smwgExportResourcesAsIri Sets whether resources should be exported as IRIs (Internationalized Resource Identifiers)
true
2.5.0+
$smwgSparqlCustomConnector Defines the SPARQL custom database connectors
custom
1.6.0+
$smwgSparqlDataEndpoint Sets the endpoint for data on the SPARQL database
http://localhost:8080/data/
1.6.0+
$smwgSparqlDefaultGraph Sets the identifier (graph) of the SPARQL database
''
1.7.0+
$smwgSparqlQFeatures Sets the SPARQL query features that are expected to be supported by the repository of the identifier (graph) of the SPARQL database see doc­u­men­ta­tion 2.3.0+
$smwgSparqlQueryEndpoint Sets the endpoint for querying the SPARQL database
http://localhost:8080/sparql/
1.6.0+
$smwgSparqlReplicationPropertyExemptionList see doc­u­men­ta­tion +
$smwgSparqlRepositoryConnector Identifies a database connector that ought to be used together with the semantic data store.
default
2.0.0+
$smwgSparqlUpdateEndpoint Sets the endpoint for updating the SPARQL database
http://localhost:8080/update/
1.6.0+

Miscellaneous settings[edit]

Parameter Description Default Version
$smwgCheckForConstraintErrors Sets whether constraint violations are shown to the user via a page indicator see doc­u­men­ta­tion 3.1.0+
$smwgMandatorySubpropertyParentTypeInheritance
false
3.1.0+
$smwgPDefaultType Sets the default datatype for a property if it was not defined manually
_wpg
1.1.2+
$smwgTranslate Sets that all labels within special page "Browse"Shows all properties and their values annotated to a page are being translated given that they have interwiki links
false
0.7+
$smwgChangePropagationProtection Sets whether property pages are protected from editing while a property change propagation is being processed
true
3.0.0+
$smwgChangePropagationWatchlist Sets the properties that are relevant for property change propagation see doc­u­men­ta­tion 1.5.0+
$smwgDataTypePropertyExemptionList Sets which datatypes are exempted from the property registration process see doc­u­men­ta­tion 2.5.0+
$smwgExperimentalFeatures Sets experimental features see doc­u­men­ta­tion 3.0.0+
$smwgExtraneousLanguageFileDir Sets the path to the extraneous language files used by Semantic MediaWiki as seen in the local filesystem
__DIR__ . '/i18n/extra';
2.5.0+
$smwgPropertyReservedNameList Sets which names are reserved from usage as property names see doc­u­men­ta­tion 3.0.0+
$smwgQTemporaryTablesAutoCommitMode Sets whether certain types of database transactions may be performed that cannot be safely logged using global transaction identifiers (GTIDs)
false
2.5.0+
$smwgServicesFileDir Sets the path to the service's files used by Semantic MediaWiki as seen in the local filesystem
__DIR__ . '/src/Services';
2.5.0+

Experimental settings[edit]

The following configuration parameters enable or control the behaviour of experimental features.

Parameter Description Default Version
$smwgEnabledQueryDependencyLinksStore Sets whether tracking and storing of dependencies of embedded queries may be used
false
2.3.0+
$smwgQueryDependencyPropertyExemptionList Sets special properties that should be exempted from embedded queries updates see doc­u­men­ta­tion 2.3.0+
$smwgEnabledFulltextSearch Sets whether full-text search support for properties may be used
false
2.5.0+
$smwgFieldTypeFeatures Sets relational database specific field type features
false
3.0.0+
$smwgFulltextDeferredUpdate Sets the number of expected full-text search index updates
true
2.5.0+
$smwgFulltextLanguageDetection Sets which languages to detect for the full-text search from an indexable text
[];
2.5.0+
$smwgFulltextSearchIndexableDataTypes Sets which datatypes are allowed to be indexed using the full-text search see doc­u­men­ta­tion 2.5.0+
$smwgFulltextSearchMinTokenSize Sets the minimum word/token length to help to decide whether MATCH or LIKE operators are to be used for a condition statement
3
2.5.0+
$smwgFulltextSearchPropertyExemptionList Sets the property keys for which value assignments are being exempted from the full-text indexing see doc­u­men­ta­tion 2.5.0+
$smwgFulltextSearchTableOptions Sets the full-text search table options to use during installation or update see doc­u­men­ta­tion 2.5.0+
$smwgQFilterDuplicates Sets whether duplicate query conditions should be removed from computing query results
false
2.5.0+
$smwgQueryResultCacheLifetime Sets the cache lifetime of embedded queries and their results fetched from the query engine
60 * 60 * 24 * 7
2.5.0+
$smwgQueryResultCacheType Sets whether the query result cache may be used
CACHE_NONE
2.5.0+