Extension:KML Export/kml.folder

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 parser function puts features of the current article into a subfolder in the KML tree and also sets parameters of this folder.

Categories always generate folders even if kml.folder is not used. Articles may automatically generate folders depending on the extension configuration and if there are more than one feature in the same article.

This function instantiates a <Folder> KML feature.

Syntax[edit]

{{#kml.folder: 
 id=id
|name=name
|visibility=visibility
|open=open
|snippet=snippet
|style=style
|description
}}

Arguments[edit]

id (optional)
XML identifier used to refer to this folder. Usually unnecessary.
name (optional)
Name of the folder. If not provided, the current article title is used insted.
visibility (optional)
Sets visibility of the folder. Must be either 0 (zero) or 1 (one). Defaults to 1.
open (optional)
Sets if folder tree node is open. Must be either 0 (zero) or 1 (one). Defaults to 1.
snippet (optional)
Sets the snippet text of the folder.
style (optional)
Sets style URL of the folder. Usually it is a name starting with #, referring to a style set with kml.style. The style doesn't need to be in the same article.
description (optional)
Sets the description of the folder. You may use arbitrary wiki markup that will be converted to HTML

Returns[edit]

On success, this parser function returns no text. If the syntax is not understood, a red error message box is displayed.

Example[edit]

{{#kml.folder:
 name=Monuments and memorials in Brazil
|style=#folderstyle
|These are [[monument]]s and [[memorial]]s in [[Brazil]].
}}