Spark Documentation
Sammary
- Created: Tue, 13 Oct 2015
- latest Update: Fri, 30 Nov 2018
- By: Khaoula
Deliverables
Deliverable are:
spark-theme-6.2.0.1-ce.war: The theme installation package.
spark-theme-src-6.2-ce.zip: The theme source code.
You can download the packages from our software catalog.
User documentation
This section will allow you to start using the theme directly in your new website or an existing (For an existing one, please read carefully section Use the Webcontent templates)
Installation
To install the theme in your Liferay instance, you can either:
- Copy the theme war to <liferay installation>/deploy folder which will trigger the theme hot deployment.
- Or you can use you liferay portal, just follow those steps:
Go Admin -> Control panel -> App Manager -> Install -> Select the spark theme war and by clicking install, it will be uploaded to the server and installed
After seeing the success deploying message, you can find the theme site template under sites.
Apply the theme
After installing the theme, you are probably wondering how can use and apply it to your actual site.
Here are the steps:
- Go Admin -> Control Panel -> sites and choose the desired site
- In the available theme section select Spark
Using the Site Template
The Site Template has the same pages as the themes Demo Site in Themeray. You can use it as a template for your new Site.
So to do that:
- Go Admin -> Control Panel -> Site -> Add ->Spark Theme
- Set The Site name and click Save -> Save
And that's you cant see your site with all the theme pages
To See it click Page -> Site page -> View pages (Private/public)
Change the Theme Settings
- Color Schemes
- Display or not, the widgets in the footer
- 3 different settings for the footer widget section (left, right and middle)
- Display or not, the footer
- 2 setting for the footer container (left and right)
- Display or not, the language section
To modify any of those settings all what you have to do is to go back to the site -> look and feel and you save any modification you make
- Color Schemes: there are three diffrent colors you can choose the one you like and save it.
- Footer widgets:
- widgets-footer-section-1-article-id, widgets-footer-section-2-article-id and widgets-footer-section-3-article-id fields should contain the ID of the created webcontent (like the default webcontent for section 1 "FOOTER_CONTACT" )
- To modify the default web contents of the theme, you can go Admin -> Content select the desired webContent and make the change you need.
- Footer:
- Language section: If you need multi-language for your site, you can set this setting to true
Use the Webcontent templates
- Go to control panel -> Site Templates select the Spark Theme ->Content -> Web Content then export all the web content.
After finishing the webcontent exportation, go back to your site -> Content -> Web Content -> then click the setting button -> click export/import
Slect the exported webcontent you just downloaded from spark theme -> continue -> continue -> import.
And that's it, you can now use the spark webcontent. In the page you need to display the webcontent:
Add a web content display:
Under the web content display click select web conten
Then choose the any web content you need.
After saving your choice, you can also edit it by clicking the icon edit.
Technical documentation
