Collections
Collections are essentially indexes of Mura CMS content items based on pre-defined search criteria and/or filters.
For example, Mura CMS can create an index of content items which have been flagged as "Featured" and categorized as "Domestic News" where the content resides under either the Blog or News sections of your site. You can control the maximum number of items you wish to display and more.
You can also choose to broadcast Collections as RSS feeds (http://en.wikipedia.org/wiki/RSS), making it easy for visitors, or even other web sites, to consume information from your site and bring visitors back for details.
In addition to creating Collections of Mura content items, Mura CMS can also consume external RSS feeds and display pieces of that information on your site using the Collection Module, and Remote Feed as the Content Source.
Content Collections
A Local Index is essentially a collection of content which has been indexed and aggregated from either the entire site, or specified areas of the site, based on desired filter criteria. Once created, these Local Indexes can be used as a Collection Module in one or more areas of the site.
The built-in, customizable Collection Module displays a listing of content items which typically include the title, associated image, summary text, official release date, author, and a hyperlink to the full version of the page.
Mura CMS also gives you the ability to publish a Local Index as a RSS feed (http://en.wikipedia.org/wiki/RSS) to syndicate content automatically.
Collections are managed via the back-end administration area of Mura CMS. From the admin navigation menu, select Collections to view the Collections screen.
How to Create a Local Index
- From the Collections screen, click the Add Local Index button.
- The Create Local Index screen should appear. Take a look at the default settings. These are the default "filters" that control which content items get indexed.
- Basic Tab
- Name (required)
- Enter a name for the Collection.
- Sections Pulled From
- You may optionally select zero, one, or more section(s) to narrow down where you want content items to be searched for. If you leave this blank, Mura CMS will automatically search the entire site. Follow the steps below to apply one or more section(s) to the Local Index:
- Click the "Select Section" button to review a search box.
- Enter your desired section title (e.g., "News"), then click the spyglass button.
- Results will be displayed below the search box. Click the plus sign next to the section you would like to include in the Local Index. Once you click the plus sign icon, the selected section should then appear under the Section area.
- If you select the wrong section, click the trash can icon to remove it.
- Repeat these steps for each section you would like to include in the Local Index.
- Sort By
You can sort your Local Index by a variety of fields, or explicitly "Do Not Apply Sort".
- Last Update
- Official Release Date
- Start Date/Time (e.g., Calendar)
- Navigation Title
- Long Title
- Rating
- Created
- Local Manual Order
- Random
- Do Not Apply Sort
- Sort Direction
- Once you choose your Sort By option, you can choose to sort the Local Index by Ascending or Descending.
- Max Items
- Limit the number of content items returned by making a selection here.
- Items Per Page
- Limit the number of content items to be displayed on the page at a time. If more content items are returned than the number selected here, pagination will display.
- Include features only?
- If Yes, Mura will only include content items where the "Feature in this section" field has been enabled.
- If No (default), Mura will ignore this field.
- Include navigation items only?
- If Yes, Mura will only include content items where the "Include in Site Navigation" field has been enabled.
- If No (default), Mura will ignore this field.
- Include items that have been excluded from site search?
- If Yes, Mura will include items that have "Exclude from Site Search" enabled on the Publishing tab.
- If No (default), Mura will not include items that have "Exclude from Site Search" enabled on the Publishing tab.
- Lock name?
- If Yes, Mura will prevent the "Name" of the Collection from being changed, rendering the field as a read-only field. This is useful for developers who reference the specific Collection via code.
- If No (default), the "Name" of the Collection is editable.
- Categories Tab
- Category Filters
- Select any desired categories you wish content items to match in order to be included in the Collection.
- Match All Selected Category Filters
- If Yes, then content items must be categorized as all selected/applied Category Filters to be included in the Collection.
- If No, then content items can be categorized as any of the selected/applied Category Filters to be included in the Collection.
- Advanced Filters Tab
- Choose Advanced Filters
- This section allows you to apply filters based on various form fields, including custom attributes created using Class Extensions. You can then filter based on a number of options pertaining to that field and criteria. For example, whether or not a field such as Credits "Contains" a particular value, as shown in the example above.
- RSS Tab
Most information on this tab is used by experienced developers and/or site administrators.
- Description
- Text entered here will be included in the description node of the XML file automatically created by Mura CMS so RSS parsers can display the information to their users.
- Allow HTML in item descriptions?
- If Yes, HTML will be allowed in the item descriptions.
- If No, HTML will not be allowed in the item descriptions, and will be parsed out when being broadcast.
- Is this a Public Feed?
- If Yes, a link to the collection's RSS feed can be included in the layout templates by your developers.
- If No, a public link will not be generated.
- Version
- Select your desired format to broadcast the RSS feed in. Options include RSS 2.0, and RSS 0.920.
- Language
- You may choose to enter a specific language and country code to be included in the RSS feed.
- Access: Restrict Access to Specific Site Member Group(s)?
- If enabled, you can choose which group(s) you wish to allow access.
- Once you have applied all of your desired filters and criteria, click Add to save the new Local Index.
- Your Local Index should appear in the list of available Local Indexes.
- Whenever you create or edit a Local Index, you should click the three-dot menu to the left of your Local Index, and select View RSS and examine the results.
- Depending on your browser's capabilities, you should be able to view either an XML output or nicely formatted output of the Local Index displaying the content items which match your desired filters.
- If you don't see any items listed, it doesn't mean you did anything wrong, it only means there are no content items which match all of the selected filters you've applied when creating/editing your Local Index.
RSS Feeds
An RSS Feed is an automated collection of content from an external website. This works by using an external website's RSS feed. You can also choose to import the content directly into Mura, and then make modifications to the content items as you wish.
How to Create an RSS Feed
- From the Collections screen, click the Add RSS Feed button.
- The Create RSS Feed screen should appear.
- Basic Tab
- Name (required)
- Enter a name for the Collection.
- URL (required)
- Is this Feed Active?
- If Yes, the feed will appear as an option for content managers when creating Collection display objects.
- If No, the feed will not appear as an option for content managers when creating Collection display objects.
- Is this a Public Feed?
- If Yes, a link to the RSS feed can be included in the layout templates by your developers.
- If No, a public link will not be generated.
- Max Items
- Select the default number of items you wish to consume/import.
- Version
- In order to properly consume the content, it's extremely helpful to indicate the external RSS feed's version/format. Options include RSS 0.920, RSS 2.0, and Atom.
- Categories Tab
- Category Filters
- Select any desired categories you wish content items to match in order to be included in the Collection.
- Import Location Tab
- Import Location
- You may optionally choose to import the external content items into your own website. Select the desired section of the site you wish the content items to be imported to.
- Auto Import
- If Yes, Mura will periodically check the external feed for new content items and import them if found.
- If No, Mura will not import new content items automatically. If you wish to import new content items, you can select the three-dot menu of the Remote Feed, and select "Import" when you wish to do so.
- Click the Add button when finished to save the new Remote Feed.
- Your Remote Feed should appear in the list of available Remote Feeds.
- Whenever you create or edit a Remote Feed, you should click the three-dot menu to the left of your Remote Feed, and select View Feed and examine the results.
- Depending on your browser's capabilities, you should be able to view either an XML output or nicely formatted output of the Remote Feed displaying the content items which match your settings.
- If you don't see any items listed, you may want to verify your settings are entered correctly, and that content items match your desired categories, if selected.
Components
Components are reusable content objects that can be shared across multiple pages or sections within your site. For example, maybe you have an announcement you want to share across your website such as "Closed for Holidays." Without components, you would most likely have to contact a developer, then give the developer a listing of areas you want the notice to appear. However, in this scenario, you most likely would not be able to edit the content of the notice or control whether or not it is on display, etc.
Utilizing components shifts that control back to the content manager. You could create a notice, and choose which page(s) and/or section(s) of the site you would like it to appear, all using a single interface. This means that although the content may span several pages or sections of the site, you can simply edit the component once and it will update all instances throughout the entire site.
Another function of components is to use them as content templates so that non-technical users can recreate a visual style for a specific type of content without having to start from scratch.
How to Create a Component
- From the back-end administration area, go to the Content section, select the Tree View tab, then select the Components button.
-
Click the three-dotted menu beside Components and select Add Content.
-
The Select Content Type dialog window should appear.
-
Component
-
Folder
-
The Folder option is available so that you can create groupings of Components. This is useful for grouping components logically and also for keeping components used by similar groups of users together so you only need to set permissions on the Folder, versus having to modify permissions for each and every component.
-
The Create Component screen should appear.
-
Basic Tab
-
Publishing Tab
-
Display
-
Content Parent
-
Notify For Review
- When enabled, Send to and Message fields will appear.
- Send to
- You may select one or more users to receive an email notification after saving or publishing the component. To select more than one person, use <CTRL> + click (on a PC) or <CMD> + click (on a Mac).
- Message
- Text entered here will accompany a link to view the component in the email notification.
-
Add Notes
-
Categories Tab
-
The Categories tab is where you manage a component's Categories. To learn more about Categories, including how to create/manage categories, and categorize content, visit the Categories section.
-
Tags Tab
-
Advanced Tab
- Content ID
- This is a unique identifier of the component and typically used by developers.
-
Layout Template
-
Locking
- After completing the form, select your desired publishing option to save your component.
- To add the component to a page or section of your site, please visit the Text Module section.
Publishing Options
Mura content managers have a number of publishing options, covered in the Basic Publishing section.
The following section covers content version history, versions comparison, audit trails, the exporting and importing of content.
Version History
Each time a content item is saved, a new version of that content is created. If the content item was published, the previously published version is archived. Each version of the content is available for preview, editing, and publishing through the Version History menu.
To access Version History for content, you can follow these steps:
- From the Tree View or List View tabs, click on the three-dotted menu located next to the content item you wish to view.
- This should reveal a menu of options to select from.
- Or, from the "Edit Content" screen, click the Actions button to reveal a menu of options.
- Select the Version History option from the menu of options.
- Or, from the front-end editing view, select the Version History icon button from the front-end toolbar.
- The Version History screen should appear.
- From the Version History screen, select the three-dot menu next to a specific version of content to Edit, Preview, Delete, or view the Audit Trail.
- From the Version History screen, you can also click the Actions button to reveal options to Clear Version History, Delete the content item altogether, and edit the Permissions of the content item.
Compare Versions
With Mura CMS, you can compare different versions of a content item, to visually see what has changed to various fields. You can compare versions of content from either the Version History screen, or the Audit Trail screen. Follow the steps below to compare different versions of a content item.
- On both the Version History and Audit Trail screens, there are two columns of radio buttons located under a Compare button.
- Select a radio button in one column to indicate the version you want to compare to, and another radio button in the other column to indicate the version you wish to compare from. It really doesn't matter which column you select for either one, as long as the radio buttons in each column are selecting different content versions, Mura will be able to display the differences between the two selected versions.
- Next, click the Compare button above the two columns of radio buttons.
- The Version History Comparison: Code & Attribute Diff screen should now appear, revealing which fields have been changed. The newer version of content will be highlighted in light-green and underlined, while old information will be highlighted in pink with a strikethrough.
Roll Back to a Prior Version
Using the Version History feature of Mura CMS, you can roll back content items to a prior version quickly and easily.
How to Roll Back to a Prior Version
- Go to the Version History screen of the content item you wish to roll back.
- Select the specific version of the content item you wish to re-publish.
- At this point, you can optionally choose to make any desired to edits to the content item.
- When ready, select your desired publishing option (e.g., Publish, Save to Change Set, etc.)
- You have now created a brand new version of the content item, and successfully rolled back to a prior version. Please keep in mind Mura will still maintain the original version of the content item you wished to roll back to, as well as the newly published content item, as you could have made some additional changes prior to publishing it.
Audit Trail
An Audit Trail reveals the individual history of each specific version of content. While similar in nature to the Version History, the primary difference is that content managers can determine which version was used as its source. To view an Audit Trail, go to the Version History of your desired content item, and follow the steps below.
- From the Version History screen, select the three-dot menu icon next to the content version you wish to investigate.
- A menu of options should appear, including an option labelled Audit Trail.
- If you hover (don't click!) over the Audit Trail label, the specific version of content you're hovering over will be highlighted, as well as the versions that it derived from. In the example below, hovering over Audit Trail of the most recent draft reveals the version from 02/10/2017 was used as its source, and the version before that was used at its source, and so on.
- If you click on the Audit Trail menu option, you should be taken to the Audit Trail screen, revealing the specific history of that particular version of content you're currently working with, thus eliminating any unrelated versions from view.
Export Content
Mura CMS offers the capability to export content from your website. You can choose to export your entire site, a section of your site, or even just a page. This is useful for creating a simple backup of a small section of your site, or if you want to move/copy a section of your website to a completely different Mura CMS website.
How to Export Content
- Log in to the back-end administration area of the website.
- Select the content item representing either the page or section you wish to export, and edit the content item.
- From the Edit Content screen, click the Actions button, and select Export.
- If the content item you've selected has any children (sub-pages, files, etc.), you should be presented with the Export Content screen. If you're exporting a single content item without children, this screen will not appear.
- You may choose to export either the Children Only, or This Content Item and Children. When making your selection, you may wish to consider how you will be using the content you are exporting. For example, if you want to include the "News" landing page in addition to its children, then select "This Content Item and Children."
- Once you've made your selection, click Export Content.
- From the Alert dialog window, click Yes to confirm your selection.
- Once Mura CMS bundles the content together for you, a prompt to save the export file as a .ZIP document will appear. You can choose to save it wherever you wish.
- The exported file is now ready for archival and/or ready to be imported into another Mura CMS site.
Import Content
Mura CMS offers the ability to import content that has been exported from Mura CMS, quickly and easily. Please review the steps from the Export Content section before proceeding.
How to Import Content
- From the back-end administration area of Mura, select a content item to edit, where you would like to import the new content. For example, if you would like to import the entire "News" section, you could choose to edit the "Home" page.
- From the Edit Content screen, go to Actions > Import.
- You should be taken to the Import Content screen.
- Click Choose File or Browse to select the Mura CMS created/exported .ZIP file you wish to import.
- Select your desired Content Status for the imported content.
- Published
- The content will be visible by users visiting the front-end, public facing view of your website.
- Draft
- The content will not display on the front-end, public facing view of your website.
- Save to Change Set
- When you select Save to Change Set, the Change Set Name field will appear. Simply enter your desired Change Set Name.
- Click Import.
- Once completed, the imported content should now appear.
Extending the Web Editor
Mura is a Content Management System (CMS), and as such, supports the creation and modification of digital content. Part of the user interface includes a "web editor" that allows a user, even with limited expertise, to add, modify, and remove content from a website without the intervention of a webmaster.
The web editor is most often encountered in Mura when editing content, and is used for form fields such as "Content" and "Summary" that require HTML, yet abstracts the vast majority of the syntax from the content manager.
The current version of Mura utilizes CKEditor, an open source WYSIWYG text editor, which is designed to bring common word processor features directly to web pages, simplifying their content creation. The image below illustrates the default configuration of the web editor.
Many of the features and customization options for the web editor can be found in the CKEditor Documentation at http://docs.ckeditor.com. As a Mura theme developer, you are probably most interested in how to leverage information from the CKEditor Developer Guide. While the information contained there definitely applies, you will need to be aware of where to go in Mura, to make your customizations in an upgrade-safe manner. Throughout this section, you should be able to do just that.
Editor Settings
Mura's web editor, CKEditor, comes with a rich set of configuration options that make it possible to customize its appearance, features, and behavior.
Custom Configuration File
Mura utilizes a custom configuration file for setting CKEditor's configuration. Using a custom configuration file allows you to customize the various toolbars, and offers a way to control much of the way the web editor looks and functions.
The important piece to know is where you can place your custom configuration information. Mura automatically scans for specific files within your theme to use for CKEditor's configuration file. Listed below are the files Mura checks for in the specified order.
../themes/{ThemeName}/js/editor/config.js.cfm
../themes/{ThemeName}/js/editor/config.js
The default theme for Mura as of v7.1, MuraBootstrap4, includes a sample file with miscellaneous configuration examples. You can find it under ../MuraBootstrap4/js/editor/config.js.cfm.txt
Since the sample file's extension ends with ".txt
", Mura will ignore it. If you wish to use it, simply rename the file to remove the ".txt
" file extension.
Custom Toolbar
A common question from developers centers around the ability to customize the editor toolbar. For example, if you only want the "Default" editor toolbar to display Bold, Italic, and Underline options, your configuration file could look something like the following code example.
if ( 'CKEDITOR' in window) {
CKEDITOR.editorConfig = function( config ) {
config.toolbar_Default = [
{name:'group1',items:['Bold','Italic','Underline']}
];
};
}
Using the example code above, the editor toolbars for "Content" will only display the Bold, Italic, and Underline options. However, the "Summary" toolbar will not change, as shown below.
As noted in the sample configuration file, if you wish to update the "Summary" toolbar, you'll need to explicitly define that as well. In addition, the front-end toolbar may be referenced with "QuickEdit". Below is an example that would update all three toolbars.
if ( 'CKEDITOR' in window) {
CKEDITOR.editorConfig = function( config ) {
config.toolbar_Default = [
{name:'group1',items:['Bold','Italic','Underline']}
];
config.toolbar_Summary = config.toolbar_Default;
config.toolbar_QuickEdit = config.toolbar_Default;
};
}
As you can see in the example code, we're simply using the first definition for the other toolbars. However, you could easily have different options for each toolbar definition, if you wish.
The example below displays both the Summary, and Content ("Default") toolbars.
The example below displays the "QuickEdit" toolbar used for front-end editing.
As you can see, Mura exposes CKEditor's configuration settings to allow you the ability to customize Mura's web editor quickly and easily.
Where to Learn More
All available CKEditor configuration options can be found in the CKEditor API documentation. Please refer to the CKEDITOR.config object definition for full details on each option.
Editor Styles Drop-down
Mura's web editor, CKEditor, includes a Styles drop-down list which contains styles that you can apply to editor content in order to assign semantic value to the text you are creating. The functionality is provided by the Styles Combo plugin.
Defining Styles
Mura automatically scans for specific files within your theme to apply styles to the drop-down list. Listed below are the files Mura checks for in the specified order.
../themes/{ThemeName}/js/editor/styles.js.cfm
../themes/{ThemeName}/js/editor/styles.js
Using the first option with a ".cfm
" file extension, allows you the ability to include dynamic code, in the event you wanted to do so.
The default theme for Mura as of v7.1, MuraBootstrap4, includes a sample file with some styles included. You can find it under ../MuraBootstrap4/js/editor/styles.js. Any styles defined here will appear in the Style drop-down list.
Where to Learn More
To learn more about CKEditor Styles, visit the Applying Styles to Editor Content section in the CKEditor documentation. Please refer to the CKEDITOR.styleSet object definition for full details on each option. The Styles section also has some useful information.
Editor Content CSS
Mura's web editor, CKEditor, can include your own CSS files to be used to apply style to the editor content. Generally, these styles should reflect the CSS used in the target pages where the content is to be displayed.
Mura automatically scans for specific files within your theme, specifically for this purpose. Listed below are the files Mura checks for in the specified order.
../themes/{ThemeName}/css/editor.css.cfm
../themes/{ThemeName}/css/editor.css
Using the first option with a ".cfm
" file extension, allows you the ability to include dynamic code, in the event you wanted to do so.
The default theme for Mura as of v7.1, MuraBootstrap4, includes a sample file with basic styles included. You can find it under ../MuraBootstrap4/css/editor.css. Any style definitions found in the file are applied to content entered in the editor body/content area.
For example, if you wanted to set the color of <h2>
and <h3>
tags to "green", you could add the following to your CSS file.
h2, h3 {
color: green;
}
The example image below illustrates the result of the <h2>
tag (visible due to the Show Blocks button being enabled).
Your style definitions may also affect the styles of elements in the Paragraph Format select menu.
Where to Learn More
The CKEditor documentation has more information. The section on Applying Block-Level Text Formats contains some useful information as well.
Editor Body Templates
Mura includes the Content Templates plugin for CKEditor, which provides a dialog to offer predefined content templates - with page layout, text formatting and styles. It comes with a couple of sample templates, and theme developers may also create their own templates.
This feature only impacts the "Content/Body" area of the layout, and is separate from Mura's layout templates.
To see the sample templates in action, select a content item to edit, and locate the template button on the web editor toolbar. It's typically located on the last row, just before the Mura [m] tag button, as highlighted below.
Clicking the template button will launch the Content Templates dialog window.
The sample layouts include 2 Columns, 3 Columns, and 4 Columns. If "Replace actual contents" is enabled, all content will be deleted and replaced with the sample content. If you wish to disable this feature by default, you can add config.templates_replaceContents = false;
to your editor's configuration settings.
The options on this dialog window are controlled by files located under the theme at ../themes/{ThemeName}/js/editor/templates/. Example files can be found in the default theme for Mura as of v7.1, currently MuraBootstrap4.
The images
directory contains the preview images that will display in the dialog window.
The default.js
file contains the code used by CKEditor for the templates.
If you open the default.js
file, you'll see where the "templates
" are defined.
Each template definition should include the following:
title
- This is the text used next to the image in the dialog window as the Title.
image
- This is the image file used for the example layout to be displayed in the dialog window.
description
- This text will display under the Title in the dialog window.
html
- This markup is used to populate the web editor, if the template is selected.
You may add, modify, replace, or delete, any of the examples included.
Note: The sample default.js
file included with MuraBootstrap4 includes the use of Bootstrap class names. You may want to modify these to match your own framework's classes.
Summary
In this section, we covered many of Mura's advanced features such as the fields of each of the available Tabs when editing content items, Publishing Options, Components, Forms, and Collections. From creating categories, tags, and related content, to creating forms and managing data, you should be well prepared to handle working with the more advanced content features of Mura.