Project

General

Profile

GUI standard

Here follows a list of best practices when working develop a virtuemart view.

Using javascript

Administrators should have js enabled. We can expect that administrators have js enabled. Therefore the backend can have features that only reachable with js.

But the shoppers are sometimes afraid to use js and dont trust a shop that is only working with js. So the whole frontend should be workable without js. This does not mean that every feature for comfort must be accessible without js, but the base functions.

Use of of JText and hardcoded formats and simular

Since joomla 3 the base JText::_ function is overloaded with an internal vsprint. Therefore we derivated our own JText => vmText. To stay compatible with VirtueMart 2.5 and VirtueMart 3, use vmText.

echo vmText::_('VM_FILES_LIST_THUMBNAIL_IMG').": ";
This is very bad and mustn't done. The ":" is hardcoded in the code. The right solution here is to write

echo vmText::_('VM_FILES_LIST_THUMBNAIL_IMG');
and to add the colon and space to the language file.

Reference to functions in explanations

Use in explanation always the sprintf function to use the real label of the button and do not use some meta expression for it. For an exampel look on the view updatesmigration (Tools & Migration) in BE.
echo JText::sprintf('COM_VIRTUEMART_SYSTEM_DANGEROUS_TOOL_ENABLED',JText::_('COM_VIRTUEMART_ADMIN_CFG_DANGEROUS_TOOLS'),$link)
Before we had a text like "Please enable the dangerous tools in the config". But the option is named "Enable database Update tools". The new text shows "To use these tools fully, you must check 'Enable database Update tools' in the Configuration panel." There is additionally a link added directly to the option, this is also a prefered behaviour.

Clicking cancel

When the user clicks cancel, the user is taken back from the editing screen to the page listing. No cancellation message will be shown.

Delete button on row

The page listings should not contain a delete button per row. A single delete button needs to be placed in the toolbar.

Database ID numbers

The page listings should not contain a database ID number.

Sortable columns

A column should, where possible be made sortable by clicking on the column header.

List order fields

A list order field should for new entries be disabled and shown the text string containing: "New items default to the last place. Ordering can be changed after this item is saved." For existing entries, the List order dropdown will be shown, this will allow the user to choose where to place the item.

Hiding of layouts for the joomla view chooser

It is important that there is always the default layout visible in the chooser. In other case layouts used for overrides, makes it impossible to choose the default layout.

Redmine Appliance - Powered by TurnKey Linux