WordPress is free open source CMS software for creating websites. It can scale with your needs when you're ready to grow and is easy to learn with many free and low-cost tutorials. You can learn more about WordPress at wordpress.org.
What is a theme?
A WordPress theme changes the way your site looks and affects the style of the content displayed on it. WordPress themes are built so you can change your site's design without losing content. As you are reading a user manual for a WordPress theme and it requires WordPress to run, let's install it first.
The theme allows you to import a demo content, which matches theme demo website. Then you can simply change the imported demo content to your needs and build your website faster that way.
Before you import the theme demo content, please check these important notes:
Theme demo contains a lot of pages. You will certainly end up not using most of them. In that case it is strongly recommended to delete the leftover demo content you no longer need from your website. It improves your website performance and relevance.
Please understand that demo images, audio and video files are of low quality. This is to prevent any copyright infringement. You should replace them with your own, properly licensed media that fit your website project.
Recommended:Classic widgets interface
WordPress 5.8 introduced a new block-based interface to widgets and sidebars management screen. Theme demo content was built using the classic widgets interface, so it is highly recommended to install and activate Classic Widgets plugin to retrieve the classic WordPress widgets interface again.
Warning:Page builder compatibility
If you want to use a page builder, please understand that if the theme demo content was not built with your page builder, you will not be able to edit the imported demo pages.
By default, all the pages display with a sidebar. However, if you would like to display a page full width, with no sidebar, use this page template. It is useful template for page builder pages.
Do not forget to set up your custom H1 heading in this case.
Use this page template to display a whole food menu of your restaurant, or just a specific section (with its subsections). Please note that you need to have Jetpack plugin installed and activated to use Food Menu functionality.
Also, please note that each food menu section title will get linked to the corresponding archive page. You can disable this linking in "Food Menu" section of the theme customizer.
By default WordPress displays a caption in archive page titles (such as "Category:" in front of a category name). Use an Archive Title plugin to hide these labels.
Table of Contents on Parted Post
If you are setting up a multipage post (using a "Page break" button in visual editor, or <!–nextpage–> tag in "Text" tab of visual editor), the automatic table of contents will be generated for the post/page for you.
All you need to do is to set up a post parts titles at the top of each post part (so, immediately after <!–nextpage–> tag) with H2 heading.
On the post edit screen you can choose a post format supported in the theme:
This is basic standard blog post layout.
Displays audio player to play your audio files. Could be used for Podcasting.
To set the audio, use an [audio] (or [playlist]) shortcode in the content. The first [audio] ([playlist]) shortcode will be used in post media area in posts list display, including the post featured image.
If no [audio] or [playlist] shortcode used, but oembed media URL found, this media will be displayed instead of the featured image in posts lists display.
Just add a [gallery] shortcode anywhere in the content. The first [gallery] shortcode images (3 of them) are used as a preview in posts list display.
On single post page it acts like standard post, in posts list it displays an image, post title and "Excerpt" field content which can be used as a brief image info.
Enhances any links in the post content. No post title is displayed.
Displays the post content as blockquote (any blockquotes in the content will be removed and replaced with single wrapping blockquote).
Use <cite> to set the quote source, or set the quote_source custom field, or the post title will be used as quote source. No post title and featured image is displayed.
A short status update, similar to a Twitter status update. The whole post content is displayed without excerpt and post title. If no featured image set, the post author avatar is used.
Displays a video player to play your video files. Could be used for video blogging.
To set a video, use a [video] (or [playlist]) shortcode in the content. The first [video] ([playlist]) shortcode will be used in post media area in posts list display.
If no [video] or [playlist] shortcode used, but oembed media URL found, this media will be displayed instead of the featured image in posts list display.
This custom post type is provided via Jetpack plugin.
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.
This is an extension for the standard posts and 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.
Navigational menus for your website can be created at Appearance → Menus. They may contain links to pages, categories, custom links or other content. You can specify a custom menu item label, as well as other attributes.
Display menus on your website by assigning them to a predefined theme menu location. The theme defines these menu locations for you:
The main navigation area in the header of the website, can be nested and hierarchically organized.
Social icons linked to your social network profiles can be displayed anywhere on the website. But beforehand you must create and set up a social links menu:
Go to Appearance → Menus in the WordPress admin.
Click create a new menu link.
Give the menu a name, such as "Social Menu".
Click Create Menu button.
Click the Custom Links header on the left side of the page.
Type a link (such as https://www.facebook.com/webmandesigneu/) in the URL field.
Give the link a label by typing in the Link Text field. (This label text will be accessibly hidden.)
Click Add to Menu.
Repeat the above steps for additional social links.
In the Menu Settings section at the bottom, check the "Social Links" box for Theme locations.
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. Once you assign a social links menu this way, feel free to use a Navigation Menu widget to display it in sidebars of your website.
The theme displays icons as SVG images. For full list of supported icons please refer to assets/images/svg folder of your theme.
For links starting with mailto: an envelope icon is applied. For unrecognized links a link chain icon is used.
WordPress 5.8 introduced a new block-based interface to widgets and sidebars management screen. As this may be confusing and possibly even cause incompatibility issues in some cases, you can consider reverting back the interface with Classic Widgets plugin.
Predefined Widget Areas
The content of widget areas (sidebars) can be customized in Appearance → Widgets or Appearance → Customize → Widgets. The theme predefines these widget areas:
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.
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.
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.
Custom sidebars & website layout control
You can create a custom widget areas (sidebars) and use them anywhere on the website with a help of Content Aware Sidebars plugin.
That way you can control even displaying of the sidebar, effectively altering the page layout - limitless options, great flexibility!
Customizer can be accessed at Appearance → Customize. All the changes you make in Customizer will be immediately displayed in the preview, but they will be made live only after you press the Publish button.
At Appearance → Customize → Theme Options panel you'll find theme-specific options. Check them out to get familiar with theme customization capabilities.
Create a copy of the original auberge/languages/auberge.pot file.
Rename the copied file now: add hyphen followed with your language code locale, and change the file extension to "po". (So, the British English file would be named auberge-en_GB.po.)
Use Poedit to translate the file and export (save) translation in "mo" file format.
Upload translated auberge-en_GB.mo file into your WordPress languages directory, into themes folder (such as /wp-content/languages/themes/auberge-en_GB.mo (if the themes folder does not exist in your WordPress languages directory, create it).
Warning:Don't lose your files!
When you update the theme, all custom translation files will be deleted from /wp-content/themes/auberge/languages folder. Do not put your custom translation files into that folder! Basically, you should never modify the actual theme files and folders.
If you are lucky, your plugin contains your language translations already and you don't have to do anything. But if you need to translate a plugin, the best advice is to check the plugin's documentation for the best approach.
Alternatively you can also use Loco Translate plugin (again) to translate your plugins directly in your WordPress admin area.
Share Your Translation
If you would like to help out translating the theme, please contribute your translations at WebMan Design support forum by submitting a ZIP package of your .po and .mo translation files in a new support ticket attachment. Thank you!
Why do you need to use plugins when you expected the theme to have all the functionality in it? Well, according to WordPress guidelines and generally the best practice: themes are meant for presentational purpose only, while plugins provide website functionality.
The reason for this is that when you decide to update your website looks you simply change a theme without loosing your website content and additional functionality such as eCommerce or portfolio.
This theme follows this WordPress philosophy and you can rest assured your site is as future-proof as possible. No lock-in effect with WebMan Design themes!
The theme does not need any plugin to work properly. It is coded responsibly and flexibly enough so it should be compatible with any decently coded 3rd party plugin.
However, please understand there are thousands of plugins available for WordPress and it is not humanly possible to test them all. Feel free to use your plugin and in case of an issue contact support for help.
Theme provides code and/or design integration for certain plugins. You will find these plugins in recommendations list below. They provide additional functionality for your website or improve your and your visitor's experience.
Please note that these are only recommended, suggested plugins, they are not required for the theme to work. Always read the plugin description before installing a plugin and install only those plugins you will use on your website.
Appearance → Install Plugins
Warning:Demo content required plugins
List of plugins the theme recommends may differ from plugins that are required when installing demo content. Check the demo content information for more details.
Here is a list of plugins that were successfully tested with the theme and the theme even provides additional integration layer for them:
Restores the previous WordPress widgets settings screens. Sidebars and widgets are not going to be used in fully block themes in the future, so if your website still uses sidebars, it is better to use this plugin to enable classic user interface.
Jetpack plugin contains a lot of useful tools and functionality for your website. Among others, there are portfolio and testimonials management, extra editor blocks, social network sharing functionality, content delivery network to speed up your website, site verification functionality, and others.
Jetpack provides the Food Menu custom post type and functionality for the theme. Theme further modifies and improves this functionality. You will be prompted to install the plugin after the theme activation.
The theme requires certain minimal image dimensions for optimal display. Info about recommended image size setup can be found at Settings → Media.
Once you set correct image sizes, all your newly uploaded images will get processed with new settings. But for the images already uploaded to your website you need to use additional plugin to refresh their sizes. Regenerate Thumbnails plugin (or similar) will do the trick.
Having a performant website is a must. It makes your website more SEO friendly and most importantly pleasing for your visitors, more accessible. This theme was coded with performance in mind but we can always take things even further:
Use a good host
A good hosting for your website is very important choice you can make towards a speedy website. Depending on your location it is also advised to use a host that has servers in your country or at least on the same continent.
You should always keep the file size of your website media as low as possible. Prepare images before you upload them to your website: compress them, reduce their dimensions, maybe even crop them. Use plugins to optimize further more.
In case of video and audio files set the optimal compression and formats before uploading them to your site. Consider also using services such as Vimeo, YouTube or SoundCloud to host your files off your servers.
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.
Here is some tip for setting up your breadcrumbs display:
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 <span class="breadcrumbs-title">You are here: </span>.
Using "child theme" plugin is mostly beneficial when you use a block theme (full site editing theme) for some time already and then you decide you need to modify something with code.
If you plan to provide means for future code modifications right from the start use a child theme, even with a block parent theme.
More technical details
Full site editing block theme compatibility with WordPress child themes concept is limited. This is due to Site Editor user-modifications being stored in WordPress database. It causes issues when you decide to use a child theme afterwards, because all of these database records are bound to a specific (parent) theme name.
The plugin works the same way as classic child theme would - you can use it anytime, even after you've already made custom changes in Site Editor, and it involves less code in comparison to a child theme.
A downside of the plugin may be overriding parent theme templates with code:
With WebMan Design themes this should not be an issue as they are very flexible and contain useful action and filter hooks you can use instead.
The theme provides multiple useful action and filter hooks, which can alter its functionality. Check the theme's source code for hook references: simply search for do_action and/or apply_filters. Or contact support for help.
Auberge theme uses Theme Hook Alliance (THA) hooks too. This is useful to rebuild theme structure or add your custom sections anywhere.