Documentation

On this page you may find a compilation of all necessary information to enable you contributing to the development of OXID eShop and other OXID products. The main scope of this page is focussed on the development of OXID eShop itself and extensions. Please find technical documentation, OXID framework basics and tutorials in this area. Intended to be used by developers.

Getting started
You’re new to OXID? Get all the essential information about installation, module and template system etc. in a quick start.
Online merchant and administrator’s manual: OXID eShop Installation
Instructions on how to install and update OXID eShop < 6
Online merchant and administrator’s manual: OXID eShop Configuration
Please find useful information about configuring OXID eShop here. Tended to be used by users of OXID eShop.
Developer documentation
This links to the OXID eShop developer documentation. You may even contribute here while sending pull requests 😉
Getting help at the boards
Discuss diverse e-commerce and software issues. Find solutions discussed often before. Ask your questions, get help, and lend your support to new members.
Articles about OXID basics
Study the useful blog posts of other users about the OXID framework
Tutorials
Read other user’s blog posts containing tutorials and how-to handle special behaviours you want to achieve in OXID eShop.

Source code documentation
Find an overview of doxygen generated source code documentation for OXID eShop < 6
Demo shop for templates
A demo shop using $this->iDebug = 8; in config.inc.php. Locate the template you want to adapt here or set it yourself in your own installation with $this->iDebug = 8;
Database documentation
Leads to a page with an overview of the latest OXID eShop series. Click on the version number you run to get a visualized database structure!
Release notes
See all posts about recent release notes here
Developer tool chain
Please find the the SDK (software development kit), suggestions, best practises and coding standards in this section.
Trouble shooting
Links to blog posts about trouble shooting.
Security
OXID takes security certain. This page links to information on on what is dealt as a security issue, how to deal with it when you think you caught one and the procedure how it will be handled.