CCIKM Documentation (v.1)
CCIKM is a hub for climate change related information, a platform for the management and publication of geospatial and time series data. It brings together different information linked to climate and environment under a consistent and easy-to-use interface allowing non-specialized users to share data and create interactive maps.
Important! CCIKM provide easy access of documentation through its library features, geospatial data through geoportal as well as time series data visualization of climate and hydrological stations of Bangladesh
It is also designed to be a flexible platform that other developers can access different information from the rest API.
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 hello@chitrakootweb.com
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
Image Placeholders
All images are replaced by placeholder due to copyright policy. We cannot include them in the package and sell it.
Geoportal
Geoportal is build with Geonode.
GeoNode is a geospatial content management system, a platform for the management and publication of geospatial data. It brings together mature and stable open-source software projects under a consistent and easy-to-use interface allowing non-specialized users to share data and create interactive maps.
For more detail please check Geonode documentationIn CCIKM three client applications have been developed within the Geonode:
- Climate Impact Atlas
- Climate Vulnerability Atlas
- Time Series Map
<html> <head> <!--CSS includes--> </head> <body> <header> <nav class="navbar navbar-expand-lg"><!--navbar--></nav> </header> <section><!--section content--></section> <footer><!--footer--></footer> <script> //JS plugins includes </script> </body> </html>
Climate Impact Atlas
Climate Impact Atlas
is the wrapper for the header content - this includes topbar, logo
and navigation content.
Climate Impact Atlas
main header content wrapper.
Climate Vulnerability Atlas
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
- 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.
-
Then open the
default.css
file to change fonts and find the@import...
element which loads the Google font and place your copied code. -
Final step is to change the font family in the
default.css
file. Findbody
tag on the beginning of the file andfont-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 isfont-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:
- Add template to the koala
- Set
styles.sccs
path to output pathstyles.css
(With right click of styles.scss) - Now open the
style.scss
in your text editor, find Replace or Find and Replace function - As original text enter the red color #ff0000 (template default color)
- As Replace with enter HEX value of blue color #0000ff
Font Awesome Icons
Font Awesome includes more than 600 icons that can be easily used on your site. For example you want the download link with the PDF icon.
-
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.
-
Place the copied line to your link:
Download File
- 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 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 opacity-medium
Example: Background image with the 75% opacity:
<section class="cover-background" style="background-image: url('image path');"> <div class="opacity-medium bg-extra-dark-gray"></div> <div class="container"><!--content--></div> </section>
Important! You can also change the opacity and color with
changing of
opacity-light | opacity-medium | opacity-full-dark | bg-extra-dark-gray | bg-black | bg-white
classes.
Parallax Background
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"
.
<div class="parallax" data-overlay-dark="6" data-background="image path" data-stellar-background-ratio="0.5"> <div class="container"><!--content--></div> </div>
Forms
Template uses Bootsrap form structure and brings some own styles.
Contact and News Letter Forms
Attention! You have to setup your own email address for email receiving. As a default it is addyour@emailhere and it is located in the quform/apply-job.php, quform/free-trial.php, quform/getin-touch-one.php, quform/newsletter-name.php, quform/newsletter-two.php, quform/request-call.php files on line 42 and 62. For more details please refer the form-documentation (documentation/form-documentation-quform/documentation).
Important! Make sure It will not work in local sytem or localhost, It will work when your site goes live. (If you don't receive email than once check spam folder as well)
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.
/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
Get your location from the map
You have to just copy and replace your location HTML code in the contact page. (You have to just keep iframe only, there are some CSS and DIVs which doesn't require)
Owl Carousel
For more detail please check plugin documentation
This plugin is used for creating slider/carousels from list of images or even HTML elements.
Carousel must be wrapped in owl-carousel
class.
Example: Carousel with 3 visible slides, 30px margin, auto play, infinite loop and 5s pause.
<div class="owl-carousel owl-theme"> <img src="img/1.jpg"> <img src="img/2.jpg"> <img src="img/3.jpg"> </div> Javascript (file path - /js/main.js) $('.owl-carousel').owlCarousel({ items:3, loop:true, margin: 30, mouseDrag:false, autoplay:true, smartSpeed:500 });
All attributes you can use with owl-carousel
-
items
number of items in carousel. 1 item for fullscreen carousel -
nav
show or hide navigation arrows. Default:0
-
dots
show or hide navigation dots. Default:0
-
center
center carousel. Default:0
-
loop
infinite loop. Default:0
-
auto-width
carousel will move according the slides width. Default:0
-
autoplay
carousel will play automatically. Default:0
-
autoplay-timeout
pause between slides in milliseconds. Default:5000
-
auto-height
height of the carousel will automatically change according the slide height. Default:5000
-
fadeout
fade effect between transitions. Default:0
Revolution Slider
Revolution Slider Documentation
Please send us mail at hello@chitrakootweb.com with your license ID if you want more details.
Utilities
Template is using Bootstrap Utilities along with custom ones. Here is the list of available custom utilities:
Borders
border-all
border for all sideborder-width-1
border width 1pxborder-color-white
border color whiteborder-rounded
border roundedborder-dotted
border style
Font Size
display-7 to display-34
display-sm-1 to display-sm-34
display-md-1 to display-md-34
display-lg-1 to display-lg-34
display-xl-1 to display-xl-34
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 100font-weight-200
font weight 200font-weight-300
font weight 300font-weight-400
font weight 400font-weight-500
font weight 500font-weight-600
font weight 600font-weight-700
font weight 700font-weight-800
font weight 800font-weight-900
font weight 900
Font Color
text-white
white text colortext-black
black text colortext-primary-color
primary text colortext-secondary-color
secondary text color
Divider
divider-full
divide the items in a list with 1px border
Margin
m-1
margin to all sidem-0
remove marginmt-0
remove margin from topme-0
remove margin from rightmb-0
remove margin from bottomms-0
remove margin from leftmy-1
margin top and bottommx-1
margin left and rightm-md-1
for medium screen - margin to all sidem-sm-1
for small screen - margin to all side
Important! If you add xxl
xl
lg
md
sm
prefix before the class it will be consider
for large, medium and small screens. Please refer the default.css
for more
classes.
No Gutters
Removes padding from col*. Apply on row
class
g-0
removes padding from cols
Overflow
overflow-hidden
overflow hiddenoverflow-visible
overflow visibleoverflow-auto
overflow automd-overflow-hidden
medium screen overflow hiddenmd-overflow-visible
medium screen overflow visiblemd-overflow-auto
medium screen overflow autosm-overflow-hidden
small screen overflow hiddensm-overflow-visible
small screenoverflow visiblesm-overflow-auto
small screen overflow auto
Position
position-inherit
position inheritposition-relative
position relativeposition-absolute
position absoluteposition-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 opacityopacity2
.2 opacityopacity3
.3 opacityopacity4
.4 opacityopacity5
.5 opacityopacity6
.6 opacityopacity7
.7 opacityopacity8
.8 opacityopacity9
.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.
p-1
padding to all sidep-0
remove paddingpt-0
remove padding from toppe-0
remove padding from rightpb-0
remove padding from bottomps-0
remove padding from leftpy-1
padding top and bottompx-1
padding left and rightp-md-1
for medium screen - padding to all sidep-sm-1
for small screen - padding to all side
Important! If you add xxl
xl
lg
md
sm
prefix before the class it will be consider
for large, medium and small screens. Please refer the default.css
for more
classes.
Shadow
box-shadow
box shadowbox-shadow-light
light shadowbox-shadow-dark
dark shadowbox-shadow-large
large shadowshadow-none
No shadowshadow-sm
Small shadowshadow
Regular shadowshadow-lg
Larger shadow
Width
width-10px
10px widthwidth-10
10% widthmd-width-10px
medium screen 10px widthmd-width-10
medium screen 10% widthsm-width-10px
small screen 10px widthsm-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 111z-index-111
z-index 111z-index-99
z-index 99z-index-1
z-index 1z-index-2
z-index 2z-index-3
z-index 3z-index-4
z-index 4z-index-5
z-index 4z-index-0
z-index 0z-index-minus2
z-index -2
Other Utilities
no-letter-spacing
no letter spacingletter-spacing-1
letter spacing 1letter-spacing-2
letter spacing 2letter-spacing-3
letter spacing 3letter-spacing-4
letter spacing 4letter-spacing-5
letter spacing 5
d-block
display blockd-none
display noned-inline-block
display inline blockd-inline
display inlined-inherit
display inheritd-table
display tabled-table-cell
display table cell
Credits
Template is using third party plugins. Here is the list of third party plugins:
Third Party Plugins (Attribution)
- jQuery (MIT License)
- Mailform (MIT License)
- PHP Mailer (GNU Lesser General Public License)
- Animate CSS (MIT License)
- Bootstrap (MIT License)
- Fontawesome (MIT License)
- Magnific Popup (MIT License)
- OwlCarousel (MIT License)
- Easy Responsive Tabs ( MIT License)
- Isotope (MIT License)
- Counterup (GNU Lesser General Public License)
- Parallax (MIT License)
- jQuery Waypoints (MIT License)
- Google Map (MIT License)
- Chart (MIT License)
- Modernizr (MIT License)
- xZoom (Apache License 2.0)
- PrismJS (MIT License)
- Clipboard (MIT License)
- For Images (Unsplash)