Xhands Documentation
Introduction
This document covers the installation and use of this template and often reveals answers to common problems and issues – we encourage you to read this document thoroughly if you need an in-depth guide on how to use the template.
If you have any questions that are beyond the scope of this document, feel free to ask via ticket support system: Ticket System
To get access to the ticket system, create an account on this page: Create an AccountInstallation
The section will help you with steps to install JL xHands template – Quickstart and Manual installation.
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
Why Quickstart
The quickstart allows you to replicate JL xHands demo to your server. It means, after install the quickstart, you will have a site exactly the same as the demo site.
Download JL xHands quickstart package →, upload to your server and extract it.
Step 1 Configuration: add Site name, Admin email, Admin username and password
Step 2 Database: select database type, host name, database username, password, database name & table prefix
Step 3 Remove/Rename “installation” folder: for security purpose, you need to rename or remove the “installation” folder
Detail documentation with screenshots
Manual 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.
Install Gantry 5 Framework
Step 1 Install Gantry 5 Framework
From your back-end setting panel, go to: “Extensions → Extension Manager”, browse Gantry 5 plugin installation package then hit the “Upload and Install”Install JL xHands template
From your back-end setting panel, go to: “Extensions → Extension Manager”, browse JL xHands template installation package then hit the “Upload and Install”Step 2 Set default template style
Go to: “Extensions → Template Manager”, set JL xHands template style as your default template style.Update
Updating the template
Updating the template is really easy. Here are the steps you need to perform:
- Download the new version of the template from the “Download” section on our website
- Go to “Extensions” -> “Manage” and click on the “Browse” button
- Select the template file you downloaded in step 1. It will usually be called
tpl_it_NAME.zip
- 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.
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).
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.
xHands Template Particles
- Heading | Documentation
- Animated Counter | Documentation
- Carousel | Documentation
- Testimonial | Documentation
- Progressbar | Documentation
- Accordion | Documentation
xHands Template Atom
- Cookie Consent | Documentation
- Backtotop | Documentation
- Sticky Atom | Documentation
Core Gantry5 Particles
- Logo
- Menu
- To Top
- Social
- Module Positions
- Spacer
- Mobile Menu
- Custom HTML
- Module Instance
- Page Content
- System Messages
Build Demo Pages
Base Outline
This page will acts as the global default for any gantry pages. This is where global style, particle defaults, page settings, and layout options are set. For more information, please take a look at Gantry 5 Inheritance. To edit this page, go to Outline -> Base Outline -> Layout Tab
1. Changing the Navigation Section
The Navigation Section contains Logo Particles, Menu Particles.
1.1 Changing the Logo ParticlesYou will need to change the logo, that’s for sure. You can do that easily by editting the settings of the “Logo” particle:
Click the logo particle icon settings and do following 1.2 Changing the Menu ParticlesClick particle menu settings to config the menu for joomla, for more detail about Menu particle, please take a look at this documentation
2. Changing the Footer Section
The Footer Section contains 2 rows, row 1 Module Position – Footer About, Module Position – Footer Link, Module Position – Footer Newsletter, Module Position – Address, row 2 Branding Particles and Horizontal Menu.
2.1 Changing the Module Position – Footer AboutThis module position creates position footer-about and is assigned with module “footer-about”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
2.2 Changing the Module Position – Footer LinkThis module position creates position footer-link and is assigned with module “footer-link”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
2.3 Changing the Module Position – Footer NewsletterThis module position creates position footer-newsletter and is assigned with module “footer-newsletter”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
2.4 Changing the Module Position – Footer AddressThis module position creates position footer-address and is assigned with module “footer-address”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
2.5 Changing the Brading ParticlesClick particle branding settings to edit the Content
2.6 Changing the Horizontal Menu ParticlesClick particle Horizontal menu settings to edit the Content
3. Changing the Offcanvas Section
The Offcanvas section contains Mobile-meunu Particles.
3.1 Changing the Mobile-menu ParticlesAdd the Mobile-menu particles to the menu on the mobile device
Home Page
This outline is assigned to Main Menu -> Home . If you want to edit the assignments and move it to another menu, please select Home from the outline list then switch to Assignments tab. You can assign this outline to whatever menu you want, then click the save assignments button.
Home Layout
1. Changing the Top Bar Section
The Top Bar Section contains Email & Working Hours (Custom HTML Particles) and Phone & Social (Custom HTML Particles).
1.1 Changing the Email & Working Hours (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
1.2 Changing the Phone & Social (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
2. Changing the Navigation Section
The Navigation section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 1 above to edit the Navigation. If you want to edit for only Home page, remove the inheritance then edit it like Base Outline -> Section 1 above.
3. Changing the Slider Section
The Slider Section contains Module Position – Slideshow.
3.1 Changing the Module Position – SlideshowThis module position creates position Slideshow and is assigned with module “Slideshow”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
4. Changing the Header Section
The Header Section contains About (Custom HTML Particles) and Text (Custom HTML Particles).
4.1 Changing the About (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
4.2 Changing the Text (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
5. Changing the Intro Section
The Intro Section contains Contractors … (Custom HTML Particles) and Get a quote button (Custom HTML Particles).
5.1 Changing the Contractors … (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
5.2 Changing the Get a quote button (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
6. Changing the Features Section
The Features Section contains The Best Company … (Custom HTML Particles).
6.1 Changing the The Best Company … (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
7. Changing the Utility Section
The Utility Section contains Content Tabs Particles.
7.1 Changing the Content Tabs ParticlesTo edit the Content Tabs particle, click the Content tabs particle icon settings.
8. Changing the Container About Section
The Container About Section contains 2 Section : Above-left and Above-right.
8.1 Changing the Above-left Section
The Above-left Section contains Helping Small Business … (Custom HTML Particles).
8.1.1 Changing the Helping Small Business … (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
8.2 Changing the Above-right Section
The Above-right Section contains 2 Animated Counter Particles.
8.2.1 Changing the Animated Counter ParticlesTo edit the animated counter, click the animated counter particle icon settings. For more detail about animated counter particle, please take a look at Animated Counter Particles Documentation
9. Changing the Testimonials Section
The Testimonials Section contains 2 rows, row 1 Testimonials Particles, row 2 Carousel Particles.
9.1 Changing the Testimonial ParticlesTo edit the Testimonial, click the Testimonial particle icon settings. For more detail about Testimonial particle, please take a look at Testimonial Particle documentation
9.2 Changing the Carousel ParticlesTo edit the Carousel, click the Carousel particle icon settings. For more detail about Carousel particle, please take a look at Carousel Particles Documentation
10. Changing the Footer Section
The Footer section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 2 above to edit the Footer. If you want to edit for only Home page, remove the inheritance then edit it like Base Outline -> Section 2 above.
11. Changing the Offcanvas Section
The Offcanvas section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 3 above to edit the Offcanvas. If you want to edit for only Home page, remove the inheritance then edit it like Base Outline -> Section 3 above.
About Page
This outline is assigned to Main Menu -> Page -> About . If you want to edit the assignments and move it to another menu, please select About from the outline list then switch to Assignments tab. You can assign this outline to whatever menu you want, then click the save assignments button.
About Layout
1. Changing the Navigation Section
The Navigation section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 1 above to edit the Navigation. If you want to edit for only About page, remove the inheritance then edit it like Base Outline -> Section 1 above.
2. Changing the Header Section
The Testimonials Section contains Module Position – About.
2.1 Changing the Module Position – AboutThis module position creates position about and is assigned with module “about”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
3. Changing the Features Section
The Features section inherited from home so it copies particles and settings from home. If you want to edit this section for all pages, please go to Home -> Section 6 above to edit the Features. If you want to edit for only About page, remove the inheritance then edit it like Home -> Section 6 above.
4. Changing the Utility Section
The Utility Section contains Progressbar Particles and Accordion Particles.
4.1 Changing the Progressbar ParticlesTo edit the Progressbar particle, click the Progressbar particle icon settings. For more detail about Progressbar particle, please take a look at Progressbar documentation
4.2 Changing the Accordion ParticlesTo edit the Accordion particle, click the Accordion particle icon settings. For more detail about Accordion particle, please take a look at Accordion documentation
5. Changing the Above Section
The Above Section contains Carousel Particles.
5.1 Changing the Carousel ParticlesTo edit the Carousel particle, click the Carousel particle icon settings. For more detail about Carousel particle, please take a look at Carousel documentation
6. Changing the Testimonials Section
The Testimonials Section contains Our Job is … (Custom HTML Particles) and Contact Now Button (Custom HTML Particles).
6.1 Changing the Our Job is … (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
6.2 Changing the Contact Now Button (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
7. Changing the Footer Section
The Footer section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 2 above to edit the Footer. If you want to edit for only About page, remove the inheritance then edit it like Base Outline -> Section 2 above.
8. Changing the Offcanvas Section
The Offcanvas section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 3 above to edit the Offcanvas. If you want to edit for only About page, remove the inheritance then edit it like Base Outline -> Section 3 above.
Contact 1 Page
This outline is assigned to Main Menu -> Contact 1 . If you want to edit the assignments and move it to another menu, please select Contact 1 from the outline list then switch to Assignments tab. You can assign this outline to whatever menu you want, then click the save assignments button.
Contact 1 Layout
1. Changing the Top Bar Section
The Top Bar section inherited from Home so it copies particles and settings from Home. If you want to edit this section for all pages, please go to Home -> Section 1 above to edit the Top Bar. If you want to edit for only Contact 1 page, remove the inheritance then edit it like Home -> Section 1 above.
2. Changing the Navigation Section
The Navigation section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 1 above to edit the Navigation. If you want to edit for only Contact 1 page, remove the inheritance then edit it like Base Outline -> Section 1 above.
3. Changing the Header Section
The Header Section contains 2 rows, row 1 Module Position – Map, row 2 Get In Touch With Us (Custom HTML Particles).
3.1 Changing the Module Position – MapThis module position creates position map and is assigned with module “map”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
3.2 Changing the Get In Touch With Us (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
4. Changing the Container Main Section
The Container Main Section contains 2 Section : Mainbar and Sidebar.
4.1 Changing the Mainbar Section
The Mainbar Section contains Module Position – Contact Form.
4.1.1 Changing the Module Position – Contact FormThis module position creates position contact-form and is assigned with module “contact-form”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
4.2 Changing the Sidebar Section
The Sidebar Section contains Module Position – Contact Info.
4.2.1 Changing the Module Position – Contact InfoThis module position creates position contact-info and is assigned with module “contact-info”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
5. Changing the Footer Section
The Footer section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 2 above to edit the Footer. If you want to edit for only Contact 1 page, remove the inheritance then edit it like Base Outline -> Section 2 above.
6. Changing the Offcanvas Section
The Offcanvas section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 3 above to edit the Offcanvas. If you want to edit for only Contact 1 page, remove the inheritance then edit it like Base Outline -> Section 3 above.
Contact 2 Page
This outline is assigned to Main Menu -> Contact 2 . If you want to edit the assignments and move it to another menu, please select Contact 2 from the outline list then switch to Assignments tab. You can assign this outline to whatever menu you want, then click the save assignments button.
Contact 2 Layout
1. Changing the Top Bar Section
The Top Bar section inherited from Home so it copies particles and settings from Home. If you want to edit this section for all pages, please go to Home -> Section 1 above to edit the Top Bar. If you want to edit for only Contact 2 page, remove the inheritance then edit it like Home -> Section 1 above.
2. Changing the Navigation Section
The Navigation section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 1 above to edit the Navigation. If you want to edit for only Contact 2 page, remove the inheritance then edit it like Base Outline -> Section 1 above.
3. Changing the Slider Section
The Slider Section contains 2 rows, row 1 Get In Touch With Us (Custom HTML Particles), row 2 Module Position – Contact Form.
3.1 Changing the Get In Touch With Us (Custom HTML Particles)To edit the Custom HTML particle, click the Custom HTML particle icon settings.
3.2 Changing the Module Position – Contact FormThis module position creates position contact-form and is assigned with module “contact-form”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
4. Changing the Header Section
The Slider Section contains Module Position – Contact Maps.
4.1 Changing the Module Position – MapThis module position creates position map and is assigned with module “map”. To edit the position name, click the module position particle icon settings. Edit position name on the key field. For more information about Module position, please take a look at Gantry 5 positions document
To select which module appears in this place. Go to Extensions -> Modules, select your modules you wish to display, then switch position to the name of module positions, then save it.
5. Changing the Footer Section
The Footer section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 2 above to edit the Footer. If you want to edit for only Contact 2 page, remove the inheritance then edit it like Base Outline -> Section 2 above.
6. Changing the Offcanvas Section
The Offcanvas section inherited from base outline so it copies particles and settings from base outline. If you want to edit this section for all pages, please go to Base Outline -> Section 3 above to edit the Offcanvas. If you want to edit for only Contact 2 page, remove the inheritance then edit it like Base Outline -> Section 3 above.
Stop
Positions
JL xHands 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.
Learn how to create any positions quickly without coding here.
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.
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 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.
Below you will find the Download link and the Documentation for each extension (Component, Module, Plugin) that we have used in this template.
- AcyMailing – Download | Documentation
- SP Quick Contact – Download
- Unite Slider (already included in quickstart package) – Purchase | Documentation
- Our Gantry 5 Particles
If you have any specific request or feedback as well as suggestions, feel free to drop us a line in Ticket System. We’ll try to cover them all.
Comments