Getting Started Theme Features Setting up your

Crux
Table of Contents
Getting Started
Installing WordPress
Installing the theme
Installing the Required Plugins
Theme Features
Custom Menus
Theme Options
Serving Retina Images
Child Theme Support
Setting up your store
Setting up Categories
Products
Setting up the Page templates
Blog Page
Archives Page
Contact Page
The Homepage
The “Widgetized” page template
Static Content Section at Theme Options
Using background images
Background images for categories
Background images for pages
Working with Sidebars
Sidebar Options at theme options panel
Page Layout Settings
Using the Stag Custom Sidebars plugin
Custom Widgets
Section: Featured Products
Section: Latest Products
Section: Best Sellers
Section: On Sale Products
Section: Top Rated Products
Section: Category Boxes
Using the Slider
Having the Slider at homepage
Using Sample Slides
About the .psd files
Credits
Go to Support Desk
Made with
♥ by Codestag.
Getting Started
Thanks for purchasing Crux – A modern Woo-Commerce theme. Crux is not one of
those multipurpose themes that actually have no purpose at all. Crux is coded with best
practices and designed to avoid all the bloat from it’s admin interface, helping you
concentrate on your true purpose: set up an awesome store quickly and efficiently.
This documentation supposes that you are familiar with WordPress and WooCommerce. We are not going to cover Woo-Commerce related topics about how WooCommerce works, as you can find all this information at the Woo-Commerce site here.
Crux also includes a $15 value Slider, the awesome Layer Slider. The documentation of
the Layer Slider is also included in the file package you just downloaded. We hope you
find it easy to use and enjoy it as much as we did while creating the slides for the demo.
More info about the Layer Slider plugin will be covered later in this documentation file.
Installing WordPress
In order to install the current version of WordPress Theme, please go
to http://wordpress.org and download the current version of WordPress. For information
on how to install a WordPress Platform, please see the WordPress codex
page http://codex.wordpress.org/Installing_WordPress.
Installing the theme
When you are ready to install a theme, you must first upload the theme to your
WordPress directory. There are two ways you can install the theme:
Using FTP: By using any FTP program of your choice you can upload the non-zipped
folder to the /wp-content/themes/ folder on your server.
Using WordPress: Navigate to Appearance > Themes > Install Themes. Go to upload
and select the zipped theme folder and hit install now and theme will be uploaded
and installed.
Once you have uploaded the theme, you need to active it. To activate your new theme,
go to Appearance > Themes and activate your chosen theme.
Installing the Required Plugins
Some plugins are required in order for the theme to look and work like the demo.
Installing them takes only minutes, and does not require any purchases.
Once you will install the theme, you will see a notification at your admin side notifying
you about the plugins you need to install. For each one, click “Begin installing plugin”,
and once installed, activate them. Here are a few words about each of the plugins:
WooCommerce
The most vital Plugin for Crux. This is what will turn your theme into a robust and
powerful store.
StagTools
StagTools is a lightweight and free plugin that adds some custom widgets and adds a
shortcode generator where you can quickly add handy shortcodes in your theme. You
can keep StagTools with you even if you change your theme so you don’t have to
update those shortcodes on changing theme each time. More details about the plugin
you can find here.
Stag Custom Sidebars
A truly powerful and simple plugin that lets you create unlimited sidebars. Allows you to
create widget areas where you can put widgets, and output them as a sidebar with a
shortcode. Combined with the “Widgetized” page template, with this plugin one can
create multiple widgetized pages (like the homepage) as landing pages etc. More
details about the plugin you can find here.
Layer Slider
LayerSlider is a powerful plugin that is provided with Crux for free. In the theme files
you just downloaded you will find a separate help file for the slider, created by the
plugin’s author. Right after you install the theme, you will also see a notification to
download and install the LayerSlider Plugin. Please do so, just like you did for the other
plugins.
Loading Dummy Data
You can easily import some dummy data if you feels that this will help you find your
way around. In order to do so, please go
to http://support.codestag.com/knowledgebase/where-is-the-dummy-content-xmlfile/ locate Crux and click the download link. This will download a zipped file that
contains:
An xml file that has the dummy (demo) content. Additional information on how to
import the xml file can be found here.
To import the slide we are using on our demo, just go LayerSlider WP settings and
click on Import Sample Sliders in top right corner. Locate the slider dummy file
which is included in the downloaded package and import it. You should be good to
go.
Please note: In many cases just importing the dummy .xml will not work since you will
also have to make some manual configurations. Please go through this documentation
to fully understand how the theme works in order to customize it to fit your needs.
Theme Features
This theme comes with a variety of features and great functionality which gives your
the freedom to control your theme’s look and feel. This section of the document will
explain on how you can use your theme effectively.
Custom Menus
You can setup custom menus to configure your site’s navigation. This theme comes
with three custom menu locations:
Primary Menu which serves as the main navigation for your shop
Subheader Menu which is located at the very top of the theme, above the logo.
Footer Menu which is located at the footer.
To setup your menus, navigate to Appearance > Menus. Give your menu a name and
add a variety of items including pages, categories and custom links.
Theme Options
The theme comes with a simple to use theme options panel. You can access it by
navigating to Crux > Theme Options. The theme options are conveniently spread over a
number of tabs and each tab contains the options that pertain to a particular area of the
theme with inline help text.
Serving Retina Images
Any asset/design element used under this theme is already optimized for viewing on
high resolution displays. Also this theme comes with custom icons web font which
looks good on any size. If you want to keep your site look good on retina displays, you
will need to optimize images used on your site. You can do so by following below
steps:
Upload two versions of any image. For example: if you are uploading a logo named
‘logo.png’ with a size 100px x 40px, then upload the same image with double size, in
this case, 200px x 80px and name it as logo@2x.png.
It is important to rename the second image ending with ‘@2x’ otherwise it won’t
work.
We are using a script on the theme, which replaces any image on site with another
image ending with @2x, if it’s not there it won’t replace and the same image will be
served for both retina and non-retina screens.
Child Theme Support
This comes comes with a child theme in download package. It is recommended to
upload both parent theme and child theme to your WordPress site and activate child
theme.
It saves your from losing any manual customization made to the theme and you can
update your theme without any problem whenever there is an update available.
Setting up your store
As mentioned at the beginning, we are not going to cover any Woo-Commerce related
topics, since you can easily find the related documentation at the official plugin
page here. However, we are going to go through a very quick introduction on how to
create Categories and products for your store. Let’s get started.
Setting up Categories
Setting up categories is easy. As posts, products too can be assigned to categories and
subcategories. Provided that you have installed the WooCommerce plugin, navigate to
Products>Categories. You will see the following screen:
The page comes with inline help, so you will not have trouble to figure out how things
work.
Display Type
Let’s pay attention at the “Display type” dropdown. You have 3 options there:
Default will grab the values set at WooCommerce>Settings>Catalog: Default
Category Display
Products will show only products at the category page (Currently we use this option
at the demo)
Subcategories will show a list of subcategories and the number of products at each
one of them
Both will show both the subcategories links at the top and the products right below.
At Crux demo we are only showing products at the category page, however you can
choose the option that works best for you.
Thumbnail
Here you can choose an image to show as a custom background image of the category
page. If you see the category pages of the demo, you will see that there is a
background image at the top, behind the category’s title. Crux grabs that image from
the Thumbnail configuration we just discussed. You may wonder what are the
appropriate dimensions for such an image… For the demo we have used image
dimensions of 1400 x 405 pixels, but since the image adapts to the viewport, the
image dimensions that will be displayed each time may vary. On a side note, just to let
you know that the image is optional, and you can choose to have this space blank
(white).
Page Layout
This customized section controls the layout of the specific category page. You can have
it full width (4 products in a row) or with a sidebar (with 3 products in a row) at the left or
right side.
If you choose the default value, this will grab the settings that are configured at
Crux>Theme Options>Sidebar Settings: Sidebar on Archive Pages
Products
Products of course are the most vital elements for your store. You should not face any
difficulty to set them up, but in case you do you can always refer to the WooCommerce
documentation, on how to set up the products.
Let’s see the product page a bit, Once you hit the add product or edit product links, you
will see something like this:
As you see at the screenshot above there are 2 highlighted areas: the content editor
(top) and the product short description at the bottom. At the front-end these 2 areas
correspond to 2 different layout sections:
Main editor content: This content will appear at the “Product Description” tab right
under the product’s main image.
The short text (short description) that appears on the right side of the product’s main
image is the content of the “Product short description” panel.
Product image dimensions
The ideal dimensions for the product images/thumbnails are:
Main product image: 470 x 577 pixels
Product thumbnail (at category pages): the main product image above will
automatically be resized to 270 x 330 pixels. You have nothing to do here.
Setting up the Page templates
There are several page templates that have to be configured in order for the theme to
work at it’s full potential. Setting them up is quite easy. Let’s see how it works, starting
from the most simple configurations:
Blog Page
Let’s set the Blog Page. First step is to create a New Page. Go to Pages > Add new and
create a New page. Give it a name e.g. “Blog” or “Blog Entries”. Hit the Publish button
on the top right.
Next step is to assign this page as the page that displays the posts. Go to Settings >
Reading and from the first set of radio buttons, check the “A Static page” and from the
Posts Page dropdown select the page you have created, like at the screenshot below.
Do not worry about the Front Page dropdown for now, we will work on this later. Click
Save and you are good to go.
Archives Page
You can also have a custom Archives page that shows the latest activity of your blog.
Just create a new page and select Archives under templates, from the Page Attributes
panel on the right.
Contact Page
Crux includes a custom page template ‘Contact Form’ which you can use to display a
contact form. Just create a page and select Contact Form under templates, from the
Page Attributes panel on the right.
Adding a map at the contact page
Provided that you have successfuly downloaded and installed the StagTools plugin, you
can easily use the shortcode generator and generate a Google Maps shortcode. You
will only need your Google Maps URL.
The Homepage
The homepage is completely widgetized. This has tremendous advantages because
you can choose what modules/widgets will be shown, and also you can re-arrange them
according to your needs. Creating a homepage similar to the demo is not difficult at all.
But it requires some steps. Let’s get started, it will take you only a couple of minutes.
First thing to do is to create a static page. Go to Pages > Add new and create a New
page. Give it a suitable name like “home” and select Widgetized under templates,
from the Page Attributes panel on the right. Hit Save.
Now we have to go the the “Reading settings” and define this page as the
homepage.Go to Settings > Reading and from the first set of radio buttons, check the
“A Static page” and from the front page dropdown select the page you have created
(in our example “home”). Click Save and you are good to go.
So far we have defined that the homepage of our store will be a widgetized page
named “Home”. Now the next step is to create a widget area, and decide which
widgets we will use. Let’s go to Appearance>Widgets and create a Custom widget
area through the panel below. Let’s give it a name like “Home”. Hit the “Add Widget
Area button” and a new widget panel will appear. Note that this new widget panel
has a shortcode.
Great, now we just need to define which of the custom widgets (sections) we need at
the homepage. For the demo, we have used a widget selection as shown below.
Please refer to the Custom Widgets section of this documentation, to find out what
each of the widgets does, and how to set them properly.
Last step is to go back to the static page we created as homepage a while ago. The
only thing you have to do now is to paste the shortcode of the widget panel you just
created, to the editor. This will output the widgets to the homepage. Hit Update and
enjoy the homepage.
The “Widgetized” page template
The widgetized page is a great way to create pages similar to the homepage, for use as
landing pages, promotional pages etc. You can create as many of them as you need,
and in order to set up their structure, you have to follow the steps taken for the
homepage. The homepage is a common widgetized page, with the only difference
being that we have set it as the “Homepage” under Settings> Reading settings.
Static Content Section at Theme Options
At the theme options panel, you will see a section about static content. What these
settings do is to output content from a static page, at an area just above the footer. You
can select which page to output content from, customize the appearance and choose at
which pages the section will appear. This is quite useful for site-wide anouncements,
but the possibilities are endless. In the demo we decided to use this area to show social
network links.
Using background images
A great way to give a customized appearance to each page, or category, is by using the
background function. You just select an image to be displayed under the menu, and
“behind” the beginning of the content, as the image below shows…
Background images for categories
Well, we have already covered this a few steps ago, at the “Setting up your Store >
Store Categories” section. Again, at Products>Categories: Thumbnail you can choose
an image to show as a custom background image of the category page. Crux grabs that
image from the Thumbnail configuration we just discussed. You may wonder what are
the appropriate dimensions for such an image…
For the demo we have used image dimensions of 1400 x 405 pixels, but since the
image adapts to the viewport, the image dimensions that will be displayed each time
may vary. On a side note, just to let you know that the image is optional, and you can
choose to have this space blank (white).
Background images for pages
Setting a background image for pages is easy. At the admin side, under the content
editor of each page you will see a “Background settings” panel (screenshot below).
Here is where you can select the background image for this specific page. Note that
every page template has this panel, except for the “widgetized” pages, where the
layout is more modular and having a background image would not fit in many
occasions.
Working with Sidebars
Crux and sidebars play well together. Notice that in order to fully make use of the
theme possibilities, you will have to have the Stag Custom Sidebars plugin installed, as
described at the “Installing the required plugins” section of this documentation. With
this plugin you can have unlimited sidebars, and use the one you want for each page.
Sidebar Options at theme options panel
The theme options panel has a dedicated tab for the sidebar settings. Let’s have a look
at it.
As you see, this screen provides default settings for the most common pages, with
inline text help. Here you can set the default settings that would apply to all the pages,
and if you want you can override each one of them for every individual post, page,
category. Note: The setting for the Archive pages will also apply for the product
categories. You can override this at the individual edit category screen.
Page Layout Settings
At each post or page edit screen, you will notice the “Layout Settings” panel on the top
right of the screen (screenshot below). There you can configure wether or not you want
a sidebar. If you want a sidebar, the second dropdown lets you choose which sidebar. If
you create custom sidebars using the Stag Custom Sidebars plugin, you can select
which of these sidebars should be shown with this page, or just use the default ones.
Using the Stag Custom Sidebars plugin
It’s too easy. Go to Appearance>Widgets, and you will see a Custom Widget Area panel.
Give a name e.g. “demo” and hit the “Add Widget Area” button.
This will create a new widget area where you can add widgets. Then, you can select
which sidebar to show for every individual page, through the “Sidebar Settings” at the
edit page screen.
Custom Widgets
Custom widgets are highlighted in blue for your convenience. Custom widgets with the
“Section:” prefix can be used at widgetized pages, and they output entire sections.
Let’s have a look at what each one of them does.
Section: Featured Products
This widget will output a section with the featured products, in a carousel mode, with
left and right navigation icons. You can configure the number of products to show and
the title of this section.
Section: Latest Products
A simple widget to show your latest products. There are 4 products per row in the
layout of this widget, and you can choose the title of this section and the number of
products to show.
Section: Best Sellers
This one will show your best selling products. Again, there are 4 products per row in the
layout of this widget, and you can choose the title of this section and the number of
products to show.
Section: On Sale Products
This one will show products that are on sale. Again, there are 4 products per row in the
layout of this widget, and you can choose the title of this section and the number of
products to show.
Section: Top Rated Products
This one will show products that have received the highest ratings. Again, there are 4
products per row in the layout of this widget, and you can choose the title of this
section and the number of products to show.
Section: Category Boxes
This one is a bit different. If you use this widget, it will output a section that shows
category boxes. You can pick a background color for the background of this section.
Adding category boxes
At the widgets screen, locate the “Category Boxes Section” widget area. In here, you
should only put “Category Box” widgets. A category box widget outputs an image for
the category, the title of the category, and the link url. All these can be manually
customized for greater control over the appearance of the section.
Using the Slider
Crux uses the Awesome Layer Slider, a $15 value plugin, which is included in the
download files. Make sure you have installed the Layer Slider Plugin as described at the
beginning of the documentation “Installing the required Plugins”.
A separate help file for the slider plugin is included in the download folder. Please refer
to this file for any information about configuring the Slider.
Having the Slider at homepage
There are 2 ways to output the slider at your homepage. The simplest way is to add the
“LayerSlider WP Widget”, at the custom widget area that you are using for your
homepage. Another way is to do it through a shortcode. In order to do this, follow these
steps:
At your admin side, navigate to LayerSlider WP. At the top section you will see a list
of available Sliders. The second column shows the shortcode that can be used to
output the slider.
Go to your Homepage Edit page screen, and insert the shortcode at the beginning of
the content to show the Slider at the top.
Using Sample Slides
We have created some cool slides for the demo’s Slider, and you are free to work on
them, using them as your starting point. To do so, you must first import the slider.
Follow these steps:
To import the slide we are using on our demo, just go LayerSlider WP settings page.
On settings page, locate the ‘Import & Export Sliders’ tab under which you can upload
dummy file containing LayerSlider slides. You can find the dummy file under
download package that comes with theme located under crux-package/dummy
content/layerslider/sample_slider.json
About the .psd files
In the downloaded folder, you will also find a .psd folder that contains the photoshop
files of Crux, in case you want to further customize it. The files are well grouped and
properly layered to make the slicing process easy. The designs are highly customizable,
because of the use of layer styles and shape layers. So if you want to change colors and
details, you can tweak the layer style of any specific layer and you can easily customize
it’s appearance.
Credits
All the product images that we use in the demo are by the Awesome Prana Clothing
Brand, and they are not included in the download files as they serve only for
demonstration purposes. Go ahead and check the awesome Prana products
at http://www.prana.com/
For the demo we have used some photos from Flickr, which are licensed under
a Creative CommonsLicense. The photos belong to the following awesome
photographers:
Adam Bove
Alessandro Valli
Dana Le
Henrik Mundal
DoodleDeMoon
Maria Ly