Cargo/Other features

View or edit this template

Cargo

Basics

• Main page
• Quick start guide

Using Cargo

• Storing data
• Querying data (Display formats)
• Exporting data
• Other features

Additional help

• Troubleshooting
• Attaching tables
• Customizing tables
• Recreating tables

"Purge cache" tab

Cargo provides a "Purge cache" action in the actions dropdown by the searchbar. Wikis with Cargo should not enable the "purge" gadget or they may end up with two purge buttons.

Special:CargoTables

The page Special:CargoTables shows a listing of all tables in the wiki, and some helpful links for each one. The page does double duty: for users and administrators, it's a convenient way of seeing the overall layout of the data; while for administrators, it's also a sort of dashboard for maintaining all the tables. For users, Special:CargoTables has a link to each Cargo table. For administrators, each table also gets "recreate" and "delete" links, making it easier to manage all the data from a single location.

The main link for each table goes to the page "Special:CargoTables/tableName". Going to such a subpage will show a table displaying the full contents (again, except for "hidden" fields), as well as a listing of all the fields and their types.

This page has one global setting: $wgCargoTablesPrioritizeReplacements, which, if set to true in LocalSettings.php, will first display all tables that have a replacement table for them, at the top, instead of simply listing all tables in alphabetical order.

Special:CargoQuery

If you are logged in and go to the page Special:CargoQuery , you can see a form that that lets you create and run queries (with the same structure as #cargo_query) by filling out the form inputs. These inputs provide help like autocompletion and validation in order to make the task easier.

Cargo data for a single page

If Cargo is installed, you can click "Cargo data" in the toolbox section of any page to see what Cargo data is stored on that page. This link will be present even if no data is stored.

API

Cargo defines a number of API actions, some for internal use (to be called via Ajax), and some for use by outside scripts:

• cargofields - returns all the fields in a specified table
• cargoformatparams - returns all the parameters for a specified format
• cargoquery - calls the specified Cargo query, generally for use by JavaScript-based display formats
• cargoqueryautocomplete - returns a list of table or field names matching a substing, for use within Special:CargoQuery
• cargorecreatedata - recreates a specified Cargo table, for use from various pages
• cargorecreatespecialtable - recreates a "special" Cargo table such as _pageData
• cargorecreatetables - recreates all the tables associated with the specified template
• cargotables - returns all the tables defined in the wiki

Displaying maps outside of a query

Cargo's maps only support real-world maps. To display fictional maps, please see DataMaps.

The parser function #cargo_display_map will display coordinates on a map outside of a Cargo query. It takes in coordinates, as well as a few optional parameters, and displays a map for that one point.

The parameters for #cargo_display_map are:

• point= - takes in a set of coordinates (mandatory).
• service= - the mapping service used; can be googlemaps (for Google Maps), leaflet (for Leaflet) or openlayers (for OpenLayers). OpenLayers is the default service.
• zoom= - sets the zoom level. For both Google Maps and OpenLayers, the zoom level is an integer number between 1 and around 20, with higher numbers being more zoomed in. The default value for this parameter is 16 for both mapping services.
• height= - sets the height of the map; the default value is 400px.
• width= - sets the width of the map; the default value is 700px.
• image= (for the leaflet service only) - sets an image to be the background for the map display, instead of a standard geographical map; specified image must be one that has been uploaded to the wiki.