# "OmahPsd Template"

DOCUMENTATION BY "OMAHPSD" V1.0

## Pandawa

Created: 07/04/2014

By: omahpsd.com

Email: omahpsd@gmail.com

Thank you for downloading Pandawa theme. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. Thanks so much!

## Table of Contents

- Getting Started

- HTML/1200 Grid Structure - Basic HTML information, using the 1200.gs Grid System

- Bootstrap LESS - Style Using Bootstrap LESS

- JavaScript/jQuery Plugins - Site plugin information

- Sources and Credits

### A) Getting Started - top

Since this is an HTML/CSS template, you can actually run it off your computer with little setup on the server. When you are ready to put the site on your server, upload all the files in the theme folder to your server.

### B) HTML/1170 Grid Structure - top

This theme is a fixed layout with up to 12 columns. All of the information within the main content area is nested within a div with an class of "wrapper".The general template structure is the same throughout the template as it uses the 12 column 1200.gs Bootstrap framework.

#### 1200.gs Bootstrap framework

The general concept behind the 12 column framework is that all the columns (labeled span'x') need to add up to 12 when using the 12 column version of their framework.

The Bootstrap site has a nice demo and you can also see it on the columns-all.html file included with this theme. The best way I would suggest to become familiar with this framework is to simply edit what I have already set up.

Bootstrap has a great overview of the Grid System framework you may want to check out.

### C) Style Using Bootstrap Less - top

At first glance, the CSS may look confusing, because CSS is create using LESS let me explain each below:

- style.css - Our's custom css and custom Bootstrap CSS Framework, do not edit this file.

- bootstrap.css - The Bootstrap Grid and CSS Framework, do not edit this file.

if you want to custom style you can custom file style.less on folder with name less, if you confiuse how to custem the LESS file you can see the how to use LESS on http://lesscss.org

#### Handy CSS Classes:

.clearfix - A quick way to clear floated HTML elements

.img-thumbnail - Add a soft border and padding image edge

.img-circle - Add a full rounded image edge with CSS3 rounded borders.

.img-rounded - Add a soft rounded image edge with CSS3 rounded borders.

.pull-left - Float item to left

.pull-right - Float item to right

.text-center - Center text

.text-left - Left text

.text-right - Right text

etc you can see all on bootstrap documentation

#### Change Color Theme

If you want to change the color theme, we just custom theme's color on 'variable.less' in less folder, just replace value on variable @brand-primary with your own color code and you can change the other variable to

### D) JavaScript/jQuery Plugins - top

    <script src="js/jquery-1.10.2.js"></script>
    <script src="js/bootstrap.js"></script>
    <script src="js/ekko-lightbox.js"></script>
    <script src="js/jquery.shuffle.js"></script>

#### Bootstrap jquery plugin

See all bootstrap jquery plugin setup on bootstrap documentation

#### jquery shuffle

The portfolio content, powered by "jquery Shuffle" is very easy to manage. Please see the code in script.js to copy and modify to fit your needs.

Full option reference jquery Shuffle: http://vestride.github.io/Shuffle/

jquery jquery Shuffle setup:

    //html filtering menu
    <ul id="filterOptions" class="clearfix">
    	<li class="cur"><a class="btn btn-link linear" href="#" data-group="all">All</a></li>
    	<li><a class="btn btn-link linear" href="#" data-group="websites">Websites</a></li>
    	<li><a class="btn btn-link linear" href="#" data-group="graphics">Graphics</a></li>
    </ul>
    //html filtering content
    <div class="main-folio clearfix metro" id="grid">
    <div class="col-xs-6 col-sm-4 col-md-4 box" data-groups='["all", "graphics"]'>
    	<div class="thumb-img">
    		<a href="img/portfolio/f1.jpg" class="thumb-mask" data-gallery="global-gallery" data-parent="" data-toggle="lightbox" data-title="Image Title Here"><img src="img/plus.png" alt="folio" /></a>
    		<img src="img/portfolio/f1.jpg" alt="folio" />
    	</div>
    </div>
    <div class="col-xs-6 col-sm-4 col-md-4 box" data-groups='["all", "websites"]'>
    	<div class="thumb-img">
    		<a href="img/portfolio/f2.jpg" class="thumb-mask" data-gallery="global-gallery" data-parent="" data-toggle="lightbox" data-title="Image Title Here"><img src="img/plus.png" alt="folio" /></a>
    		<img src="img/portfolio/f2.jpg" alt="folio" />
    	</div>
    </div>
    </div>

    //jquery setup
    $(window).load(function(){
    $('#filterOptions a').click(function (e) {
        e.preventDefault();

        // set active class
        $('#filterOptions').find('.cur').removeClass('cur');
        $(this).parent().addClass('cur');

        // get group name from clicked item
        var groupName = $(this).attr('data-group');

        // reshuffle grid
        $grid.shuffle('shuffle', groupName );
    	});
        /* initialize shuffle plugin */
        var $grid = $('#grid'),
    	$sizer = $grid.find('.shuffle__sizer');

        $grid.shuffle({
            itemSelector: '.box', // the selector for the items in the grid
    		sizer: $sizer
        });
    });

#### Metro style

For make the grid to be a metro style it's just change the padding-left and padding-right of bootstrap class "col-", for make grid coloumn to be a metro style , put all class 'col- ' in class 'metro' see the example:

    	<div class="main-folio clearfix metro" id="grid">
    		<div class="col-xs-6 col-sm-4 col-md-4 box" data-groups='["all", "graphics"]'>
    			.....
    		</div>
    		<div class="col-xs-6 col-sm-4 col-md-4 box" data-groups='["all", "websites"]'>
    			.....
    		</div>
    	</div>

#### jquery ekko-lightbox

The lightbox on the portfolio content powered by 'jquery ekko-lightbox' the setup for lightbox on HTML is like the following code:

to change the padding left and rigth, see the configuration on file 'style.less' in less folder, change the value of '@grid-gutter-metro-width'

for image of the portfolio content, the image size is 800px x 600px for small image and 800px x 1012px for the large image

for the link of the copy right and the social media you can change on the footer divison, just find HTML CODE like the following Code:

    <a href="img/portfolio/f1.jpg" class="thumb-mask" data-gallery="global-gallery" data-parent="" data-toggle="lightbox" data-title="Image Title Here"><img src="img/plus.png" alt="folio" /></a>

for full documentaion you can see on https://github.com/ashleydw/lightbox

    <div class="cpRight build">
    	<p>&copy;  2014 Pandawa by <a href="#omahpsd.com">OmahPSD</a>. All Rights Reserved.</p>
    </div>

    <ul class="follow-social">
    	<li><a href="#"><i class="fa fa-twitter fa-3x"></i></a></li>
    	<li><a href="#"><i class="fa fa-facebook fa-3x"></i></a></li>
    	<li><a href="#"><i class="fa fa-dribbble fa-3x"></i></a></li>
    </ul>

for the social icon you can change the class for example class 'fa-facebook' change with the another class social media, you can fide the class on fontawesome documentation http://fontawesome.io/icons

you also can change tha font family on the css file you can fan on the folder css/style.css just open the style.css and find the css code like the following css code:

     @font-face {
    	font-family: 'VerelaRound';
    	src: url('VarelaRound-Regular.eot'); /* IE9 Compat Modes */
    	src: url('VarelaRound-Regular.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */

    	     url('VarelaRound-Regular.ttf')  format('truetype'), /* Safari, Android, iOS */
    	     url('VarelaRound-Regular.svg#svgFontName') format('svg'); /* Legacy iOS */
    }

and replace the font file on the css folder css/VarelaRound-Regular.ttf, replace with the your own font, and then change the name of font-family ond the css file

     @font-face {
    	font-family: 'YourOwnFont';
    	src: url('YourOwnFont.eot'); /* IE9 Compat Modes */
    	src: url('YourOwnFont.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */

    	     url('YourOwnFont.ttf')  format('truetype'), /* Safari, Android, iOS */
    	     url('YourOwnFont.svg#svgFontName') format('svg'); /* Legacy iOS */
    }

for the background image on the header you can also find and change on the style.less file, just find the following css code:

    /* =============================== header ===================================== */
    .header {
    background: url(../img/bg.jpg) no-repeat top center fixed;
    -webkit-background-size: cover;
    -moz-background-size: cover;
    -o-background-size: cover;
    background-size: cover;
    filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='.myBackground.jpg', sizingMethod='scale');
    -ms-filter: "progid:DXImageTransform.Microsoft.AlphaImageLoader(src='myBackground.jpg', sizingMethod='scale')";
    position:relative;
    }

replace the bghead.jpg on the folder img/bghead.jpg and done, on this theme the image size we use is 1541px x 652px

#### jquery Custom Toggle navigation

The Navigation we made its on side so we create the button toogle for show and hide, you can see the jquery code for make it happen on script.js

see like the following code

    $("#menu-close").click(function(e) {
    	e.preventDefault();
    	$("#sidebar-wrapper").toggleClass("active");
    });
    $("#menu-toggle").click(function(e) {
    	e.preventDefault();
    	$("#sidebar-wrapper").toggleClass("active");
    });

And for make scroll page when click the navigation menu, you can see te setup code like the following code:

    $('a[href*=#]:not([href=#])').click(function() {
      if (location.pathname.replace(/^\//,'') == this.pathname.replace(/^\//,'')
    	|| location.hostname == this.hostname) {

    	var target = $(this.hash);
    	target = target.length ? target : $('[name=' + this.hash.slice(1) +']');
    	if (target.length) {
    	  $('html,body').animate({
    		scrollTop: target.offset().top
    	  }, 1000);
    	  return false;
    	}
      }
    });

#### Header height

for support the btnAbout in order to follow the window when the window on resize or on small screen, we setup the header height in order to follow the window height, because the btnAbout is on the header container, you can see the setup like the following code:

    (function(){
    boxHeight();
    })();
    $(window).resize(function(){
    boxHeight();
    });
    function boxHeight(){
    var wHeight = $(window).height();
    $('.header').css('min-height', wHeight);
    }

### E) Sources, Credits and Font - top

I've used the following images, icons or other files as listed.

- Icon Font/fontawesome-http://fontawesome.io/
- jQuery Plugin: prettyPhoto - http://www.no-margin-for-errors.com/projects/prettyphoto-jquery-lightbox-clone/
- Bootstrap CSS Framework - http://getbootstrap.com/
- jQuery - www.jquery.com
- IE9.js - Project Hosting on Google Code: http://html5shiv.googlecode.com/svn/trunk/html5.js
- 'VarelaRound-Regular.ttf'-google fonts