Documentation

Installing the module

1. Sign-in to the Miva Merchant admin.
2. Click on the "Modules [Add]" link in the left navigation frame.
3. The Add Module screen will be displayed with a "Module" field and just to the left of the field is the upload button.
4. Click the upload button (small icon resembling a hard drive with a yellow arrow on top.
5. The "Upload File" window will be displayed.
6. Click on the "Browse" button, locate and the module's .mvc file.
7. Click on the "Upload" button.
8. The file will be uploaded, and the file name and path displayed in the "Module" field of the main admin frame.
9. Click on the "Add" button;
10. The module will be installed, and the information screen displayed.

See MIVA Merchant 5 - Online Help - Add or Edit Modules for more info.

Assigning the module to a store

1. The module is assigned to a store using the Store Utility Configuration.
2. Click on the store-level "Utilities" link.
3. The Store Utility Configuration screen will be displayed.
4. Select the "Assigned" checkbox to the left of the module.
5. Click on the "Update" button.

See MIVA Merchant 5 - Online Help - Store Utility Configuration for more info.

Licensing the module and completing the installation

1. On the Store Utility Configuration screen, click on the module's tab, labeled "latu.net Store Helper".
2. The module's licensing screen will be displayed.
3. Enter the License Key.
4. Read the End User License Agreement.
5. Accept the license agreement.
6. Click on the "Update" button.
7. The module's configuration screen will be displayed

Editing the User Interface

• When the module is installed, a User Interface Item Extension is created for the head Item.
• You will need to manually add the module's entity tokens to the:
  • HEAD Tag Content template
    and/or
  • CTGY Page template
  • PROD Page template

Editing the HEAD Tag Content – for placement of the Metatags

1. Click on the link for the store(displayed as the name of the store) in the left navigation frame.
2. The Edit Store screen will be displayed.
3. Click on the "HEAD Tag Content" tab.
4. The "HEAD Tag Content" template will be displayed.
5. Insert the following code:
   
   <mvt:if expr="ISNULL l.settings:head:meta:description"> <meta name="description" content="[default]"> <mvt:else> <meta name="description" content="&mvt:head:meta:description;"> </mvt:if> <mvt:if expr="ISNULL l.settings:head:meta:keywords"> <meta name="keywords" content="[default]"> <mvt:else> <meta name="keywords" content="&mvt:head:meta:keywords;"> </mvt:if> <mvt:if expr="ISNULL l.settings:head:meta:robots"> <meta name="robots" content="[default]"> <mvt:else> <meta name="robots" content="&mvt:head:meta:robots;"> </mvt:if> <mvt:if expr="ISNULL l.settings:head:meta:revisit"> <meta name="revisit-after" content="[default]"> <mvt:else> <meta name="revisit-after" content="&mvt:head:meta:revisit;"> </mvt:if>
   
   (Where [default] is the metatag content that will be displayed
   if there is no metatag for a specific product or category.)
   
   Or insert the following alternate code:
   
   <mvt:if expr="NOT ISNULL l.settings:head:meta:description"> <meta name="description" content="&mvt:head:meta:description;"> </mvt:if> <mvt:if expr="NOT ISNULL l.settings:head:meta:keywords"> <meta name="keywords" content="&mvt:head:meta:keywords;"> </mvt:if> <mvt:if expr="NOT ISNULL l.settings:head:meta:robots"> <meta name="robots" content="&mvt:head:meta:robots;"> </mvt:if> <mvt:if expr="NOT ISNULL l.settings:head:meta:revisit-after"> <meta name="revisit-after" content="&mvt:head:meta:revisit-after;"> </mvt:if>
   
6. Click on the "Update" button.

Editing the Category Page Template – for placement of the HTML Title

1. Click on the "Pages" link in the left navigation frame.
2. Find the CTGY page and click on the page's "EDIT" button.
3. Replace the <title> tag with the following code:
   
   <title> <mvt:if expr="ISNULL l.settings:head:meta:title"> &mvt:store:name;: &mvt:category:name; <mvt:else> &mvt:head:meta:title; </mvt:if> </title>
   
4. Click on the "Update" button.

Editing the Product Page Template – for placement of the HTML Title

1. Click on the "Pages" link in the left navigation frame.
2. Find the PROD page and click on the page's "EDIT" button.
3. Replace the <title> tag with the following code:
   
   <title> <mvt:if expr="ISNULL l.settings:head:meta:title"> &mvt:store:name;: &mvt:product:name; <mvt:else> &mvt:head:meta:title; </mvt:if> </title>
   
4. Click on the "Update" button.

See MIVA Merchant 5 - Online Help - User Interface: Pages & Items for more info.

Configuring the module

• The module can be configured from the Store Utility Configuration screen or the Edit Store screen.

1. Click on the module's tab, labeled "latu.net Store Helper"
2. The module's configuration options are displayed:
   1. Active - Convenient method for activating or de-activating module. All other configuration options are preserved.
   2. Use Product Description as META Description - If selected, product description will be used as the metatag description. HTML tags will be stripped and text properly formatted.
   3. Truncate Product META Description - Product description will be truncated, when used as the metatag description, to the number of characters entered. Leave blank if no truncation is desired.
   4. Use Product Description as META Keywords - If selected, keywords will be extracted from the product description and used as the metatag keywords.
   5. # of Product META Keywords - The number entered will the the maximum number of metatag keywords used from the product description.
   6. Use Category Header as META Description - If selected, category header will be used as the metatag description. HTML tags will be stripped and text properly formatted.
   7. Truncate Category META Description - Category header will be truncated, when used as the metatag description, to the number of characters entered. Leave blank if no truncation is desired.
   8. Use Category Header as META Keywords - If selected, keywords will be extracted from the category header and used as the metatag keywords.
   9. # of Category META Keywords - The number entered will the the maximum number of metatag keywords used from the category header.

Editing the Category and Product Metatags

• The metatags are edited using the Products or Categories Admin

1. Click on the "Products" or the "Categories" link in the left navigation frame
2. The Products or Categories listing will be displayed.
3. Click on the "EDIT" button for a Product or Category.
4. The Edit Product or Edit Category screen will be displayed
5. Then click on the "Metatags" tab.
6. The Metatags fields will be displayed.
   There are five fields:
   1. HTML title
   2. META description
   3. override
   4. auto-generated preview
      (from product description or
      category header; to edit,
      copy & paste into the
      "META keywords" field;)
   5. META keywords
   6. override
   7. auto-generated preview
      (from product description or
      category header; to edit,
      copy & paste into the
      "META keywords" field;)
   8. META robots
   9. META revisit-after

• A META description & META keywords are auto-generated by the module for each product and category.
• The auto-generated versions can be used or custom versions can be entered.
• To use a custom version of the META description or META keywords, enter the content and select the corresponding "override" checkbox.

Uninstalling the module

1. The module must first be unassigned on the Store Utility Configuration
2. The module's item extension must then be removed.
3. The final step is to delete the module.

See MIVA Merchant 5 - Online Help - Delete Module for more info.