Author: ChitrakootWeb

Amava Documentation

Thank you for purchasing our template! This is the documentation that will help you with customizing and orienting in the template.

Important! This is a static HTML template and not a WordPress theme! It doesn't have any admin/back-end panel. and it is created for the developers or people who knows the HTML code.

Getting started

Before you dive into code, you we want you to explain how the template is structured and organized, what support is included, what tools did we have used etc.

Help & Support

Item support includes:
  • Availability of the author to feedback
  • Get assistance with reported bugs and issues
Item support does not include:
  • Customizations and installations

Support is node via email at [email protected]

How to find a version of your template

Go to /css and open style.css. Here you can find a Version at the very top.

Folder Structure

amava

Main (root) folder

bat

contains contact form processing .php script.

css

Template styles.css and styles.scss and other plugins CSS files.

fonts

Font Awesome (icons) files.

img

Images that are used in the template.

js

Template main.js and other JS plugins.

search

performs search through content of .html files.

video

Video that is used in the template.

Image Placeholders

All images are replaced by placeholder due to copyright policy. We cannot include them in the package and sell it.

Layout

Template is responsive and uses Bootstrap grid system. Base layout includes three sections.

  • Header
  • main-banner-area
  • Section Content
  • Footer
<html>
<head>
<!--CSS includes-->
</head>
<body>

    <div class="main-wrapper">
        <header class="header"><!-- banner -->
            <nav class="navbar navbar-expand-lg"><!--navbar--></nav>
        </header>
        <section><!--section content--></section>
        <footer><!--footer--></footer>
    </div>        

<script>
    //JS plugins includes
</script>

</body>
</html>

Header


                            

scrollHeader is used to stick the navigation to the top of the page when scrolling.

Main Banner Area

For Demo-01


For Demo-02

For Demo-03 (One page)

Section Content

section this tag gives the top and bottom padding.

Basic Customization

How To Edit Files

You can use whatever text editor you like, even default Text Editor in the OS. But we recommend to use the one with th syntax highlighting such as:

  • Sublime
  • Notepad++

How To Change Fonts

  1. If you are not satisfied with the default font, you can choose from hundreds ones from the Google Fonts. After you are happy with the selected font, click SEE SPECIMEN. You'll be redirected to to font detail. Then click Select this font. Popup window will show with text "1 Family Selected" - click it. Then you can customize your selection by clicking Customize. When you are done copy the text in import tab.
    For example @import url('https://fonts.googleapis.com/css?family=Open+Sans:300,400,600,700,800');
  2. Then open the helper.css file to change fonts and find the @import... element which loads the Google font and place your copied code.
  3. Final step is to change the font family in the css/plugins/default.css file. Find body tag on the beginning of the file and font-family inside. Go back to Google Fonts page where you have chose your font and copy the line placed in the Specify in CSS. In this example it is font-family: 'Open Sans', sans-serif;

How To Change Colors - Simple Way

There are two methods how to change the main color. 1st Just by replacing the HEX color value in the styles.css (simple) and 2nd by installing koala or you can choose another compiler as well (advanced). Here is the simple way.

Let say, that you want to change the default red color to blue one:

  1. Add template to the koala
  2. Set styles.sccs path to output pathstyles.css (With right click of styles.scss)
  3. Now open the style.scss in your text editor, find Replace or Find and Replace function
  4. As original text enter the red color #ff0000 (template default color)
  5. As Replace with enter HEX value of blue color #0000ff

Font Awesome Icons

Font Awesome includes more than 900 icons that can be easily used on your site. For example you want the download link with the PDF icon.

  1. Go to Font Awesome Icons gallery and find the one you need. I our example it is file-pdf. Click the detail, then find and copy .
  2. Place the copied line to your link: Download File
  3. Final result: Download File

Bootstrap Utilities

Template is using Bootstrap utilities very often. We think that it is better solution as writing all styles for every element into CSS file. It makes the style.css smaller and it is more flexible. You can find more about Bootstrap Utilities.

Advanced Customization

JavaScript

JavaScript (JS) files/plugins are located in the /js folder and in the HTML file they are called using code. All JS files are located at the bottom of the HTML file. main.js file is the template's JS file that includes scripts for running other plugins.

Note: You will need to modify only main.js file. Read more about it in the Plugins section.

Styling the Background

You can easily change the color of the background without editing of the CSS/SCSS files. This can be applied to whole section or particular element as well.

Background Color

To change the background color of the element use bg-* class.

Example: Change the background color of the section to black.

<section class="bg-black">
<h2>This Section is Black</h2>
</section>

Background Image

To add the background image of the element. You can also add an opacity using data-overlay-dark

Example: Background image with the 70% opacity:

 <section class="bg-img cover-background" data-overlay-dark="7" data-background="image path;">
     <div class="container"><!--content--></div>
 </section>

Important!

  • You can also change the opacity and color with changing of data-overlay-dark | data-overlay-light
  • You can also change the background overlay color with use of class="theme-overlay" For example: <section class="bg-img cover-background theme-overlay"
  • <div class="parallax"> or <div class="bg-img"> It's necessary to use one class of above without that it won't be work. (class="parallax" or class="bg-img").
  • Easy background parallax effect is done using data-background. You can also change the speed and overlay of the parallax effect and overlay by adding data-stellar-background-ratio="0.5" and data-overlay-dark="6" (For Parallax effect just add the class="parallax")

Forms

Template uses Bootsrap form structure and brings some own styles.

Contact Form

Amava comes with working email. You can use them for contact, subscribe or other forms that will collect the user's email address and send it to your receiving one.

Important! Contact form must have action="bat/rd-mailform.php"

Note: It is better to test email sending on live server. It does not work on a local machine.

Setup a path to PHP file

In your <form> element you need to specify a path to the .php file that will handle the email.

<form method="post" action="bat/rd-mailform.php" class="mailform off2">
    <input type="hidden" name="form-type" value="contact">
    <div class="row">
        <div class="col-md-4">
            <input type="text" name="name" placeholder="Your Name:" data-constraints="@LettersOnly @NotEmpty">
        </div>
        <div class="col-md-4">
            <input type="text" name="phone" placeholder="Telephone:" data-constraints="@Phone">
        </div>
        <div class="col-md-4">
            <input type="text" name="email" placeholder="Email:" data-constraints="@Email @NotEmpty">
        </div>
        <div class="col-md-12">
            <textarea name="message" rows="5" placeholder="Message:" data-constraints="@NotEmpty"></textarea>
        </div>
        <div class="mfControls col-md-12">
                <button type="submit" class="butn">Sumbit comment</button>
        </div>
    </div>
</form> 

Note: Necessary files are js/mailform, bat folder and css/plugins/mailform.css.

Setup a Receiving Email Address

You have to setup your own email address for email receiving. As a default it is addyour@emailhere and it is located in the bat/rd-mailform.php.
How to change the address:

Go to bat/rd-mailform.php and find $recipients = 'addyour@emailhere'; and change the address to your own.

Search Form

Attention! Search feature will not work without wamp or xamp in locally. It works only on a hosting-server with PHP enabled.

Important! Search result comes from the /search folder

Setup a path to HTML file

In your <form> element you need to specify a path to the .html file that will handle the search result.

<form class="search-form" action="search.html" method="GET" accept-charset="utf-8">
   <input type="text" name="s" />
   <a onclick="document.getElementById('search').submit()">Search</a>
</form>

Files needed to work with the form:

  • jquery.js – jQuery library (the form will work with this version of library only);
  • search.css – stylesheet file which is being used for stylization of the search results pages ;
  • search.html – page where the search results will appear;
  • search.js – script which is responsible for the search results output in an iframe on the page search.php;
  • results.php – PHP script which actually performs the search.

In this form we should define such parameters as: action="search.html" and method="get", also set parameter for an input: name="s". If you want to change the name of the search form, which is id="search" by default, you should change it on the line 3 in the file search.js as well, you can find it in search folder.

Plugins

Here is the list of the JS plugins used in the template. Usually they are loaded from /js folder.

Important! Every JS plugin loaded from /js must be called BEFORE the main.js
<script src="js/jquery.min.js"></script>

<!-- Plugins from /js -->

<script src="js/main.js"></script>

Google Maps

Plugin Documentation

Create a Map Element

To use a Google Maps on your site, you need to create a map element with map class and give it a unique ID first:

Get a Google Maps API Key

You have to obtain your unique API key for the Google Map, otherwise you can see this error:

Oops Something Went Wrong Error

To get an API key:

Utilities

Template is using Bootstrap Utilities along with custom ones. Here is the list of available custom utilities:

Borders

  • border-all border for all side
  • border-width-1 border width 1px
  • border-color-white border color white
  • border-none removes any border
  • border-radius-5 5px border radius
  • border-dotted border style
  • border-top border on top
  • border-right border on right
  • border-bottomborder on bottom
  • border-left border on left

Font Size

  • font-size11 to font-size20 11px to 20px font size
  • font-size22 to font-size50 22px to 50px font size - Just even font size
  • font-size100 100px font size
  • font-size130 130 screen font size
  • md-font-size11 to font-size20 medium screen 11px to 20px font size
  • md-font-size22 to font-size50 medium screen 22px to 50px font size - Just even font size
  • md-font-size100 medium screen 100px font size
  • md-font-size130 medium screen 130 screen font size
  • sm-font-size11 to font-size20 small screen 11px to 20px font size
  • sm-font-size22 to font-size50 small screen 22px to 50px font size - Just even font size
  • sm-font-size100 small screen 100px font size
  • sm-font-size130 small screen 130 screen font size

Important! If you add md and sm prefix before the class it will be consider for medium and small screens.

Font Weight

  • font-weight-100 font weight 100
  • font-weight-200 font weight 200
  • font-weight-300 font weight 300
  • font-weight-400 font weight 400
  • font-weight-500 font weight 500
  • font-weight-600 font weight 600
  • font-weight-700 font weight 700
  • font-weight-800 font weight 800
  • font-weight-900 font weight 900

Font Color

  • text-white white text color
  • text-black black text color
  • text-pink-color pink text color

Divider

  • divider-full divide the items in a list with 1px border

Margin

  • margin-one-all 1% margin to all side
  • margin-10px-all margin 10px to all side
  • no-margin remove margin
  • no-margin-top remove margin from top
  • no-margin-right remove margin from right
  • no-margin-bottom remove margin from bottom
  • no-margin-left remove margin from left
  • margin-10px-top margin 10px top
  • margin-10px-right margin 10px right
  • margin-10px-bottom margin 10px bottom
  • margin-10px-left margin 10px left
  • margin-10px-lr margin 10px left and right
  • margin-10px-tb margin 10px top and bottom
  • md-margin-10px-all for medium screen - margin 10px to all side
  • sm-margin-10px-all for small screen - margin 10px to all side

Important! If you add md and sm prefix before the class it will be consider for medium and small screens.

No Gutters

Removes padding from col*. Apply on row class

  • no-gutters removes padding from cols

Overflow

  • overflow-hidden overflow hidden
  • overflow-visible overflow visible
  • overflow-auto overflow auto
  • md-overflow-hidden medium screen overflow hidden
  • md-overflow-visible medium screen overflow visible
  • md-overflow-auto medium screen overflow auto
  • sm-overflow-hidden small screen overflow hidden
  • sm-overflow-visible small screenoverflow visible
  • sm-overflow-auto small screen overflow auto

Position

  • position-inherit position inherit
  • position-relative position relative
  • position-absolute position absolute
  • position-fixed position fixed

Important! If you add md and sm prefix before the class it will be consider for medium and small screens.

Opacity

  • opacity1 .1 opacity
  • opacity2 .2 opacity
  • opacity3 .3 opacity
  • opacity4 .4 opacity
  • opacity5 .5 opacity
  • opacity6 .6 opacity
  • opacity7 .7 opacity
  • opacity8 .8 opacity
  • opacity9 .9 opacity

Padding

Although, Bootstrap has p*-0 utility, but sometimes you need to remove just one side of padding and it is not possible with the same Bootstrap's padding utility.

  • padding-one-all 1% padding to all side
  • padding-10px-all padding 10px to all side
  • no-padding remove padding
  • no-padding-top remove padding from top
  • no-padding-right remove padding from right
  • no-padding-bottom remove padding from bottom
  • no-padding-left remove padding from left
  • padding-10px-top padding 10px top
  • padding-10px-right padding 10px right
  • padding-10px-bottom padding 10px bottom
  • padding-10px-left padding 10px left
  • padding-10px-lr padding 10px left and right
  • padding-10px-tb padding 10px top and bottom
  • md-padding-10px-all for medium screen - padding 10px to all side
  • sm-padding-10px-all for small screen - padding 10px to all side

Important! If you add md and sm prefix before the class it will be consider for medium and small screens.

Shadow

  • box-shadow box shadow
  • box-shadow-light light shadow
  • box-shadow-dark dark shadow
  • box-shadow-large large shadow

Width

  • width-10px 10px width
  • width-10 10% width
  • md-width-10px medium screen 10px width
  • md-width-10 medium screen 10% width
  • sm-width-10px small screen 10px width
  • sm-width-10 small screen 10% width

Important! If you add md and sm prefix before the class it will be consider for medium and small screens.

Z-Index

  • z-index-1111 z-index 111
  • z-index-111 z-index 111
  • z-index-1 z-index 1
  • z-index-2 z-index 2
  • z-index-3 z-index 3
  • z-index-4 z-index 4
  • z-index-5 z-index 4
  • z-index-0 z-index 0
  • z-index-minus2 z-index -2

Other Utilities

  • no-letter-spacing no letter spacing
  • letter-spacing-1 letter spacing 1
  • letter-spacing-2 letter spacing 2
  • letter-spacing-3 letter spacing 3
  • letter-spacing-4 letter spacing 4
  • letter-spacing-5 letter spacing 5
  • display-block display block
  • display-none display none
  • display-inline-block display inline block
  • display-inline display inline
  • display-inherit display inherit
  • display-table display table
  • display-table-cell display table cell

Credits

Template is using third party plugins. Here is the list of third party plugins:

Third Party Plugins (Attribution)