Contao Theme Luxe Documentation
First: Install Contao
Follow the official installation guide to install Contao. Follow all instructions provided by the Contao install tool /contao/install.
Then: Install your Theme
1. Step: Install the extensions
To import the template you need to install the following extensions first:
rocksolid-custom-elements, rocksolid-columns, rocksolid-icon-picker and rocksolid-slider
You can find the license key for premium extensions in your personal customer area in the downloads section.
To install the extensions open the Contao Manager at /contao-manager.phar.php and klick on Install Packages. Enter rocksolid-custom-elements in the search field, click Check & Install next to the extension and Apply Changes at the bottom of the viewport. After the package is installed, click on Install Tool to update the database. Please repeat this step for: rocksolid-columns, rocksolid-icon-picker and rocksolid-slider.
If you don't install the needed extensions or don't use the right theme version for your Contao installation, you'll see the following error message "The import failed! Is the database structure up to date and is the template file compatible with your Contao version?"
If you plan to use the Theme Assistant (make customizations without coding) and Frontend Helper (edit content directly), you can choose to install them in this step as well. If you want to install them please repeat the step for rocksolid-theme-assistant and rocksolid-frontend-helper.
2. Step: Download the theme and import it
Immediately after purchasing your theme you can download the theme package in your personal customer area.
Unpack the ZIP file and you'll see multiple folders and files. We'll only need the file luxe.cto for now, you can find it in the contao subfolder.
Log into your back end and goto Layout › Themes click on Theme import in the upper right section. Choose the luxe.cto in the file menu and click on Theme import. If no conflicts are detected click on Continue to complete the theme import.
Almost done: Import the website template (demo data)
Installing the demo data is perfect for new projects, since you'll get everything shown in the demo and can edit the content right away, additionally you'll see how everything is put together. On top of that all the for Contao typical connection between modules and content are already made for you.
If you website is already filled with content, that you can't transfer afterwards, skip this step.
Please note: If you import the Contao website template the current content of your database will be replaced with the demo data.
If you're using Contao 4: To import the website template go back to the Contao installation tool under /contao/install. Open the section Import a template, select the luxe/demo-website.sql and click on the button Import template. Now you can enter the credentials for your admin user and click on Create admin account.
For Contao 5 goto Layout › Themes in the back end and click on Theme import in the upper right section. Choose the luxe.cto in the file menu and click on Theme import. Now under Import an example website select the file luxe/demo-website.sql and the import type Full SQL import. Click Continue to complete the import of the demo data.
Are you having trouble installing?
Blank page, error message, theme isn't showing up? This interactive check list guides you step by step.
- Followed the installation instruction step by step
- Installed the required extensions before importing the template (important!)
- Used the latest/right version of your theme (Download)
- Used the latest/right version of Contao
- Another installation attempt leads to the same problem?
Adding a Google Maps API key
To use Google Maps in your theme you'll need to enter an API key. You can get a free key on https://developers.google.com. After receiving your key you can edit the maps modules and enter it in the field Google Maps API key.
FAQ: Common Questions
The import failed! Is the database structure up to date and is the template file compatible with your Contao version?
Did you make sure that all needed extension are correctly installed, as explained in step one? Did you make sure to use the theme version that matches your Contao installation? Is your Contao installation untouched and you didn't install 3rd party extensions before trying to import the template?
Background: To import the demo data your Contao Installation must match the database structure. After importing the template, you can easily remove the extensions if you want to use different/custom solutions.
Is it possible to use my own extensions instead?
Yes, that's one of the major benefits of RockSolid Themes. You can choose the right tools for your project. Be it the customization or the extensions. We've developed a set of perfectly tailored extensions like the RockSolid Responsive Slider, Custom Content Elements and so on, but you don't have to use them. Everything can be un-installed seamlessly to make room for your own custom extension or another plugin.
Where can I find element X to make changes?
The RockSolid Frontend Helper makes it easy for you to find and edit elements with a single click.
Yeah: You are done! What's next?
Did you have difficulties following this instructions or did you spot a mistake? Please let us know by providing your feedback. Thank you!