{module_literature}

Description

When inserted into a page it will display the literature item(s). After adding the Literature module to a web page, you can make changes to it to slightly to alter its behavior.

Syntax

{module_literature render="item|collection" filter="item" itemid="literature-item-Id or classificationId" targetFrame="blank" collection="my_custom_collection_name" template="/folder/template.tpl"}

Note: When using named parameters always wrap the individual parameters in double quotes. Also, do note that modules using named parameters do not work for campaigns just yet.

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • filter - filtering criteria for display and can be one of the following:
    • item - individual item
    • all - all items
    • latest - latest items
    • latestClassified - latest items in a category
    • random - random item
    • randomClassified - displays a random item in a particular category
    • classified - all the items in a category
  • itemid - the ID of the literature item or the ID of the categorysystem generated (do not change)
  • targetFrame - the frame in which to open the item in
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • the list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use the News layout reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:
Liquid tag Description
Add literature to favorites list. Optionally customize to display your own custom image for adding and removing.
{tag_button,Your Text} replace Your Text with your own text, e.g. Click for more information
{{counter}} Incremental count of the literature on the page
{{description}} Description of literature
{{expiryDate}} Expiry date of literature
{{fileSize}} File size of the literature in KB
{{iconUrl}} Icon representing the file type of the literature (16x16 pixels)
{{lastUpdateDate}} Last update date of literature
{{name}} Literature name (will not have hyperlink)
{{fileUrl}} Literature item file Url
{{releaseDate}} Release date of literature
Tell a friend about this literature

Examples

  • {module_literature filter="item" itemid="823" targetFrame="_blank"} - This will display the link to individual literature item which when clicked will open in the new window
  • {module_literature filter="a" targetFrame="_blank"} - This module will display links to all literature items which when clicked will open in the new window
  • {module_literature filter="latest"} - This module will display the latest items (default is 10 items)
  • {module_literature filter="random"} - This module will display 1 random literature item
  • {module_literature filter="cr" itemid="14606"} - This module will display 1 random literature item, from the category called "Company", identified through id 14606
  • {module_literature filter="item" itemid="823" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.

Syntax

{module_literature,filter,id,targetFrame}

Parameters

  • filter - filtering criteria for display and can be one of the following:
    • i - individual item
    • a - all items
    • l - latest items
    • r - random item
    • cr - displays a random item in a particular category
    • cl - latest items in a particular category
  • id - system generated (do not change)
  • targetFrame - the frame in which to open the item in

Layouts

Examples

  • {module_literature,i,823,_blank} - This will display the link to individual literature item which when clicked will open in the new window
  • {module_literature,a,,_blank} - This module will display links to all literature items which when clicked will open in the new window
  • {module_literature,l,} - This module will display the latest items (default is 10 items)
  • {module_literature,r,} - This module will display 1 random literature item
  • {module_literature,cr,14606,} - This module will display 1 random literature item, from the category called "Company", identified through id 14606