Lexicon on product detail page

About the Extension

Purpose of the plugin

The product detail page often requires additional information on product properties or product property values. Especially for specific product properties, explanations for customers can be very helpful.

With the lexicon plugin, you can have information texts automatically and rule-based fade in according to product properties, product property values and / or keywords in the product description.

The lexicon entries can be displayed around the product information as simple descriptions or also as tooltips for certain product properties, product property values or keywords in the product description. Whereby the display of headings, texts and pictograms can be customized and many other setting options can be carried out.

In addition, the entries are assigned to lexicon groups, which make it possible to make further settings across groups.

The lexicon groups can also be displayed in the frontend to structure the lexicon.

Application examples

• You want automatically display information about a specific property of a product in order to provide the customer with a detailed description of the property. However, you do not want to set this separately each time.

• You want automatically display a tooltip directly next to a keyword in the description of a product, which explains the keyword better.

• You want to display an extensive lexicon with several chapters on the product detail pages, which refers to various keywords in the product description and / or product properties and / or product property values. It should be displayed automatically.

• You want to provide the customer with a document or image for download on the product detail page for a certain product property value.

Use of the plugin

After installing and activating the plugin, you can find in the admin area under Extensions > My extensions > Lexicon > ... > Configure the basic settings for the lexicon display (right or left next to the product description, above or below the product description, no display), general tooltip settings (background color, text color, text alignment), as well as the setting with which separator lexicon entries should be imported.

These basic settings can also be made under Settings > Extensions > Lexicon > More settings. In addition, under Settings > Extensions > Lexicon the management of lexicon entries (Lexicon entries list & creation / editing of lexicon entries) and lexicon groups (Lexicon groups list & creation / editing of lexicon groups) are available.

Lexikon entries

Section Settings

• Internal ID: Can be used for API bindings.

• Internal name: Used for display in administration.

• Priority: The higher the priority, the further forward the lexicon entry is ranked.

• Active: If active, the lexicon entry will be displayed.

• Assigned rules: Active if any of the assigned rules match (OR operation). If no rule is assigned, this is considered always active.

• Lexicon groups: Specify under which groups the lexicon entry should be displayed and which lexicon group-crossing settings should be applied here (e.g. layout of lexicon entries only as list, only as pictrogram or both | show text of too long lexicon entries collapsed).

Section Display conditions

• Assigned properties (property groups): If any of the assigned product properties match, the lexicon entry will be displayed on the product detail page.

• Assigned property values: If any of the assigned product property values match, the lexicon entry will be displayed on the product detail page.

   The lexicon entry is displayed on the product detail page when:

    - the product has one of the assigned properties and/or

    - the product has one of the assigned property values and/or

    - the product description contains one of the assigned keywords

Section Assigned keywords

   If the keyword appears in the product description, the lexicon entry is displayed. Several keywords can be entered.

   Matching type "Strict" or also Regular Expressions can be used. For matching type 'Strict' there is only a match if the keyword occurs 1:1 in the product description. Regular expressions are patterns used to match character combinations in strings.

Section Display

• Heading of the lexicon entry: Displayed only if at least one property and/or property value is selected (possible selections: property (property group), property value, property & property value, no display).
  

• Heading display: Selectable format how the heading should be displayed. Field displayed only if heading display is selected in "Heading of the lexicon entry" (e.g. property (property group), property value, property & property value).
  

• Separator: A fine line that can be used to separate lexicon entries. (possible selections: above or below lexicon entry, no display)
  

• Description of the lexicon entry: Information text, which is displayed in the entry.

  Here, the product property, product property value and / or the keywords of the product description should be well described.

• Display lexicon entry as tooltip at product description: The lexicon entry is only displayed as a tooltip if the keywords appear in the description.

  Tooltip placement can be customized (Top, Bottom, Right, Left of the keyword in the description).

• Display lexicon entry as tooltip at product properties: The lexicon entry will only be displayed as a tooltip if the property group or property applies to the product.

      Display via small circled question mark in the same line as the selected property or property value of the product.

      Tooltip placement can be customized (Top, Bottom, Right, Left of the small circled question mark in the same line as the selected property or property value).

• Upload pictogramm: If a pictogram should be displayed at an entry, it can be selected here.

Section Lexicon documents

   If an image or document should be displayed at an entry for download, it can be selected here.

Lexicon groups

Section Settings

• Display name: Name can be displayed at storefront.

• Description: Description can be displayed at storefront.

• Priority: The higher the priority, the further forward the lexicon group is ranked in the display.

• Active: If active, the lexicon group can be used at storefront.

Section Display

• Show group name: If active, the group name will be shown on the website.

• Show group description: If active, the group description will be shown on the website.

• Lexicon entries layout: Can be selected how the entries of the group are displayed (list only, pictogram only, pictogram & list).

  If the layout 'Pictogram only' is selected, only lexicon entries containing a pictogram will be displayed.

  With 'list only', all entries are displayed, regardless of whether a pictogram is present or not.

  If the layout 'Pictogram & List' is selected, all lexicon entries are displayed - the entries are slightly indented to make room for the pictrogram. If there is no pictogram, the indented space remains empty.

• Show text of lexicon entries collapsed: It can be defined from which height the text should be collapsed.

  The collapsed text function will be activated if the height of the displayed text is smaller than the text.

• Lexicon entry button text: show more: The text of the button can be customized here.

  By default, the button text 'Show more' is entered. This setting is only displayed if YES has been selected for "Show text of lexicon entries collapsed".

• Lexicon entry button text: show less: The text of the button can be customized here.

  By default, the button text 'Show less' is entered. This setting is only displayed if YES has been selected for "Show text of lexicon entries collapsed".

• Lexicon entry button layout: The layout of the Lexicon entry button can be selected based on the defined theme (Primary, Secondary, Success, Danger, Warning, Info, Light, Dark, Link).

  This setting is only displayed if YES has been selected for "Show text of lexicon entries collapsed".

• Height of displayed lexicon text: This value in px is the visible text before the user unfolds the text. This setting is only displayed if YES has been selected for "Show text of lexicon entries collapsed".

• Transparent gradient at bottom: A slight gradient is displayed between the lexicon entry and the button.This setting is only displayed if YES has been selected for "Show text of lexicon entries collapsed".

Section Assigned lexicon entries

   All entries assigned to the group are displayed in a list.

More Settings

Section Basic configuration

• Sales Channel: Select which sales channels the plugin should be applied to.

• Lexicon display: Position where the entire lexicon is displayed. (Link, Right, Above or Below the product description).

• Tooltip: background color: If no color is selected, the default Shopware tooltip layout is used.

• Tooltip: text color: If no color is selected, the default Shopware tooltip layout is used.

• Tooltip: text alignment: The text in the tooltip can be left-aligned, right-aligned or centered.

• Lexicon entries import separator: The entered separator will be used for separating the association entries on the lexicon entries import.