Last edited one day ago
by Redaktion

Reference:External Data: Difference between revisions

No edit summary
Tag: 2017 source edit
No edit summary
 
Line 1: Line 1:
{{BSExtensionInfobox
{{BSExtensionInfobox
|removed=No
|desc=allows for using and displaying values retrieved from various sources: external URLs, local wiki pages and local files (in CSV, GFF, JSON and XML formats), database tables, and LDAP servers.
|desc=allows for using and displaying values retrieved from various sources: external URLs, local wiki pages and local files (in CSV, GFF, JSON and XML formats), database tables, and LDAP servers.
|status=stable
|status=stable
Line 9: Line 10:
|license=GPL v2+
|license=GPL v2+
|docu=https://www.mediawiki.org/wiki/Extension:External_Data
|docu=https://www.mediawiki.org/wiki/Extension:External_Data
|active=Yes
|features='''ExternalData''' extension allows MediaWiki pages to retrieve, filter, and format structured data from one or more sources. These sources can include external URLs, regular wiki pages, uploaded files, files on the local server, databases or LDAP directories.
|features=
'''ExternalData''' extension allows MediaWiki pages to retrieve, filter, and format structured data from one or more sources. These sources can include external URLs, regular wiki pages, uploaded files, files on the local server, databases or LDAP directories.




==Parser functions==
== Parser functions ==
The extension defines the following parser functions:
The extension defines the following parser functions:


Line 35: Line 34:
* '''<code>#get_inline_data</code>''' - parses data passed to it, in the same formats as #get_web_data.
* '''<code>#get_inline_data</code>''' - parses data passed to it, in the same formats as #get_web_data.


and also #clear_external_data that erases the current set of retrieved data or only some variables.
and also <code>'''#clear_external_data'''</code> that erases the current set of retrieved data or only some variables.
|active=Yes
}}
}}
{{wcagCheck
{{wcagCheck

Latest revision as of 14:50, 29 April 2026

all extensions


Overview
Description: allows for using and displaying values retrieved from various sources: external URLs, local wiki pages and local files (in CSV, GFF, JSON and XML formats), database tables, and LDAP servers.
State: stable Dependency: MediaWiki
Developer: Yaron Koren, and others License: GPL v2+
Type: MediaWiki Category: Infrastructure
Edition: BlueSpice pro
Version:

Features

ExternalData extension allows MediaWiki pages to retrieve, filter, and format structured data from one or more sources. These sources can include external URLs, regular wiki pages, uploaded files, files on the local server, databases or LDAP directories.


Parser functions

The extension defines the following parser functions:

Data retrieval and handling functions, which set local variables and then display or store them:

  • #external_value - displays the value of any such variable.
  • #for_external_table - cycles through all the values retrieved for a set of variables, displaying the same "container" text for each one.
  • #display_external_table - cycles through all the values retrieved for a set of variables, displaying each "row" using a template.
  • #format_external_table - available only if Cargo is installed. Formats the retrieved external data the same way as #cargo_query.

In the Legacy mode the extension also defines data retrieval functions, which set local variables available with wikipage scope that can later be displayed using the above functions:

  • #get_external_data - retrieves data from various sources, thus replacing any of the below parser functions, and assigns it to variables that can be accessed on the page.
  • #get_web_data - retrieves CSV, GFF, JSON, YAML, XML, HTML, ini, or free-form data from a URL and assigns it to variables that can be accessed on the page.
  • #get_soap_data - retrieves data from a URL via the SOAP protocol.
  • #get_file_data - retrieves data from a file on the local server, in the same formats as #get_web_data.
  • #get_db_data - retrieves data from a database.
  • #get_ldap_data - retrieves data from an LDAP server.
  • #get_program_data - retrieves data returned by a program run server-side.
  • #get_inline_data - parses data passed to it, in the same formats as #get_web_data.

and also #clear_external_data that erases the current set of retrieved data or only some variables.



PDF exclude - start

To submit feedback about this documentation, visit our community forum.

PDF exclude - end