Bootstrap Template Documentation

Introduction What can be found in this package and what it can be used for

Thank you for purchasing a website template from our company. This manual will show you how to work with your template, how to edit it and make it a "live" website.

All pages content is made with HTML and dynamic animation is made with JavaScript.

Unzipping Template Package

After unzipping the template package you will find 3 folders: "documentation", "screenshots" and "site". You can also see a zip archive called "sources_############.zip" that you need to unzip.

The sources package contains all source files for the template. The package is password protected and can be extracted only with WinZip (Windows OS) and StuffitExpander (MAC OS) software.

You can download both applications for free using the free trial options:

While unzipping "sources_############.zip" archive you will be prompted to enter a password, which you can find at your Product Download Page (open the link in the email you received from our company).

As soon as you are done with the unzipping the template you should have 4 folders in total: "documentation", "screenshots", "site" and "sources".

General Information

Software requirements

Adobe Dreamweaver (download free trial). Used to edit the .HTML, .JS, .PHP and .CSS files.
Adobe Photoshop CS or later (download free trial). Used to edit .PSD files.

The following scheme displays the template files structure.

  • Documentation – contains documentation on template editing and installation.
  • Screenshots - contains screenshots of the template.
  • Site - contains the .html files of the template.
    • assets - contains assets and bonus add-ons.
    • bat - contains contact form processing .php script.
    • css - contains all the .css files used in the design.
    • img - contains all the images used in .html files.
    • js - contains JavaScript libraries and jQuery plugins.
    • search - contains .js, .php and .css file of the search engine.
  • sources contains source files.
    • psd - contains Adobe Photoshop .psd files.
    • less - contains .css LESS files used in the template.
  • fonts_info.txt - contains the list of fonts used in template.
  • info.txt - contains the information about password protected "sources" folder.

Editing template

Working with the template you need to edit the .html, .css, .js and .psd files.

Editing HTML and CSS files

All editable HTML files are located in "site" folder of the template package (index.html, index-1.html,index-2.html, etc.) Each index-#.html file represents a single template page.

To open .html file with Adobe Dreamweaver application, you should right mouse click on the file, and in the context menu select Open with > Adobe Dreamweaver. When the file is opened you can start editing it.

Adobe Dreamweaver is a recommended application as it allows you to edit the HTML files content in visual mode. Open any .html file and click the Live Code button at the top of the screen to switch to visual mode.

Feel free to check the detailed text and video tutorials on how to edit HTML files with Adobe Dreamweaver.

CSS files are used to change the template appearance like fonts (font-family, font-size, color etc), backgrounds, column width values etc. You can edit the css files with Adobe Dreamweaver application. Detailed tutorials on how to work with the CSS files are available at our online help center.

Editing PSD files

PSD files are located in the "sources/psd" folder in your template package. PSD are the source files of the template design. They are divided into layers so any part of the template design can be changed.

During the customization process you can refer to the PSD files in order to change the images used in the content pages or in the design.

You can learn more about working with photoshop by checking the detailed tutorials.

Custom Fonts

Some templates may contain the non-default fonts used in the design. By default the internet browser can render only fonts that are installed to your operating system. In other words if your website design uses some custom fonts and these custom fonts are not installed on your website visitor's computer, custom fonts won't be displayed. Default fonts will be rendered instead. That's why web developers should look for some alternative solutions. In our templates custom fonts are embedded using Google Web Fonts technology.

Google Web Fonts

You can learn more on using Google Web Fonts by checking the tutorial on how to work with Google web Fonts.

Customization Tutorials

How to edit text

Templates are HTML based templates so all content is stored and could be accessed though the .html files.

  1. Open your template package and go to the site folder.
  2. There open index.html  file with your HTML editor.
  3. You can use the search tool CTRL+F to find any text you need.
  4. Edit text in HTML editor. Save the file and open it with your Browser to see the changes.

The other way is to use the browser developer tool to find the blocks you want to edit. You can learn more about the developer tools checking the tools description and tutorials.

Feel free to check the following Developer Tools article.

You can also check the video tutorial on how to edit text in JS Animated templates

How to edit images

Open the template folder, go to 'site/img' directory. You can upload your images with the same name and extension to replace the default ones.

The other way is to upload custom images with your titles and extensions. Then you’ll need to change the image file names in the html files.

  1. Open .html file from the “site” folder with your html editor.
  2. Use search tool CTRL+F to find the images in the html file.
  3. Replace the image title and extension.

You can also check the video tutorial on how to edit images.

How to activate contact form

  1. Open the template folder.
  2. Go the site/js directory.
  3. There open the 'TMForm.js' file with your editor (Adobe Dreamweaver, Notepad etc).
  4. Using the Find and Replace tool (CTRL+F) search for the ownerEmail or just scroll down to the very bottom of the page.

You should see the following line:

ownerEmail:'#'

replace # symbol with your email address. That's all, now the contact form should send the messages to your email account.

You can see the detailed tutorial on how to activate contact form in your template.

TM add-ons

Depending on a template design, a template may include the following free add-ons:

  1. Contact Form - gives visitors the opportunity to send messages to the site-owner.
  2. Search Engine - performs search through content of .html files.
  3. Under Construction - is the page with countdown timer.
  4. Subscription Form - allows to organize newsletter subscription.

Note, depending on the template design, it may include Contact Form, Search Engine, Countdown and Subscription Form add-ons that are already implemented into your template and are working by default. Feel free to check the detailed documentation for each add-on in case of additional configuration or if you are going to implement them into another website/project/template.

Contact Form manual

    Contact Form gives visitors the opportunity to send messages to the site-owner. The contact data (Name, Email, Text message) is submitted into the corresponding fields. It can be very beneficial if the visitor does not have an Email Client installed or uses someone else's computer (e.g. in the internet club). For this reason we have developed the universal contact form that sends messages to the email specified by the site owner, has the expandable number of fields and transmissible data verification feature.
Contact form submitted.
<form id="contact-form">
  <div class="success-message">this is success message</div>
  <label class="name">
    <input type="text" placeholder="Name:" data-constraints="@Required @JustLetters" />
    <span class="empty-message">*This field is required.</span>
    <span class="error-message">*This is not a valid name.</span>
  </label>
  <label class="state">
    <input type="text" placeholder="State:" data-constraints="@JustLetters" />
    <span class="empty-message">*This field is required.</span>
    <span class="error-message">*This is not a valid state.</span>
  </label>
  <label class="email">
    <input type="text" placeholder="Email:" data-constraints="@Required @Email" />
    <span class="empty-message">*This field is required.</span>
    <span class="error-message">*This is not a valid email.</span>
  </label>
  <label class="phone">
    <input type="text" placeholder="Phone:" data-constraints="@Required @JustNumbers"/>
    <span class="empty-message">*This field is required.</span>
    <span class="error-message">*This is not a valid phone.</span>
  </label>
  <label class="fax">
    <input type="text" placeholder="Fax:" data-constraints="@JustNumbers" />
    <span class="empty-message">*This field is required.</span>
    <span class="error-message">*This is not a valid fax.</span>
  </label>
  <label class="message">
    <textarea placeholder="Message:" [email protected] @Length(min=20,max=999999)'></textarea>
    <span class="empty-message">*This field is required.</span>
    <span class="error-message">*The message is too short.</span>
  </label>
  <div>
    <a href="#" data-type="submit" >submit</a>
    <a href="#" data-type="reset" >reset</a> 
  </div>  
</form>		

Description

The HTML structure inside the form is flexible, the only condition is that all the fields (input, textarea HTML elements) should be placed inside the label tags that have class corresponding to their type.

There are following classes/types by default:

  • name – the User's Name. Validation: digits are disallowed, not less than 2 symbols;
  • email – the User's Email;
  • state – Country (Area). Validation: digits are disallowed, not less than 2 symbols;
  • phone – Phone. Validation: digits only, not less than 5 symbols. Additional acceptable not alphabetical symbols: "space", "+" and "-";
  • fax – Fax. Validation: digits only, not less than 5 symbols. Additional acceptable not alphabetical symbols: "space", "+" and "-";
  • message – Message. Validation: any symbols, not less than 20 symbols.
  • @Required – This data-constraints attribute is used as a pointer for the optional fields while filling the forms out.

Also label tag mentioned above can contain nested span elements with classes error-message and empty-message, which include the error message in case the data in the field is specified incorrectly or the field is just empty.

There is also div container with the class success-message inside the form, which is displayed after the message has been sent.

Script Initialization

To activate the contact form you need to include contact from script in the <head> section of HTML file and copy "bat" folder to your website root folder. The "bat" folder should contain 1 file: MailHandler.php

<script type="text/javascript" src="js/jquery.js"></script>
<script type="text/javascript" src="js/TMForm.js"></script>

After this you should initialize your contact form on the $(window).load() : event

<script type="text/javascript">
$(window).load(function(){
  $('#contact-form').TMForm({
    ownerEmail:'#'
  })
})
</script>

Use the following parameters for initialization:

  • ownerEmail – the Email address the data will be sent to;
  • successShow – the period of time in milliseconds, during which the Send Message will be shown and after which the fields will be emptied, by default it is 4000 - 4 sec.

Search engine manual

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

Enter a word to search for: For instance: lorem, ipsum, dolor
<form id="search" action="search.php" method="GET" accept-charset="utf-8">
   <input type="text" name="s" />
   <a onclick="document.getElementById('search').submit()">Search</a>
</form>

Description

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 the search results pages stylization;
  • search.php – 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.php" 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.

Settings

Note, search form is enabled, configured and works by default. These steps are required if you are trying to use this search form in another project/template without working search form.

To make the form work correctly, please, perform the following steps:

  • copy search folder to the root directory with your *.html files;
  • move file search.php from the search folder to the root directory (with *.html files);
  • edit your form, using the directions above;
  • copy partly header and footer with all the connected scripts in the section <head></head> to the page search.php, but necessarily add connection of the file search.js. For example:
    <link rel="stylesheet" href="css/reset.css" type="text/css" media="all">
    <link rel="stylesheet" href="css/fonts.css" type="text/css" media="all">
    <link rel="stylesheet" href="css/style.css" type="text/css" media="all">
    <script src="js/jquery.js"></script>
    <script src="search/search.js"></script>
  • for the search results output add the following block to your content:
    <h3>Search result:</h3>
    <div id="search-results"></div>
  • change style of the search results, using search.css.

All the rest main styles of your template will be automatically pulled from the file style.css by the PHP script.

Countdown Script Manual (Under Construction page)

Days
Hours
Minutes
Seconds
<div id="counter"></div>
<div class="counter_desc">
  <div class="days">Days</div>
  <div class="hours">Hours</div>
  <div class="minutes">Minutes</div>
  <div class="seconds">Seconds</div>
</div>

Features:

  • counts time till exact date;
  • has custom skin designs.

Description

Files needed to work with the timer:

  • jquery.js – jQuery library (the timer will work with this version of library only);
  • jquery.countdown.min.js – the timer functionality;
  • demo.css – the set of CSS styles for the timer stylization.
Please include the following files in the <head> section of HTML file to start working with the timer:
<link rel="stylesheet" href="css/demo.css" type="text/css" media="all">
<script type="text/javascript" src="js/jquery.js"></script>
<script type="text/javascript" src="js/jquery.countdown.min.js"></script>

Initialization

You can find code for the timer initialization in the end of the jquery.countdown.min.js file:

$(document).ready(function(){
var _date=new Date()
	,countdown_to={
		year:2013
		,month:6 
		,date:13
		,hours:0
		,minutes:15
		,seconds:00
	}

_date.setFullYear(countdown_to.year,countdown_to.month,countdown_to.date)
_date.setHours(countdown_to.hours)
_date.setMinutes(countdown_to.minutes)
_date.setSeconds(countdown_to.seconds)

/*code for demonstration*/
_date=new Date()
_date.setMonth(_date.getMonth()+8)
/*end code for demonstration*/
	
$('#counter').countdown({
	image: 'img/digits_inverted.png',
	startTime: _date,
	stepTime: 35
});	
});							

The initialization occurs on the event $(document).ready().

Parameters:
  • image – shows path to the image which will be used as a skin (the directory img contains files that you can use as skins for the timer);
  • startTime – sets the final date of the countdown. Time countdown is implemented with  the help of variable _date;
  • stepTime – sets cycle rate of numbers' animation.

The demo version shows the time that remains from the current date plus 8 months. That is why timer starts a new countdown every time you refresh the demo page. Here is a code where you can edit these parameters:

/*code for demonstration*/
_date=new Date()
_date.setMonth(_date.getMonth()+8)
/*end code for demonstration*/
					

If you want to set exact date, you should change variable _date. To do this you must change values for year, month(pay attention that months' numbering starts from zero), date, hours, minutes, seconds. Here is a piece of code where you can change these parameters:

$(document).ready(function(){
var _date=new Date()
	,countdown_to={
		year:2013
		,month:6 
		,date:13
		,hours:0
		,minutes:15
		,seconds:00
	}
});							

Also you have to delete the following code:

/*code for demonstration*/
_date=new Date()
_date.setMonth(_date.getMonth()+8)
/*end code for demonstration*/
						

Color themes

Below you'll find examples of skin solutions for the timer. All these skins you can find in img directory.

Days
Hours
Minutes
Seconds
$('#counter').countdown({
	image: 'img/digits.png',
});						
Days
Hours
Minutes
Seconds
$('#counter').countdown({
	image: 'img/digits2.png',
});						

Subscription form manual

Subscribe Form Sample

Your subscription request has been sent!
<form id="subscribe-form">
  <div class="success">Your subscription request<br> has been sent!</div>
    <fieldset>
    <label class="name">
        <input type="text" value="Enter Name:">
        <span class="error">*This is not a valid name.</span></label>
    <label class="email">
        <input type="email" value="Enter Email:">
        <span class="error">*This is not a valid email address.</span></label>
    <div class="btns"><a href="#" class="button" data-type="submit">Submit</a></div>
  </fieldset>
</form>                       

Description

The HTML structure inside the form is flexible, the only condition is that inputs should be placed inside the label tags that have class corresponding to their type.

There are following classes/types by default:

  • name – the User's Name. Validation: digits are disallowed, not less than 2 symbols;
  • email – the User's Email;

Also label tag mentioned above can contain nested span elements with class error, which include the error message in case the data in the field is specified incorrectly.

Script Initialization

To activate the subscribe form you need to include subscribe form script in the <head> section of HTML file and copy "bat" folder to your website root folder. The "bat" folder should contain 1 file: MailHandler-sub.php

<script type="text/javascript" src="js/jquery.min.js"></script>
<script type="text/javascript" src="js/sForm.js"></script>

After this you should initialize your subscription form on the $(window).load() : event at the end of sForm.js file

$(window).load(function(){
  $('#subscribe-form').sForm({
    ownerEmail:'#',
    sitename:'sitename.link'
  })
})					

Use the following parameters for initialization:

  • ownerEmail – the Email address the data will be sent to;
  • sitename – website address which maintains subscription form.

In case of successful subscription website owner and website visitor get two separate successful subscription confirmation emails. Website owner target email is grabbed from sForm.js file and website visitor email is an email specified during subscription.

Uploading template

In order to make your site "live", you need to upload all the content of "site" folder from your local computer to your hosting server.

Please note: your website root depends on the directory structure on your hosting server. If you upload the "site" folder itself into your server, the root to your website will be http://your_domain_name/site. To avoid this and make the website root http://your_domain_name/ please open the "site" folder and upload the folder content.

This video tutorial will show you how you can upload files to your host using free FTP software FileZilla.

This video tutorial will show you how you can upload files to your host using hosting cPanel (WebHost Manager, WHM).

Please do not upload the sources directory or any of the template source files to the hosting server.

Addendum where to get help, support and additional information

We hope this manual was useful for you and helped you to install, edit the template and to resolve your issues.

Help and Support