Documentation

Installation

The most important decision to make before proceeding with your installation is whether you should install the template manually, or if you can use the Quickstart package, which will install everything for you.

Which installation method you should use depends on the current status of your site. Also, before installing either the template manually or the Quickstart Package, please make sure you meet the Joomla! and the template requirements.

Requirements

  • Apache 2.2+ or Microsoft IIS 7 (Apache strongly recommended)
  • PHP 5.4+ (PHP 5.5+ Recommended)
  • MySQL 5.1+
  • Joomla 3.4+

Also, please have a look at the Gantry5 requirements. Basically, they are the same as the above, but you will find some additional details there.

Quickstart Installation

The Quickstart Package consist of a full installation of Joomla! that installs Joomla itself, the template, the extensions, the demo content and the database data to match our demo layout. Have in mind that as this is a full Joomla! installation it may only be used on a clean server; the package cannot be installed in an existing Joomla installation. It can only be used when you start a new project/website.

99% of the customers purchase Joomla Templates because of the Quickstart Package. They just install it, replace the demo content with theirs and the site is ready. Installing the Quickstart Package will save you a lot of work.

Installing the Quickstart Package is a fairly simple process. Generally, a Quickstart install will consist of these small steps:

  1. Ensure you have installed an FTP client and prepared a database for your server, or have the credentials for an existing database.
  2. Download and extract the Quickstart Package.
  3. FTP the extracted Quickstart contents to your preferred install location.
  4. Open your browser to the install location on your server to begin the Joomla! installation process, entering the database credentials where required.

Once this final step is complete you will have a fresh install of Joomla!, along with the template and all the settings and content needed to match the demo, including sample article content. However, the images from the demo will NOT be included, as they are licensed via a third party. Instead, blank placeholder images will be included so that you can customize the content easily with your own images. For some users, the above steps are all that is needed for a successful installation of the Quickstart Package, but for those who are less experienced with this process, we recorded the following video (it is for the Oxygen template but the process is absolutely the same for all our templates).

Watch the Video

Manual Installation

Manual Installation refers to installing the template on your Joomla! powered website. This means you already have a website with content items, modules, extensions, so you just decided you want to improve the design of your website.

If you install just the template over an existing Joomla website you will need to install and configure all extensions that are installed in the demo site and configure them absolutely the same way as they are configured in the demo site in order for your website to look like the demo site. For this purpose you will still need to install the Quickstart Package on another location, see how everything is configured there and just duplicate it on your installation.

You can find step-by-step instructions as well as a video instructions regarding the Manual Installation in the Gantry5 Documentation, in the "Installation" chapter.

Customization

All your customization (custom code) should be placed in your "Custom Style Sheet" file. This is the custom.scss file. By default, the custom.scss file does not exists, so you will need to create it. You need to create this file in root/templates/TEMPLATE_NAME/custom/scss. You will find all details in the Gantry5 Documentation, in the "Adding a Custom Style Sheet" chapter.

Changing the logo

You will need to change the logo, that's for sure. You can do that easily by editting the settings of the "Logo" particle:

  1. Go to the "Template Manager"
  2. Click on "Royalty - Default"
  3. Select the "Base" Outline
  4. Go under the "Particle Defaults" tab, scroll down to the "Logo" particle, upload your logo file and save the changes

You can also change the logo from the Layout Manager by editing the "Logo" particle in it but then you will need to do it for each Outline.

If your logo is with different dimensions than the Royalty demo logo (130x130) you might want to adjust the logo margins. You can do that easily by adding the following code in your custom.scss file:

.g-logo {
  margin: 30px 0;
}

You need to modify this 30px so the logo fits the design. This 30px are actually 30px space/margin from the top and 30px from the bottom.

Have a look at the following video. It shows everything that we explained above.

Watch the Video

Update

Updating the template

Updating the template is really easy. Here are the steps you need to perform:

  1. Download the new version of the template from the "Download" section on our website
  2. Go to "Extensions" -> "Manage" and click on the "Browse" button
  3. Select the template file you downloaded in step 1. It will usually be called tpl_it_NAME.zip
  4. Click on the "Upload & Install" button

Gantry5 Framework update

This is just a simple one click task. If there is a newer version of the Gantry Framework released you will notice that in your Joomla Admin as well as in the Template Manager. Then just click on the button.

You might also want to read the "Updating" and "Updating Themes" chapters in the Gantry5 Documentation.

Gantry 5 Basics

Please have a look at the Gantry Documentation in order to discover what Gantry is all about, the core-concepts behind it, and how to get started with this next-generation framework.

You do need to read the Gantry Documentation in order to be able to setup and configure our templates on your website.

The most important things you need to know when working with our Gantry5-based templates are:

  • The Layout Manager is used mostly for creating your module positions. Apart from the module positions, you should also keep the static content in the Layout Manager. By "static content" we mean the "Logo" particle, the "Menu" particle, the "System Messages" particle, the "Page Content" particle, the "To Top" particle and the "Mobile Menu" particle.
  • If you want to hide some modules/elements on some devices (phones, tablets, etc) you should use the hidden-phone, hidden-tablet, etc. classes but you should add them in the particular module positions (under the "Block" tab) in the Layout Manager, rather then in the "Module Class Suffix" field for the particular module. You will find more details in the "Layout Manager" chapter in the Gantry Documentation.
  • As mentioned above, you create your module positions in the Layout Manager, but then you will use the Module Manager to assign your modules, as you would do in any other framework as well as in the default Joomla!
  • In order to publish the custom particles that come with the template you will use the "Gantry5 Particle" module in the Module Manager, rather than adding them directly in the Layout Manager.
  • If you want to change the style of some sections (background color, background image, text color, etc.) globally, for the whole website, you should do it under the "Styles" tab in the "Base" outline. The "Base" outline holds the defaults for the whole website. You can then override those defaults in each outline you create.
  • If you want to load an asset (JS, CSS, etc.) globally in the whole website, you can do it under the "Page Settings" tab in the "Base" outline.
  • If you want to create an empty page so you can assign modules to it, you will use the "Gantry5 Themes" -> "Custom Page" menu item type. Previously, you would use the "Featured Items" menu item type.

Required Atoms

Please have a look at the Atoms sections in the Gantry Documentation so you know what they are all about.

Atoms basically load assets (scripts and stylesheets).

You must load the following atoms so the template can work properly. We recommend adding these atoms to the "Base" outline so the assets can be loaded on all your pages:

  • "UIkit for Gantry5" Atom - loads a modified and optimized version of the UIkit Framework.
  • "Template.js" Atom - loads the template specific JavaScript code.

Optionally, you can also add the "ScrollReveal.js" atom if you want to have onscroll animations. ScrollReveal.js is a library to easily reveal elements as they enter the viewport.

If you install the Quickstart package you do not need to do anything because the above Atoms are loaded by default.

You need to load these Atoms if you install the template manually (refer to the "Installation" section for more details).

The following video shows how you add the Atoms.

Watch the Video

Particles

Gantry5 comes with a brand new Particle system which makes it easy to create, configure, and manage content blocks.

Basically, everything that you would create a Custom HTML module for is now coded in to a particle. You no longer need to copy/paste long HTML codes and edit them, you just need to click here and there and fill out fields in the Admin.

In this chapter we will show you the custom particles that we developed as well as some of the core Gantry 5 particles that we modified and enhanced, for example the "Social" particle.

For more information about the core Gantry5 particles, please have a look at the "Particles" chapter in the Gantry5 Documentation.

CTA Button

The "CTA Button" particle displays a really nice and highly effective Call-to-action button. The following video shows the particle itself and most of its options.

Watch the Video

Contacts

The "Contacts" particle displays contact information. It is a really flexible particle so you can basically display whatever contact details you want. The following video shows the particle itself and most of its options.

Watch the Video

Content PRO

The "Content PRO" particle is one of our most advanced particles. It incorporates several UIkit components as well as quite some custom code and functionality written by us. You can use this particle for many different things. Basically, you will use it to display content, usually images, titles and text. The following video shows the particle itself and most of its options.

Watch the Video

Features

The "Features" particle displays, the quite popular nowadays, features that you, your company or your product provides. The following video shows the particle itself and most of its options.

Watch the Video

Feedback

The "Feedback" particle displays feedback of users, clients and guests. The following video shows the particle itself and most of its options.

Watch the Video

Gallery

The "Gallery" particle is also a very advanced particle that incorporated several UIkit components. It is now a piece of cake to build awesome, responsive galleries in your Joomla! website. The following video shows the particle itself and most of its options.

Watch the Video

Google Map

The "Google Map" particle is really flexible and displays a Google Map. The following video shows the particle itself and most of its options.

The video below is from the Galaxy template as it shows how to generate the "Google Map API Key" as per the changes made by Google on 22nd of June 2016.

Watch the Video

Main Feature

The "Main Feature" particle is divided into a left and right side. It displays an image and some text with a button. You can achieve some really nice visual effects if you add the ScrollReveal.js functionality to this particle. The following video shows the particle itself and most of its options.

We have not modified the "Main Feature" particle for the Royalty template so it has absolutely the same features and design as in the Oxygen template. Therefore, the video below is from the Oxygen template.

Watch the Video

OnePage Menu

The "OnePage Menu" particle display a sidebar, vertical menu that gets sticky/fixed when the user starts scrolling. And the page gets smoothscrolled to the particular sections when a menu item is clicked. The following video shows the particle itself and most of its options.

We have not modified the "OnePage Menu" particle for the Royalty template so it has absolutely the same features and design as in the Oxygen template. Therefore, the video below is from the Oxygen template.

Watch the Video

Page Title

The "Page Title" particle is a nice, small particle that shows a title, icon and description. The following video shows the particle itself and most of its options.

Watch the Video

Portfolio

The "Portfolio" particle is also a very advanced particle that incorporated several UIkit components. It is now a piece of cake to build awesome, responsive portfolios in your Joomla! website. The following video shows the particle itself and most of its options.

Watch the Video

Pricing Tables

The "Pricing Tables" particle displays pricing tables. The following video shows the particle itself and most of its options.

We have not modified the "Pricing Tables" particle for the Royalty template so it has absolutely the same features and design as in the Oxygen template. Therefore, the video below is from the Oxygen template.

Watch the Video

Search/Toggle

The "Search/Toggle" particle is designed specifically for the Royalty template. It is supposed to be used in the Header ONLY. The "Search/Toggle" particle publishes the Search and Contact functionality and it is also responsible for toggling (open/close) the Header/Sidebar. The following video shows the particle itself and most of its options.

Watch the Video

Slideshow

The "Slideshow" particle is basically the UIkit Slideshow coded into a particule and brought as a feature in our Gantry5-based templates. We also added many custom features in it (v2) so it is now one of the most powerful Slideshows you can find on the web. The following video shows the particle itself and most of its options.

Watch the Video

Social

The "Social" particle displays social icons. We enhanced it so you can now also have tooltips with custom test. The following video shows the particle itself and most of its options.

Watch the Video

Social/Copyright

The "Social/Copyright" particle is designed specifically for the Royalty template. It is supposed to be used in the Header ONLY. The "Social/Copyright" particle combines the "Social" and "Copyright" particles so you can publish them at once, in one module position. The following video shows the particle itself and most of its options.

Watch the Video

Tabs

The "Tabs" particle is basically the UIkit Tabs and UIkit Switcher coded into a particule and brought as a feature in our Gantry5-based templates. The following video shows the particle itself and most of its options.

We have not modified the "Tabs" particle for the Royalty template so it has absolutely the same features and design as in the Paradise template. Therefore, the video below is from the Paradise template.

Watch the Video

Modules and Positions

Royalty comes with unlimited module positions. Thanks to the awesome Gantry 5 framework you can now easily create as many module positions as you want. You just need to go to the Layout Manager, drag and drop the "Module Position" particle wherever you want it to be and set the module position name.

Quickstart Package - Modules Overview

Here, just for your orientation, you can see where the modules from the demo are published and what Module Class Suffixes they use.

Header/Sidebar

1. Search/Contacts/Toggle

Module: Gantry 5 Particle
Particle: Search/Toggle
Module Position: header-a
Module Class Suffix: none
Show Title: Hide

2. Logo

"Logo" particle - this is done from the Layout Manager

3. Menu

"Menu" particle - this is done from the Layout Manager

4. Social Icons/Copyright

Module: Gantry 5 Particle
Particle: Social/Copyright
Module Position: header-b
Module Class Suffix: none
Show Title: Hide

"To Top" button

1. To Top

"To Top" particle (Style 1) - this is done from the Layout Manager

"Home - Slideshow" Page

1. Slideshow

Module: Gantry 5 Particle
Particle: Slideshow
Module Position: fullwidth
Module Class Suffix: none
Show Title: Hide

"Home - Portfolio" Page

1. Portfolio

Module: Gantry 5 Particle
Particle: Portfolio
Module Position: fullwidth
Module Class Suffix: none
Show Title: Hide

"Home - Gallery" Page

1. Gallery

Module: Gantry 5 Particle
Particle: Gallery
Module Position: fullwidth
Module Class Suffix: none
Show Title: Hide

"Portfolio - Portfolio" Page

1. Page Title

Module: Gantry 5 Particle
Particle: Page Title
Module Position: navigation-a
Module Class Suffix: none
Show Title: Hide

2. Breadcrumbs

Module: Breadcrumbs
Module Position: breadcrumb-a
Module Class Suffix: none
Show Title: Hide

3. Portfolio

Module: Gantry 5 Particle
Particle: Portfolio
Module Position: showcase-a
Module Class Suffix: none
Show Title: Hide

"Portfolio - Gallery" Page

1. Page Title

Module: Gantry 5 Particle
Particle: Page Title
Module Position: navigation-a
Module Class Suffix: none
Show Title: Hide

2. Breadcrumbs

Module: Breadcrumbs
Module Position: breadcrumb-a
Module Class Suffix: none
Show Title: Hide

3. Gallery

Module: Gantry 5 Particle
Particle: Gallery
Module Position: showcase-a
Module Class Suffix: none
Show Title: Hide

"Contact Us" Page

1. Google Map

Module: Gantry 5 Particle
Particle: Google Map
Module Position: fullwidth
Module Class Suffix: none
Show Title: Hide

2. Company Information

Module: Gantry 5 Particle
Particle: Custom HTML
Module Position: sidebar-right
Module Class Suffix: title-border
Show Title: Show

3. Contact Details

Module: Gantry 5 Particle
Particle: Contacts
Module Position: sidebar-right
Module Class Suffix: title-border
Show Title: Show

"About Us" Page

1. Page Title

Module: Gantry 5 Particle
Particle: Page Title
Module Position: navigation-a
Module Class Suffix: none
Show Title: Hide

2. Breadcrumbs

Module: Breadcrumbs
Module Position: breadcrumb-a
Module Class Suffix: none
Show Title: Hide

3. Who We Are And What We Do

Module: Gantry 5 Particle
Particle: Content PRO
Module Position: feature-a
Module Class Suffix: none
Show Title: Hide

4. "Our Core Values" (Tabs)

Module: Gantry 5 Particle
Particle: Tabs
Module Position: subfeature-a
Module Class Suffix: title-center-border
Show Title: Show

5. What Our Guests Say

Module: Gantry 5 Particle
Particle: Feedback
Module Position: utility-a
Module Class Suffix: title-center-border
Show Title: Show

6. CTA Button

Module: Gantry 5 Particle
Particle: CTA Button (Style 1)
Module Position: mainbottom-a
Module Class Suffix: none
Show Title: Hide

7. Footer Menu

Module: Menu
Module Position: copyright-a
Module Class Suffix: none
Show Title: Hide

8. Social Icons

Module: Gantry 5 Particle
Particle: Social
Module Position: copyright-b
Module Class Suffix: none
Show Title: Hide

"Portfolio 1 (RS Mosaic)" Page

1. Page Title

Module: Gantry 5 Particle
Particle: Page Title
Module Position: navigation-a
Module Class Suffix: none
Show Title: Hide

2. Breadcrumbs

Module: Breadcrumbs
Module Position: breadcrumb-a
Module Class Suffix: none
Show Title: Hide

3. Portfolio 1

Module: RokSprocket > Mosaic Layout > Default Theme
Columns: 3
Blocks per View: 9
Module Position: showcase-a
Module Class Suffix: none
Show Title: Hide

4. Footer Menu

Module: Menu
Module Position: copyright-a
Module Class Suffix: none
Show Title: Hide

5. Social Icons

Module: Gantry 5 Particle
Particle: Social
Module Position: copyright-b
Module Class Suffix: none
Show Title: Hide

"Portfolio 2 (RS Mosaic)" Page

1. Page Title

Module: Gantry 5 Particle
Particle: Page Title
Module Position: navigation-a
Module Class Suffix: none
Show Title: Hide

2. Breadcrumbs

Module: Breadcrumbs
Module Position: breadcrumb-a
Module Class Suffix: none
Show Title: Hide

3. Portfolio 2

Module: RokSprocket > Mosaic Layout > Gallery Theme
Columns: 3
Blocks per View: 9
Module Position: showcase-a
Module Class Suffix: none
Show Title: Hide

4. Footer Menu

Module: Menu
Module Position: copyright-a
Module Class Suffix: none
Show Title: Hide

5. Social Icons

Module: Gantry 5 Particle
Particle: Social
Module Position: copyright-b
Module Class Suffix: none
Show Title: Hide

"Pricing" Page

1. Page Title

Module: Gantry 5 Particle
Particle: Page Title
Module Position: navigation-a
Module Class Suffix: none
Show Title: Hide

2. Breadcrumbs

Module: Breadcrumbs
Module Position: breadcrumb-a
Module Class Suffix: none
Show Title: Hide

3. Choose Your Plan

Module: Gantry 5 Particle
Particle: Pricing Tables
Module Position: feature-a
Module Class Suffix: none
Show Title: Hide

4. Pricing Features

Module: Gantry 5 Particle
Particle: Features (Style 2)
Module Position: subfeature-a
Module Class Suffix: none
Show Title: Hide

5. CTA Button

Module: Gantry 5 Particle
Particle: CTA Button (Style 1)
Module Position: mainbottom-a
Module Class Suffix: none
Show Title: Hide

6. Footer Menu

Module: Menu
Module Position: copyright-a
Module Class Suffix: none
Show Title: Hide

7. Social Icons

Module: Gantry 5 Particle
Particle: Social
Module Position: copyright-b
Module Class Suffix: none
Show Title: Hide

"FAQ" Page

1. Page Title

Module: Gantry 5 Particle
Particle: Page Title
Module Position: navigation-a
Module Class Suffix: none
Show Title: Hide

2. Breadcrumbs

Module: Breadcrumbs
Module Position: breadcrumb-a
Module Class Suffix: none
Show Title: Hide

3. FAQ

Module: RokSprocket > Lists Layout > Default Theme
Module Position: showcase-a
Module Class Suffix: none
Show Title: Hide

4. Footer Menu

Module: Menu
Module Position: copyright-a
Module Class Suffix: none
Show Title: Hide

5. Social Icons

Module: Gantry 5 Particle
Particle: Social
Module Position: copyright-b
Module Class Suffix: none
Show Title: Hide

"Typography" Page

1. Page Title

Module: Gantry 5 Particle
Particle: Page Title
Module Position: navigation-a
Module Class Suffix: none
Show Title: Hide

2. Breadcrumbs

Module: Breadcrumbs
Module Position: breadcrumb-a
Module Class Suffix: none
Show Title: Hide

3. OnePage Menu

Module: Gantry 5 Particle
Particle: OnePage Menu
Module Position: sidebar-left
Module Class Suffix: none
Show Title: Hide

4. Footer Menu

Module: Menu
Module Position: copyright-a
Module Class Suffix: none
Show Title: Hide

5. Social Icons

Module: Gantry 5 Particle
Particle: Social
Module Position: copyright-b
Module Class Suffix: none
Show Title: Hide
The best thing you can do (and actually you MUST do) is to install the Quickstart Package and see how everything is configured and what module class suffixes are used for each module.

Extensions

The Web is full of all kinds of different Joomla extensions. Throughout the years we had the chance to work with many extensions from many different providers which helped us to filter the best of the best ones. The extensions that we use in our templates have the cleanest code, the best functionality and they've been very well supported by their developers.

Almost all of the extensions that we use are FREE! If there is a premium (paid) extensions, we usually try to include a FREE alternative for it.

Below you will find the Download link and the Documentation for each extension (Component, Module, Plugin) that we have used in this template.

Become an insider | Subscribe to our Newsletter
Subscribe to our mailing list and stay up-to-date with all our awesome releases, latest updates and amazing discount offers!