> > Preferences variables

Preferences variables

'Preferences' variables can be used to alter the way in which content types behave. For example, you can display a custom message when a user submits a form, or make a menu appear at the top of the 'keyword index' content type, when there is more than one keyword being displayed.

To set 'preferences' variables:

  • Go to 'Location setup > Advanced > Preferences' of the desired page
  • Enter the relevant variables in the following 'query string' format (e.g. 'variable1=a value&variable2=another value&variable3=yet another value'). It is normally OK to enter spaces in the values of variables.
  • NOTE: Once set, you can edit the values of variables individually by clicking on 'Show preferences' at the top of the page whilst viewing the 'Location setup' properties (this link only appears when 'preferences' variables have been set).

You can find a list of examples below, along with explanations of where they are used and what they do.

|
C
|
F
|
K
|
L
|
S
|
V
|
Keyword index
Variable: keyword_index_make_menu
Purpose: Creates a menu of keywords at the top of the 'keyword index' content type, if you are using more than one keyword. (This allows users to navigate more easily within long pages).
To activate: set to 'keyword_index_make_menu=1'
Comparison tables
Variable: comparison_header
Purpose: Defines the overall title of a comparison table.
To activate: set to e.g. 'comparison_header=A title'
Comparison tables
Variable: comparison_column1 / comparison_column2
Purpose: Defines the column headings of comparison tables.
To activate: set to e.g. 'comparison_column1=A column heading'
Site map
Variable: site_map_show_hidden
Purpose: Does not show items set to 'hidden' or 'editorial status=red' in a site map.
To activate: set to 'site_map_show_hidden=hide'
Competition quiz
Variable: quiz_competition_form
Purpose: Sends 'Competition quiz' and 'Competition quiz on a single page' variables to a different location upon submission (useful for sending variables to a form).
To activate: set to 'quiz_competition_form=LOCATION_ID'
Form
Variable: form_show_form_on_success
Purpose: When the user has submitted content using a form, this shows a blank form to be used again (by default, the form usually disappears and is replaced by a response).
To activate: set to 'form_show_form_on_success=1'
Form
Variable: form_success_message_overrides
Purpose: Makes a custom response appear when a user has submitted a form, instead of a standard one.
To activate: set to 'form_success_message_overrides=1'
Form
Variable: form_success_message
Purpose: Displays a custom response when a form has been submitted. NOTE: you will also need to activate 'form_success_message_overrides'
To activate: set to e.g. 'form_success_message=< h3 >Thanks< p >Your submission has been received< /p >' (NOTE: remove spaces in HTML tags)
Keyword index
Variable: keyword_index_hide_description
Purpose: Hides the description for keyword index items, just displaying the title.
To activate: set to 'keyword_index_hide_description=1'
Vocabulary list
Variable: vocablist_column1 / vocablist_column2
Purpose: Defines the column headings of vocabulary tables.
To activate: set to e.g. 'vocablist_column1=A column heading'
Vocabulary list
Variable: vocablist_follow_item
Purpose: Allows vocabulary list items to be attached to separate pages of an article (when 'Article' and 'Vocabulary list' are used on the same page)
To activate: set to 'vocablist_follow_item=true'
Links
Variable: link_show_all
Purpose: Makes all pages in a link list appear on the same page, at once, rather than being paged sequentially.
To activate: set to 'link_show_all=true'

Comments

Add a comment

Comments are moderated, and will not appear immediately.

Your e-mail address will not be revealed to the public.
HTML is forbidden, but line-breaks will be retained.
This can be a URL of an image or a YouTube, MySpaceTV or a Flickr page (we'll handle the media embedding from there!)
This is to prevent automatic submissions.