# WorkScout

##### WorkScout Documentation

Thank you for purchasing my 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 on themeforest.net/user/purethemes.Thanks so much!

Changelog
Credits

# For the latest and more complete version of this documentation please visit www.docs.purethemes.net/workscout/ The document below might be outdated, use online version please. Thanks!

# Getting started

I assume you have your own WordPress installation, so let's get started!

### Installation

You can do it in two ways:

1. ##### FTP Upload:

   - Extract the “workscout.zip”
   - Open up your FTP manager and connect to your hosting
   - Browse to wp-content/themes
   - Upload the workscout theme folder.
   - Log Into WordPress and go to Appearance - Themes
   - Find the WorkScout and click activate

2. ##### WordPress Upload

   - Download the “Installable WordPress file only” you'll find it here

   - Navigate to Appearance Add New Themes Upload.
   - Follow the instructions on the screen, select the downloaded theme folder (“workscout.zip”).
   - Hit Install Now and the theme will be uploaded and installed.

Once the theme is uploaded, you need to activate it. Go to Appearance Themes and activate WorkScout.

SInce version 1.4 we've added Setup Wizard to WorkScout that will do the demo import for you!

### Core Add-on Bundle

If you want the same content as the demo page, you need to buy also some additional plugins, WorkScout is based on WP Job Manager and it's add-ons. The free version of WP Job Manager allows for listing jobs and job submissions, If you want to have resumes, application, bookmarks, job alerts and other features you can see on a demo, the best way would be to buy the Core Add-on Bundle

If you decide on that option, it's important to buy and install the add-ons before importing demo content

You should see Setup Wizard page immediately after activating WorkScout, if you don't or you've skipped it, you can find it in Appearance -> Setup Wizard.

Here's a screencast from the installation process

It's pretty basic, you just need to confirm each step, the wizard will install and activate all required plugins, import all the content, and set basic options. There are few things you need to do manually after.

### Importing Revolution Slider

Go to your Dashboard -> Revolution Slider and click Slider Import

In the next form upload the file extras/revolutionslider.zip from "All files & documentation" or download it from here https://www.dropbox.com/s/i0k55e6ek9fglo1/revolutionslider.zip?dl=0

### Setting Up Plugins Pages

If you've installed all core plugins, and imported demo setting, now the last thing to do is to setup pages. Follow the screenshot to select appropriate pages for each setting.

Job Listings for WP Job Manager:

Resume pages for Resume Manager Add-on:

### Setting Logo

The logo can be set in Appearance -> Customize -> Site Identity.

However, the home page that uses Page Template named "Page with Jobs Search" with the Transparent Header enabled needs it's own logo image, as in most cases the dark logos won't look good there. To add that logo, go to Appearance -> Customize -> Home Page Options -> Logo for transparent header

# Creating Content Post, Pages, Jobs, Resumes

## Post

Creating posts is nothing special if you have even basic experience with WordPress. WorkScout theme offers couple of additional options in Post editor.

##### Post types

WorkScout supports for posts formats. You can change it in right side box. Default is Standard - that one shows only text of post and thumbnail image if added. Each change will show a form with options to fill. For Video, just put there a link to a video from youtube, vimeo, or any other service that has support for oEmbed.

Below Editor you'll see Layout box and Post options box.

##### Layout

Layout gives you ability to select sidebar to display with post or page, and also select layout of post - you can put sidebar on left or right side.

##### Sidebar

You can create more sidebars in Theme Options in Sidebars section. Just follow instruction there. After that you will be able to add Widgets to them in Appearance -> Widgets, and that way create

If you want to use shortcodes in post content, you need to write the excerpt or you might see non parsed shortcodes in search results or in front page.

### Pages

##### Job header background

You can add background to the page title section on some pages and single job listings

##### Layout box

Layout box gives you ability to select sidebar to display with post or page, and also select layout of post - you can put sidebar on left or right side, or just show full-width content. Full width is default.

##### Sidebar

You can create more sidebars in Theme Options in Sidebars section. Just follow instruction there. After that you will be able to add Widgets to them in Appearance -> Widgets, and that way create

##### Slider

If you'll change your Page Template to "Page with Slider", you can select here which slider will be displayed

### Jobs

##### Job data

Most of those fields are default fields from WP Job Manager, however there are 6 fields added by WorkScout, all are optional, so you don't have to fill them

- Salary min You can set a range of salary you want to offer in a job, if you don't want to set maximum, set just a minimum
- Salary max
- Rate/h minYou can set a range of rate per hour you want to offer in a job, if you don't want to set maximum, set just a minimum
- Rate/h max
- Hours per weak if it's not full-time job, you can set here how many hours it will take

### Resumes

##### Resume data

Most of those fields are default fields from WP Job Manager, however there is also rate per hour added by WorkScout - useful if you want to make a "freelance" section with resumes.

### Contact Page

You should use contact form 7 plugin for contact form. After installing it, go to Contact - Add new (or edit current one) and in Form field paste what's below:

    <fieldset>
    <div><label>Name</label>[text* your-name] </div>
    <div><label>Email<span>*</span></label>[email* your-email] </div>
    <div><label>Message<span>*</span>:</label>[textarea your-message] </div>
    </fieldset>

    [submit "Send"]
    <div class="clear"></div>

Than at the top of page you'll see shortcode, for example (it will be different on your website):

    [contact-form-7 id="503" title="Contact form 1"]

Use it on a page you want to have contact form. The contact page should use Page Template named "Contact Page". To add points to the map, go to Appearance -> Theme Options -> Contact Page -> Add New

# Plugins Configuration

Here's some short info about basic plugins you can and need to use in WorkScout.

### Purethemes.net Shortcodes Required plugin

This will add new icon to your TinyMCe editor (the one you use to edit posts and pages) that will open a box with shortcode generator.

### Web Fonts Social Icons WP Recommended plugin

Adds a widget and shortcode with icons from popular social sites. Example here

### WP-PageNavi Optional plugin

This will replace standard "next/prev" page buttons with pagination list.

# Shortcodes & Widgets Configuration

- [clear]
- [icon]
- [space]
- [highlight]
- [button]
- [dropcap]
- [popup]
- [list]
- [box_job_categories]
- [headline]
- [jobs]
- [spotlight_jobs]
- [testimonials_wide]
- [actionbox]
- [centered_headline]
- [clients_carousel]
- [column]
- [latest_from_blog]
- [jobs_categories]
- [box]
- [infobanner]
- [counters]
- [counter]
- [pricing_table]
- [pricing_woo_tables]
- [tab]
- [accordion]

WorkScout has many shortcodes which will help you to build awesome layouts. There's also Visual Composer included, which will allow you to build your pages with easy drag and drop tool.

Here is list of all shortcodes:

### Clear shortcode:

    [clear]

Empty div with clearfix, use after floated elements

### Space shortcode:

    [space class="margin-top-30"]

This works like [clear] shortcode but allows you to add custom class, for example to make some whitespace. There are couple class available, margin-top-xx, margin-bottom-xx where xx can be number 0,10,15,20,25,30,35,40,45 or 50

### Icon shortcodes:

    [icon icon="book"]

This will add one of icons from Font Awesome pack

### Highlight shortcodes:

    [highlight style=""] text [highlight]

This will highlight wrapped text.

Options

- style "color" (default), "gray", "light"

### Button shortcode:

    [button color="green" url="#" icon="icon-ok" iconcolor="white"] Text [/button]

Options

- url link
- color "color" (default), "gray", "dark"
- customcolor "#000000" (any color hash)
- iconcolor "white","black"
- icon Font Awesome icon name
- target "_blank"
- customclass

### Dropcap shortcode:

    [dropcap type=""] A[/dropcap]

Make first letter of paragraph larger than the rest of the text. As "type" you can use also 'full'.

### Popup shortcode:

    [popup buttontext="Open Popup" title="Modal Popup"]Content of Popup[/popup]

Open a text added between the tags in the nicely styled popup window

Options

- buttontext text to show on button that displays popup
- title title of modal box area

### List styles

    [list style=1 color="yes"]
    <ul>
    <li> list item </li>
    <li> list item </li>
    </ul>
    [/list]

Options

- style 1 | 2 | 3 | 4
- color yes | no

Use it to replace boring list bullets with nice icons

### Box job categories

    [box_job_categories]

Options

- hide_empty Whether to not return empty $terms. 1 (true) - Default (i.e. Do not show empty terms) 0 (false)
- orderby id, count, name - Default, slug, term_group - Not fully implemented (avoid using), none
- orderASC - Default,DESC
- numberThe maximum number of terms to return.
- browse_link adds button with link to Browse Categories page - pass URL as value
- include term ids to include, use coma to separate. Empty returns all.
- exclude term ids to exclude, use coma to separate.
- child_of Get all descendents of this job category. Default is 0. Note: child_of gets all descendants (as many levels as are available)

Use it to replace boring list bullets with nice icons

### Headline shortcodes:

    [headline margintop="0" marginbottom="25" clearfix="0" type="h3"] Header [headline]

Just a simple header with margin class.

Options

- margintop 0,10,15,20,25,30,35,40,45 or 50
- marginbottom 0,10,15,20,25,30,35,40,45 or 50
- clearfix 0 | 1 ; 1 ads clearfix after header
- type h1, | h2 | h3 | h4 | h5 - choose header type, default is h3

### Jobs listing shortcode

    [jobs]

Options

- per_page how many items show per page
- orderby id, count, name - Default, slug, term_group - Not fully implemented (avoid using), none
- orderASC - Default,DESC
- show_filters true | false - show filter section
- show_categories true | false - show categories in filters
- show_category_multiselecttrue | false
- show_paginationtrue | false
- show_moretrue | false
- show_descriptiontrue | false - if false shows just a title of job and basic values.
- categories show results just form specific category
- job_typeshow results just form specific job types
- featuredTrue to show only featured, false to hide featured, leave null to show both.
- filledTrue to show only filled, false to hide filled, leave null to show both/use the settings.
- locationShow jobs from specific locations
- filled
- keywords
- selected_category
- selected_job_types

Shows the list of all jobs added via WP Job Manager

### Spotlight Jobs

    [spotlight_jobs]

Options

- per_page how many items show per page
- orderby id, count, name - Default, slug, term_group - Not fully implemented (avoid using), none
- orderASC - Default,DESC
- title Title of the section
- categories show results just form specific category
- job_typeshow results just form specific job types
- featuredTrue to show only featured, false to hide featured, leave null to show both.
- filledTrue to show only filled, false to hide filled, leave null to show both/use the settings.

Shows the list of all jobs added via WP Job Manager

### Testimonials fullwidth

    [testimonials_wide]

Options

- per_page how many items show per page
- orderby id, count, name - Default, slug, term_group - Not fully implemented (avoid using), none
- orderASC - Default,DESC
- exclude_postsid of testimonials you want to exclude
- include_postsid of testimonials you want to include - if not specified
- backgroundurl to image that acts as a background for this section, should be around 1900x700px

Shows the carousel with testimonials added in wp-admin -> Testimonials

### Action box

    [actionbox wide="true" title="Start Building Your Own Job Board Now" url="#" buttontext="Do Action"]

Options

- wide set actionbox to be full screen wide, or page wide
- title Title of the section
- url optional link for the button
- buttontext caption for optional button

Shows the call to action box element

### Centered headline

    [centered_headline wide="true" title="Start Building Your Own Job Board Now" url="#" subtitle="Do Action"]

Options

- wide set actionbox to be full screen wide, or page wide
- title Title of the section
- url optional link for the button
- subtitle subtitle

Shows the call to action headline element

### Columns shortcodes:

WorkScout is based on modified Skeletons grid - Full width page has 16 columns, if it's page with sidebar it has 16 columns. Using columns shortcodes you can build your own layouts.

The important part of columns shortcode except the width is place. You have 3 options here - first, none or last. If last is used, it's assumed that this column is last in current row and floats will be cleared. First will set margin-left to 0px. If you have more than two columns you might want to use also place="center" - it will set margin left and margin right to 0px. It's good to try different parameters to find out what looks the best in specific situation.

    [column width="one-third" place="first" ] Put here content [/column] [column width="two-thirds" place="last" ] Put here content[/column]

Options

- width "1/3", "2/3", "sixteen" (default), "fifteen", "fourteen", (..), "two", "one"
- place "first" (default), "center", "last", "none"
- custom_class just adds custom class to the container div, handy if you want to style something in different way

You can use other shortcodes in columns.

### Accordion shortcode:

It need's to be wrapped with [accordionwrap] shortcode

    [accordionwrap] [accordion title="Accordion#1"] Lorem ipsum dolor sit amet, consectetur adipiscing elit tortor libero sodales leo, eget blandit nunc tortor eu nibh. Aenean nisl orci lorem, condiment ultrices consequat eu lorem ipsum dolor sit amet inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo dolor sit amet.[/accordion][accordion title="Accordion#1"] Lorem ipsum dolor sit amet, consectetur adipiscing elit tortor libero sodales leo, eget blandit nunc tortor eu nibh. Aenean nisl orci lorem, [/accordion][accordion title="Accordion#1"] Lorem ipsum dolor sit amet, consectetur adipiscing elit tortor libero sodales leo, eget blandit nunc tortor eu nibh. Aenean nisl orci lorem, [/accordion] [/accordionwrap]

### Tabs shortcode:

    [tabgroup] [tab title="Tab 1"] Aliquam egestas consectetur elementum class aptent taciti sociosqu ad litora torquent perea conubia nostra lorem inceptos orem ipsum dolor sit amet, consectetur adipiscing elit.[/tab] [tab title="Tab 2"] Lorem ipsum pharetra felis. Aliquam egestas consectetur elementum class aptent taciti sociosqu ad litora torquent perea conubia nostra lorem inceptos orem ipsum dolor sit amet, consectetur adipiscing elit.[/tab] [tab title="Tab 3"] Lorem ipsum pharetra felis. Aliquam egestas consectetur elementum class aptent taciti sociosqu ad litora torquent perea conubia nostra lorem inceptos orem ipsum dolor sit amet, consectetur adipiscing elit. [/tab] [/tabgroup]

### Box shortcode:

    [box type=error] Error! Please fill in all the fields required. [/box]

Options

- type "error", "notice", "warning", "success"

## Widgets

- WorkScout Tabbed Widget
  Shows recent, popular and

### Theme Options

Options panel is based on OptionsTree plugin and additional visual settings are available in Appearance-> Customize

##### Sidebars

All sidebars that you create here will appear both in the Appearance > Widgets, and then you can choose them for specific pages or posts. Please choose a unique title for each sidebar and make it one word.

### Theme Customizer

WorkScout is using new feature of latest WordPress - Theme Customizer, you'll get there by clicking Appearance - Customize

It gives you real time preview of changes you made to your site.

### Translation

WorkScout theme is translation ready. I assume your WordPress is already in your language. If not:

1. Go to: Dashboard > Settings > General and change the Site language.
2. Open wp-config.php and modify the line below, or add it if it is missing.

For German language it will be:

     define ('WPLANG', 'de_DE');

There are three ways to translate it to your language:

### Method 1 - using Loco Translate

Install plugin Loco Translate. After successful installation go to Loco Translate -> Manage Localization, you should see this screen:

Click New language, select your language and click Start Translating.

Now you should see that screen where you can translate each string that is used in theme:

When you're done, click Save, and you can also click both "Po" and "Mo" buttons to save them on your PC as a backup.

### Method 2 - using Codestyling Localization

Install plugin Codestyling Localization. After successful installation go to Tools -> Localization, you should see this screen:

Click Themes (if you'll see any timeout errors etc., click the 'enable low memory code' checkbox) and find workscout on the list:

Here we already have English and Polish version

Now we can add new languages, let's add German. Click Add New Language, in the popup find 'de_DE' and click "create po-file'.

German language should appear on the list.

Click Rescan button and than 'Scan now' in new popup. After that you can click Edit on the list.

This how it should look now:

You can translate here every string that comes in the theme, and after you do it click Generate mo-file

There's a notice message on the top:

> Warning: The actual loaded translation content contains mixed textdomains and is not pure translateable within one textdomain. It seems, that there is code contained extracted out of other plugins, themes or widgets and used by copy & paste inside some source files. The affected unknown textdomains are: woocommerce, option-tree

All strings that are from WooCommerce textdomain will be translated automatically if your WooCommerce is in the same language as you set (so German in this example). Read more about WC localization - Translating WooCommerce

### Method 3- using PoEdit

Download PoEdit and run it.

Click 'Create new translation', navigate to workscout/languages, and select en_US.po (you might need to switch filter on the browser from *.pot to *.po). Select your language"

now you can translate one by one each string from the theme, after you finish (you don't need to translate everything, save the file as for example fr_FR.po, not fr.po like PoEdit suggest. That should generate two .po and .mo file.

### Making your Localization upgrade safe

Keep a backup of your translation in safe place, as WordPress might remove files during auto-updates, and you probably wouldn't want to lose it :)

Once again, thank you so much for purchasing this theme. As I said at the beginning, I'd be glad to help you if you have any questions relating to this theme. No guarantees, but I'll do my best to assist. If you have a more general question relating to the themes on ThemeForest, you might consider visiting the forums and asking your question in the "Item Discussion" section.

### Changelog

### Credits