.. You may want to use the usual include line. Uncomment and adjust the path. 
.. include:: ../Includes.txt


===============================
EXT: TYPO3 Commerce ordernumber
===============================

:Author:
      Kasper Skårhøj

:Created:
      2002-11-01T00:32:00

:Changed by:
      Ingo Schmitt

:Changed:
      2007-08-10T18:16:32

:Author:
      Ingo Schmitt

:Email:
      is@marketing-factory.de

:Info 3:


:Info 4:


.. _EXT-TYPO3-Commerce-ordernumber:

EXT: TYPO3 Commerce ordernumber
===============================

Extension Key:  **com\_ordernumber**

Copyright 2006-2007, Ingo Schmitt, <is@marketing-factory.de>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

\- a GNU/GPL CMS/Framework available from www.typo3.com

.. _Table-of-Contents:

Table of Contents
-----------------

**EXT: TYPO3 Commerce ordernumber 1**

**Introduction 1**

What does it do? 1

Screenshots 1

**Users manual 1**

**Adminstration 1**

**Configuration 2**

TypoScript Reference 2

**Known problems 2**

**To-Do list 2**

**Changelog 2**


.. _Introduction:

Introduction
------------


.. _What-does-it-do:

What does it do?
^^^^^^^^^^^^^^^^

This extension creates human readable order numbers for TYPO3 Commerce
instead of the default uinqueID Numbers


.. _Screenshots:

Screenshots
^^^^^^^^^^^

\- Screenshots are very much welcome for a visual impression.

\- This section will have a link in the EM, so therefore it's very
important that it conveys this message.

\- Target group: Mostly Developers and administrators, but should be a
non-technical and visual presentation.

\- This section is  **required** and in some cases it basically tells
it all.


.. _Users-manual:

Users manual
------------

This uses the TYPO3 Commerce hook for creating the order number. You
can configure the layout of the number to your needs by setting a
individual starting number and a order number prefix.


.. _Adminstration:

Adminstration
-------------

After the install of this extension you could configure the number-
layout by a new TypoScript object in the tx\_commerce\_pi3 section. A
new order number will be created by the given TypoScript definition.
To have a order number only used once on a webserver, the new order
number is stored in a file, assuming the OS takes care of file locking
to this file. If the file is not present, the last order number in the
database would be used to generate the next order number.


.. _Configuration:

Configuration
-------------

This extension creates a new object in tx\_commerce\_pi3:
tx\_com\_ordernumber


.. _TypoScript-Reference:

TypoScript Reference
^^^^^^^^^^^^^^^^^^^^

\- tx\_com\_ordernumber

.. ### BEGIN~OF~TABLE ###


.. _startingAt:

startingAt
""""""""""

.. container:: table-row

   Property
         startingAt
   
   Data type
         integer
   
   Description
         Number to start for generating the order number
   
   Default



.. _endingAt:

endingAt
""""""""

.. container:: table-row

   Property
         endingAt
   
   Data type
         integer
   
   Description
         Number to end for generating the order number, keep this number high,
         to have enough “space” for new orders
   
   Default



.. _interval:

interval
""""""""

.. container:: table-row

   Property
         interval
   
   Data type
         integer
   
   Description
         Interval to increase the order number for each order
   
   Default


.. ###### END~OF~TABLE ######

[tsref:(cObject).TEST]


.. _generated:

((generated))
"""""""""""""

.. _Example:

Example
~~~~~~~

Add this code to you TypoScript for the checkout page.

::

   plugin.tx_commerce_pi3 {
      tx_com_ordernumber.startingAt = 21000000
      tx_com_ordernumber.endingAt   = 21999999
      tx_com_ordernumber.interval = 1
   }


.. _Known-problems:

Known problems
--------------

\- The order number is stored in a temporary file under a temporarily
path, mainly /tmp/ under unix. This could cause problems with some
windows versions.


.. _To-Do-list:

To-Do list
----------

- Find a way to get the path of the TYPO3TEMP directory, to place the
  actual ordernumber below this path, instead of /tmo under unix

- add checkout page uid to tmp file name, to have different files for
  different shops in one TYPO3 instance.


.. _Changelog:

Changelog
---------

10.08.2008, Version 1.0.0, initial upload in TER

|img-1| EXT: TYPO3 Commerce ordernumber - 2


.. ######CUTTER_MARK_IMAGES######

.. |img-1| image:: img-1.png
.. :align: left
.. :border: 0
.. :height: 32
.. :id: Graphic1
.. :name: Graphic1
.. :width: 102