Loading...

Heading and text formats

We no longer maintain the Knowledge Base since version 4.3.x. All the latest user and developer documentation for 4.3.x and newer versions is now available at docs.cs-cart.com.

  • This article applies to CS-Cart versions:
  • 3.0.x

Heading and text formats

Avoiding redundancy

Example - product
  • Product name in the product list is product
  • On the editing page - product name

Also, on the editing page we can see:

  • Product taxes
  • Product code
  • Downloadable product
  • Configurable product
  • Returnable product
We can conclude that the prefix product is redundant for all the fields.

The exception is Product code. If we take away 'product', the field name will not present its characteristics (alternatively replace it with SKU).

Formatting

General

  • Field of an object name should be named Name
  • The object name should not be used on a list page and on a detail page of an object (except the cases with implicit identification – see the note above).

For object editing page

  • When creating an object – mainbox name: New [object]
New product
New category
New news

 

  • When editing an object – mainbox name: Editing [object]: [name]
Editing product: Adidas
Editing category: DVD players
Editing news: New CS-Cart is released

 

The following buttons should be in a form:

  • Save (for editing) / Create (for creation)
  • Cancel
|----------|
|  Save    |   or Cancel
|----------|     ---------
 
|----------|
|Create    |   or Cancel
|----------|     ---------
Cancel is a link (<a href="#" onclick="history.go(-1)">Cancel</a>)

When several objects are processed

There should be the following buttons in a form:
  • Save
  • Add [object] (Examples - Add product, Add page)
  • Delete [optional] (aligned right)

Objects list page/search

  • If there are no objects or they are not found – "No data found" is displayed
  • If objects should be defined and nothing is defined – "No items defined" is displayed
  • If objects are specified (i.e. when nothing is specified, it means that all objects are included) – "All items included" is displayed.

Tabs

The first tab on the object editing page is always named "General".

 

<< Read previous Read next >>
Home / Docs / Appendix / Coding Standards / Heading and text formats