143 lines
1.6 KiB
ReStructuredText
143 lines
1.6 KiB
ReStructuredText
|
|
Configuration
|
|
=============
|
|
|
|
* Create new extension:
|
|
|
|
``./zaz.py -new -t ~/projects -n MyGreatExtension``
|
|
|
|
|
|
* Move to new folder:
|
|
|
|
``cd ~/projects/MyGreatExtension``
|
|
|
|
|
|
* Edit file ``conf.py``
|
|
|
|
``vim conf.py``
|
|
|
|
|
|
Parameters
|
|
----------
|
|
|
|
**Configure correctly this options, before you start code your extension.**
|
|
|
|
Only modify this options.
|
|
|
|
|
|
Type extension
|
|
^^^^^^^^^^^^^^
|
|
|
|
**TYPE_EXTENSION**
|
|
|
|
The type extension that you want develop.
|
|
|
|
* Integer
|
|
* 1 = Normal extension
|
|
* 2 = New components
|
|
* 3 = Calc addin
|
|
|
|
Example:
|
|
|
|
.. code-block:: python
|
|
|
|
TYPE_EXTENSION = 1
|
|
|
|
|
|
Version
|
|
^^^^^^^
|
|
|
|
**VERSION**
|
|
|
|
* String
|
|
* The current version of extension, look: `Semantic Versioning`_
|
|
|
|
Example:
|
|
|
|
.. code-block:: python
|
|
|
|
VERSION = '0.1.0'
|
|
|
|
|
|
Name
|
|
^^^^
|
|
|
|
**NAME**
|
|
|
|
* String
|
|
* Your extension name, not used spaces.
|
|
|
|
Example:
|
|
|
|
.. code-block:: python
|
|
|
|
NAME = 'MyGreatExtension'
|
|
|
|
|
|
ID extension
|
|
^^^^^^^^^^^^
|
|
|
|
The internal name for extension.
|
|
|
|
**ID**
|
|
|
|
* String
|
|
* Should be unique, used URL inverse
|
|
|
|
Example:
|
|
|
|
.. code-block:: python
|
|
|
|
ID = 'org.yourname.extensionname'
|
|
|
|
|
|
Locales
|
|
^^^^^^^
|
|
|
|
If your extension will be multi-language (recommended)
|
|
|
|
**USE_LOCALES**
|
|
|
|
* Bool
|
|
|
|
Example:
|
|
|
|
.. code-block:: python
|
|
|
|
USE_LOCALES = True
|
|
|
|
|
|
Domain for locales
|
|
^^^^^^^^^^^^^^^^^^
|
|
|
|
The base name for generate files POT
|
|
|
|
**DOMAIN**
|
|
|
|
* String
|
|
|
|
Example:
|
|
|
|
.. code-block:: python
|
|
|
|
DOMAIN = 'base'
|
|
|
|
|
|
Path pyGetText
|
|
^^^^^^^^^^^^^^
|
|
|
|
Absolute path for tool `pygettext.py` for generate POT.
|
|
|
|
**PATH_PYGETTEXT**
|
|
|
|
* String
|
|
|
|
Example:
|
|
|
|
.. code-block:: python
|
|
|
|
PATH_PYGETTEXT = '/usr/lib/python3.9/Tools/i18n/pygettext.py'
|
|
|
|
|
|
.. _Semantic Versioning: https://semver.org/
|