Documentation: Content Calendar module
Frontend module (PRO)
Unlock this and other features by upgrading to Joomill Content Calendar PRO
Go PRO
Besides the administrator dashboard widget, Content Calendar PRO also ships a separate module that shows the calendar to your visitors on the site itself. Install and publish it like any other Joomla module, under Content > Site Modules (not Administrator Modules), and assign it to a menu item or module position.
Basic settings
| Categories | Select categories to display articles from. |
| Date Field | Select which date field to use for displaying articles in the calendar: Start Publishing, Featured Up, or a Custom Field. |
| Custom Date Field | When Date Field is set to Custom Field, select a custom calendar field to use for displaying articles. |
| End Date Field | Optional, and chosen independently of the start date field: None (default), Finish Publishing, Featured Down, or a Custom Field. With an end date set, an article is shown on every day of its period instead of only on its start day. Note that Finish Publishing and Featured Down mark the end of the publication, not necessarily the end of the event. |
| Custom End Date Field | When End Date Field is set to Custom Field, select the custom calendar field holding the end date. |
| Sort Items Within a Day | Order of the items that fall on the same day: Start Date (default), Start Publishing Time, Featured Up Time, or a Custom Field. By default the items follow the start date and then the order in which they were entered. See Sorting items within a day below. |
| Sort Field | When Sort Items Within a Day is set to Custom Field, select the custom field to sort the items of one day on. Items without a value are shown last. |
| Link items to | Choose what a click on a calendar item opens: the article (default), Link A, Link B or Link C from the Options tab of the article itself, a custom field, or nothing, which shows the items without a link. See Linking items to another page below. |
| Link field | When Link items to is set to a custom field, select the article field that holds the address. A URL or text field works. |
| When the link is empty | What to do with an article that has no address in the selected link: open the article anyway (default) or show the item without a link. |
| Open articles in | Choose how an article opens when a calendar item is clicked: the current window (default), a new window, or a modal popup. The modal renders in the page itself, so it inherits the site template styling and keeps working after AJAX month navigation. An item that links somewhere other than its own article always opens as a normal link, also when the modal popup is selected. |
| On hover | Choose what appears when the mouse hovers a calendar item: a plain browser tooltip (default), a hover card that follows the popup layout below, or nothing. Hover and click are independent, so a hover card on hover combined with opening the article on click is possible. Devices without hover (touch) skip the card and simply follow the configured click action. |
| Popup layout | Build the popup used by the modal and the hover card: add rows and drag them into the order the elements should appear. Choose from Title, Category, Author, Publish date, Created date, Intro image, Full article image, Intro text, Full text, Tags, Read more link, or an article Custom field, each with an optional Show label toggle. When empty, a default layout is used (title, publish date, author, intro image, full text). |
Multi-day events
As soon as an End Date Field is configured, the calendar looks for articles that overlap the period on screen instead of articles that start in it, so an event that began before the visible month or week is still drawn on the days it runs into it.
A multi-day event is drawn as one continuous bar: on the side where the event continues, the corners are squared off and the bar runs up to the cell edge. The title is repeated at the start of every week row, so a bar continuing from the previous row or month is never a nameless block of colour, and the tooltip gains an end date line.
Without an End Date Field the calendar behaves exactly as before: every article appears on its start day only.
Sorting items within a day
When several items fall on the same day, Sort Items Within a Day decides their order. This is useful when your start date field holds a date only and the start time sits in a separate field: without sorting, those items appear in the order they were entered.
The items are sorted on their time of day, not on the full date, so a multi-day event continuing from the day before takes its place by its own start time. A custom field holding text such as "10:00 AM" or "14:30" is read as a time, which puts 12:15 PM correctly before 1:00 PM. A value that is not a time is sorted alphabetically after the timed items, and items without a value are shown last.
The AJAX month navigation sorts the same way as the first page load. With Start Date (default) the order is unchanged from previous versions.
Linking items to another page
By default a click on a calendar item opens the Joomla article. With Link items to you can send visitors somewhere else, for example to an external event page whose address you keep in the article:
- Link A, B or C from the article: the links on the Options tab of the article itself. When the article also fills in the link text, the read more button in the popup uses that wording instead of the standard "Read more".
- A custom field: any article custom field holding an address, selected under Link field.
- Nothing: the items are shown without a link.
When the link is empty decides what happens with an article that has no address in the selected link: open the article anyway, or show the item without a link.
An item that points somewhere other than its own article always opens as a normal link, even with Open articles in set to the modal popup, because a popup showing the Joomla article would contradict where the link points. Joomla's own target setting on Link A, B and C is not used; Open articles in stays the single setting that decides how a link opens.
Only web addresses (http, https, mailto, tel) and paths within your own site are used. Anything else in the field is ignored and the item follows the When the link is empty setting.
Display settings
| Layout | Choose the module layout: a monthly grid or a rolling weeks view. |
| Week starts on | Choose which day begins the week in the calendar grid: Monday (default) or Sunday. Applies to both the monthly grid and the weeks layout, including the weekday header row and the weekend background styling option. |
| Show last week | When Layout is set to the weeks view, also include the previous week before the current range. |
| Number of upcoming weeks | When Layout is set to the weeks view, how many upcoming weeks to show after the current week (0-10, default 5). The current week is always shown; enable Show last week to also include the previous week. |
Colors
| Color mode | Choose how article colors are determined: by Category, Tag, Author, or an article Custom Field. |
| Category Colors | When Color mode is set to By category, define custom colors for specific categories. Use + to add a new category or the remove icon to delete a row. |
| Tag Colors | When Color mode is set to By tag, define custom colors for specific tags. If multiple tags match an article, the first matching tag determines the color. |
| Author Colors | When Color mode is set to By author, define custom colors for specific authors. |
| Custom Color Field | When Color mode is set to By article custom field, select the article custom field that determines the color. A color-type field is used directly; for a list-type field, map its values to colors below. |
| Field Value Colors | Map the values of the selected list field to colors. Not needed for a color-type field, since its value is used directly. Articles without a matching value fall back to the category color. |
Styling
Every styling option is empty by default and only applies when set, so your template's own styling remains the fallback. Settings apply per module instance.
| Month title color | Color of the month/period title above the calendar. |
| Weekday header background / text color | Background and text color of the weekday header row. |
| Border color | Color of the grid borders. |
| Day background | Background color of a regular day cell. |
| Empty day background | Background color of a day outside the current month (monthly layout). |
| Weekend background | Background color of Saturday and Sunday cells. |
| Today background | Background color of the current day's cell. |
| Today accent color | Background of the day number highlight on today (monthly layout). |
| Day number color | Text color of the day number. |
| Day cell height (px) | Fixed height of a day cell, in pixels. |
| Article text color | Text color inside an article bar. |
| Article font size (px) | Font size inside an article bar, in pixels. |
| Article corner radius (px) | Corner rounding of an article bar, in pixels. A multi-day bar keeps square corners on the side where the event continues. |
| Custom CSS | Extra CSS rules, output as-is after the styling options above. |
Advanced
| Header icon | FontAwesome icon class shown next to the module title. |
Visibility
The module only shows articles the current visitor is allowed to see. Both the initial page load and the AJAX month navigation check that the module is published and visible for the visitor's access level; the same check applies to the article content loaded into the modal or hover card.