Configuration

From semantic-mediawiki.org
Jump to: navigation, search
N/A
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 the file "DefaultSettings.php" (as of Semantic MediaWiki 3.0.0Released on an unknown date and compatible with MW 1.27.0 - 1.30.x.).

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.

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

Installation settings

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

Parameter Description Default Version
$smwgAdminFeatures Sets which administrative features may be used via special page "SemanticMediaWiki" see documentation 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+
$smwgCreateProtectionRight Sets the user right required to create new properties
false
3.0.0+
$smwgDVFeatures Sets the available features regarding property data values see documentation 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
SMWSQLStore3
1.0+
$smwgEditProtectionRight Sets the user right required to edit pages which are edit protected with special property "Is edit protected"
false
2.5.0+
$smwgEnableUpdateJobs Defers some tasks until after a page was edited by using the job queue.
true
1.2.0+
$smwgEnabledEditPageHelp Sets whether helpful information is displayed when editing a page
true
2.1.0+
$smwgEnabledHttpDeferredJobRequest Sets whether selected jobs can be executed asynchronously to the initial transaction triggering the job
true
2.3.0+
$smwgEnabledInTextAnnotationParserStrictMode Sets whether strictness should be enforced during the annotation parsing process
true
2.3.1+
$smwgEnabledQueryDependencyLinksStore Sets whether tracking and storing of dependencies of embedded queries may be used
false
2.3.0+
$smwgEnabledSpecialPage Enables Semantic MediaWiki specific annotation and content processing for special pages
array( 'Ask' );
1.9.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+
$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
array();
1.9.0+
$smwgImportFileDir Sets the contents import directory for legitimate files to be imported upon Installation of Semantic MediaWiki see documentation 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 documentation 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+
$smwgNamespace Sets the namespace of exported URIs see documentation 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 documentation 0.7+
$smwgOnDeleteAction Moves the update process for when a page / property and its value assignments are deleted to the job queue. see documentation 1.9.0.1 - 2.3.1
$smwgPageSpecialProperties Sets the page related special properties to be used
array( '_MDAT' );
1.7.0+
$smwgPropertyInvalidCharacterList Sets a list of invalid characters which are not allowed to be used for property naming see documentation 2.5.0+
$smwgPropertyLowUsageThreshold Sets a threshold value for when a property is being highlighted as "hardly being used" on special page "Properties".
5
1.9.0+
$smwgPropertyZeroCountDisplay Sets whether properties with a usage count of zero should be shown on special page "Properties"
true
1.9.0+
$smwgQEnabled Activates or deactivates all query related features and interfaces
true
1.0+
$smwgQueryDependencyAffiliatePropertyDetectionList Sets affiliate special properties that additionally initiate a query dependency update when value change occurs
array();
2.4.0+
$smwgQueryDependencyPropertyExemptionList Sets special properties that should be exempted from embedded queries updates see documentation 2.3.0+
$smwgQueryProfiler Sets whether specific monitorable profile data are recorded
true
1.9.0+
$smwgShowHiddenCategories Sets whether or not to omit categories marked with the HIDDENCAT behaviour switch from the annotation process.
true
1.9.0+


Cache settings

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

Parameter Description Default Version
$smwgAutoRefreshOnPageMove Sets whether or not to refresh semantic data in the store when a page was moved.
true
1.9.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 documentation 1.9.0+
$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+
$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+
$smwgQueryResultNonEmbeddedCacheLifetime Sets the cache lifetime of non-embedded queries and their results fetched from the query engine
60 * 10
2.5.0+
$smwgValueLookupCacheLifetime Sets the cache lifetime of the value lookup cache until it is being invalidated
60 * 60 * 24 * 7
2.3.0+
$smwgValueLookupCacheType Sets a separate cache type for the object cache when requesting value lookups from the database
CACHE_NONE
2.3.0+
$smwgValueLookupFeatures Sets which value lookup features should be served from value lookup cache see documentation 2.3.0+


Interface settings

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
$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 documentation 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+
$smwgConceptPagingLimit Sets the number of listings shown in the namespace "Concept"
200
1.3.0+
$smwgDecodeTextAnnotationWithStripMarker Sets whether strip markers for properties of datatype "Text" may be stored within property values
false
3.0.0+
$smwgMaxPropertyValues Sets the number of values that are shown for each page in the listing on pages in namespace "Property"
3
1.4.3+
$smwgPropertyPagingLimit Sets the number of results shown in the listings on pages in the namespace "Property"
25
0.7+
$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 documentation 1.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+
$smwgTypePagingLimit Sets the number of listings shown in the namespace "Type"
200
0.7+


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

$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

$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.

Parameter Description Default Version
$maxRecursionDepth Sets the recursion depth for a template output
2
1.4.0+
$smwgAutoRefreshSubject Sets whether or not to refresh the pages on which semantic data is stored.
true
1.5.6+
$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 documentation 3.0.0+
$smwgEnabledQueryDependencyLinksStore Sets whether tracking and storing of dependencies of embedded queries may be used
false
2.3.0+
$smwgQComparators Sets the list of comparator characters supported by queries for use in a regex. see documentation 1.0+
$smwgQDefaultLimit Default number of rows returned in a query. Can be increased with limit=... in #ask.
50
1.0+
$smwgQDisjunctionSupport Sets whether disjunctions are supported in queries
true
1.0 - 1.1.2
$smwgQEqualitySupport Should 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_SOME
1.0+
$smwgQFeatures Defines which query features should be available by default. see documentation 1.2.0+
$smwgQFilterDuplicates Sets whether duplicate query conditions should be removed from computing query results
false
2.5.0+
$smwgQMaxDepth Maximal property depth of queries
4
1.0+
$smwgQMaxInlineLimit Sets the maximal number of rows ever printed in a single inline query on a single page, even if a setting limit=... is given.
500
1.0+
$smwgQMaxLimit Sets the maximal number of results ever retrieved, even when using special query pages.
10000
1.0+
$smwgQMaxSize Maximal number of conditions in queries.
12
1.0+
$smwgQPrintoutLimit Maximal number of supported printouts (added columns in result table, ?-statements).
100
1.0+
$smwgQRandSortingSupport Sets whether random sorting of query results should be possible
true
1.0+
$smwgQSortFeatures Sets the behaviour for the sorting features of the Semantic search see documentation 3.0.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)
10
1.0+
$smwgQSubpropertyDepth Sets the maximum level of subproperty inclusion (steps within property hierarchy)
10
1.0+
$smwgQUpperbound Sets the upper bound of the offset used for the maximal number of rows ever printed in a single inline query on a single page.
5000
2.1+
$smwgQuerySources Sets another query back-end for Semantic MediaWiki
unset
1.8.0+
$smwgUseCategoryHierarchy Sets whether Semantic MediaWiki should consider MediaWiki's subcategory hierarchy as hierarchy elements in the annotation process
true
1.5.0+
$smwgUseCategoryRedirect Set whether redirects on categories should be detected and used as annotation value
true
3.0.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 array(NS_MAIN, NS_IMAGE).

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

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

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
$smwgAutocompleteInSpecialAsk Sets whether the printout selection on special page "Ask"Provides an interface that assists users with creating and executing semantic queries should use autocompletion on property names
true
1.5.2 - 2.5.5
$smwgResultFormatsFeatures Sets whether features for some result formats should be extended
SMW_RF_TEMPLATE_OUTSEP
2.5.0+


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 full-text search

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
array();
2.5.0+
$smwgFulltextSearchIndexableDataTypes Sets which datatypes are allowed to be indexed using the full-text search see documentation 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 documentation 2.5.0+
$smwgFulltextSearchTableOptions Sets the full-text search table options to use during installation or update see documentation 2.5.0+


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

Parameter Description Default Version
$smwgRSSEnabled Sets whether RSS is enabled or not
true
1.0 - 1.7.1
$smwgRSSWithPages Sets whether RSS feeds should deliver whole pages or just link to them
true
1.0 - 1.7.1

OWL/RDF export

Parameter Description Default Version
$smwgExportResourcesAsIri Sets whether resources should be exported as IRIs (Internationalized Resource Identifiers)
true
2.5.0+
$smwgNamespace Sets the namespace of exported URIs see documentation 1.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

The following settings usually need no modification.

SPARQL and RDF store stettings

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

Parameter Description Default Version
$smwgDefaultStore Sets the storage backend to be used for the semantic data
SMWSQLStore3
1.0+
$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 Defines the SPARQL query features that are expected to be supported by the repository of the identifier (graph) of the SPARQL database. see documentation 2.3.0+
$smwgSparqlQueryEndpoint Sets the endpoint for querying the SPARQL database
http://localhost:8080/sparql/
1.6.0+
$smwgSparqlRepositoryConnector Identifies a database connector that ought to be used together with the semantic data store.
default
2.0.0+
$smwgSparqlRepositoryConnectorForcedHttpVersion Sets whether CURLOPT_HTTP_VERSION should explicitly be forced for the endpoint communication
false
2.3.1+
$smwgSparqlUpdateEndpoint Sets the endpoint for updating the SPARQL database
http://localhost:8080/update/
1.6.0+


Miscellaneous settings

Parameter Description Default Version
$smwgChangePropagationProtection Set 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 documentation 1.5.0+
$smwgDataTypePropertyExemptionList Sets which datatypes are exempted from the property registration process see documentation 2.5.0+
$smwgEntityLookupFeatures Sets improved entity lookup specific features
SMW_EL_INPROP
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+
$smwgHistoricTypeNamespace Sets whether the namespaces "Type" and "Type talk" can be accessed
false
1.6.0+
$smwgIP Sets the path to the installation of Semantic MediaWiki as seen in the local filesystem
__DIR__ . '/';
0.1+
$smwgPDefaultType Sets the default datatype for a property if it was not defined manually
_wpg
1.1.2+
$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+
$smwgSimilarityLookupExemptionProperty Sets the property used to exclude a property from being evaluated during similarity checks
owl:differentFrom
2.5.0+


Parameter Description
$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

Experimental settings

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

Parameter Description Default Version
$smwgEnabledFulltextSearch Sets whether full-text search support for properties may be used
false
2.5.0+
$smwgEnabledQueryDependencyLinksStore Sets whether tracking and storing of dependencies of embedded queries may be used
false
2.3.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
array();
2.5.0+
$smwgFulltextSearchIndexableDataTypes Sets which datatypes are allowed to be indexed using the full-text search see documentation 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 documentation 2.5.0+
$smwgFulltextSearchTableOptions Sets the full-text search table options to use during installation or update see documentation 2.5.0+
$smwgQFilterDuplicates Sets whether duplicate query conditions should be removed from computing query results
false
2.5.0+
$smwgQueryDependencyAffiliatePropertyDetectionList Sets affiliate special properties that additionally initiate a query dependency update when value change occurs
array();
2.4.0+
$smwgQueryDependencyPropertyExemptionList Sets special properties that should be exempted from embedded queries updates see documentation 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+
$smwgQueryResultCacheType Sets whether the query result cache may be used
CACHE_NONE
2.5.0+
$smwgQuerySources Sets another query back-end for Semantic MediaWiki
unset
1.8.0+
$smwgValueLookupCacheType Sets a separate cache type for the object cache when requesting value lookups from the database
CACHE_NONE
2.3.0+
$smwgValueLookupFeatures Sets which value lookup features should be served from value lookup cache see documentation 2.3.0+