CS-Cart Developer Documentation

This web resource is aimed at those who want to improve or complement CS-Cart functionality. It covers different aspects of programming and gives a clear idea of architecture peculiarities and standards. The provided material will be of great help to you in customizing CS-Cart or developing new addons. All the documents are grouped into thematic units, so that it will be easy to find the desired information. General programming and formatting rules are also given here.

Introduction

• CS-Cart API Overview - a brief introduction into CS-Cart application programming interface and its technology
• CS-Cart Architecture Peculiarities - CS-Cart architecture overview
• Technologies Used - overview of the technologies behind CS-Cart

General Methodology

• Initialization - gives the steps of initialization
• Controllers - details the controller structure and describes how a controller works
• Database - specifies placeholders used in requests to the database
  • Connect Additional Databases - describes how to connect and use external databases
• Hooks - general hooking information and examples
• Microformats - description of a microformat and its structure
• Special classes - a list of classes that are used to minimize a CSS file size
• AJAX - a reference with examples for creating AJAX requests
• Notifications - information on notification pop-ups

Add-ons

• Add-on Folder Structure - structure of an addon directory
• addon.xml - description of an addon.xml file
• Addon Connection - explains how to connect an addon with the help of hooks
• Creating a CS-Cart Add-on Tutorial - learn how to write CS-Cart add-ons
• Adapting Add-on From 2.x to 3 - CS-Cart 3 add-on migrating guide

Design and Layout

• Layout Principles and Block Manager - block scheme and types description.
• Design changes - gives basic knowledge about the CS-Cart design system and explains how to make minor design changes
• Storefront design template scheme - gives the general idea of the storefront template scheme

Appendix

• Coding Standards
  • Programming standards - some basic CS-Cart programming standards
  • Object selection standards - search form standards
  • Heading and text formats - general hints on heading and text formatting
• Hook base - the complete CS-Cart hook list
• List of Microformats - CS-Cart microformats with descriptions
• List of Special Classes - CS-Cart special classes with descriptions
• Examples of Design Changes - most frequently asked design changes
  • 1-6
  • 7-11
  • 12-16
• Tools and Information Sources
  • HTML Basics
  • CSS Basics
  • Smarty Basics
  • Smarty Debug Console