Custom Menu

Welcome

Thank you for purchasing Custom Menu extension!

This document contains information for Custom Menu extension. If you have any questions that are not found in this readme document, please look for contact information in the support section.

Extension info

Features

Overview

Allow store owner to add own custom links in the top menu.

What's New in v1.7

1. Added shortcut links for Manufacturers (Brands).
2. Added support for latest OpenCart v2.0.
3. Added language as criteria.

Highlights

1. Any type of link can be added including internal and external links.
2. Custom links appear side by side with existing category links.
3. Custom links can be sorted with existing category links.
4. Custom link can be a child of another custom link or an existing category link.
5. Custom link can be limited to certain customer groups.
6. Custom link can be limited to certain languages.
7. Multi languages supported.
8. Multistore supported.
9. SEO URL supported.

Installation

Prerequisite

1. OpenCart version must be a compatible version. Please refer to the 'OpenCart version compatibility' list stated above in the Extension Info.
2. Skip to Install only if vQmod is installed and working on your store.
3. Requires vQmod 2.4.1 minimum. (vQmod 2.5.1 required for OpenCart v2.0.2.0) Get it from here: https://github.com/vqmod/vqmod/releases
4. Follow instruction in https://github.com/vqmod/vqmod/wiki/Installing-vQmod-on-OpenCart

Install

1. Copy all contents in 'upload' folder into your store. No files will be overridden.
   
2. Login to your admin page, go to Extensions > Modules, and click on the Install button for Custom Menu module.
   

Setup

1. Click on the Edit button for Custom Menu.
   
2. Click on the Add New button to start creating custom links.
   
3. Please see Usage > Creating a Link for further info.

Upgrade

Please follow the steps below if you are upgrading from a previous Custom Menu version.

1. Make sure vQmod is at least v2.4.1. (vQmod 2.5.1 required for OpenCart v2.0.2.x)
2. Copy all contents in 'upload' folder into your store. Only extension files of previous version will be replaced.
3. Login to your admin page, go to Extensions > Modules, and click on the Edit button for Custom Menu module. At this point, the upgrade will be done automatically in the background.
4. There's no need to uninstall and reinstall the extension. All previously saved link data will be retained.

Usage

Creating a Link

Click Insert button to create a new custom link.

Name

Name of link. This field is required.

Link

Insert custom link here. It is recommended to include https:// in a link. Examples: https://www.amazon.com, https://gmail.google.com

To create a false or empty link, just insert a hash '#' symbol.

Alternatively, you can use the shortcut link to insert internal link to your store. Just select from the drop down list of Routes, Informations, Categories, Products(select a category first), & Manufacturers and the link will be automatically inserted into the link text field above it.

SEO URL

Links will be automatically displayed as SEO URL if it's available and enabled in your store settings.

Category Links

Category links can still be managed under Catalog > Categories in your admin. You can remove all original category links by navigating to Catalog > Categories > [ Edit ] any unwanted category > under Data tab > uncheck Top checkbox > Save.

Parent Link

Select a parent link if you want to make this link appears as a child link.

Example result:

Parent Category

Select a parent category link if you want to make this link appears as a child link under existing top category link. Can be set together with Parent Link.

Example result:

Columns

Number of columns for child links. Works just like the Column setting in category setting. Only relevant for top links without any parent link.

Example result:

Open link in new window

Set link to open in a new window.

Show in Top Navigation

Set link to appear on the top navigation main menu.

Show in Category Module

Set link to appear on the Category module.

Login Required

Set link to appear only when customers are logged in.

Customer Group

Set link to appear only to selected customer groups.

Store

Set link to appear only to selected stores.

Sort Order

Enter a numerical value to sort link by order. This value is affected by the sort order in categories. This means that you can sort a link in any order in the top menu even between existing categories.

Alternatively, links can be easily sorted on the previous link list page.

Status

Enable or disable the current link.

Save

Please click the Save or Save & Exit button after you are done with the settings.

Managing Links

After saving your links, you can manage them with the buttons on the top right corner of the Custom Menu list.

Viewing

Click on the table headers to sort the links by Name and Sort Order in the table.

Copy

To make a copy of your links, simply select them by checking the checkbox and click the Copy button.

Delete

To delete your links, simply select them by checking the checkbox and click the Delete button.

Sorting

To set the sort order of your links, simply enter numerical values into the text field under the Sort Order column.

When you are done, click the Save button to save all sort order values.

Customization

Custom Language

Custom Menu readily supports multi languages. Once you have setup custom languages for your store, Custom Menu will automatically accepts custom language for link name, and displays the appropriate language on your store front depending on chosen language.

Custom Template (Only for Custom Menu v1.4 and below)

The following steps provide a basic guide in customizing Custom Menu for your custom template on your store(Only for v1.4 and below. In v1.5 there is no longer required to customize any template)

Please note that:

• It is to be performed after installation.
• All files listed below are from your store server.
• Assuming custom template folder is 'custom_theme'.
• Might not work on some custom template.

1. Copy the folder 'myoc' in /catalog/view/theme/default/template/ and paste it into /catalog/view/theme/custom_theme/template/
2. Open and edit the file you just copied to: /catalog/view/theme/custom_theme/template/myoc/cmenu.tpl
3. Modify the html to suit your custom template.
4. If your custom theme supports 3rd level navigation, remove or comment out the css on line 4 in cmenu.tpl:

   display: none; /* hide 3rd level navigation for OpenCart default theme */

5. If your custom theme supports active navigation, Custom Menu uses 'current' as class name for active links. Rename it if required on line 10, 18, and 26 in cmenu.tpl.
6. If custom links is not showing on top menu, open and edit /vqmod/xml/myoc_cmenu.xml
7. Search for line 15:

   <search position="replace"><![CDATA[<?php if ($categories) { ?>]]></search>

8. Make sure in your custom template /catalog/view/theme/custom_theme/template/common/header.tpl file that the text in between the <search> tag exists.

   <?php if ($categories) { ?>

9. If not, you need to modify the text into something that exists in your custom template file.

Display Product Count (only for OpenCart v1.5.3.1 and lower)

If you are using OpenCart v1.5.3.1 and older, product count on category links will not be available.

To display product count on category links, please perform the following steps.

1. Open and edit /vqmod/xml/myoc_cmenu.xml
2. Search for line 101:

   'name'    => $cmenu_gchild['name'] . ($this->config->get('config_product_count') ? ' (' . $product_total . ')' : ''),

3. Modify it to:

   'name'    => $cmenu_gchild['name'] . ' (' . $product_total . ')',

4. Search for line 133:

   'name'     => $cmenu_child['name'] . ($this->config->get('config_product_count') ? ' (' . $product_total . ')' : ''),

5. Modify it to:

   'name'     => $cmenu_child['name'] . ' (' . $product_total . ')',

6. Save the modified file.

For OpenCart 1.5.4 and above, simply enable or disable Category Product Count under store Settings > Option tab.

Troubleshoot

Q: Installation failed.

A: Make sure your current store database user account have permission to 'CREATE', 'DELETE', 'ALTER', and 'SHOW' tables in your MySQL database.

Q: Extension is not working after installation.

A: Make sure vQmod is installed. If you are using a custom template, you might require to customize the extension. Please see Customization > Custom Template.

Q: Custom links are not showing on top menu.

A: Make sure you have set the extension settings properly in your admin. Please see Usage > Creating a Link.

Q: I want to remove all the original category links.

A: Login to admin > Catalog > Categories > [ Edit ] the unwanted category > under Data tab > uncheck 'Top' checkbox > Save.

Q: Product count is not showing on category links.

A: Please see Display Product Count under Customization section on this page.

Uninstall

Please follow the steps below to uninstall Custom Menu from your store.

1. Login to your store admin and navigate to Extensions > Modules.
2. Click on [ Uninstall ] for Custom Menu module. WARNING: All custom links data will be erased.
3. Remove the following files from your store.
   1. /admin/controller/module/myoccmenu.php
   2. /admin/language/english/module/myoccmenu.php
   3. /admin/model/myoc/cmenu.php
   4. /admin/view/template/myoc/cmenu_form.tpl
   5. /admin/view/template/myoc/cmenu_list.tpl
   6. /catalog/controller/myoc/cmenu.php (Custom Menu v1.4 and below)
   7. /catalog/model/myoc/cmenu.php
   8. /catalog/view/theme/default/template/myoc/cmenu.tpl (Custom Menu v1.4 and below)
   9. /vqmod/xml/myoc_cmenu.xml

Changelog

Version v1.7.7

Version v1.7.6

Version v1.7.5

Version v1.7.3

Version v1.7.2

Version v1.7.1

Version v1.7

Version v1.6

Version v1.5

Version 1.4

Version 1.3.1

Version 1.3

Version 1.2

Version 1.1

Version 1.0

Support

Questions

If you have any questions regarding this extension, please email to [email protected]

Professional Service

We provide a variety of professional services for your OpenCart store.

• Extension Customization
• Extension Integration
• Custom Template Integration

Please email your request to [email protected] and see how we can help you.

Comments and Feedbacks

You can always post your comments, feedback, or suggestion on the extension page here: www.opencart.com/index.php?route=extension/extension/info&extension_id=6074