Kosmic - Magento 2 Theme

Navigation
Getting Started
Introduction
Prerequisite
Complete Installation
Complete Installation
Theme Installation
Theme Installation
Theme Configuration
Theme Configuration
Pre-Installed Extension
Pre-Installed Extension
Other
Conclusion
Frequently Asked Questions
Upcoming Features
Support & Customization

Kosmic - Magento 2 Theme | Documentation

Kosmic - Getting Started

Created On: 5th January 2016
Last Updated On: 2nd June, 2022
By: Solwin Team
Email: info@solwininfotech.com

Introduction

Thank you for downloading Magento theme. This documentation consists of several parts and covers the entire process of installing and setting up Magento 2 theme starting from scratch.

Kosmic Theme files structure

The theme package you have downloaded consists of several folders. Let's see what each folder contains:

documentation

contains documentation files.
- documentation.html
  
  a main documentation file you are reading at the moment.
sources

contains the theme source files.
- screenshots.zip
  
  contains the theme screenshots for reference
- demo-pages.zip
  
  contains all the demo pages .txt files
- demo-blocks.zip
  
  contains all the demo static blocks .txt files
theme-files

contains kosmic theme files data
- kosmic-theme.zip
  
  contains kosmic theme files
- kosmic-theme-magento-2.1.x-patch.zip
  
  contains Kosmic theme patch files for magento 2.1.x.
- kosmic-theme-magento-2.2.x-patch.zip
  
  contains Kosmic theme patch files for magento 2.2.x.
- kosmic-theme-magento-2.3.x-patch.zip
  
  contains Kosmic theme patch files for magento 2.3.x.
- kosmic-theme-magento-2.3.6-patch.zip
  
  contains Kosmic theme patch files for magento 2.3.6.
kosmic-demo.url

redirect to kosmic theme demo.

Prerequisite

Before you install Magento, you must check all of the following:

Apache

You must run Apache version 2.2 or 2.4.
In addition, the apache mod_rewrite module must be enabled. mod_rewrite enables the server to perform URL rewriting.

PHP

For Magento 2.1 version

PHP 5.6.X, 5.5.22, 7.0.2, 7.0.4 and 7.0.6

For Magento 2.1 version

PHP 5.6.5, 7.0.2, 7.0.4 and 7.0.6

For Magento 2.2 version

PHP 7.0.13 and 7.1.0

For Magento 2.3 version

PHP 7.1.3 and 7.2.0

Visit this magento official document page for further details of installation
https://devdocs.magento.com/guides/v2.2/install-gde/system-requirements-tech.html

Required PHP extensions:

PDO/MySQL
mbstring
mcrypt
mhash
SimpleXML
curl
xsl
gd, ImageMagick 6.3.7 (or later) or both
soap
intl
bc-math (Enterprice Edition Only)
openssl

MySQL

You must run MySQL version 5.6 or later

File Permission

The web server user must have write access to the following files and directories:

var
app/etc
pub

We recommend setting the permissions as follows:

All directories have 770 permissions.
770 permissions give full control (that is, read/write/execute) to the owner and to the group and no permissions to anyone else.
All files have 660 permissions.
660 permissions mean the owner and the group can read and write but other users have no permissions.

Complete installation

The complete installation method can be used if you want to set up a Magento store using a sample content. We assume that you have completed all the preparation steps.

The installation process consists of 3 stages:

1. Creating a database.

2. Uploading all the required files to the server.

3. Installing a Magento Commerce engine together with the template you have purchased.

Let's get started!

Creating a database

First, you need to prepare a new database for your Magento store. You can create the new database using the database management tool from your hosting control panel (usually PhpMyAdmin).

The following data will be received while creating a database: database name, database username, password and you server name. You need to save this data as you will need it for further Magento installation.

With the phpMyAdmin tool you will be able to create a new database in 3 simple steps(check the slides below):

1. Open the "Database" tab, you will see the list of databases.

create database - image1

2. Input your database name. Click "Create" button.

create database - image2

3. Your database has appeared in the list. In order to enter the database, click on its name in the list.

create database - image3

If you have any issues with creating a database, please contact your hosting provider for help and assistance.

Magento Installation

When you are done with uploading files, you can start Magento engine installation process. Open your browser and in the address bar type your 'domain name/path to your Magento directory'. You should see the welcome screen. Please follow the instructions below to install Magento.

Step 1: Installation Assistant

Please read the license agreement and click the "Agree and Setup Magento" checkbox if you agree with the terms.

how to install - image1

Server Readiness Check

Click the "Start Readiness Check" button to check your server settings compatibility with the Magento 2 engine requirements.

how to install - image2

Step 2: Database connection

Here you need to input the database details and some initial settings. Add a Database – input your host name, database name, database user and password. Contact your hosting provider, if you don't have the necessary details.

Make sure you have a database created for the Magento installation. And also make sure it is clear, without any tables.

how to install - image4

Step 3: Web Configuration

Here you can change Magento admin panel URL and the main store address. Other settings you can leave unchanged.

Make a point of the admin panel path. Note it or insert your specific admin panel URL to remember the admin panel access.

how to install - image5

When the checking procedure is complete, click 'Next'. button.

Step 4: Localization

Select the required time zone, default currency and store language. In the Advanced Modules Configurations section you can also select default modules that should/shouldn't be installed. We recommend that you do not perform changes in this section.

how to install - image6

When the checking procedure is complete, click 'Next'. button.

Step 5: Create Admin Account

Here you need to input personal details for the store owner and administrator.

how to install - image7

Step 6: Install

The store configuration is done. Press the Install Now button to start the store installation process.

how to install - image8

Step 7: Success

This is the final installation step. Copy the generated encryption key and keep it safe.

how to install - image9

Kosmic theme installation

This theme is not compatible with Magento 1.x engine. It will work with the Magento 2.x engine only.

First of all, please make sure your Magento installation version meets the template requirements. If you are using an outdated Magento engine version, you need to upgrade it. Don't forget to make a backup of your store files and database. The detailed Magento update guide you will find on the site Magento Wiki.

If your Magento engine meets the template requirements, you can start the template installation.

1. Open the theme package(kosmic-multipurpose-responsive-magento-theme.zip) and go to the Theme Files folder.

2. Extract "kosmic-theme.zip" file and Upload the app & pub folder to the root Magento installation directory on your server. This folder includes the template files, that will not effect your existing files. If you are using Magento 2.1.x, Magento 2.2.x and Magento 2.3.x version then add the patch files.

3. Once done with uploading "app" folder, you need to execute below command at magento root directory using command line

4. Run deploy command as specified:
- php bin/magento setup:upgrade
- For Magento 2.0.x and 2.1.x: php bin/magento setup:static-content:deploy
- For Magnento 2.2.x and Magento 2.3.x: php bin/magento setup:static-content:deploy -f

5. Clear the cache either from the admin panel or command line php bin/magento cache:clean

For more details click here

Template configuration

We are going to review template configuration options based on the example. We will configure it the same way as our Live Demo template, without affecting products data.

Activate the new theme

1. (For 2.0.x) Open Magento admin panel and navigate to Stores > Configuration menu.

Theme set - image1

(For 2.1.x) Open Magento admin panel and navigate to Content > Design > Configuration menu.

Theme set - image1-1

2. (For 2.0.x) In the General menu select Design tab. Click Design Theme tab and in the Design Theme drop-down list select the required theme, then click Save Config button.

Theme set - image2

(For 2.1.x) Go to Edit.

Theme set - image2

(For 2.1.x) Select the template from dropdown. And click on 'Save Configuration'

Theme set - image2

Reindex data

1. In the fist column open the drop-down list and choose the "Select All" option.

Theme set - image3

2. In the fist column open the drop-down list and choose the "Select All" option.

Theme set - image4

3. In the top "Actions" selector choose "Update on save" option. It will allow automatically reindex the specified data after saving any settings in the admin panel.

Theme set - image5

Click "Submit" button.

Please be patient, this may take a while.

Reindex data using command line

In order to reindex data using command line, please execute below command at magento root directory

bin/magento indexer:reindex

For more details click here

Disable cache

In order to make the changes appear on your website with no delay, you need to disable cache. It prevents additional cache clearing actions after every change you make. You can enable it when you are done with store editing.

1. Open Magento admin panel and navigate to System > Cache Management menu.

Theme set - image6

2. In the fist column open the drop-down list and choose the "Select All" option.

Theme set - image7

3. In the top "Refresh" field select "Disable" option.

Theme set - image8

4. Click "Submit" button.

Logo configuration

For 2.0.x

Please follow these steps when setting up logo image included into the theme package (you can view it on the Live Demo page).

1. Open the Magento admin panel and select Stores > Configuration in the side menu.

Theme set - image9

2. Select the "General" tab.

Theme set - image10

3. In the "General" section, select the Design tab. Choose Header and upload your logo.

4. Click "Save Config" button.

For 2.1.x

Open Magento admin panel and navigate to Content > Design > Configuration menu.

Theme set - image9-1

2. Expand the "header" tab.

Theme set - image10-1

3. In the "Header" section, click on 'Upload' button to upload your logo.

4. Click "Save Configuration" button.

Import cms blocks & pages

Import Static Blocks button import all the static blocks that comes with kosmic theme. If you want to overwrite existing blocks than select Overwrite Existing Blocks to Yes and Save Config. Then after Click on Import Static Blocks button. Do same for import cms pages.

import blocks and pages

Pages configuration

In order to make your template look exactly like our Live Demo, you need to set up store pages in a specific way. We provide all the files with the pages source code (kosmic-multipurpose-responsive-magento-theme.zip/sources/demo-pages). You need to add them into Magento admin panel as per the below instructions:

1. From the top menu select Content > Pages. Here you can find all the store pages. Home page, About Us and Customer Service should already be available, so you don't need to add them. You only need to update the pages HTML and XML content. Open any of them in order to get the access to the content.

page settings - image2

2. Open the page and select the Content tab. It contains the HTML code of the page. We have source code for look home page exactly like our Live Demo.

For this, please go to kosmic-multipurpose-responsive-magento-theme.zip/sources/demo-pages in given theme zip file. There are 2 files : home and home2. Open any file, copy the code from that file and paste it to the content area.

page settings - image3

3. To add Widget click on Insert Widget.. button. It will open popup , from there select widget that you want to display on home page with widget options and click on Insert Widget button

4. When you are done with the HTML code, switch to "Design" tab. It contains the page XML code. XML code allows you to add Magento static blocks and widgets to the page. The XML code should be copied the same way as the HTML from the source file. Copy the XML code to the "Layout Update XML" area.

page settings - image4

5. Don't forget to select the valid "Layout" option.

6. In case you need to add a new page, click the "Add New Page" button in the top right corner.

Static blocks configuration

When you are done configuring the pages, you need to configure the static blocks. The procedure is similar: you need to copy the code from the source files (kosmic-multipurpose-responsive-magento-theme.zip/sources/demo-blocks) and paste it to the corresponding fields in the Magento admin panel.

1. In the top menu navigate to Content > Blocks.

2. In the top right corner click the "Add New block" button to add a new static block.

static block - image1

Specify the block name and identifier. You can get the block details from kosmic-multipurpose-responsive-magento-theme.zip/sources/demo-blocks.zip

Open the block source file and copy the HTML code into the content area.

static block - image2

When you are done configuring store pages and blocks, your store is ready to go.

For change home page block image.

If you need to change below slider advertisment block.

static block - home static block edit image

Edit "Home Advertisement 1" and change image as you like.

static block - home static block edit image backend

Theme Settings

Open Magento admin panel and navigate to Theme Cpanel.

theme cpanel

Click on Theme Cpanel > Configuration. Set Predefined theme color or set custom theme color for different stores.

theme setting

Layout Configuration

Set Theme layout: Full-width Layout, Box Layout and Maximum Width: 1170, 1280 (Default)

theme layout

Static Content Configuration

Add static block identifier to display content on home page, register page, contact page and product detail page.

Static Content Configuration

Header Configuration

Click on Header tab. From that you can set Top Header Notification, custom information static block, enable/disable Sharing addon with Pub ID of Addthis (you can get pub id from addthis.com) and set header type from 2 different header layout.

header configuration

Footer Configuration

Click on Footer tab. From that admin can customize newsletter block with background image, block title, block text etc. Admin can also set footer logo and social icons with url.

footer configuration

From Footer Map settings, store owner can enable/disable google map in footer.

footer map configuration

From Footer Links settings, store owner can set Social block, Information block, Theme features block & Contact block

footer links configuration

From Copyright Block Settings, store owner can set Copyright before & after static blocks

footer copyright configuration

Product Page Configuration

On product list page admin can easily enable or disable New & Sale label, Enable/Disable product block effect, Keep product image aspect ratio, Set image width, Alternate image on hover etc from product configuration option.
Also in product view page show sharing addons from that customer's can share product on social media. Show/hide Related, Upsell & Crosssell products from product view page.

product configuration

Sidebar Content Configuration

Add CMS static block identifier to display static block content in sidebar.

sidebar content configuration

Contact Page Configuration

In Contact page, Admin can show google map for their store by using Google map embeded code. Also set their store name, store address, contact info, store email etc from admin on contact page.

contact configuration

Loader Settings

Show loader on home page or all pages with uploaded loader image

Add Custom Css

Add custom css that will apply on all pages on frontside

add custom css

General Information

Kosmic theme provides powerful and most advanced menu, we're going to describe detailed instructions how to use this powerful menu features as our demo site.

Necessary Menu Settings

For general menu settings, please go to Kosmic > Mega Menu Settings and follow instructions there. It describes how to:

1. set default menu type for all menu items

2. set visible menu depth

3. show "home" link & "home" icon

4. show custom links into menu, for example, "Features" menu that you can see from our demo.

5. show category labels such as "New", "Hot" as our demo site

How to add a menu item that has fixed-width mega menu?

1. Add new cateogry and necessary subcategories for dropdown content.

2. Set "Menu Style" field as "Static Width"

3. Set "Static Width" for the fixed mega menu as your needs. For example, 600px.

4. Set "Sub Category Columns" for the your menu popup level. For example, 2.

5. Set Block Width that you prefer to add image or custom block as right image.
For example, set 5 - (it means it will take 5 columns area from 12 columns) for "Block Right Width(%)", right block will be 250px in this case.

6. Add custom block to show in the mega menu. For example, please add follow codes.
<img src='{{media url="wysiwyg/kosmic/category/banner/woman-fashion.png"}}' alt='' style='position: absolute;right: 10px;top: -10px;height: 273px;width: auto;max-width: none;z-index: -1;border-radius: 8px;' />

How to add a menu item that has full-width mega menu?

1. Add new cateogry and necessary subcategories for dropdown content.

2. Set "Menu Style" field as "Full Width"

3. Set "Sub Category Columns" for the your menu popup level. For example, 3.< /li>

4. Fill "Block Top" field to show custom content in the top area as the right sample screenshot. For example,
<div style="margin: 0 20px;padding: 10px 0 15px;border-bottom: 1px solid #eee;width: 63%;color: #000;"> <b style="margin-right: 15px;">SUGGESTIONS:</b><a href="#" style="margin-right: 15px;color:#000">3D</a> <a href="#" style="margin-right: 15px;color:#000">MOBILE</a><a href="#" style="margin-right: 15px;color:#000">CAMERAS</a> <a href="#" style="color:#000">HEADSETS</a> </div>

6. Add custom block to show in the mega menu. For example, please add follow codes.
<div class="menu-right-block" style="position: relative;text-align:center;"> <img src="{{media url="wysiwyg/kosmic/category/banner/electronic.png"}}" alt="" style="margin-top:20px"/> <div style="position: absolute;top: -35px;left: -15px;text-align: left;"> <h2 style="font-size: 23px;font-weight: 600;color: #fff;background-color: #2e2e2e;line-height: 1;padding: 6px 50px 6px 8px;">SHOP NOW <b style="font-weight:700;">3D</b> <strong style="font-weight: 800;">TV's</strong></h2> <a class="btn btn-default" style="padding: 5px 7px 5px 15px;color: #fff; border: 0;font-size:13px;" href="http://kosmic/magento/kosmic/electronics.html">VIEW NOW <em class="icon-right-dir"></em></a> </div> <div style="position: absolute;bottom: 8px;width: 60%;text-align: center;left: 50px;line-height: 14px;font-size: 13px;">This is a custom block. You can add any images or links here.</div> </div>

How to add a menu item that has classic dropdown menu?

1. Add new cateogry and necessary subcategories for dropdown content.

2. Select the menu item that you just created and go to "Menu" tab.

3. Choose "Menu Style" field as "Static Width".

Design Settings

Open Magento admin panel and navigate to Theme Cpanel.

theme cpanel design

Set Header Top, Search box, Navigation Menu, Minicart block colors

header design

Set Footer Top Newsletter block, Social block, Footer Middle(Links) block, Bottom(Copyright) block etc

footer design

Add You custom CSS.

Custom CSS

How to change newsletter popup settings?

Go to Theme Cpanel > Newsletter > Configuration

From that you can change newsletter settings like,

General Settings: Show/hide Newsletter Popup

Content Display Settings: Show/hide/change main title, change main title font color, text size etc, set custom message, show newsletter popup checkbox, show background image etc

Popup Box Settings: Popup box height & width, open & close effect, set delay time for popup appear, set cookie expiration time etc

Social Options: Show social icons with url like facebook, google plus, twitter, youtube, flicker, vimeo, pinterest, instagram, foursquare, tumblr, rss, email etc

How to edit homepage slider?

To edit homepage slider content, please go to Admin Theme Cpanel > Banner Slider > Manage Bannerslider and you can add/edit bannerslider as per your requirement.

You can also change bannerslider configuration from Theme Cpanel > Banner Slider > Configuration

How to add static blocks on homepage?

To show static blocks in homepage, add below code in cms homepage (Content > Pages > Home Page > Design Tab)