Auberge WordPress Theme

How to Install the Theme?

How to Update the Theme?

You will be notified in the WordPress dashboard or via an email alert each time a new updated theme version is released. To install this updated theme version please follow the steps below.

Automatic Theme Update

• Have you obtained the theme from WordPress.org themes repository?

  The WordPress itself will notify you about a new theme update. Only thing you need to do now is to proceed with update procedure suggested in your WordPress dashboard.

• Have you obtained the theme from ThemeForest?

  You can obtain automatic theme updates with help of Envato Market or Envato WordPress Toolkit plugin.

Manual Theme Update PLUS

• Updating via WordPress dashboard

  A simple way of doing a manual theme update would be deleting and reinstalling the theme directly via WordPress dashboard. You can read an article or watch a video on how to do this.

• Updating via FTP

  This is a more advanced manual theme update procedure and you will need an FTP client (such as FileZilla) to connect to your server:

  1. (Re)download the theme package ZIP folder from the marketplace where you've purchased the theme from and unpack the theme installation ZIP file on your computer.
  2. Now you will need an FTP client to connect to your server.
  3. On your server navigate to YOUR_WORDPRESS_INSTALLATION_FOLDER/wp-content/themes/ folder.
  4. Delete the existing auberge folder (or create a backup just in case).
  5. Copy the unpacked theme auberge folder from your computer (from step 1. above) to the YOUR_WORDPRESS_INSTALLATION_FOLDER/wp-content/themes/ on your server.
  6. Log into your WordPress admin area and check the version of the theme in Appearance » Themes. Your theme should be updated now.

Required and Recommended Plugins

Bellow you'll find a list of plugins that were successfully tested with the theme and works with it without any conflicts:

Other Great Plugins Worth Checking Out

You can use any plugin with this theme. Here are some tested, used and recommended plugins by the theme author:

404page

An easy and very flexible solution for custom error 404 page design.

Caldera Forms

A great form builder plugin for WordPress! Highly recommended!

Custom Post Type Editor

Allows you to rename any post type.

Customizer Export/Import

Perfect plugin for backing up your theme's Customizer settings.

Disable Comments

Disables comments site-wide per post type.

Front-end Editor

Edit your posts on the front-end of your site.

Imsanity

Automatically resizes huge image uploads.

Intuitive Custom Post Order

For easy posts ordering.

Maps Builder - Google Maps Plugin

Let's you build a custom Google Maps to be used in your posts and pages.

My Eyes Are Up Here

Helps you control how WordPress generates thumbnails.

Polylang

Making your WordPress website multilingual. A great free alternative to paid WPML plugin.

Rename Taxonomies

Allows you to rename any taxonomy.

Smart Slider 3

Great free advanced, layered slider plugin.

Theme Check

Checks your themes against the latest WordPress theme review standards.

WooSidebars

For creating unlimited widget areas (sidebars) and using them anywhere on the website.

WP Featherlight

The best free image lightbox (zooming) plugin that just works!

How to Install Theme Demo Content?

For detailed instructions regarding each demo content file installation and download, please visit the theme demo files repository at Github.

function child_theme_excerpt_length( $length ) {
  return 18; // Theme default: 18
}
add_filter( 'excerpt_length', 'child_theme_excerpt_length', 20 );

Setting Up a Post Format PLUS

On the post edit screen choose one of the predefined post formats in Format metabox on the right. The theme supports these post formats:

What Are They and How to Use Them?

Food Menus custom posts are used to display food menu of your restaurant website.

If the food menu item contains any content, the link will direct visitors to view the food menu item page. If you don't set the post content for the food menu item, the link will display full size of the food menu item featured image.

Food menu will be displayed without featured images on your website front page and in full, with featured images, on a "Food menu" page template.

You can use nested food menu sections with this theme (such as create a main section of Drinks and then create a child sections of Cocktails, Beverages,...). However, on your website front page, the food menu will be generated from your main food menu sections. If you would like to display each main section with list of subsections, use a "Food menu" page template and specify the food menu section displayed on the page, or link the food menu section archive page(s) in your website navigation.

What Are They and How to Use Them?

This is not actually a Custom Post Type but rather an extension for the standard posts and the Food Menu posts.

If you want to display a recipe on a post or Food Menu item page, just set the recipe setup boxes on post edit page in WordPress dashboard. The required field to set for the recipe to display is "Instrucions" - if this field is not set up, recipe won't display on the post page.

Each recipe setup field is self explanatory or contains a description to help you understand what it does and how it displays.

Ingredients are being stored as WordPress taxonomy (similar to tags), so, for example, you can even display them in a tag cloud on your website. When you start typing the ingredient name, the stored ingredient names will be suggested to you, otherwise, if the system doesn't recognize the new ingredient name, it will store it for future reference.

What is It and How to Use It?

/* This will get rid of the gradient on Custom Banner only: */
.custom-banner:before { display: none; }

/* This will get rid of the gradient on default banner only: */
.site-banner-media:before { display: none; }

/* This will get rid of the gradient on all banners: */
.custom-banner:before,
.site-banner-media:before { display: none; }

Adding Social Network Links and Icons

Social icons linked to your social network profiles can be displayed in the header and footer of your website. But beforehand you must create and set up a social links menu:

1. Go to Appearance » Menus in the WordPress admin.
2. Click create a new menu link.
3. Give the menu a name, such as "Social Menu".
4. Click [Create Menu] button.
5. Click the Links header on the left side of the page.
6. Type a link (such as https://www.facebook.com/webmandesigneu) to one of your social profiles in the URL field.
7. Give the link a title by typing the name of the service into the Link Text field.
8. Click [Add to Menu].
9. Repeat the above steps to add additional social profiles.
10. In the Menu Settings section at the bottom, check the "Social Links Menu" box for Theme locations.
11. Click [Save Menu] button.

Adding your social links as a custom menu allows you to sort your profiles and add as many as you want.

Widget Areas Contained in the Theme

The theme predefines these widget areas:

Sidebar

This widget area is displayed on all pages and posts. If you don't want to display a sidebar on a page, please use a "Fullwidth page" page template.

Custom Banner PLUS

Use this widget area to display a custom banner or slider on the front page.

Front Page Widgets

These widgets are displayed below the banner area on front page.

Footer Widgets

Display widgets in footer area of the website. Widgets will be aligned into columns automatically depending on the number of widgets in the widget area. If you set more than 3 widgets in this widget area, they will be spread into 3 columns, and masonry layout will apply.

What is Customizer and How to Use It

The theme seamlessly integrates its options into the WordPress Customizer.

You can access it navigating to Appearance » Customize. All the changes you set in Customizer will be immediately displayed in the theme preview. However, these changes will not be saved until you press the [Save & Publish] button.

You can set up your site's title, tagline and logo, header images, manage navigational menu locations and widget areas, set up a front and blog page, theme colors, layout, predefined texts and typography.

All the custom theme options can be found under Appearance » Customize » Theme section.

How to Translate the Theme?

1. Make a copy of the original auberge/languages/auberge.pot file.
2. You need to rename the copied file now. The naming convention is based on the language code (e.g. "en" for English) followed with underscore and the country code (e.g. "GB" for Great Britain). Also, rename the file extension to "po". So, the British English file would be named as en_GB.po.
3. Use Poedit to translate the file and export (save) translation also in "mo" translation file format.
4. Upload translated en_GB.mo file into your WordPress language directory, such as /wp-content/languages/themes/auberge/en_GB.mo. Alternatively you can put translations in your child theme: /wp-content/themes/your-child-theme/languages/en_GB.mo.

When and How to Use a Child Theme?

If you need to make any styling or functional changes to the theme, please use the WordPress native child theme functionality. This way you can continue updating the parent (original) Auberge theme without any worry of your changes being overwritten as all your custom styles and functionality are kept in a child theme. You can read more about child themes on WordPress Codex pages.

You can put all your custom CSS styles into YOUR_WORDPRESS_INSTALLATION/wp-content/themes/YOUR_CHILD_THEME/style.css file. (You can alternatively use a plugin, such as Jetpack, to insert a custom CSS.)

If you also want to change the functionality of the original Auberge theme, do so in YOUR_WORDPRESS_INSTALLATION/wp-content/themes/YOUR_CHILD_THEME/functions.php file. You can freely modify any theme's function here as they are all pluggable. Plus, you can use any filter and action hooks available in the theme source code.

Resources:

• Download the sample child theme
• WordPress Codex on child themes
• Why child themes are so important
• How To Make A Child Theme for WordPress (Includes Video & Downloads)
• Child Theme Configurator plugin

List of Frequently Asked Questions:

1. How to customize WordPress admin?
2. How to set up breadcrumbs?
3. How to create tables easily?
4. My images are blurry/small/of bad quality, what can I do?
5. How to use the Formats button in post editor?
6. What are custom fields and how to use them?
7. How to edit the CSS or add your own?
8. How to use action and filter hooks?

How to customize WordPress admin? Back to FAQ list ↑

If you are building a website for a client using WordPress (and Auberge theme), you might want to adapt the WordPress admin area a bit to remove unnecessary things and maybe even rename some post types. In this case we provide some useful resources you would want to check out:

• WordPress Admin Customization video course
• Use Custom Post Type Editor plugin to rename any post type
• Use Rename Taxonomies plugin to rename any taxonomy
• For easier pages/post advanced settings use Advanced Custom Fields plugin. Once you activate this plugin, the theme will automatically creates a metaboxes for all the custom fields it uses for you.

How to set up breadcrumbs? Back to FAQ list ↑

The theme supports Breadcrumb NavXT plugin that allows very flexible set up and display of breadcrumbs navigation on your website. After you install and activate the plugin, the theme displays the breadcrumbs navigation above and below the page content.

If you would like to display the breadcrumbs navigation the same way it is displayed on the theme demo website, please use these settings (feel free to set up all the other breadcrumbs settings to your need):

Settings » Breadcrumb NavXT » General » "Breadcrumbs Separator"

Set to <span class="sep"> / </span>.

Settings » Breadcrumb NavXT » General » "Home Template"
Settings » Breadcrumb NavXT » General » "Home Template (Unlinked)"

Prepend the existing text with <strong class="breadcrumbs-title">You are here: </strong>….

How to create tables easily? Back to FAQ list ↑

There are times you need to display tabular data in your posts and/or pages. This is not an easy task in WordPress if you are not familiar with HTML coding as there is no out-of-the-box tool to create HTML tables in post editor. But, there is an easy fix for the issue: try using a great TablePress plugin.

My images are blurry/small/of bad quality, what can I do? Back to FAQ list ↑

The theme uses 5 different image sizes:

• Thumbnail 420 × 280 (cropped)
  This image size is used in posts lists.
• Medium 632 × (variable height) (scaled)
  
• Large 1020 × (variable height) (scaled)
  This image size is set to fill the theme's content area.
• Banner (auberge_banner) 1640 × 686
  This image size is used for images displayed in the banner area.
• Small Banner (auberge_banner_small) 1020 × 426
  Smaller version of the Banner image size used for food menu featured images, for example.

WordPress will rescale and crop the images to selected formats automatically during the image upload process. If you already have some images on your website, these need to be rescaled when using the theme. Please use a plugin such as Force Regenerate Thumbnails to do the rescaling for you.

How to use the Formats button in post editor? Back to FAQ list ↑

The theme adds a new Formats button to the visual editor of WordPress posts/pages. Please use this button to create a special elements, such as pullquotes, cite source, inline code, super/sub-scripts, uppercase text, highlighted (marked) text.

For all the formats please select a text in post/page content first. The format will be applied on this selected text then.

Text styles » Dropcap text

Apply the "Dropcap Text" format on the paragraph of text, not the single character.

Illustration image only

What are custom fields and how to use them? Back to FAQ list ↑

To allow more control over pages and posts appearance, the theme uses some predefined custom fields. Here is the list of the fields explained:

food_menu_section

Set this field on "Food menu" page template only to a value of a food menu section ID. Once set, the specific food menu section is displayed on the page instead of the whole menu.

banner_text

Set this on featured posts or on your front page (if you are using static banner instead of slideshow). This text will override the default text displayed in your website front page banner.

quote_source PLUS

Set this on Quote post formats only to customizer quote source.

TIP:

For easier setup of custom fields please install and activate the Advanced Custom Fields plugin. Once you activate this plugin, the theme will automatically creates a metaboxes for all the custom fields it uses for the specific post types.

Illustration image only

How to edit the CSS or add your own? Back to FAQ list ↑

If you need to apply a custom CSS to override theme styles, please use a child theme or custom CSS plugin (such as Jetpack's Custom CSS or Reaktiv CSS Builder or Theme Junkie Custom CSS).

How to use action and filter hooks? Theme development and modifications Back to FAQ list ↑

The theme is coded according to WordPress coding standards and is full of action and filter hooks. You can easily hook onto these to alter functions outputs or alter parameters and variables, to add your own meta data, theme or design options, layouts and much more!

Please check the theme's source code for which hook to use, or contact WebMan Design Support Forums for more details and tips.

Auberge itself uses the Theme Hook Alliance hooks too. This is useful to entirely rebuild the theme structure or add your own sections anywhere in the theme.

You can also watch an instructional video on how to use WordPress hooks.