Help:UploadWizard/Campaigns

From: Everything Food & Drink.org
Jump to: navigation, search

Concept[edit]

The UploadWizard can be configured to behave in a number of ways using various settings. Often one wants the UW on a single wiki to behave differently for different tasks, in which case more than one set of configuration is needed. The UW allows defining such sets of configuration, also called campaigns, which can then be put into affect by specifying a single argument in the url via which the UW is accessed.

Using a campaign[edit]

When navigating to Special:UploadWizard, no campaign will be used, so you will get the default configuration. To get the configuration for a campaign, add ?campaign=name to the url, where "name" is the name of the campaign.

Campaign administration[edit]

On Special:UploadCampaigns all campaigns are listed in a table, with links edit and delete links for each campaign. This page also allows adding new campaigns. When editing or adding a campaign, you get a form that lists all configuration you can set for the campaign. The first two fields on the form allow specifying the name of the campaign and if it should be enabled or not. When it's not enabled, people attempting to access it will get a notice stating the campaign is disabled.

Campaign options[edit]

Header text[edit]

This option allows you to display content such as banners above the UploadWizard interface. The option takes the title of a page that holds this content. For internationalization purposes one can use "$1" as token which then gets replaced by the language code, ie Awesome_banner_$1 will be turned into Awesome_banner_en for users that have their language set to English, and to Awesome_banner_nl for those with Dutch as language. When there is no page for the users language, English will be used as fallback.

Skip the licensing tutorial[edit]

When this option is checked, the upload wizard will not show the licensing tutorial on page load.

Tutorial width[edit]

The width of the tutorial image, in pixels.

Imagemap coordinates[edit]

The coordinates of the clickable area on the licensing tutorial image that links to the helpdesk.

ID field wikitext[edit]

When anything is specified here, an ID field will be shown on the details page. $1 in the setting will be replaced by the ID entered by the user and then put onto the image page after upload. For example, when this setting is set to {{Rijksmonument|$1}}, and the users enters 42, the image page will contain {{Rijksmonument|42}}.

ID field label text[edit]

Text to display as label above the ID field.

ID field page name[edit]

Instead of specifying some simple text using the ID field label text setting, it's possible to specify a page of which the content should be used for this purpose. When specified, and the page exists, this value will be used instead of the one of the ID field label text setting. For internationalization purposes one can use "$1" as token which then gets replaced by the language code, ie ID_Field_label_$1 will be turned into ID_Field_label_en for users that have their language set to English, and to ID_Field_label_nl for those with Dutch as language. When there is no page for the users language, English will be used as fallback.

Copyright holder choice[edit]

This setting allows restricting uploads to only own work licenses, only third-party work licenses or allow for both, in which case the user gets to choose.

Own work licenses[edit]

The licenses that the user should be able to choose for own work uploads. When there is only a single license, the user will not be shown any further options, and only be able to accept it or abort upload.

Default own work license[edit]

The license that will be used for the image when the user does not make any licensing changes.

Default categories[edit]

A pipe-separated list of categories that will be listed in the describe tab by default. The user can remove these categories.

Auto categories[edit]

A pipe-separated list of categories that will be added to the image page after upload. These categories are not displayed in the UW interface, so the user cannot remove them during the upload process.

Auto wikitext[edit]

Wikitext that will be added to the image page after upload. This is not displayed in the UW interface, so the user cannot remove it during the upload process.

Thanks label page[edit]

This option allows modifying the thanks message displayed on top of the use page after the upload has finished. The option takes the title of a page that holds the content to be used for this message. For internationalization purposes one can use "$1" as token which then gets replaced by the language code, ie Thanks_message_$1 will be turned into Thanks_message_en for users that have their language set to English, and to Thanks_message_nl for those with Dutch as language. When there is no page for the users language, English will be used as fallback.