Article Widgets

From unroole CMS wiki
Jump to: navigation, search

The following widgets are provided as part of the article engine in unroole. They provide a user with a way to display article related items that can be managed through the Article Management panel.

Archive Widget

The Article Archive Widget provides a simple way to display a list of articles from various years and months. Any months with articles will create links to add additional filters that can be used to filter the results of other article widgets.

Properties

Article Archive Widget In Action.png

Using article archive widget to display a list of years and months with links to articles.
Name Description
Article Type Choose for which type of articles to filter the list by. If left blank the widget will use the first type.
Article Path The relative path where a visitor should be directed when they click on one of the links for this widget. Leave blank to be on the same page.

For global widget properties see Widgets

Article Calendar Widget

Article Calendar Widget In Action.png

Using article calendar widget to display calendar with links to article.

The Article Calendar Widget provides a simple way to display a calendar of article posts for a given month. Only days which have articles published on that day will be clickable. Once clicked it will append date parameters to the end of the url. You can use the parameters to customize the view of the page. Other article related widget may also use these parameter to determine what to show. For example the Article Post Widget will automatically use these parameters to only show articles created on that day. When changing months the Article Calendar Widget will append any previously used parameters in order to preserve the page state. The calendar can be easily styled using CSS by targeting the following classes:

  • article_calendar_title
  • article_calendar
  • article_calendar_month
  • article_calendar_table

Properties

Article Calender Widget Property.png

Property panel for article calendar widget
Name Description
Article Type Choose which type of the article links you want the calendar have. If left blank will use the first type.
Article Path The relative path where a visitor should be directed when they click on one of the links for this widget. Leave blank to be on the same page.

For global widget properties see Widgets

Article Post Widget

Article Post Widget In Action.png

Using article post widget to display articles.

The Article Post Widget provides a simple way to display articles in reverse chronological order. This is useful when you want a section of your website to display some dynamic information, such as news. Once the articles are added through the article management panel it will automatically shows up in the article post widget (depending on widget options).

Properties

Article Post Widget Property.png

Property panel for article post widget
Name Description
Article Type Choose which type of the articles you want to display. If left blank will use the first type.
Article Path The relative path where a visitor should be directed when they click on one of the links for this widget. Leave blank to be on the same page.
Display Tags Choose whether you want to display tags.
Articles Per Page Number of articles to display in one page.
Display Permalink Choose whether you want to display permalink for each articles.
Article Manifest Length Number of characters to display in the manifest.
Display Manifest Choose "Yes" if you want to display the manifest for each articles. Choose "No" if you want to display the full content of each articles.
Display Author Choose the format for displaying author

For global widget properties see Widgets

Article Category Widget

Article Category Widget In Action.png

Using article category widget to display a list of categories.

The Article Category Widget provides a simple way to display a list of categories of the all articles of a certain type. Each category can then be filtered on by using the appropriate link provided.

Properties

Article Category Widget Property.png

Property panel for article category widget
Name Description
Article Type Choose for which type of articles you want to display the categories. Only categories that were used by at least one article of this type will be shown. If left blank will use the first type.
Article Path The relative path where a visitor should be directed when they click on one of the links for this widget. Leave blank to be on the same page.

For global widget properties see Widgets

Article Featured Widget

Article Featured Widget In Action.png

Using article featured widget to display articles.

The Featured Article Widget provides a simple way to display featured articles. The difference between this widget and the article post widget is that this widget only display the title and some of the content of the articles while the article post widget can also display information like the author, publish date and tags of the article. This article is useful when you want to show some articles in a relatively small section such as the sidebar, because it does not contain all the extra information that the article post widget have, so it is not as crowded.

Properties

Article Featured Widget Property.png

Property panel for article featured widget
Name Description
Article Type Choose which type of the articles you want to display. If left blank will use the first type.
Number of Posts Enter the number of posts to display
Article Manifest Length Maximum number of characters to display for each article.

For global widget properties see Widgets

Article Tag Cloud Widget

Article Tag Cloud Widget In Action.png

Using article tag cloud widget to display a tag cloud.

The Article Tag Cloud Widget provides a simple way to display a tag cloud. It displays all the tags that have been created for all the articles under a specific type. Each tag can then be used as a filter to limit the articles displayed by other article widgets.

Properties

Article Tag Cloud Widget Property.png

Property panel for article tag cloud widget
Name Description
Article Type Choose for which type of articles you want to display tag cloud for. If left blank will use the first type.
Article Path The relative path where a visitor should be directed when they click on one of the links for this widget. Leave blank to be on the same page.

For global widget properties see Widgets