Extension:KML Export/Configuration

From MediaWiki.org
Jump to navigation Jump to search
KML Export Features Installation Quick start How to use Parser functions Special pages Configuration Style syntax

This page describes configuration options of KML Export.

Extension settings[edit]

These are configuration options you may set that changes the behavior of the extension. These settings should be put in your LocalSettings.php file, after the line where you load the extension.

$wgKMLExportFoldMode[edit]

Sets how multiple placemarks on the same article are disposed on the KML tree.

Possible values are:

KML_FOLD_ALWAYS
always put placemarks in a subfolder for every article
KML_FOLD_MULTIPLE
put placemarks in a subfolder if article has more than one placemark
KML_FOLD_NEVER
put all placemarks in the category folder

The default setting is KML_FOLD_MULTIPLE.

$wgKMLExportExcerpts[edit]

Not implemented yet...

$wgKMLExportMaxRecursion[edit]

Sets how many categories the extension will descend into while generating KML output. Try to avoid deep recursions, the current algorithm doesn't scale well for deep recursion trees.

The default setting is 3 categories.

$wgKMLExportMultipleCategory[edit]

MediaWiki allows for articles to be categorized into more than a single category, but KML uses a tree structure where every folder and placemark are contained into exactly one parent folder. Normally, if an article is contained in many categories and more than one of these categories are generated on the KML tree, we list the article only on the first category.

If this option is set, placemarks of the same article are listed multiple times, once for each category the article is contained in. This may look more coherent, but creates extra overlapping placemarks, makes output bigger and requires more time to generate.

Before setting this option, you should consider organizing your categories so that this wouldn't be necessary.

The default setting is false.

System messages[edit]

These are internal wiki articles that are used by KML Export. You may change these messages online through Special:Allmessages and the MediaWiki: namespace.

kmlexport[edit]

This is the title of the Special:KMLExport special page. It is required by MediaWiki, but not used. There is no need to change it.

Default (en): "Export geographic coordinates".

kmlexport-common[edit]

This message is parsed for every KML output generated by Special:KMLExport. It is useful to set global styles.

Default: (empty).

kmlexport-root-category[edit]

The name of the root category used by Special:KMLExport when the user doesn't provide one in the URL.

Default (en): "Category:Articles with geographic coordinates".

kmlexport-goto-page[edit]

HTML fragment added to placemark/folder description used to link it back to the wiki.

Default (en):

<p><a href="$1">Click here to open the article page in your browser</a>.</p>

Arguments:

$1
Article page URL.
$2
Article title.

kmlexport-full-article[edit]

Not used yet...