Mentor Theme Documentation

Thank you for purchasing the Mentor - Premium Drupal Theme by Theme Boutique. In order to get the most out of your purchase, please make sure to carefully read all of the information contained in this document. Use the table of contents on the left hand side of the page to jump to a relevant section.

I. Installation

New Installation

New installations come equipped with all of the demo content and can be set up in a matter of minutes. Follow the steps below to get started:

  1. This theme requires a working Drupal installation to function. Download the latest version of Drupal 7 and go through the installation process. When Drupal is installed, move onto the next step.
  2. Unzip the contents of Mentor.zip (found in the theme download from ThemeForest). The unpacked zip file contains three folders:
    • sites/all/themes -- Contains the Mentor theme files
    • sites/all/modules -- Contains the module files required by the Mentor theme
    • sites/default -- Contains the demo content images
    Upload these files to the sites folder found at the root level of your Drupal installation. Make sure the paths mentioned above match up with the default folder structure of the Drupal installation from step #1 -- there should already be "all" and "default" folders inside of the sites directory.
  3. Click the Modules link in the Drupal administration toolbar at the top of the page and enable the "Backup and Migrate" module. When your settings are saved, move onto step #4.
  4. Navigate to Configuration > Backup and Migrate in the Drupal UI. Click the "Restore" tab and upload the Mentor-2013-09-11T21-58-23.mysql.gz file (found in the Assets folder of the Mentor theme download from ThemeForest). When the file has been selected, click the "Restore Now" button.
  5. The last step is to change the administrator username/password back to your own credentials -- the admin username/password was reset when the demo content was uploaded in the previous step. (New Username: admin, New Password: admin). Navigate to the People section in the Drupal UI and click the "edit" link for the admin account to reset your username/password:

    Change Password
  6. Congratulations! The Mentor theme, along with the demo content, is now installed.

Existing Installation

Existing installations do not come with the demo content. If you would like to implement the footer blocks seen in the theme demonstration, please refer to the footer blocks section of the installation guide. To setup the Mentor theme on an existing installation, follow these steps:

  1. Unzip the contents of Mentor.zip (found in the theme download from ThemeForest). The unpacked zip file contains three folders:
    • sites/all/themes -- Contains the Mentor theme files
    • sites/all/modules -- Contains the module files required by the Mentor theme
    • sites/default -- Contains the demo content images
    Upload the contents of sites/all/themes and sites/all/modules to the sites folder found at the root level of your Drupal installation. Make sure the paths mentioned above match up with Drupal's default folder structure -- there should already be "all" and "default" folders inside of the sites directory. The contents of the sites/default folder found in Mentor.zip do not need to be uploaded for existing installations.
  2. Click the Modules link in the Drupal administration toolbar at the top of the page and enable the "Mentor: Features" module.
  3. Optional: Populate the taxonomy terms used for the blog/portfolio. Terms can be added to the Categories, Tags, and Portfolio vocabul aries found by navigating to Structure > Taxonomy. The portfolio terms are used for the filter on portfolio pages, where as the Categories/Tags vocabulary terms are used with the blog. Adding terms to the "Tags" vocabulary will also populate the Tag Cloud block in the footer.

Multilingual / RTL Setup

Sometimes referred to as i10n, Localization allows for localized and/or multilingual Drupal installations. This section of the documentation will cover three areas:

Installing Language Libraries

Before we can begin exploring the multilingual capabilities of our Drupal installation we'll need to install the appropriate language libraries.

  1. Click the Modules link in the Drupal administration UI and enable the Locale, Content Translation, and Localization Update modules. If all of these modules are enabled, move onto the next step.
  2. Navigate to Configuration > Languages > Add Language. Choose a language and click the "Add Language" button:

    Add Language

    Drupal will now update your installation with all available translations for your setup. This may take a minute or two:

    Add Language
  3. A detection path for the new language needs to be setup. Click the "Detection and Selection" tab:

    Detection and Selection

    Enable the URL Detection Method and save your settings:

    Detection URL
  4. You're now ready to start using multiple languages with Drupal. Languages can be switched by appending the language code (found at Configuration > Languages) to the end of your website's URL. For example:

    Language Code

    When http://www.mydomain.com/fr is accessed, Drupal is now in French:

    French

Enabling Right to Left (RTL)

To change the text direction to right-to-left, follow these steps:

  1. Navigate to Configuration > Language in the Drupal administration UI. Find the language(s) you would like to convert to RTL and click "Edit".
  2. Change the Direction option to "Right to Left" and save your options:

    Right to Left (RTL)

Further Information

The steps above install a basic multilingual configuration in Drupal. If needed, the Internationalization suite can be used to extend Drupal's multilingual capabilities even further. Download the Drupal 7 version and place the contents in the sites/all/modules folder to get started.


II. Content Types / Templates

This section contains a list of the content types which come prepacked with the Mentor theme. Content types are used to organize the nodes created on your Drupal website. Each content type has specific fields for certain pieces of data. These fields are described in greater detail for each content type below:

To create a new node under a content type, click the Add Content link in the Drupal administration toolbar at the top of the page. A list of each content type will be prompted -- choose a content type and create the new node.

Fields for each content type can be added, edited or deleted through the Drupal administration interface. Please refer to the documentation related to each individual content type for more details.

Basic Page

The following fields can be editted in the Drupal administration interface. Navigate to Structure > Content Types > Basic Page > Manage Fields to modify the basic page field settings.

Basic Page

Below is a list of each basic page field along with a description of it's respective purpose:

  • Title: The node title. This value will be used as the page title sitewide.
  • Body: The body field contains a node's content. Valid formats consist of Plain Text, Filtered Text, and HTML code.

Blog Post

The following fields can be editted in the Drupal administration interface. Navigate to Structure > Content Types > Blog Post > Manage Fields to modify the basic page field settings.

Blog Post

  • Title: The node title. This value will be used as the page title sitewide.
  • Subtitle: The subtitle is used on the blog homepage and on certain templates for blog post. Please refer to the Post Type bullet on this list for more information on blog templates.
  • Post Type: What kind of post type is this blog post? The post type will determine which blog template is used. If no post type is selected, Drupal's default field settings will be used. For a demonstration of each blog template, please refer to the Mentor theme demo.
  • Image: Image(s) to be displayed with this blog post. Multiple images can be integrated with a Slider or Lightbox based on the post type selected.
  • Video: If the Video post type is selected, enter the URL to a YouTube or Vimeo video.
  • Body: The body field contains a node's content. Valid formats consist of Plain Text, Filtered Text, and HTML code.
  • Social Media: Add a Pinterest, Facebook, Twitter, or Google+ button to this post.
  • Categories: Blog post categories. This list can be modified or added to by navigating to Structure > Taxonomy.

Portfolio

Portfolio

  • Title: The node title. This value will be used as the page title sitewide.
  • Subtitle: The subtitle is used on the portfolio views and portfolio nodes.
  • Template: What kind of post type is this portfolio? The post type will determine which portfolio template is used. If no post type is selected, Drupal's default field settings for this content type will be used. For a demonstration of each portfolio template, please refer to the Mentor theme demo.
  • Image: Image(s) to be displayed with this portfolio item. Multiple images can be integrated with a Slider or Lightbox based on the template selected.
  • Video: If the Video post type is selected, enter the URL to a YouTube or Vimeo video.
  • Body: The body field contains a node's content. Valid formats consist of Plain Text, Filtered Text, and HTML code.
  • Social Media: Add a Pinterest, Facebook, Twitter, or Google+ button to this post.
  • Tags: Portfolio tags that will be used with the filter on portfolio views. This list can be modified or added to by navigating to Structure > Taxonomy.

Contact Page

Contact Module

The contact page is generated by the Contact module. To change the e-mail address this page sends to, naviagate to Modules > Contact > Configure.

Several elements on the contact page can be modified through the Mentor theme settings by navigating to Appearence > Settings > Contact Page. Here the latitude/longitude values for Google Maps, along with the introduction message on the contact page, can be configured.


III. Drupal Configuration

Modules

Mentor requires a few Drupal modules to function fully. To enable these modules, navigate to the Modules section in the Drupal UI (found at the top of the screen in the Drupal administration toolbar). Inside of the sites/all/modules folder of the download files you will find the following module folders and their contents:

  • Required Modules:
    • Block Class: The block class module allows users to add CSS classes to blocks on the block edit page.
    • Flippy: Flippy is a module which enables pagination for node types.
    • Image URL Formatter: Allows image fields to be exported as a URL. Used for prepackaged. Mentor views.
    • Menu Attributes: The menu attributes module is used to style Mentor's dropdown menus through the Drupal administration interface.
    • Pathauto: A module to control URL text markup (also great SEO tool).
    • Token: Used by the Flippy and Pathauto modules
    • Views Isotope: Integrates the popular isotope.js plugin with the Views module, used for portfolio views
  • Optional Modules:
    • Backup & Migrate: Used for the "new installation" option, demo content installation.
    • Features: Used for the "existing installation" option.
    • Localization Update: Utilized for multilanguage websites.
    • Mentor: Tools: The Mentor: Tools module contains functionality, such as the slide builder, to enhance the Mentor theme's usability.
    • Revolution Slider: The Revolution Slider module adds functionality and a drag/drop interface for the popular Revolution Slider jQuery plugin.
    • Mentor: Features: Used in conjunction with the Features module on the "existing installation" option.
    • Simplenews: Enables newsletter management.

Drupal 7 menus can be configured through the administration interface at Structure > Menus. This portion of the documentation will detail the following:

  • Dropdown Menus
  • Bootstrap Styles

Dropdown Menus

To create or modify a dropdown menu, navigate to Structure > Menus > Main Menu > Edit Menu. The diagram below illustrates an example of a dropdown menu:

Dropdown Menus

The diagram above illustrates a parent link (the Pages link) and several child links (indented items underneeth the Pages link).

Ensure that the parent item always has the show as expanded item checked to trigger a dropdown menu. Each child link, along with the parent item, must be checked as Enabled to be displayed in the menu.

Indenting any menu item will make the item a child link within the dropdown menu.

Bootstrap Styles

Mentor's menu system is built with elements from the popular Twitter Bootstrap framework using a modified version of the Menu Attributes module to style menu items. The diagram below lists each menu item used with the Mentor theme:

Mentor Menu Attributes
  1. Divider: Check this box if you would like a divider to appear above the menu item. Option commonly used with header text (see #2).
  2. Header Text: Enter text for a header to be displayed above the menu item. All text is automatically capitalized.
  3. Badge/Label Text: Enter text for a badge/label to be appended to the menu item. All text is automatically capitalized.
  4. Badge/Label Class: Enter CSS classes for a badge/label to be appended to the menu item. More Information
  5. Icon Class: Enter CSS classes for an icon to be appended to the menu item. Make sure the icon-white class is always included. More Information

Blocks / Regions

Blocks and Regions are two elements used do develop Drupal websites. Blocks (a block of content) are placed inside of regions to organize the content which appears inside of regions on your Drupal website. This section will document the following information:

  • Regions: An example illustrating the layout for block regions available with the Mentor theme.
  • Blocks: Create a new block (HTML is allowed inside of blocks) and placing a block in a region.

Regions

The grid below demonstrates the region layout for the Mentor theme. Each region is used as a container to hold blocks. CSS elements for each region can be added/modified through the Theme Settings at Appearence > Settings > Regions.

Header Region
Prescript Region
Left Sidebar Region
Content Region
Right Sidebar Region
Postscript Region
Footer Region

The diagram above can be used to help you determine where on the page you want to place blocks. Blocks can be created, and added to regions, by navigating to Structure > Blocks in the Drupal administration interface. The section below, titled Blocks, will describe creating new blocks and placing blocks within regions in greater detail.

Blocks

Creating a Block

Blocks can be added/modified by navigating to Structure > Blocks > Add Block in the Drupal administrative interface. Each block can hold plain text or full HTML markup and be used on multiple pages of your website. Using a block is highly recommended when an element needs to be used on multiple pages. Make sure you check the filter settings if HTML is needed.

Editing a Block

Blocks can be edited by navigating to Structure > Blocks in the Drupal administration interface, or by hovering over a block on the page and clicking the Edit block link. CSS classes can also be added to each block on the edit block page.

Placing Blocks in a Region

Blocks can be placed in regions by utilizing the "drag and drop" interface found at Structure > Blocks or on the block edit page:

Drag/Drop Blocks into a Region Drag/Drop Blocks into a Region


Each block can be edited by navigating to Structure > Blocks in the Drupal administration interface and clicking the "configure" link next to the block you wish to modify.

Limiting Blocks to Specific Pages


Limiting Blocks to Specific Pages

To place a block on a specific page, or multiple pages, navigate to Structure > Blocks in the Drupal administration interface and click the configure link next to the block you are editing.

Locate the Pages tab at the bottom of the page. Here you can specify the address to each page you wish to include or disclude each respective block on.

Example In the example on the left, the block will only be listed if the path is /contact or /node/17.

Note: If a more robust way to control blocks/regions is desired, use of the Context module is highly recommended.


Views

The Views Module is a popular Drupal module utilized extensively within the Mentor theme framework to build blocks and pages based upon node and taxonomy content. Views is being integrated into Drupal core for Drupal 8, so if you've never used the module before now is a great time to learn. Both the Mentor: Tools module and demo content file (enabled during theme installation) come packaged with the following views (found at Structure > Views):

Mentor: Views

Click the Edit button to modify each view individually. If you would like to control the placement of these blocks on pages, please refer to the Blocks/Regions section of this documentation.

Views is a complex module with an enormous amount of capabilities (which are far too broad to detail in this documentation file). If you are unsure of how to configure the Views module, please contact Theme Boutique support and we can help you solve your problem.

Reverting Views

If you're a more experienced Drupal user, there is nothing particularly important that needs to be known about the View pages/blocks which come with the Mentor theme. Fields, field markup, and filters can be added or modified as needed. If the need to revert a view back to the default settings should ever arise, navigate to Structure > Views and locate the view in question. Open the dropdown menu for the view and click "Revert" (the Mentor: Tools module must be enabled for this functionality).


Theme Settings

Various settings for the Mentor theme are specified through Drupal's theme settings, found at Appearence > Settings. The theme settings comprise of four sections:

I. General

The general settings consist of the default Drupal theme settings.

II. Region Settings

Region Settings

The region settings allow users to add a Twitter bootstrap grid class and additional CSS classes.

III. Layout Settings

Layout Settings

The layout settings section contains the following options:

  • Color Scheme: Select a green, blue, or orange color scheme to use with the Mentor theme.
  • Return to Top: If this option is enabled, the "return to top" button will be disabled.

IV. Contact Page

Region Settings

The contact page section contains the following options:

  • Google Maps: Specify the longitude/latitude coordinates and the zoom level for Google Maps.
  • Title/Summary Text: The title/summary text to be displayed on the contact page. HTML is allowed.

Mentor Slider

To create a new slideshow, navigate to Structure > Add Content and select the Mentor: Slider option. When creating a new slider, there are three fields which must have values:

Step 1: Create Slides

Slide Builder

  • Title: The title of the slideshow. This value will be used to name the block created from each node.
  • Autopause: If enabled, the slideshow will pause on hover.
  • Slide: The slide field has three values. The Image value specifies the slide image, the delay value determines how long the slide will remain active, and the link value will link the slide to a URL when active. This field is reusable, and the values of each slide is specified by each row in the field.

Step 2: Create Slider Block

Now that you have some slides with data/images created for a slideshow, the content needs to be generated by creating a block with the Views module. Navigate to Structure > Views > Mentor: Slider.

Mentor: Slider View Block

First, you'll want to clone one of the existing blocks by utilizing the dropdown menu found on the right hand side of the screen (figure 1). Once a clone has been created, change the node ID in the "filter settings" to the node ID (figure 2) for the Mentor: Slider node you created in Step 1: Create Slides. When finished, save your new view block and assign the new block to the appropriate page at Structure > Blocks.


Revolution Slider

The Revolution Slider module links together three key components: the slide builder, the Views Module, and Revolution Slider option sets. This section of the documentation will detail the aforementioned components in greater detail so you can get started on creating your own slides as soon as possible!

Slide Builder

Before we can create a slider, we're going to need to populate the slider with some slides first. The Slide Builder tool will be utilized for this process. Navigate to Add Content > Revolution Slider.

Revolution Slider

The slide builder consists of five sections:

  • Title: The title of the slide. This is used for administrative purposes only.
  • Image: The slide background image. Suggested image dimensions (in pixels) are 1920x460.
  • Slide Settings: The settings for the slide.
  • Preview: Drag and drop slide editor used in conjunction with the layer settings.
  • Layer Settings: The settings for each layer.

Although descriptions for each field are provided in the slide builder itself, further documentation may be needed if you have never used the Revolution Slider in the past. Please refer to the Revolution Slider documentation (found in the assets folder of the Mentor theme download from ThemeForest) for a comprehensive overview of the plugin's capabalities.

Notes:

  • An image must first be uploaded to activate the Slide Builder preview.
  • If the "layer type" option is set to "Select Layer Type...", the layer will be deleted on save. A "delete button" is being planned for future versions of the Revolution Slider module, in the meantime please use this method to delete unwanted layers.
Integrating CSS styles with the Revolution Slider

The Slide Builder module integrates with the css/slider.css file found in the Mentor theme directory. When stying your slider elements, please make sure to use this file if you want to see your styles in the Slide Builder preview.

If this theme was purchased simply for the Revolution Slider module and you plan on using the module with a different theme, the location of this CSS file can be modified on line 395 of revolution_slider.module in the modules/revolution_slider folder (Note: for advanced users only -- if you don't know PHP, simply create a css/slider.css file in the folder of your default theme instead).

Option Sets

Option sets can be defined by navigating to Configuration > Revolution Slider in the Drupal UI. Existing option sets can be edited and new option sets can be defined here. These option sets will be used in the third part of this process (View Blocks).

You may be wondering -- what is an option set? Option sets are a collection of defined slider settings which can be applied to Revolution Slider blocks in views. These options influence default slider settings, transitions, speeds, and navigation elements for the Revolution Slider module:

Option Sets

Descriptions of these options are detailed in "Layout" section ofv the Revolution Slider plugin documentation (found in the assets folder of the Mentor theme download from ThemeForest). When done editing an option set or defining a new option set, be sure to save your options.

View Blocks

At this point, we should have at least a few slides built via the Slide Builder tool and an the default option sets defined (at a minimum -- feel free to define yor own options when necessary). The Views module is going to be used to integrate the slides and option sets. To get started, navigate to Structure > Views > Revolution Slider > Edit.

View Block

Click the Settings link next to "Format: revolution_slider" to assign option sets to a view block.

View Block: Option Sets

When the option set is selected, click the Apply button and save the view. The Revolution Slider block is now ready to be used! Please visit the Contexts section of the documenation for more information on assigning blocks to regions.

Adding multiple sliders

To add a new slider block, navigate to Structure > Views > Revolution Slider > Edit. On the right hand side of the page there is a drop down menu with the contents "edit view name/description" selected. Open this menu and click Clone View.

View Block: Clone View

This process will create a clone of the original Revolution Slider block that can be modified as needed. Repeat the steps listed above to customize this slider block.


Customer Support

Support Policy

Having troubles? We're here to help! Theme support is handled through our dedicated support forum. If you are having an issue with a theme, please create an account on our support forums (you'll need access to your purchase code to create an account). Once your purchase has been verified, your forum account will be approved. Thanks!

Customization Requests

All theme modifications which alter or built upon the original theme functionality are considered extra customizations and are not covered by Theme Boutique's support policy. If you would like to request a quote for paid customizations, please contact us through our author profile page and we will respond to your query within 48 hours.