Follow

Article List Module

Please note that Article List Modules are used for Rivista Classic. If you have Rivista 5, please use Mixed Content Lists

The Article List Module will allow you to create a predefined list of articles to display on a page. Configure the module by providing input to the fields displayed. To use the module, go to the Page Editor, Add/Arrange Modules and add the newly created module to your page.

An explanation of the various fields available in this module:

  • Title - This field is only used internally, within your Rivista interface. Name your module in whatever fashion works best to describe the function of your module.
  • Category - Content Manager modules can belong to categories. To include this module in an existing or new category, simply type the name of the category. If the category already exists, you will see a prompt to include this module in that category. If you type a name that does not exist, a new category will be created automatically for you. Categories can be used to sort and filter your Content Manager browser, as well as the “Add and Arrange Modules” interface on the Page Editor.
  • ID Name - This field is used to apply an internal named ID that can be referenced in your templates.
  • Go Live Date - By setting a Go Live Date, you can create and place a module so that it may be published automatically at a predetermined date.
  • Published - This toggle controls whether the module is published on your live site. Unpublished modules will not appear as available for placement in the left field of the “Add and Arrange Modules” interface.
  • Notes - This field is for any notes you may want to leave for yourself or other people working on your website.
  • HTML ID - Not required. Use this field to set a unique ID for your module that will show up in the rendered markup. The ID value must start with a letter, and may not include a space. Legal characters include: a through z, A through Z, 0 through 9, underscore, and dash.
  • HTML Class Name(s) - Not required. Use this field to set a CSS class or classes for your module that will show up in the rendered markup. Each class value must start with a letter. Multiple class names can be specified by separating them with spaces. Legal characters include: a through z, A through Z, 0 through 9, underscore, and dash.
  • Template - You must select a template for your Article List module. The template controls the layout of your module, and may also include some logic to control the display of your data. There are several base templates for the Article List module, and you may also create your own local, custom templates. Base templates are followed by ”(base)” in the template drop down, and local custom templates are followed by ”(custom)”. To include a custom template in this list, name your template with the following naming convention: “module.articlelist.*.tpl” - where the asterisk (*) is your unique name for the template. Place this template in your /html/templates/includes/ directory. You will need SFTP or SSH access to your server in order to do this. If you do not know how to get this access, please contact your Rivista support representative. What follows is a description of the characteristics of each of the base templates:
    • module.articlelist.basic.tpl - Shows a basic, vertical list of articles, based on the tags selected within the module.
    • module.articlelist.departments.tpl - This module has special logic built into it to display a list of articles based on a tag hierarchy. The way the template works is that it looks at the tag supplied, shows an article (or articles) tagged with that tag, and then proceeds through all the child tags that the original tag may have, and displays the articles tagged with those tags as well. So, let's say that you have a “Departments” tag in your Tag Editor, and this has several child tags, such as “Dining”, “Hot Spots”, and “Letter from the Editor”. By selecting the “Department” tag, and using this template, you will create a module that shows a list of “Departments”,”Dining”,”Hot Spots”, and “Letter from the Editor”. For each of these tags, a certain number of articles will be displayed under those headers. The number of articles displayed for each tag is controlled by the “Number of articles in the list” parameter. When using this template, make sure that you only select ONE tag.
    • module.articlelist.features.tpl - This template is identical to the module.articlelist.basic.tpl template, except that it will also display the name of, and link to, the current issue in the upper right of the template.
    • module.articlelist.slideshow.tpl - This template will display your list of articles as a Javascript-powered slideshow instead of a standard list. The slideshow will take the article image for each and display it as a slide in the slideshow. A numeric menu will also be rendered at the bottom of the slideshow. Note that you can control the size of the slides using the “Image Width” parameter. Slides in this template are always square, so if your images vary in their dimensions, they will be automatically cropped. You may need to adjust your stylesheets in order to get this template to look just right, depending on your overall page layout.
  • List Title - This field is the name of your module, as it will appear, displayed on your website.
  • Select Tags - Use this checkbox list to select the tags you wish to use to determine what articles to include in your list.
  • Operator (and/or) - This relates to the tags you select in the “Select Tags” parameter, when you select more than one tag. To explain this, let us use an example where you have selected two tags named A and B. Using the “OR” operator, the article list will return any articles tagged either “A” OR “B”. Using the “AND” operator, the article list will return any articles tagged both “A” AND “B”.
  • Number of articles in the list - This value must be an integer, and controls the number of items to show in the list.
  • Sort order - Options for controlling how the articles are sorted. For options that include multiple values, the sort order starts with the first item in the comma separated list, and proceeds to refine the sorting using the subsequent values. For example - if the option, “Year, Issue Period, Date Published” is selected, the resulting list will first be sorted by Year, then Issue Period, and finally by the Date Published.
  • Issue Filter - This option allows you to control whether or not the articles in the list should be limited to the current issue, or all issues in the system.
  • Show thumbnails? - This option controls whether or not to show a thumbnail with each article in the list. Thumbnails are derived from the image uploaded with the article through the Article Editor interface.
  • Image Width - This value must be an integer, and is expressed in pixels. This represents the maximum width of the image thumbnail, if that option has been set to “Yes”. For most templates, the image will be scaled to this size proportionally - meaning the height will be adjusted automatically.
  • Image Quality - This value must be an integer (from 1 - 100), and controls the quality/file-size ratio of the image. The higher the number, the higher the quality of the JPEG compression applied to the image, and the higher the file size of the image. Since many images with large file sizes take longer to download, find a middle ground that works best for what you are trying to do. To state this another way, high number = high quality / slow page, and low number = low quality / fast page.
  • Show article subtitles? - This controls whether or not to display the Sub Title field found in the Article Editor, for each article in the list.
  • Show article by-lines? - This controls whether or not to display the By Line field found in the Article Editor, for each article in the list.
  • Show article summaries? - This controls whether or not to display the Summary field found in the Article Editor, for each article in the list.
  • Show a link to the archive? - This controls whether or not to display a link to the Article Archive page. The Article Archive page must be defined in the Publication Settings first, or this option will create a link that does not work.
Have more questions? Submit a request

Comments

Powered by Zendesk