Documentation: Restaurant Menu for Joomla

To get to the component settings, go to "Components" - "IWS.BY Simple Restaurant Menu" - "Settings" in the administrator panel.

The settings are divided into two tabs. The first tab is responsible for the basic settings, and the second for the information part of the component.

Main component settings

License key

The field specifies the license key obtained when receiving the component on the IWS.BY site. Without a license key, the site will not be able to receive updates.

The settings are further divided into blocks, let's look at each block below.

CURRENCY SETTINGS

Settings are responsible for the activation of currency, its value location.

Enable currency?

The option activates the ability to display the price and currency of each dish on the site.

Currency position

The option is responsible for the location of the currency in relation to the price of the dish. It can be to the right or to the left of the price of the dish.

Currency type

The option is responsible for the type of currency. Types can be "Currency symbol", "Abbreviated currency name" and "Own name of the currency". The values for each type are in the fields and options below.

Currency symbol

The option sets the currency sign. The component adds 8 currency signs:

• $ (US dollar)
• € (Euro)
• ₽ (Russian ruble)
• ₴ (Ukrainian hryvnia)
• £ (British pound)
• ¥ (Japanese Yen)
• ¥ (Chinese yuan)
• ₺ (Turkish lira)

Abbreviated currency name

The option specifies the abbreviated name of the currency. Nine abbreviated currency names have been added to the component:

• BYN (Belarusian ruble)
• USD (US dollar)
• EUR (Euro)
• RUR (Russian ruble)
• UAH (Ukrainian hryvnia)
• GBP (British pound)
• JPY (Japanese Yen)
• CNY (Chinese yuan)
• TRY (Turkish lira)

Own name of the currency

In case the desired currency is not in the options above, this field will help you. You must enter the name of the currency or its symbol in the field to make it appear on the site.

CATEGORY SETTINGS

The settings are responsible for the categories in the restaurant menu component.

HTML category name tag

The option is responsible for the html tag that will wrap the category name in the restaurant menu.

Position of the category name

The option controls the position of the category name relative to the site visitor's screen.

Category name register

The option is responsible for the case of text that will be applied to the category name.

Stylize the category name?

If Yes is selected, the settings from the fields below will be applied to category names.

Category name style

This option sets the style applicable to category names.

Category name text size

The field sets the text size applicable to category names. Specified by a number with a value.

Category name line spacing

The field sets the text spacing applicable to category names. Specified by a number with a value.

DISH SETTINGS

The settings are responsible for the dishes in the restaurant menu component.

HTML title tag

The option is responsible for the html tag that will wrap the name of the dish in the restaurant menu.

Dish name register

The option is responsible for the case of text that will be applied to the name of the dish.

Stylize the name of the dish?

If Yes is selected, the settings from the fields below will be applied to the dish names.

Style of the name of the dish

This option sets the style applicable to the names of the dishes.

The size of the text of the dish name

The field sets the size of the text applicable to dish names. Specified by a number with a value.

Line spacing of the dish name

The field specifies the line spacing of the text applicable to dish names. Specified by a number with a value.

Popup image level

In the field you enter the numeric level at which the popup window with the image will be displayed. The analogue of the CSS property: z-index.

DISH WEIGHT SETTING

Settings are responsible for the weight of the dish in the menu component of the restaurant.

Enable weight?

If "Yes" is selected, the weight of the dish can be added to the dish.

Stylize the weight of the dish?

If "Yes" is selected, the settings from the fields below will be applied to the weight of the dish.

The style of the weight of the dish

The option sets the style applicable to the weight of the dish.

The text size of the dish weight

The field sets the text size applicable to the weight of the dish. Specified by a number with a value.

Line spacing of the dish weight

The field sets the line spacing of the text applicable to the weight of the dish. Specified by a number with a value.

DISH PRICE SETTING

The settings are responsible for the price of the dish in the menu component of the restaurant.

Stylize the price of the dish

If "Yes" is selected, the settings from the fields below will be applied to the price of the dish.

The style of the price of the dish

The option sets the style applicable to the price of the dish.

The size of the text of the price of the dish

The field sets the text size applicable to the price of the dish. Specified by a number with a value.

Line spacing of the dish price

The field sets the line spacing of the text that applies to the price of the dish. Specified by a number with a value.

HOT BID SETTINGS

The settings are responsible for the hot meal offerings in the menu component of the restaurant.

Block background

The option sets the background color of the block with the HEX-formatted hotoffer.

Text color

The option sets the color of the text at the block with the hot sentence in HEX format.

Text position

The option controls the positioning of the text in the block with the hot sentence.

Text register

The option is responsible for the text case that will be applied to the block with the hot sentence.

Text style

The option sets the style applicable to the text in the block with the hot sentence.

Text size

The field sets the text size applicable to the hot dish offer. Specified by a number with a value.

Text line height

The field sets the line spacing of the text applicable to the hot dish sentence. Specified by a number with a value.

Component information settings

Customizable information is displayed on the restaurant menu page at the beginning of the page, as a block with the restaurant name, restaurant logo, and restaurant description. Each item has individual settings. Let's look at each setting.

COMPONENT HEADER SETTINGS

These settings are responsible for the general block of information.

Set the outer indentation of the component header?

If Yes is selected, the external indents from the fields below will be added to the block with the restaurant information.

Outside margins

The group of fields is responsible for the indentation between external elements and the component header. They are indicated by a number with a unit of measure.

RESTAURANT NAME SETTINGS

The settings block is responsible for the restaurant name on the menu component page.

Show the name of the restaurant?

If "Yes" is selected, then in the header block of the component the name of the restaurant with the settings from the fields below will be displayed.

Name of restaurant

In the field you must enter the name of your restaurant.

HTML restaurant name tag

The option is responsible for the html tag that will wrap the name of the restaurant on the component page.

Restaurant name position

The option controls the location of the restaurant name relative to the site visitor's screen.

Restaurant name register

The option is responsible for the case of text that will apply to the name of the restaurant.

Stylize the name of the restaurant

If Yes is selected, the settings from the fields below will be applied to the restaurant name.

Restaurant name style

This option sets the text style applicable to the name of the restaurant.

Restaurant name text size

The field specifies the size of the text that applies to the restaurant name. Specified by a number with a value.

Line spacing of the restaurant name

Specifies the line spacing that applies to the name of the restaurant. Specified by a number with a value.

Set the outside margins of the restaurant name?

If Yes is selected, the external indents from the fields below will be added to the block with the name of the restaurant.

Outside margins

The group of fields is responsible for the indentation between the external elements and the name of the restaurant. They are specified as a number with a unit of measure.

RESTAURANT LOGO SETTINGS

The settings block is responsible for the restaurant logo on the menu component page.

Show the restaurant logo?

If "Yes" is selected, the component's header block will display the restaurant logo with the settings from the fields below.

Restaurant logo

The option specifies an image with the restaurant logo on the component page.

Logo width

The field specifies the width applied to the restaurant logo. Be sure to specify a number with a value. If you want to keep the original width of the logo, put a value "auto" in the field.

Logo height

The field specifies the height applied to the restaurant logo. Be sure to specify a number with a value. If you want to keep the original height of the logo, put a value "auto" in the field.

Position of the restaurant logo

The option controls the position of the restaurant logo relative to the site visitor's screen.

Title tag restaurant logo

The field specifies the name of the logo, which will be added to the Title attribute of the image with the logo of the restaurant.

Alt tag restaurant logo

The field specifies the name of the logo, which will be added to the Alt attribute of the image with the logo of the restaurant.

Set the outside margins of the restaurant logo?

If Yes is selected, the external indents from the fields below will be added to the block with the restaurant logo.

Outside margins

The group of fields is responsible for the indentation between the external elements and the restaurant logo. They are indicated by a number and a unit of measure.

RESTAURANT DESCRIPTION SETTINGS

The settings block is responsible for the restaurant description on the menu component page.

Show a description of the restaurant?

If "Yes" is selected, the header block of the component will display the description of the restaurant with the settings from the fields below.

Description of the restaurant

In the text editor enter a description of your restaurant in any form.

Set the outside margins of the restaurant description?

If Yes is selected, the external indents from the fields below will be added to the restaurant description block.

Outside margins

The group of fields is responsible for the indentation between the external elements and the restaurant description. They are indicated by a number and a unit of measure.

Dish Manager

The main section of the food manager

To get to the main section of the category manager, go to "Components" — "IWS.BY Simple Restaurant Menu" — "Dish Manager".

You will be presented with the Meal Manager.

The main section consists of a table with a list of dishes. Let's look at each column:

• "↑↓" — table column used to sort the dishes in the menu.
• "#" — the order number of the stock in the table with the dishes.
• "Checkbox" — element needed to select the dishes with which a mass action can be performed.
• "Title" — the name of the dish. The current cell specifies the category in which the dish is located along with the name.
• "Image" — a picture of the dish.
• "Weight" — the weight of the dish specified when adding the dish.
• "Price" — the price of the dish specified when adding the dish.
• "Published" — the publication status of the dish in the component.
• "ID" — unique identifier of the dish in the component and Joomla.

Adding a dish in the dish manager

When you add a new dish or edit an existing one, the same form will open. Let's look at each field, which is necessary for work and used by the component.

Name of dish

The field is responsible for the name of the dish that will be displayed on the restaurant menu.

Dish weight

The dimensional unit of the dish is entered in the field.

The price of the dish

The field specifies the price of the dish.

Hot Offer

If there is a hot suggestion for the dish, enter it in the field. The hot suggestion is displayed above the dish description.

Dish description

The field is filled with a description of the dish. It is made in the form of a text editor Joomla.

The next group of fields is responsible for adding an image and its attributes.

Image

The option sets the image of the dish.

Title tag image

The field sets the value of the title attribute of the dish image.

Alt tag image

The field sets the value of the alt attribute of the dish image.

Image caption

The field specifies the image caption, which will be displayed in a pop-up window with the image that opens when you click on the image of the dish.

Status

Status assigned to the added dish.

Category

The option specifies the category to which the dish will belong on the restaurant menu.

Category Manager

The main section of the category manager

To get to the main section of the category manager, go to "Components" — "IWS.BY Simple Restaurant Menu" — "Category Manager".

The main section consists of a table with categories. It is important to pay attention to the column with a checkbox, to the columns "Status", "Title" and "ID". The component categories are designed based on standard features, so some columns are not used in the component, but they are displayed on the category list page.

• "Checkbox" — field-option that allows you to mark categories en masse and perform mass actions with them.
• "Status" — The box will allow you to set the status of the category "Published" and "Unpublished".
• "Title" — the table cell displays the name of the category.
• "ID" — system category identifier in the component and Joomla.

These are all the columns to look at, the other columns are not currently used by the component, but all columns will be used in future updates.

Adding a category

When you add a new category or edit an existing one, the same form will open. Let's look at each field, which is necessary for work and used by the component.

Title

In the field you must enter the name of the category, which will be displayed on the page with the restaurant menu.

Description

In the field is filled with a description of the category. The field is made in the form of a text editor Joomla. All filled information in this field will be displayed on the menu page under the category name.

Status

The option is responsible for the availability of the category to display on the site. The status of the category that can be displayed on the site should be "Published".

Adding a page in the menu manager

To show visitors to your site your restaurant menu using a component, you need to use the Menu Manager. To do this, go to add a new menu item by the path "Menus" - "Your site menu" - "Add New Menu Item".

This will open a page where you can add a menu. On it, fill in the required fields.

Menu Title

In the field, enter the name of the item you want to display in the site menu.

Alias

In the field you must enter the alias (url address) of the page, which will be available to the page. If you leave the field empty, then Joomla will generate an alias automatically based on the data from the field "Menu Title".

The next step is to select "Menu Item Type". To do this, click on the button "Select".

A popup window will open with the available menu types on your site. You need to select "IWS.BY Simple Restaurant Menu".

The available sub-items will appear. Select a value "List of categories".

After selecting the type, the pop-up window will automatically close, and on the page of adding a menu item, there will be additional fields that must be filled in.

Categories

In the option, select the categories you want to display on the restaurant menu page. If you want to select all categories, select "All Categories".

Restaurant Menu Template

The option is responsible for the template that will be applied to the restaurant menu page. Two templates are available: one-column and two-column.

Click the "Save" button. A new menu item will appear on the site, clicking on it will open the restaurant menu.

Statistics in the component

For convenient data analysis, the component has a section "Component statistics".

To go to the component's statistics section, go to the admin menu under: "Components" — "IWS.BY Simple Restaurant Menu" - "Statistics".

On the "Component Statistics" page, two blocks of analytical information are available.

1) "Dishes Statistics"

In the block statistics on the added dishes in the component:

• "Total" — the number in this line shows the total number of dishes added to a component with any status.
• "Published" — the number of dishes that are published and available for display on the site.
• "Unpublished" — the number of dishes that are added to the component, but they are not published and are not available for display on the site.
• "In the archive" — the number of dishes that have been published, but have been moved to the component archive. These dishes are not available for display on the site.
• "In trash" — the number of dishes that have been published, but moved to the component's cart. These dishes are not available for display on the site.

2) "Category statistics"

In the block statistics on the added categories in the component:

• "Total" — the number in this line shows the total number of categories added to the component with any status.
• "Published" — the number of categories that are published and available for display on the site.
• "Unpublished" — the number of categories that are added to the component, but they are not published and are not available for display on the site.
• "In the archive" — the number of categories that have been published, but moved to the component archive. These dishes are not available for display on the site.
• "In trash" — the number of categories that have been published but moved to the component's cart. These dishes are not available for display on the site.