diff --git a/addons/web/static/src/js/view_list.js b/addons/web/static/src/js/view_list.js index 173fae49e31..715922515ec 100644 --- a/addons/web/static/src/js/view_list.js +++ b/addons/web/static/src/js/view_list.js @@ -167,7 +167,7 @@ instance.web.ListView = instance.web.View.extend( /** @lends instance.web.ListVi * @returns {String} CSS style declaration */ style_for: function (record) { - var style= ''; + var len, style= ''; var context = _.extend({}, record.attributes, { uid: this.session.uid, diff --git a/addons/web/static/src/js/views.js b/addons/web/static/src/js/views.js index b02377f1c75..18e162e0278 100644 --- a/addons/web/static/src/js/views.js +++ b/addons/web/static/src/js/views.js @@ -1447,12 +1447,12 @@ instance.web.View = instance.web.Widget.extend({ if (action_data.special === 'cancel') { return handler({"type":"ir.actions.act_window_close"}); } else if (action_data.type=="object") { - var args = [[record_id]], additional_args = []; + var args = [[record_id]]; if (action_data.args) { try { // Warning: quotes and double quotes problem due to json and xml clash // Maybe we should force escaping in xml or do a better parse of the args array - additional_args = JSON.parse(action_data.args.replace(/'/g, '"')); + var additional_args = JSON.parse(action_data.args.replace(/'/g, '"')); args = args.concat(additional_args); } catch(e) { console.error("Could not JSON.parse arguments", action_data.args); diff --git a/addons/web_graph/static/src/js/graph_view.js b/addons/web_graph/static/src/js/graph_view.js index 4a81ceaa98c..953de133ef9 100644 --- a/addons/web_graph/static/src/js/graph_view.js +++ b/addons/web_graph/static/src/js/graph_view.js @@ -52,24 +52,21 @@ instance.web_graph.GraphView = instance.web.View.extend({ if (_.has(field.attrs, 'interval')) { field_name = field.attrs.name + ':' + field.attrs.interval; } - if (_.has(field.attrs, 'type')) { - switch (field.attrs.type) { - case 'row': - self.widget_config.row_groupby.push(field_name); - break; - case 'col': - self.widget_config.col_groupby.push(field_name); - break; - case 'measure': - self.widget_config.measures.push(field_name); - break; - } - } else { // old style, kept for backward compatibility + //noinspection FallThroughInSwitchStatementJS + switch (field.attrs.type) { + case 'measure': + self.widget_config.measures.push(field_name); + break; + case 'col': + self.widget_config.col_groupby.push(field_name); + break; + default: if ('operator' in field.attrs) { self.widget_config.measures.push(field_name); - } else { - self.widget_config.row_groupby.push(field_name); + break; } + case 'row': + self.widget_config.row_groupby.push(field_name); } }); if (self.widget_config.measures.length === 0) { diff --git a/doc/01_getting_started.rst b/doc/01_getting_started.rst deleted file mode 100644 index 341d96db7ae..00000000000 --- a/doc/01_getting_started.rst +++ /dev/null @@ -1,211 +0,0 @@ -======================================== -Getting started with OpenERP development -======================================== - -.. toctree:: - :maxdepth: 1 - -Installation from sources -========================== - -.. _getting_started_installation_source-link: - -Source code is hosted on Launchpad_. In order to get the sources, you -will need Bazaar_ to pull the source from Launchpad. Bazaar is a -version control system that helps you track project history over time -and collaborate efficiently. You may have to create an account on -Launchpad to be able to collaborate on OpenERP development. Please -refer to the Launchpad and Bazaar documentation to install and setup -your development environment. - -The running example of this section is based on an Ubuntu -environment. You may have to adapt the steps according to your -system. Once your working environment is ready, prepare a working -directory that will contain the sources. For a ``source`` base -directory, type:: - - mkdir source;cd source - -OpenERP provides a setup script that automatizes the tasks of creating -a shared repository and getting the source code. Get the setup script -of OpenERP by typing:: - - bzr cat -d lp:~openerp-dev/openerp-tools/trunk setup.sh | sh - -This will create the following two files in your ``source`` directory:: - - -rw-rw-r-- 1 openerp openerp 5465 2012-04-17 11:05 Makefile - -rw-rw-r-- 1 openerp openerp 2902 2012-04-17 11:05 Makefile_helper.py - -If you want some help about the available options, please type:: - - make help - -Next step is to initialize the shared repository and download the -sources. Get the current trunk version of OpenERP by typing:: - - make init-trunk - -This will create the following structure inside your ``source`` -directory, and fetch the latest source code from ``trunk``:: - - drwxrwxr-x 3 openerp openerp 4096 2012-04-17 11:10 addons - drwxrwxr-x 3 openerp openerp 4096 2012-04-17 11:10 misc - drwxrwxr-x 3 openerp openerp 4096 2012-04-17 11:10 server - drwxrwxr-x 3 openerp openerp 4096 2012-04-17 11:10 web - -Some dependencies are necessary to use OpenERP. Depending on your -environment, you might have to install the following packages:: - - sudo apt-get install graphviz ghostscript postgresql-client \ - python-dateutil python-feedparser python-gdata \ - python-ldap python-libxslt1 python-lxml python-mako \ - python-openid python-psycopg2 python-pybabel python-pychart \ - python-pydot python-pyparsing python-reportlab python-simplejson \ - python-tz python-vatnumber python-vobject python-webdav \ - python-werkzeug python-xlwt python-yaml python-imaging \ - python-matplotlib - -Next step is to initialize the database. This will create a new openerp role:: - - make db-setup - -Finally, launch the OpenERP server:: - - make server - -Testing your installation can be done on http://localhost:8069/. You -should see the OpenERP main login page. - -.. _Launchpad: https://launchpad.net/ -.. _Bazaar: http://bazaar.canonical.com/en/ - -Command line options -==================== - -.. program:: openerp-server - -Using the command :: - - ./openerp-server --help - -General Options -+++++++++++++++ - -:: - - --version show program version number and exit - -h, --help show this help message and exit - -c CONFIG, --config=CONFIG specify alternate config file - -s, --save save configuration to ~/.terp_serverrc - -v, --verbose enable debugging - --pidfile=PIDFILE file where the server pid will be stored - --logfile=LOGFILE file where the server log will be stored - -n INTERFACE, --interface=INTERFACE specify the TCP IP address - -p PORT, --port=PORT specify the TCP port - --no-xmlrpc disable xmlrpc - -i INIT, --init=INIT init a module (use "all" for all modules) - --without-demo=WITHOUT_DEMO load demo data for a module (use "all" for all modules) - -u UPDATE, --update=UPDATE update a module (use "all" for all modules) - --stop-after-init stop the server after it initializes - --debug enable debug mode - -S, --secure launch server over https instead of http - --smtp=SMTP_SERVER specify the SMTP server for sending mail - -Database related options -++++++++++++++++++++++++ - -:: - - -d DB_NAME, --database=DB_NAME - specify the database name - -r DB_USER, --db_user=DB_USER - specify the database user name - -w DB_PASSWORD, --db_password=DB_PASSWORD - specify the database password - --pg_path=PG_PATH specify the pg executable path - --db_host=DB_HOST specify the database host - --db_port=DB_PORT specify the database port - -Internationalization options -++++++++++++++++++++++++++++ - -Use these options to translate OpenERP to another language.See i18n -section of the user manual. Option '-l' is mandatory.:: - - -l LANGUAGE, --language=LANGUAGE - specify the language of the translation file. Use it - with --i18n-export and --i18n-import - --i18n-export=TRANSLATE_OUT - export all sentences to be translated to a CSV file - and exit - --i18n-import=TRANSLATE_IN - import a CSV file with translations and exit - --modules=TRANSLATE_MODULES - specify modules to export. Use in combination with - --i18n-export - -Options from previous versions -++++++++++++++++++++++++++++++ - -Some options were removed in OpenERP version 6. For example, -``price_accuracy`` is now configured through the -:ref:`decimal_accuracy` screen. - -Configuration -============== - -.. _getting_started_configuration-link: - -Two configuration files are available: - - * one for the client: ``~/.openerprc`` - * one for the server: ``~/.openerp_serverrc`` - -If they are not found, the server and the client will start with a -default configuration. Those files follow the convention used by -python's ConfigParser module. Please note that lines beginning with -"#" or ";" are comments. The client configuration file is -automatically generated upon the first start. The sezrver -configuration file can automatically be created using the command :: - - ./openerp-server -s or ./openerp-server --save - -You can specify alternate configuration files with :: - - -c CONFIG, --config=CONFIG specify alternate config file - -Configure addons locations -++++++++++++++++++++++++++ - -By default, the only directory of addons known by the server is -server/bin/addons. It is possible to add new addons by - - - copying them in server/bin/addons, or creating a symbolic link to - each of them in this directory, or - - specifying another directory containing addons to the server. The - later can be accomplished either by running the server with the - ``--addons-path=`` option, or by configuring this option in the - openerp_serverrc file, automatically generated under Linux in your - home directory by the server when executed with the ``--save`` - option. You can provide several addons to the ``addons_path`` = - option, separating them using commas. - -Start-up script -=============== - -.. versionadded:: 6.1 - -To run the OpenERP server, the conventional approach is to use the -`openerp-server` script. It loads the :ref:`openerp library`, sets a -few configuration variables corresponding to command-line arguments, -and starts to listen to incoming connections from clients. - -Depending on your deployment needs, you can write such a start-up script very -easily. We also recommend you take a look at an alternative tool called -`openerp-command` that can, among other things, launch the server. - -Yet another alternative is to use a WSGI-compatible HTTP server and let it call -into one of the WSGI entry points of the server. - - diff --git a/doc/02_architecture.rst b/doc/02_architecture.rst deleted file mode 100644 index 203a1bceba9..00000000000 --- a/doc/02_architecture.rst +++ /dev/null @@ -1,252 +0,0 @@ -============ -Architecture -============ - -OpenERP as a multitenant three-tiers architecture -================================================= - -This section presents the OpenERP architecture along with technology details -of the application. The tiers composing OpenERP are presented. Communication -means and protocols between the application components are also presented. -Some details about used development languages and technology stack are then summarized. - -OpenERP is a `multitenant `_, `three-tiers architecture -`_: -database tier for data storage, application tier for processing and functionalities -and presentation tier providing user interface. Those are separate layers -inside OpenERP. The application tier itself is written as a core; multiple -additional modules can be installed in order to create a particular instance -of OpenERP adapted to specific needs and requirements. Moreover, OpenERP -follows the Model-View-Controller (MVC) architectural pattern. - -A typical deployment of OpenERP is shown on `Figure 1`_. This deployment is -called Web embedded deployment. As shown, an OpenERP system consists of -three main components: - -- a PostgreSQL database server which contains all OpenERP databases. - Databases contain all application data, and also most of the OpenERP - system configuration elements. Note that this server can possibly be - deployed using clustered databases. -- the OpenERP Server, which contains all the enterprise logic and ensures - that OpenERP runs optimally. One layer of the server is dedicated to - communicate and interface with the PostgreSQL database, the ORM engine. - Another layer allows communications between the server and a web browser, - the Web layer. Having more than one server is possible, for example in - conjunction with a load balancing mechanism. -- the client running in the a web browser as javascript application. - -The database server and the OpenERP server can be installed on the same -computer, or distributed onto separate computer servers, for example for -performance considerations. - -.. _`Figure 1`: -.. figure:: _static/02_openerp_architecture.png - :width: 50% - :alt: OpenERP 6.1 architecture for embedded web deployment - :align: center - - OpenERP 6.1 architecture for embedded web deployment - -The next subsections give details about the different tiers of the OpenERP -architecture. - -PostgreSQL database -+++++++++++++++++++ - -The data tier of OpenERP is provided by a PostgreSQL relational database. -While direct SQL queries can be executed from OpenERP modules, most accesses -to the relational database are done through the server Object Relational -Mapping layer. - -Databases contain all application data, and also most of the OpenERP system -configuration elements. Note that this server can possibly be deployed using -clustered databases. - -OpenERP server -++++++++++++++ - -OpenERP provides an application server on which specific business applications -can be built. It is also a complete development framework, offering a range -of features to write those applications. Among those features, the OpenERP -ORM provides functionalities and an interface on top of the PostgreSQL server. -The OpenERP server also features a specific layer designed to communicate -with the web browser-based client. This layer connects users using standard -browsers to the server. - -From a developer perspective, the server acts both as a library which brings -the above benefits while hiding the low-level details, and as a simple way -to install, configure and run the written applications. The server also contains -other services, such as extensible data models and view, workflow engine or -reports engine. However, those are OpenERP services not specifically related -to security, and are therefore not discussed in details in this document. - -**Server - ORM** - -The Object Relational Mapping ORM layer is one of the salient features of -the OpenERP Server. It provides additional and essential functionalities -on top of PostgreSQL server. Data models are described in Python and OpenERP -creates the underlying database tables using this ORM. All the benefits of -RDBMS such as unique constraints, relational integrity or efficient querying -are used and completed by Python flexibility. For instance, arbitrary constraints -written in Python can be added to any model. Different modular extensibility -mechanisms are also afforded by OpenERP. - -It is important to understand the ORM responsibility before attempting to -by-pass it and to access directly the underlying database via raw SQL queries. -When using the ORM, OpenERP can make sure the data remains free of any corruption. -For instance, a module can react to data creation in a particular table. -This behavior can occur only if queries go through the ORM. - -The services granted by the ORM are among other : - - - consistency validation by powerful validity checks, - - providing an interface on objects (methods, references, ...) allowing - to design and implement efficient modules, - - row-level security per user and group; more details about users and user - groups are given in the section Users and User Roles, - - complex actions on a group of resources, - - inheritance service allowing fine modeling of new resources - -**Server - Web** - -The web layer offers an interface to communicate with standard browsers. -In the 6.1 version of OpenERP, the web-client has been rewritten and integrated -into the OpenERP server tier. This web layer is a WSGI-compatible application -based on werkzeug. It handles regular http queries to server static file or -dynamic content and JSON-RPC queries for the RPC made from the browser. - -**Modules** - -By itself, the OpenERP server is a core. For any enterprise, the value of -OpenERP lies in its different modules. The role of the modules is to implement -any business requirement. The server is the only necessary component to -add modules. Any official OpenERP release includes a lot of modules, and -hundreds of modules are available thanks to the community. Examples of -such modules are Account, CRM, HR, Marketing, MRP, Sale, etc. - -Clients -+++++++ - -As the application logic is mainly contained server-side, the client is -conceptually simple. It issues a request to the server, gets data back -and display the result (e.g. a list of customers) in different ways -(as forms, lists, calendars, ...). Upon user actions, it sends queries -to modify data to the server. - -The default client of OpenERP is an JavaScript application running in the -browser that communicates with the server using JSON-RPC. - -MVC architecture in OpenERP -=========================== - -According to `Wikipedia `_, -"a Model-view-controller (MVC) is an architectural pattern used in software -engineering". In complex computer applications presenting lots of data to -the user, one often wishes to separate data (model) and user interface (view) -concerns. Changes to the user interface does therefore not impact data -management, and data can be reorganized without changing the user interface. -The model-view-controller solves this problem by decoupling data access -and business logic from data presentation and user interaction, by -introducing an intermediate component: the controller. - -.. _`Figure 3`: -.. figure:: _static/02_mvc_diagram.png - :width: 35% - :alt: Model-View-Controller diagram - :align: center - - Model-View-Controller diagram - -For example in the diagram above, the solid lines for the arrows starting -from the controller and going to both the view and the model mean that the -controller has a complete access to both the view and the model. The dashed -line for the arrow going from the view to the controller means that the view -has a limited access to the controller. The reasons of this design are : - - - From **View** to **Model** : the model sends notification to the view - when its data has been modified in order the view to redraw its content. - The model doesn't need to know the inner workings of the view to perform - this operation. However, the view needs to access the internal parts of the model. - - From **View** to **Controller** : the reason why the view has limited - access to the controller is because the dependencies from the view to - the controller need to be minimal: the controller can be replaced at - any moment. - -OpenERP follows the MVC semantic with - - - model : The PostgreSQL tables. - - view : views are defined in XML files in OpenERP. - - controller : The objects of OpenERP. - -Network communications and WSGI -=============================== - -OpenERP is an HTTP web server and may also be deployed as an WSGI-compliant -application. - -Clients may communicate with OpenERP using sessionless XML-RPC, the recommended -way to interoperate with OpenERP. Web-based clients communicates using the -session aware JSON-RPC. - -Everything in OpenERP, and objects methods in particular, are exposed via -the network and a security layer. Access to the data model is in fact a ‘service’ -and it is possible to expose new services. For instance, a WebDAV service and -a FTP service are available. - -Services can make use of the `WSGI -`_ stack. WSGI is a -standard solution in the Python ecosystem to write HTTP servers, applications, -and middleware which can be used in a mix-and-match fashion. By using WSGI, it -is possible to run OpenERP in any WSGI compliant server. It is also possible to -use OpenERP to host a WSGI application. - -A striking example of this possibility is the OpenERP Web layer that is -the server-side counter part to the web clients. It provides the requested -data to the browser and manages web sessions. It is a WSGI-compliant application. -As such, it can be run as a stand-alone HTTP server or embedded inside OpenERP. - -The HTTP namespaces /openerp/ /object/ /common/ are reserved for the XML-RPC -layer, every module restrict it's HTTP namespace to // - -Process model -============= - -In the past, the OpenERP server was using threads to handle HTTP requests -concurrently or to process cron jobs. Using threads is still the default -behavior when running the ``openerp-server`` script but not the recommended -one: it is in fact recommended to use the ``--workers`` option. - -By using the ``--workers`` option, the OpenERP server will spawn a fixed number -of processes instead of spawning a new thread for each incoming request. - -This has a number of advantages: - - - Processes do not suffer from CPython's Global Interpreter Lock. - - Processes can be gracefully recycled while requests are still handled by the - server. - - Resources such as CPU time and memory made available to a process can be - monitored on a per-process basis. - -When using the ``--workers`` options, two types of processes may be spawned: -web process, and cron process. - -.. versionadded:: 7.1 - -.. _longpolling-worker: - -When using the ``--workers`` options, three types of processes may be spawned: -web process, and cron process, just as previsouly, but also an evented (using -gevent) web process is started. It is used for long-polling as needed by the -upcoming Instant Messaging feature. As for now, that process is listening on a -different port than the main web processes. A reverse proxy (e.g. Nginx) to -listen on a unique port, mapping all requests to the normal port, but mapping -the ``/longpolling`` route to the evented process is necessary (the web -interface cannot issue requests to different ports). - -(It is possible to make the threaded server evented by passing the ``--gevent`` -flag.) - -The goal is to drop support for the threaded model, and also make all web -processes evented; there would be no more distinction between "normal" and -"longpolling" processes. For this to happen, further testing is needed. - diff --git a/doc/03_module_dev.rst b/doc/03_module_dev.rst deleted file mode 100644 index c5f965e4b93..00000000000 --- a/doc/03_module_dev.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _module-dev: - -======= -Modules -======= - -.. toctree:: - :maxdepth: 2 - - 03_module_dev_01 - 03_module_dev_02 - 03_module_dev_03 - 03_module_dev_04 - 03_module_dev_05 - 03_module_dev_06 - report-declaration diff --git a/doc/03_module_dev_01.rst b/doc/03_module_dev_01.rst deleted file mode 100644 index f35dab539a4..00000000000 --- a/doc/03_module_dev_01.rst +++ /dev/null @@ -1,429 +0,0 @@ -.. _module-dev-structure: - -Module structure -================ - -A module can contain the following elements: - - - **Business object** : declared as Python classes extending the class - osv.Model, the persistence of these resource is completly managed by - OpenERP's ORM. - - **Data** : XML/CSV files with meta-data (views and workflows declaration), - configuration data (modules parametrization) and demo data (optional but - recommended for testing), - - **Reports** : RML (XML format). HTML/MAKO or OpenOffice report templates, to - be merged with any kind of business data, and generate HTML, ODT or PDF - reports. - -.. figure:: _static/03_module_gen_view.png - :width: 75% - :alt: Module composition - :align: center - - Module composition - -Each module is contained in its own directory within either the server/bin/addons -directory or another directory of addons, configured in server installation. -To create a new module for example the 'OpenAcademy' module, the following -steps are required: - - - create a ``openacademy`` subdirectory in the source/addons directory - - create the module import file ``__init__.py`` - - create the module manifield file ``__openerp__.py`` - - create **Python** files containing **objects** - - create **.xml files** holding module data such as views, menu entries - or demo data - - optionally create **reports** or **workflows** - -Python import file __init__.py -++++++++++++++++++++++++++++++ - -The ``__init__.py`` file is the Python import file, because an OpenERP module -is also a regular Python module. The file should import all the other python -file or submodules. - -For example, if a module contains a single python file named ``openacademy.py``, -the file should look like: - - import openacademy - -Manifest file __openerp__.py -+++++++++++++++++++++++++++++++ - -In the created module directory, you must add a **__openerp__.py** file. -This file, which must be a Python dict literal, is responsible to - - 1. determine the *XML files that will be parsed* during the initialization - of the server, and also to - 2. determine the *dependencies* of the created module. - 3. declare additional meta data - -This file must contain a Python dictionary with the following values: - -:: - - name The name of the module in English. - version The version of the module. - summary Short description or keywords - description The module description (text). - category The categrory of the module - author The author of the module. - website URL of the website of the module. - license The license of the module (default: AGPL-3). - depends List of modules on which this module depends beside base. - data List of .xml files to load when the module is installed or updated. - demo List of additional .xml files to load when the module is - installed or updated and demo flag is active. - installable True or False. Determines whether the module is installable - or not. - auto_install True or False (default: False). If set to ``True``, the - module is a link module. It will be installed as soon - as all its dependencies are installed. - -For the ``openacademy`` module, here is an example of ``__openerp__.py`` -declaration file: - -.. code-block:: python - - { - 'name' : "OpenAcademy", - 'version' : "1.0", - 'author' : "OpenERP SA", - 'category' : "Tools", - 'depends' : ['mail'], - 'data' : [ - 'openacademy_view.xml', - 'openacademy_data.xml', - 'report/module_report.xml', - 'wizard/module_wizard.xml', - ], - 'demo' : [ - 'openacademy_demo.xml' - ], - 'installable': True, - } - -Objects -+++++++ - -All OpenERP resources are objects: invoices, partners. Metadata are also object -too: menus, actions, reports... Object names are hierarchical, as in the -following examples: - - * account.transfer : a money transfer - * account.invoice : an invoice - * account.invoice.line : an invoice line - -Generally, the first word is the name of the module: account, stock, sale. - -Those object are declared in python be subclassing osv.Model - -The ORM of OpenERP is constructed over PostgreSQL. It is thus possible to -query the object used by OpenERP using the object interface (ORM) or by -directly using SQL statements. - -But it is dangerous to write or read directly in the PostgreSQL database, as -you will shortcut important steps like constraints checking or workflow -modification. - -.. .. figure:: images/pom_3_0_3.png -.. :scale: 50 -.. :align: center - -.. *The Physical Objects Model of [OpenERP version 3.0.3]* - - -XML Files -+++++++++ - -XML files located in the module directory are used to initialize or update the -the database when the module is installed or updated. They are used for many -purposes, among which we can cite : - - * initialization and demonstration data declaration, - * views declaration, - * reports declaration, - * workflows declaration. - -General structure of OpenERP XML files is more detailed in the -:ref:`xml-serialization` section. Look here if you are interested in learning -more about *initialization* and *demonstration data declaration* XML files. The -following section are only related to XML specific to *actions, menu entries, -reports, wizards* and *workflows* declaration. - -Data can be inserted or updated into the PostgreSQL tables corresponding to the -OpenERP objects using XML files. The general structure of an OpenERP XML file -is as follows: - -.. code-block:: xml - - - - - - "field1 content" - "field2 content" - (...) - - - (...) - - (...) - - - -```` -//////////// - -Defines a new record in a specified OpenERP model. - -``@model`` (required) - - Name of the model in which this record will be created/inserted. - -``@id`` (optional) - - :term:`external ID` for the record, also allows referring to this record in - the rest of this file or in other files (through ``field/@ref`` or the - :py:func:`ref() ` function) - -A record tag generally contains multiple ``field`` tags specifying the values -set on the record's fields when creating it. Fields left out will be set to -their default value unless required. - -```` -/////////// - -In its most basic use, the ``field`` tag will set its body (as a string) as -the value of the corresponding ``record``'s ``@name`` field. - -Extra attributes can either preprocess the body or replace its use entirely: - -``@name`` (mandatory) - - Name of the field in the containing ``record``'s model - -``@type`` (optional) - - One of ``char``, ``int``, ``float``, ``list``, ``tuple``, ``xml`` or - ``html``, ``file`` or ``base64``. Converts the ``field``'s body to the - specified type (or validates the body's content) - - * ``xml`` will join multiple XML nodes under a single ```` root - * in ``xml`` and ``html``, external ids can be referenced using - ``%(id_name)s`` - * ``list`` and ``tuple``'s element are specified using ```` - sub-nodes with the same attributes as ``field``. - * ``file`` expects a module-local path and will save the path prefixed with - the current module's name, separated by a ``,`` (comma). For use with - :py:func:`~openerp.modules.module.get_module_resource`. - * ``base64`` expects binary data, encodes it to base64 and sets it. Mostly - useful with ``@file`` - -``@file`` - - Can be used with types ``char`` and ``base64``, sources the field's content - from the specified file instead of the field's text body. - -``@model`` - - Model used for ``@search``'s search, or registry object put in context for - ``@eval``. Required if ``@search`` but optional if ``@eval``. - -``@eval`` (optional) - - A Python expression evaluated to obtain the value to set on the record - -``@ref`` (optional) - - Links to an other record through its :term:`external id`. The module prefix - may be ommitted to link to a record defined in the same module. - -``@search`` (optional) - - Search domain (evaluated Python expression) into ``@model`` to get the - records to set on the field. - - Sets all the matches found for m2m fields, the first id for other field - types. - -**Example** - -.. code-block:: xml - - - account.invoice - Invoices List - account.invoice.list - account/report/invoice.xsl - account/report/invoice.xml - - -Let's review an example taken from the OpenERP source (base_demo.xml in the base module): - -.. code-block:: xml - - - Tiny sprl - - - - -.. code-block:: xml - - - admin - admin - Administrator - Administrator - - - - - - - -This last record defines the admin user : - - * The fields login, password, etc are straightforward. - * The ref attribute allows to fill relations between the records : - -.. code-block:: xml - - - -The field **company_id** is a many-to-one relation from the user object to the company object, and **main_company** is the id of to associate. - - * The **eval** attribute allows to put some python code in the xml: here the groups_id field is a many2many. For such a field, "[(6,0,[group_admin])]" means : Remove all the groups associated with the current user and use the list [group_admin] as the new associated groups (and group_admin is the id of another record). - - * The **search** attribute allows to find the record to associate when you do not know its xml id. You can thus specify a search criteria to find the wanted record. The criteria is a list of tuples of the same form than for the predefined search method. If there are several results, an arbitrary one will be chosen (the first one): - -.. code-block:: xml - - - -This is a classical example of the use of **search** in demo data: here we do not really care about which partner we want to use for the test, so we give an empty list. Notice the **model** attribute is currently mandatory. - -Function tag -//////////// - -A function tag can contain other function tags. - -model : mandatory - The model to be used - -name : mandatory - the function given name - -eval - should evaluate to the list of parameters of the method to be called, excluding cr and uid - -**Example** - -.. code-block:: xml - - - - -Views -+++++ - -Views are a way to represent the objects on the client side. They indicate to the client how to lay out the data coming from the objects on the screen. - -There are two types of views: - - * form views - * tree views - -Lists are simply a particular case of tree views. - -A same object may have several views: the first defined view of a kind (*tree, form*, ...) will be used as the default view for this kind. That way you can have a default tree view (that will act as the view of a one2many) and a specialized view with more or less information that will appear when one double-clicks on a menu item. For example, the products have several views according to the product variants. - -Views are described in XML. - -If no view has been defined for an object, the object is able to generate a view to represent itself. This can limit the developer's work but results in less ergonomic views. - - -Usage example -///////////// - -When you open an invoice, here is the chain of operations followed by the client: - - * An action asks to open the invoice (it gives the object's data (account.invoice), the view, the domain (e.g. only unpaid invoices) ). - * The client asks (with XML-RPC) to the server what views are defined for the invoice object and what are the data it must show. - * The client displays the form according to the view - -.. .. figure:: images/arch_view_use.png -.. :scale: 50 -.. :align: center - -To develop new objects -////////////////////// - -The design of new objects is restricted to the minimum: create the objects and optionally create the views to represent them. The PostgreSQL tables do not have to be written by hand because the objects are able to automatically create them (or adapt them in case they already exist). - -Reports -""""""" - -OpenERP uses a flexible and powerful reporting system. Reports are generated either in PDF or in HTML. Reports are designed on the principle of separation between the data layer and the presentation layer. - -Reports are described more in details in the `Reporting `_ chapter. - - -Workflow -"""""""" - -The objects and the views allow you to define new forms very simply, lists/trees and interactions between them. But that is not enough, you must define the dynamics of these objects. - -A few examples: - - * a confirmed sale order must generate an invoice, according to certain conditions - * a paid invoice must, only under certain conditions, start the shipping order - -The workflows describe these interactions with graphs. One or several workflows may be associated to the objects. Workflows are not mandatory; some objects don't have workflows. - -Below is an example workflow used for sale orders. It must generate invoices and shipments according to certain conditions. - -.. .. figure:: images/arch_workflow_sale.png -.. :scale: 85 -.. :align: center - - -In this graph, the nodes represent the actions to be done: - - * create an invoice, - * cancel the sale order, - * generate the shipping order, ... - -The arrows are the conditions; - - * waiting for the order validation, - * invoice paid, - * click on the cancel button, ... - -The squared nodes represent other Workflows; - - * the invoice - * the shipping - - -i18n ----- - -.. versionchanged:: 5.0 - -Each module has its own ``i18n`` folder. In addition, OpenERP can now deal with -``.po`` [#f_po]_ files as import/export format. The translation files of the -installed languages are automatically loaded when installing or updating a -module. - -Translations are managed by the `Launchpad Web interface -`_. Here, you'll find the list -of translatable projects. - -Please read the `FAQ `_ before asking questions. - - -.. [#f_po] http://www.gnu.org/software/autoconf/manual/gettext/PO-Files.html#PO-Files - - diff --git a/doc/03_module_dev_02.rst b/doc/03_module_dev_02.rst deleted file mode 100644 index ec7fa57d0dc..00000000000 --- a/doc/03_module_dev_02.rst +++ /dev/null @@ -1,961 +0,0 @@ -.. _module-dev-api: - -Objects, Fields and Methods -=========================== - -OpenERP Objects ---------------- - -.. This chapter is dedicated to detailed objects definition: - all fields - all objects - inheritancies - -All the ERP's pieces of data are accessible through "objects". As an example, there is a res.partner object to access the data concerning the partners, an account.invoice object for the data concerning the invoices, etc... - -Please note that there is an object for every type of resource, and not an -object per resource. We have thus a res.partner object to manage all the -partners and not a *res.partner* object per partner. If we talk in "object -oriented" terms, we could also say that there is an object per level. - -The direct consequences is that all the methods of objects have a common parameter: the "ids" parameter. This specifies on which resources (for example, on which partner) the method must be applied. Precisely, this parameter contains a list of resource ids on which the method must be applied. - -For example, if we have two partners with the identifiers 1 and 5, and we want to call the res_partner method "send_email", we will write something like:: - - res_partner.send_email(... , [1, 5], ...) - -We will see the exact syntax of object method calls further in this document. - -In the following section, we will see how to define a new object. Then, we will check out the different methods of doing this. - -For developers: - -* OpenERP "objects" are usually called classes in object oriented programming. -* A OpenERP "resource" is usually called an object in OO programming, instance of a class. - -It's a bit confusing when you try to program inside OpenERP, because the language used is Python, and Python is a fully object oriented language, and has objects and instances ... - -Luckily, an OpenERP "resource" can be converted magically into a nice Python object using the "browse" class method (OpenERP object method). - - -The ORM - Object-relational mapping - Models --------------------------------------------- - -The ORM, short for Object-Relational Mapping, is a central part of OpenERP. - -In OpenERP, the data model is described and manipulated through Python classes -and objects. It is the ORM job to bridge the gap -- as transparently as -possible for the developer -- between Python and the underlying relational -database (PostgreSQL), which will provide the persistence we need for our -objects. - - -OpenERP Object Attributes -------------------------- - -Objects Introduction -++++++++++++++++++++ - -To define a new object, you must define a new Python class then instantiate it. This class must inherit from the osv class in the osv module. - -Object definition -+++++++++++++++++ - -The first line of the object definition will always be of the form:: - - class name_of_the_object(osv.osv): - _name = 'name.of.the.object' - _columns = { ... } - ... - name_of_the_object() - -An object is defined by declaring some fields with predefined names in the -class. Two of them are required (_name and _columns), the rest are optional. -The predefined fields are: - -Predefined fields -+++++++++++++++++ - -`_auto` - Determines whether a corresponding PostgreSQL table must be generated - automatically from the object. Setting _auto to False can be useful in case - of OpenERP objects generated from PostgreSQL views. See the "Reporting From - PostgreSQL Views" section for more details. - -`_columns (required)` - The object fields. See the :ref:`fields ` section for further details. - -`_constraints` - The constraints on the object. See the constraints section for details. - -`_sql_constraints` - The SQL Constraint on the object. See the SQL constraints section for further details. - -`_defaults` - The default values for some of the object's fields. See the default value section for details. - -`_inherit` - The name of the osv object which the current object inherits from. See the :ref:`object inheritance section` - (first form) for further details. - -`_inherits` - The list of osv objects the object inherits from. This list must be given in - a python dictionary of the form: {'name_of_the_parent_object': - 'name_of_the_field', ...}. See the :ref:`object inheritance section` - (second form) for further details. Default value: {}. - -`_log_access` - Determines whether or not the write access to the resource must be logged. - If true, four fields will be created in the SQL table: create_uid, - create_date, write_uid, write_date. Those fields represent respectively the - id of the user who created the record, the creation date of record, the id - of the user who last modified the record, and the date of that last - modification. This data may be obtained by using the perm_read method. - -`_name (required)` - Name of the object. Default value: None. - -`_order` - Name of the fields used to sort the results of the search and read methods. - - Default value: 'id'. - - Examples:: - - _order = "name" - _order = "date_order desc" - -`_rec_name` - Name of the field in which the name of every resource is stored. Default - value: 'name'. Note: by default, the name_get method simply returns the - content of this field. - -`_sequence` - Name of the SQL sequence that manages the ids for this object. Default value: None. - -`_sql` - SQL code executed upon creation of the object (only if _auto is True). It means this code gets executed after the table is created. - -`_table` - Name of the SQL table. Default value: the value of the _name field above - with the dots ( . ) replaced by underscores ( _ ). - - -.. _inherit-link: - -Object Inheritance - _inherit ------------------------------ - -Introduction -++++++++++++ - -Objects may be inherited in some custom or specific modules. It is better to -inherit an object to add/modify some fields. - -It is done with:: - - _inherit='object.name' - -Extension of an object -++++++++++++++++++++++ - -There are two possible ways to do this kind of inheritance. Both ways result in -a new class of data, which holds parent fields and behaviour as well as -additional fields and behaviour, but they differ in heavy programatical -consequences. - -While Example 1 creates a new subclass "custom_material" that may be "seen" or -"used" by any view or tree which handles "network.material", this will not be -the case for Example 2. - -This is due to the table (other.material) the new subclass is operating on, -which will never be recognized by previous "network.material" views or trees. - -Example 1:: - - class custom_material(osv.osv): - _name = 'network.material' - _inherit = 'network.material' - _columns = { - 'manuf_warranty': fields.boolean('Manufacturer warranty?'), - } - _defaults = { - 'manuf_warranty': lambda *a: False, - } - custom_material() - -.. tip:: Notice - - _name == _inherit - -In this example, the 'custom_material' will add a new field 'manuf_warranty' to -the object 'network.material'. New instances of this class will be visible by -views or trees operating on the superclasses table 'network.material'. - -This inheritancy is usually called "class inheritance" in Object oriented -design. The child inherits data (fields) and behavior (functions) of his -parent. - - -Example 2:: - - class other_material(osv.osv): - _name = 'other.material' - _inherit = 'network.material' - _columns = { - 'manuf_warranty': fields.boolean('Manufacturer warranty?'), - } - _defaults = { - 'manuf_warranty': lambda *a: False, - } - other_material() - -.. tip:: Notice - - _name != _inherit - -In this example, the 'other_material' will hold all fields specified by -'network.material' and it will additionally hold a new field 'manuf_warranty'. -All those fields will be part of the table 'other.material'. New instances of -this class will therefore never been seen by views or trees operating on the -superclasses table 'network.material'. - -This type of inheritancy is known as "inheritance by prototyping" (e.g. -Javascript), because the newly created subclass "copies" all fields from the -specified superclass (prototype). The child inherits data (fields) and behavior -(functions) of his parent. - - -.. _inherits-link: - -Inheritance by Delegation - _inherits -------------------------------------- - - **Syntax :**:: - - class tiny_object(osv.osv) - _name = 'tiny.object' - _table = 'tiny_object' - _inherits = { - 'tiny.object_a': 'object_a_id', - 'tiny.object_b': 'object_b_id', - ... , - 'tiny.object_n': 'object_n_id' - } - (...) - -The object 'tiny.object' inherits from all the columns and all the methods from -the n objects 'tiny.object_a', ..., 'tiny.object_n'. - -To inherit from multiple tables, the technique consists in adding one column to -the table tiny_object per inherited object. This column will store a foreign -key (an id from another table). The values *'object_a_id' 'object_b_id' ... -'object_n_id'* are of type string and determine the title of the columns in -which the foreign keys from 'tiny.object_a', ..., 'tiny.object_n' are stored. - -This inheritance mechanism is usually called " *instance inheritance* " or " -*value inheritance* ". A resource (instance) has the VALUES of its parents. - - -.. _fields-link: - -Fields Introduction -------------------- - -Objects may contain different types of fields. Those types can be divided into -three categories: simple types, relation types and functional fields. The -simple types are integers, floats, booleans, strings, etc ... ; the relation -types are used to represent relations between objects (one2one, one2many, -many2one). Functional fields are special fields because they are not stored in -the database but calculated in real time given other fields of the view. - -Here's the header of the initialization method of the class any field defined -in OpenERP inherits (as you can see in server/bin/osv/fields.py):: - - def __init__(self, string='unknown', required=False, readonly=False, - domain=None, context="", states=None, priority=0, change_default=False, size=None, - ondelete="set null", translate=False, select=False, **args) : - -There are a common set of optional parameters that are available to most field -types: - -:change_default: - Whether or not the user can define default values on other fields depending - on the value of this field. Those default values need to be defined in - the ir.values table. -:help: - A description of how the field should be used: longer and more descriptive - than `string`. It will appear in a tooltip when the mouse hovers over the - field. -:ondelete: - How to handle deletions in a related record. Allowable values are: - 'restrict', 'no action', 'cascade', 'set null', and 'set default'. -:priority: Not used? -:readonly: `True` if the user cannot edit this field, otherwise `False`. -:required: - `True` if this field must have a value before the object can be saved, - otherwise `False`. -:size: The size of the field in the database: number characters or digits. -:states: - Lets you override other parameters for specific states of this object. - Accepts a dictionary with the state names as keys and a list of name/value - tuples as the values. For example: `states={'posted':[('readonly',True)]}` -:string: - The field name as it should appear in a label or column header. Strings - containing non-ASCII characters must use python unicode objects. - For example: `'tested': fields.boolean(u'Testé')` -:translate: - `True` if the *content* of this field should be translated, otherwise - `False`. - -There are also some optional parameters that are specific to some field types: - -:context: - Define a variable's value visible in the view's context or an on-change - function. Used when searching child table of `one2many` relationship? -:domain: - Domain restriction on a relational field. - - Default value: []. - - Example: domain=[('field','=',value)]) -:invisible: Hide the field's value in forms. For example, a password. -:on_change: - Default value for the `on_change` attribute in the view. This will launch - a function on the server when the field changes in the client. For example, - `on_change="onchange_shop_id(shop_id)"`. -:relation: - Used when a field is an id reference to another table. This is the name of - the table to look in. Most commonly used with related and function field - types. -:select: - Default value for the `select` attribute in the view. 1 means basic search, - and 2 means advanced search. - - -Type of Fields --------------- - -Basic Types -+++++++++++ - -:boolean: - - A boolean (true, false). - - Syntax:: - - fields.boolean('Field Name' [, Optional Parameters]), - -:integer: - - An integer. - - Syntax:: - - fields.integer('Field Name' [, Optional Parameters]), - -:float: - - A floating point number. - - Syntax:: - - fields.float('Field Name' [, Optional Parameters]), - - .. note:: - - The optional parameter digits defines the precision and scale of the - number. The scale being the number of digits after the decimal point - whereas the precision is the total number of significant digits in the - number (before and after the decimal point). If the parameter digits is - not present, the number will be a double precision floating point number. - Warning: these floating-point numbers are inexact (not any value can be - converted to its binary representation) and this can lead to rounding - errors. You should always use the digits parameter for monetary amounts. - - Example:: - - 'rate': fields.float( - 'Relative Change rate', - digits=(12,6) [, - Optional Parameters]), - -:char: - - A string of limited length. The required size parameter determines its size. - - Syntax:: - - fields.char( - 'Field Name', - size=n [, - Optional Parameters]), # where ''n'' is an integer. - - Example:: - - 'city' : fields.char('City Name', size=30, required=True), - -:text: - - A text field with no limit in length. - - Syntax:: - - fields.text('Field Name' [, Optional Parameters]), - -:date: - - A date. - - Syntax:: - - fields.date('Field Name' [, Optional Parameters]), - -:datetime: - - Allows to store a date and the time of day in the same field. - - Syntax:: - - fields.datetime('Field Name' [, Optional Parameters]), - -:binary: - - A binary chain - -:selection: - - A field which allows the user to make a selection between various predefined values. - - Syntax:: - - fields.selection((('n','Unconfirmed'), ('c','Confirmed')), - 'Field Name' [, Optional Parameters]), - - .. note:: - - Format of the selection parameter: tuple of tuples of strings of the form:: - - (('key_or_value', 'string_to_display'), ... ) - - .. note:: - You can specify a function that will return the tuple. Example :: - - def _get_selection(self, cursor, user_id, context=None): - return ( - ('choice1', 'This is the choice 1'), - ('choice2', 'This is the choice 2')) - - _columns = { - 'sel' : fields.selection( - _get_selection, - 'What do you want ?') - } - - *Example* - - Using relation fields **many2one** with **selection**. In fields definitions add:: - - ..., - 'my_field': fields.many2one( - 'mymodule.relation.model', - 'Title', - selection=_sel_func), - ..., - - And then define the _sel_func like this (but before the fields definitions):: - - def _sel_func(self, cr, uid, context=None): - obj = self.pool.get('mymodule.relation.model') - ids = obj.search(cr, uid, []) - res = obj.read(cr, uid, ids, ['name', 'id'], context) - res = [(r['id'], r['name']) for r in res] - return res - -Relational Types -++++++++++++++++ - -:one2one: - - A one2one field expresses a one:to:one relation between two objects. It is - deprecated. Use many2one instead. - - Syntax:: - - fields.one2one('other.object.name', 'Field Name') - -:many2one: - - Associates this object to a parent object via this Field. For example - Department an Employee belongs to would Many to one. i.e Many employees will - belong to a Department - - Syntax:: - - fields.many2one( - 'other.object.name', - 'Field Name', - optional parameters) - - Optional parameters: - - - ondelete: What should happen when the resource this field points to is deleted. - + Predefined value: "cascade", "set null", "restrict", "no action", "set default" - + Default value: "set null" - - required: True - - readonly: True - - select: True - (creates an index on the Foreign Key field) - - *Example* :: - - 'commercial': fields.many2one( - 'res.users', - 'Commercial', - ondelete='cascade'), - -:one2many: - - TODO - - Syntax:: - - fields.one2many( - 'other.object.name', - 'Field relation id', - 'Fieldname', - optional parameter) - - Optional parameters: - - invisible: True/False - - states: ? - - readonly: True/False - - *Example* :: - - 'address': fields.one2many( - 'res.partner.address', - 'partner_id', - 'Contacts'), - -:many2many: - - TODO - - Syntax:: - - fields.many2many('other.object.name', - 'relation object', - 'actual.object.id', - 'other.object.id', - 'Field Name') - - Where: - - other.object.name is the other object which belongs to the relation - - relation object is the table that makes the link - - actual.object.id and other.object.id are the fields' names used in the relation table - - Example:: - - 'category_ids': - fields.many2many( - 'res.partner.category', - 'res_partner_category_rel', - 'partner_id', - 'category_id', - 'Categories'), - - To make it bidirectional (= create a field in the other object):: - - class other_object_name2(osv.osv): - _inherit = 'other.object.name' - _columns = { - 'other_fields': fields.many2many( - 'actual.object.name', - 'relation object', - 'actual.object.id', - 'other.object.id', - 'Other Field Name'), - } - other_object_name2() - - Example:: - - class res_partner_category2(osv.osv): - _inherit = 'res.partner.category' - _columns = { - 'partner_ids': fields.many2many( - 'res.partner', - 'res_partner_category_rel', - 'category_id', - 'partner_id', - 'Partners'), - } - res_partner_category2() - -:related: - - Sometimes you need to refer to the relation of a relation. For example, - supposing you have objects: City -> State -> Country, and you need to refer to - the Country from a City, you can define a field as below in the City object:: - - 'country_id': fields.related( - 'state_id', - 'country_id', - type="many2one", - relation="res.country", - string="Country", - store=False) - - Where: - - The first set of parameters are the chain of reference fields to - follow, with the desired field at the end. - - :guilabel:`type` is the type of that desired field. - - Use :guilabel:`relation` if the desired field is still some kind of - reference. :guilabel:`relation` is the table to look up that - reference in. - -.. _fields-functional: - -Functional Fields -+++++++++++++++++ - -A functional field is a field whose value is calculated by a function (rather -than being stored in the database). - -**Parameters:** :: - - fnct, arg=None, fnct_inv=None, fnct_inv_arg=None, type="float", - fnct_search=None, obj=None, method=False, store=False, multi=False - -where - - * :guilabel:`fnct` is the function or method that will compute the field - value. It must have been declared before declaring the functional field. - * :guilabel:`fnct_inv` is the function or method that will allow writing - values in that field. - * :guilabel:`type` is the field type name returned by the function. It can - be any field type name except function. - * :guilabel:`fnct_search` allows you to define the searching behaviour on - that field. - * :guilabel:`method` whether the field is computed by a method (of an - object) or a global function - * :guilabel:`store` If you want to store field in database or not. Default - is False. - * :guilabel:`multi` is a group name. All fields with the same `multi` - parameter will be calculated in a single function call. - -fnct parameter -"""""""""""""" -If *method* is True, the signature of the method must be:: - - def fnct(self, cr, uid, ids, field_name, arg, context): - -otherwise (if it is a global function), its signature must be:: - - def fnct(cr, table, ids, field_name, arg, context): - -Either way, it must return a dictionary of values of the form -**{id'_1_': value'_1_', id'_2_': value'_2_',...}.** - -The values of the returned dictionary must be of the type specified by the type -argument in the field declaration. - -If *multi* is set, then *field_name* is replaced by *field_names*: a list -of the field names that should be calculated. Each value in the returned -dictionary is also a dictionary from field name to value. For example, if the -fields `'name'`, and `'age'` are both based on the `vital_statistics` function, -then the return value of `vital_statistics` might look like this when `ids` is -`[1, 2, 5]`:: - - { - 1: {'name': 'Bob', 'age': 23}, - 2: {'name': 'Sally', 'age', 19}, - 5: {'name': 'Ed', 'age': 62} - } - -fnct_inv parameter -"""""""""""""""""" -If *method* is true, the signature of the method must be:: - - def fnct(self, cr, uid, ids, field_name, field_value, arg, context): - - -otherwise (if it is a global function), it should be:: - - def fnct(cr, table, ids, field_name, field_value, arg, context): - -fnct_search parameter -""""""""""""""""""""" -If method is true, the signature of the method must be:: - - def fnct(self, cr, uid, obj, name, args, context): - -otherwise (if it is a global function), it should be:: - - def fnct(cr, uid, obj, name, args, context): - -The return value is a list containing 3-part tuples which are used in search function:: - - return [('id','in',[1,3,5])] - -*obj* is the same as *self*, and *name* receives the field name. *args* is a list -of 3-part tuples containing search criteria for this field, although the search -function may be called separately for each tuple. - -Example -""""""" -Suppose we create a contract object which is : - -.. code-block:: python - - class hr_contract(osv.osv): - _name = 'hr.contract' - _description = 'Contract' - _columns = { - 'name' : fields.char('Contract Name', size=30, required=True), - 'employee_id' : fields.many2one('hr.employee', 'Employee', required=True), - 'function' : fields.many2one('res.partner.function', 'Function'), - } - hr_contract() - -If we want to add a field that retrieves the function of an employee by looking its current contract, we use a functional field. The object hr_employee is inherited this way: - -.. code-block:: python - - class hr_employee(osv.osv): - _name = "hr.employee" - _description = "Employee" - _inherit = "hr.employee" - _columns = { - 'contract_ids' : fields.one2many('hr.contract', 'employee_id', 'Contracts'), - 'function' : fields.function( - _get_cur_function_id, - type='many2one', - obj="res.partner.function", - method=True, - string='Contract Function'), - } - hr_employee() - -.. note:: three points - - * :guilabel:`type` ='many2one' is because the function field must create - a many2one field; function is declared as a many2one in hr_contract also. - * :guilabel:`obj` ="res.partner.function" is used to specify that the - object to use for the many2one field is res.partner.function. - * We called our method :guilabel:`_get_cur_function_id` because its role - is to return a dictionary whose keys are ids of employees, and whose - corresponding values are ids of the function of those employees. The - code of this method is: - -.. code-block:: python - - def _get_cur_function_id(self, cr, uid, ids, field_name, arg, context): - for i in ids: - #get the id of the current function of the employee of identifier "i" - sql_req= """ - SELECT f.id AS func_id - FROM hr_contract c - LEFT JOIN res_partner_function f ON (f.id = c.function) - WHERE - (c.employee_id = %d) - """ % (i,) - - cr.execute(sql_req) - sql_res = cr.dictfetchone() - - if sql_res: #The employee has one associated contract - res[i] = sql_res['func_id'] - else: - #res[i] must be set to False and not to None because of XML:RPC - # "cannot marshal None unless allow_none is enabled" - res[i] = False - return res - -The id of the function is retrieved using a SQL query. Note that if the query -returns no result, the value of sql_res['func_id'] will be None. We force the -False value in this case value because XML:RPC (communication between the server -and the client) doesn't allow to transmit this value. - -store Parameter -""""""""""""""" -It will calculate the field and store the result in the table. The field will be -recalculated when certain fields are changed on other objects. It uses the -following syntax: - -.. code-block:: python - - store = { - 'object_name': ( - function_name, - ['field_name1', 'field_name2'], - priority) - } - -It will call function function_name when any changes are written to fields in the -list ['field1','field2'] on object 'object_name'. The function should have the -following signature:: - - def function_name(self, cr, uid, ids, context=None): - -Where `ids` will be the ids of records in the other object's table that have -changed values in the watched fields. The function should return a list of ids -of records in its own table that should have the field recalculated. That list -will be sent as a parameter for the main function of the field. - -Here's an example from the membership module: - -.. code-block:: python - - 'membership_state': - fields.function( - _membership_state, - method=True, - string='Current membership state', - type='selection', - selection=STATE, - store={ - 'account.invoice': (_get_invoice_partner, ['state'], 10), - 'membership.membership_line': (_get_partner_id,['state'], 10), - 'res.partner': ( - lambda self, cr, uid, ids, c={}: ids, - ['free_member'], - 10) - }), - -Property Fields -+++++++++++++++ - -.. describe:: Declaring a property - -A property is a special field: fields.property. - -.. code-block:: python - - class res_partner(osv.osv): - _name = "res.partner" - _inherit = "res.partner" - _columns = { - 'property_product_pricelist': - fields.property( - 'product.pricelist', - type='many2one', - relation='product.pricelist', - string="Sale Pricelist", - method=True, - group_name="Pricelists Properties"), - } - - -Then you have to create the default value in a .XML file for this property: - -.. code-block:: xml - - - property_product_pricelist - - - - -.. - -.. tip:: - - if the default value points to a resource from another module, you can use the ref function like this: - - - -**Putting properties in forms** - -To add properties in forms, just put the tag in your form. This will automatically add all properties fields that are related to this object. The system will add properties depending on your rights. (some people will be able to change a specific property, others won't). - -Properties are displayed by section, depending on the group_name attribute. (It is rendered in the client like a separator tag). - -**How does this work ?** - -The fields.property class inherits from fields.function and overrides the read and write method. The type of this field is many2one, so in the form a property is represented like a many2one function. - -But the value of a property is stored in the ir.property class/table as a complete record. The stored value is a field of type reference (not many2one) because each property may point to a different object. If you edit properties values (from the administration menu), these are represented like a field of type reference. - -When you read a property, the program gives you the property attached to the instance of object you are reading. If this object has no value, the system will give you the default property. - -The definition of a property is stored in the ir.model.fields class like any other fields. In the definition of the property, you can add groups that are allowed to change to property. - -**Using properties or normal fields** - -When you want to add a new feature, you will have to choose to implement it as a property or as normal field. Use a normal field when you inherit from an object and want to extend this object. Use a property when the new feature is not related to the object but to an external concept. - - -Here are a few tips to help you choose between a normal field or a property: - -Normal fields extend the object, adding more features or data. - -A property is a concept that is attached to an object and have special features: - -* Different value for the same property depending on the company -* Rights management per field -* It's a link between resources (many2one) - -**Example 1: Account Receivable** - -The default "Account Receivable" for a specific partner is implemented as a property because: - - * This is a concept related to the account chart and not to the partner, so it is an account property that is visible on a partner form. Rights have to be managed on this fields for accountants, these are not the same rights that are applied to partner objects. So you have specific rights just for this field of the partner form: only accountants may change the account receivable of a partner. - - * This is a multi-company field: the same partner may have different account receivable values depending on the company the user belongs to. In a multi-company system, there is one account chart per company. The account receivable of a partner depends on the company it placed the sale order. - - * The default account receivable is the same for all partners and is configured from the general property menu (in administration). - -.. note:: - One interesting thing is that properties avoid "spaghetti" code. The account module depends on the partner (base) module. But you can install the partner (base) module without the accounting module. If you add a field that points to an account in the partner object, both objects will depend on each other. It's much more difficult to maintain and code (for instance, try to remove a table when both tables are pointing to each others.) - -**Example 2: Product Times** - -The product expiry module implements all delays related to products: removal date, product usetime, ... This module is very useful for food industries. - -This module inherits from the product.product object and adds new fields to it: - -.. code-block:: python - - class product_product(osv.osv): - - _inherit = 'product.product' - _name = 'product.product' - _columns = { - - 'life_time': fields.integer('Product lifetime'), - 'use_time': fields.integer('Product usetime'), - 'removal_time': fields.integer('Product removal time'), - 'alert_time': fields.integer('Product alert time'), - } - - product_product() - -.. - -This module adds simple fields to the product.product object. We did not use properties because: - - * We extend a product, the life_time field is a concept related to a product, not to another object. - * We do not need a right management per field, the different delays are managed by the same people that manage all products. - - -ORM methods ------------ - -Keeping the context in ORM methods -++++++++++++++++++++++++++++++++++ - -In OpenObject, the context holds very important data such as the language in -which a document must be written, whether function field needs updating or not, -etc. - -When calling an ORM method, you will probably already have a context - for -example the framework will provide you with one as a parameter of almost -every method. -If you do have a context, it is very important that you always pass it through -to every single method you call. - -This rule also applies to writing ORM methods. You should expect to receive a -context as parameter, and always pass it through to every other method you call.. diff --git a/doc/03_module_dev_03.rst b/doc/03_module_dev_03.rst deleted file mode 100644 index 74fb4772f84..00000000000 --- a/doc/03_module_dev_03.rst +++ /dev/null @@ -1,1484 +0,0 @@ -.. _module-dev-views: - -Views and Events -================ - -Introduction to Views ---------------------- - -As all data of the program is stored in objects, as explained in the Objects -section, how are these objects exposed to the user ? We will try to answer this -question in this section. - -First of all, let's note that every resource type uses its own interface. For -example, the screen to modify a partner's data is not the same as the one to -modify an invoice. - -Then, you have to know that the OpenERP user interface is dynamic, it means -that it is not described "statically" by some code, but dynamically built from -XML descriptions of the client screens. - -From now on, we will call these screen descriptions views. - -A notable characteristic of these views is that they can be edited at any -moment (even during the program execution). After a modification to a displayed -view has occurred, you simply need to close the tab corresponding to that -'view' and re-open it for the changes to appear. - -Views principles -++++++++++++++++ - -Views describe how each object (type of resource) is displayed. More precisely, for each object, we can define one (or several) view(s) to describe which fields should be drawn and how. - -There are two types of views: - - #. form views - #. tree views - -.. note:: Since OpenERP 4.1, form views can also contain graphs. - -Form views ----------- - -The field disposition in a form view always follows the same principle. Fields are distributed on the screen following the rules below: - - * By default, each field is preceded by a label, with its name. - * Fields are placed on the screen from left to right, and from top to bottom, according to the order in which they are declared in the view. - * Every screen is divided into 4 columns, each column being able to contain either a label, or an "edition" field. As every edition field is preceded (by default) by a label with its name, there will be two fields (and their respective labels) on each line of the screen. The green and red zones on the screen-shot below, illustrate those 4 columns. They designate respectively the labels and their corresponding fields. - -.. .. figure:: images/sale_order.png -.. :scale: 50 -.. :align: center - - -Views also support more advanced placement options: - - * A view field can use several columns. For example, on the screen-shot below, the zone in the blue frame is, in fact, the only field of a "one to many". We will come back later on this note, but let's note that it uses the whole width of the screen and not only one column. - - .. .. figure:: images/sale_order_sale_order_lines.png - .. :scale: 50 - .. :align: center - - * We can also make the opposite operation: take a columns group and divide it in as many columns as desired. The surrounded green zones of the screen above are good examples. Precisely, the green framework up and on the right side takes the place of two columns, but contains 4 columns. - -As we can see below in the purple zone of the screen, there is also a way to distribute the fields of an object on different tabs. - -.. .. figure:: images/sale_order_notebook.png -.. :scale: 50 -.. :align: center - -On Change -+++++++++ - -The on_change attribute defines a method that is called when the -content of a view field has changed. - -This method takes at least arguments: cr, uid, ids, which are the -three classical arguments and also the context dictionary. You can add -parameters to the method. They must correspond to other fields defined -in the view, and must also be defined in the XML with fields defined -this way:: - - - -The example below is from the sale order view. - -You can use the 'context' keyword to access data in the context that -can be used as params of the function.:: - - - -.. code-block:: python - - def onchange_shop_id(self, cr, uid, ids, shop_id): - - v={} - if shop_id: - - shop=self.pool.get('sale.shop').browse(cr,uid,shop_id) - v['project_id']=shop.project_id.id - if shop.pricelist_id.id: - - v['pricelist_id']=shop.pricelist_id.id - - v['payment_default_id']=shop.payment_default_id.id - - return {'value':v} - - -When editing the shop_id form field, the onchange_shop_id method of -the sale_order object is called and returns a dictionary where the -'value' key contains a dictionary of the new value to use in the -'project_id', 'pricelist_id' and 'payment_default_id' fields. - -Note that it is possible to change more than just the values of -fields. For example, it is possible to change the value of some fields -and the domain of other fields by returning a value of the form: -return {'domain': d, 'value': value} - -:returns: a dictionary with any mix of the following keys: - - ``domain`` - A mapping of ``{field: domain}``. - - The returned domains should be set on the fields instead of the - default ones. - - ``value`` - A mapping of ``{field: value}}``, the values will be set on the - corresponding fields and may trigger new onchanges or attrs - changes - - ``warning`` A dict with the keys ``title`` and ``message``. Both - are mandatory. Indicate that an error message should be - displayed to the user. - - -Tree views ----------- - -These views are used when we work in list mode (in order to visualize several resources at once) and in the search screen. These views are simpler than the form views and thus have less options. - -.. .. figure:: images/tree_view.png -.. :scale: 50 -.. :align: center - -Search views --------------- - -Search views are a new feature of OpenERP supported as of version 6.0 -It creates a customized search panel, and is declared quite similarly to a form view, -except that the view type and root element change to ``search`` instead of ``form``. - -.. .. image:: images/search.png -.. :scale: 50 -.. :align: center - -Following is the list of new elements and features supported in search views. - -Group tag -+++++++++ - -Unlike form group elements, search view groups support unlimited number of widget(fields or filters) -in a row (no automatic line wrapping), and only use the following attributes: - - + ``expand``: turns on the expander icon on the group (1 for expanded by default, 0 for collapsed) - + ``string``: label for the group - -.. code-block:: xml - - - - - - - - -In the screenshot above the green area is an expandable group. - -Filter tag -+++++++++++ -Filters are displayed as a toggle button on search panel -Filter elements can add new values in the current domain or context of the search view. -Filters can be added as a child element of field too, to indicate that they apply specifically -to that field (in this case the button's icon will smaller) - -In the picture above the red area contains filters at the top of the form while -the blue area highlights a field and it's child filter. - -.. code-block:: xml - - - - - - -Group By -++++++++ - -.. code-block:: xml - - - -Above filters groups records sharing the same ``project_id`` value. Groups are loaded -lazily, so the inner records are only loaded when the group is expanded. -The group header lines contain the common values for all records in that group, and all numeric -fields currently displayed in the view are replaced by the sum of the values in that group. - -It is also possible to group on multiple values by specifying a list of fields instead of a single string. -In this case nested groups will be displayed:: - - - -Fields -++++++ - -Field elements in search views are used to get user-provided values -for searches. As a result, as for group elements, they are quite -different than form view's fields: - -* a search field can contain filters, which generally indicate that - both field and filter manage the same field and are related. - - Those inner filters are rendered as smaller buttons, right next to - the field, and *must not* have a ``string`` attribute. - -* a search field really builds a domain composed of ``[(field_name, - operator, field_value)]``. This domain can be overridden in two - ways: - - * ``@operator`` replaces the default operator for the field (which - depends on its type) - - * ``@filter_domain`` lets you provide a fully custom domain, which - will replace the default domain creation - -* a search field does not create a context by default, but you can - provide an ``@context`` which will be evaluated and merged into the - wider context (as with a ``filter`` element). - -To get the value of the field in your ``@context`` or -``@filter_domain``, you can use the variable ``self``: - -.. code-block:: xml - - - -or - -.. code-block:: xml - - - -Range fields (date, datetime, time) -""""""""""""""""""""""""""""""""""" - -The range fields are composed of two input widgets (from and two) -instead of just one. - -This leads to peculiarities (compared to non-range search fields): - -* It is not possible to override the operator of a range field via - ``@operator``, as the domain is built of two sections and each - section uses a different operator. - -* Instead of being a simple value (integer, string, float) ``self`` - for use in ``@filter_domain`` and ``@context`` is a ``dict``. - - Because each input widget of a range field can be empty (and the - field itself will still be valid), care must be taken when using - ``self``: it has two string keys ``"from"`` and ``"to"``, but any of - these keys can be either missing entirely or set to the value - ``False``. - -Actions for Search view -+++++++++++++++++++++++ - -After declaring a search view, it will be used automatically for all tree views on the same model. -If several search views exist for a single model, the one with the highest priority (lowest sequence) will -be used. Another option is to explicitly select the search view you want to use, by setting the -``search_view_id`` field of the action. - -In addition to being able to pass default form values in the context of the action, OpenERP 6.0 now -supports passing initial values for search views too, via the context. The context keys need to match the -``search_default_XXX`` format. ``XXX`` may refer to the ``name`` of a ```` or ```` -in the search view (as the ``name`` attribute is not required on filters, this only works for filters that have -an explicit ``name`` set). The value should be either the initial value for search fields, or -simply a boolean value for filters, to toggle them - -.. code-block:: xml - - - Tasks - project.task - form - tree,form,calendar,gantt,graph - - - {"search_default_current":1,"search_default_user_id":uid} - - - -Custom Filters -++++++++++++++ - -As of v6.0, all search views also features custom search filters, as show below. -Users can define their own custom filters using any of the fields available on the current model, -combining them with AND/OR operators. It is also possible to save any search context (the combination -of all currently applied domain and context values) as a personal filter, which can be recalled -at any time. Filters can also be turned into Shortcuts directly available in the User's homepage. - -.. .. image:: images/filter.png -.. :scale: 50 -.. :align: center - - -In above screenshot we filter Partner where Salesman = Demo user and Country = Belgium, -We can save this search criteria as a Shortcut or save as Filter. - -Filters are user specific and can be modified via the Manage Filters option in the filters drop-down. - - -Graph views ------------ - -A graph is a new mode of view for all views of type form. If, for example, a sale order line must be visible as list or as graph, define it like this in the action that open this sale order line. Do not set the view mode as "tree,form,graph" or "form,graph" - it must be "graph,tree" to show the graph first or "tree,graph" to show the list first. (This view mode is extra to your "form,tree" view and should have a separate menu item): - -.. code-block:: xml - - form - tree,graph - -view_type:: - - tree = (tree with shortcuts at the left), form = (switchable view form/list) - -view_mode:: - - tree,graph : sequences of the views when switching - -Then, the user will be able to switch from one view to the other. Unlike forms and trees, OpenERP is not able to automatically create a view on demand for the graph type. So, you must define a view for this graph: - - -.. code-block:: xml - - - sale.order.line.graph - sale.order.line - graph - - - - - - - - - -The graph view - -A view of type graph is just a list of fields for the graph. - -Graph tag -++++++++++ - -The default type of the graph is a pie chart - to change it to a barchart change **** to **** You also may change the orientation. - -:Example : - -.. code-block:: xml - - - -Field tag -+++++++++ - -The first field is the X axis. The second one is the Y axis and the optional third one is the Z axis for 3 dimensional graphs. You can apply a few attributes to each field/axis: - - * **group**: if set to true, the client will group all item of the same value for this field. For each other field, it will apply an operator - * **operator**: the operator to apply is another field is grouped. By default it's '+'. Allowed values are: - - + +: addition - + \*: multiply - + \**: exponent - + min: minimum of the list - + max: maximum of the list - -:Defining real statistics on objects: - -The easiest method to compute real statistics on objects is: - - 1. Define a statistic object which is a postgresql view - 2. Create a tree view and a graph view on this object - -You can get en example in all modules of the form: report\_.... Example: report_crm. - - -Controlling view actions ------------------------- - -When defining a view, the following attributes can be added on the -opening element of the view (i.e. ``
``, ````...) - -``create`` - set to ``false`` to hide the link / button which allows to create a new - record. - -``delete`` - set to ``false`` to hide the link / button which allows to remove a - record. - -``edit`` - set to ``false`` to hide the link / button which allows to - edit a record. - - -These attributes are available on form, tree, kanban and gantt -views. They are normally automatically set from the access rights of -the users, but can be forced globally in the view definition. A -possible use case for these attributes is to define an inner tree view -for a one2many relation inside a form view, in which the user cannot -add or remove related records, but only edit the existing ones (which -are presumably created through another way, such as a wizard). - - -Calendar Views --------------- - -Calendar view provides timeline/schedule view for the data. - -View Specification -++++++++++++++++++ - -Here is an example view: - -.. code-block:: xml - - - - - - -Here is the list of supported attributes for ``calendar`` tag: - - ``string`` - The title string for the view. - - ``date_start`` - A ``datetime`` field to specify the starting date for the calendar item. This - attribute is required. - - ``date_stop`` - A ``datetime`` field to specify the end date. Ignored if ``date_delay`` - attribute is specified. - - ``date_delay`` - A ``numeric`` field to specify time in hours for a record. This attribute - will get preference over ``date_stop`` and ``date_stop`` will be ignored. - - ``day_length`` - An ``integer`` value to specify working day length. Default is ``8`` hours. - - ``color`` - A field, generally ``many2one``, to colorize calendar/gantt items. - - ``mode`` - A string value to set default view/zoom mode. For ``calendar`` view, this can be - one of following (default is ``month``): - - * ``day`` - * ``week`` - * ``month`` - -Screenshots -+++++++++++ - -Month Calendar: - -.. .. figure:: images/calendar_month.png -.. :scale: 50% -.. :align: center - -Week Calendar: - -.. .. figure:: images/calendar_week.png -.. :scale: 50% -.. :align: center - - -Gantt Views ------------ - -Gantt view provides timeline view for the data. Generally, it can be used to display -project tasks and resource allocation. - -A Gantt chart is a graphical display of all the tasks that a project is composed of. -Each bar on the chart is a graphical representation of the length of time the task is -planned to take. - -A resource allocation summary bar is shown on top of all the grouped tasks, -representing how effectively the resources are allocated among the tasks. - -Color coding of the summary bar is as follows: - - * `Gray` shows that the resource is not allocated to any task at that time - * `Blue` shows that the resource is fully allocated at that time. - * `Red` shows that the resource is overallocated - -View Specification -++++++++++++++++++ - -Here is an example view: - -.. code-block:: xml - - - - - - - -The ``attributes`` accepted by the ``gantt`` tag are similar to ``calendar`` view tag. The -``level`` tag is used to group the records by some ``many2one`` field. Currently, only -one level is supported. - -Here is the list of supported attributes for ``gantt`` tag: - - ``string`` - The title string for the view. - - ``date_start`` - A ``datetime`` field to specify the starting date for the gantt item. This - attribute is required. - - ``date_stop`` - A ``datetime`` field to specify the end date. Ignored if ``date_delay`` - attribute is specified. - - ``date_delay`` - A ``numeric`` field to specify time in hours for a record. This attribute - will get preference over ``date_stop`` and ``date_stop`` will be ignored. - - ``day_length`` - An ``integer`` value to specify working day length. Default is ``8`` hours. - - ``color`` - A field, generally ``many2one``, to colorize calendar/gantt items. - - ``mode`` - A string value to set default view/zoom mode. For ``gantt`` view, this can be - one of following (default is ``month``): - - * ``day`` - * ``3days`` - * ``week`` - * ``3weeks`` - * ``month`` - * ``3months`` - * ``year`` - * ``3years`` - * ``5years`` - -The ``level`` tag supports following attributes: - - ``object`` - An openerp object having many2one relationship with view object. - - ``link`` - The field name in current object that links to the given ``object``. - - ``domain`` - The domain to be used to filter the given ``object`` records. - -Drag and Drop -+++++++++++++ - -The left side pane displays list of the tasks grouped by the given ``level`` field. -You can reorder or change the group of any records by dragging them. - -The main content pane displays horizontal bars plotted on a timeline grid. A group -of bars are summarized with a top summary bar displaying resource allocation of all -the underlying tasks. - -You can change the task start time by dragging the tasks horizontally. While -end time can be changed by dragging right end of a bar. - -.. note:: - - The time is calculated considering ``day_length`` so a bar will span more - then one day if total time for a task is greater then ``day_length`` value. - -Screenshots -+++++++++++ - -.. .. figure:: images/gantt.png -.. :scale: 50% -.. :align: center - - -Design Elements ---------------- - -The files describing the views are of the form: - -:Example: - -.. code-block:: xml - - - - - [view definitions] - - - -The view definitions contain mainly three types of tags: - - * **** tags with the attribute model="ir.ui.view", which contain the view definitions themselves - * **** tags with the attribute model="ir.actions.act_window", which link actions to these views - * **** tags, which create entries in the menu, and link them with actions - -New : You can specify groups for whom the menu is accessible using the groups -attribute in the `menuitem` tag. - -New : You can now add shortcut using the `shortcut` tag. - -:Example: - -.. code-block:: xml - - - -Note that you should add an id attribute on the `menuitem` which is referred by -menu attribute. - -.. code-block:: xml - - - sale.order.form - sale.order - - - - ......... - - - - -Default value for the priority field : 16. When not specified the system will use the view with the lower priority. - -View Types -++++++++++ - -Tree View -""""""""" -You can specify the columns to include in the list, along with some details of -the list's appearance. The search fields aren't specified here, they're -specified by the `select` attribute in the form view fields. - -.. code-block:: xml - - - stock.location.tree - stock.location - tree - - - - - - - - - - - - -That example is just a flat list, but you can also display a real tree structure -by specifying a `field_parent`. The name is a bit misleading, though; the field -you specify must contain a list of all **child** entries. - -.. code-block:: xml - - - stock.location.tree - stock.location - tree - child_ids - - - - - - - - -On the `tree` element, the following attributes are supported: - -colors - Conditions for applying different colors to items in the list. The default - is black. -toolbar - Set this to 1 if you want a tree structure to list the top level entries - in a separate toolbar area. When you click on an entry in the toolbar, all - its descendants will be displayed in the main tree. The value is ignored - for flat lists. - - -Grouping Elements -+++++++++++++++++ - -Separator -""""""""" - -Adds a separator line - -:Example: - -.. code-block:: xml - - - -The string attribute defines its label and the colspan attribute defines his horizontal size (in number of columns). - -Notebook -"""""""" - -: With notebooks you can distribute the view fields on different tabs (each one defined by a page tag). You can use the tabpos properties to set tab at: up, down, left, right. - -:Example: - -.. code-block:: xml - - .... - -Group -""""" - -: groups several columns and split the group in as many columns as desired. - - * **colspan**: the number of columns to use - * **rowspan**: the number of rows to use - * **expand**: if we should expand the group or not - * **col**: the number of columns to provide (to its children) - * **string**: (optional) If set, a frame will be drawn around the group of fields, with a label containing the string. Otherwise, the frame will be invisible. - -:Example: - -.. code-block:: xml - - - - + + + + + +{%- endblock -%} +{%- block relbar2 -%}{%- endblock -%} + +{%- block footer %} + +{%- endblock %} diff --git a/doc/_themes/odoodoc/odoo_pygments.py b/doc/_themes/odoodoc/odoo_pygments.py new file mode 100644 index 00000000000..795c0a7fb21 --- /dev/null +++ b/doc/_themes/odoodoc/odoo_pygments.py @@ -0,0 +1,70 @@ +# -*- coding: utf-8 -*- + +import imp +import sys + +from pygments.style import Style +from pygments.token import * + +# extracted from getbootstrap.com +class OdooStyle(Style): + background_color = '#ffffcc' + highlight_color = '#fcf8e3' + styles = { + Whitespace: '#BBB', + Error: 'bg:#FAA #A00', + + Keyword: '#069', + Keyword.Type: '#078', + + Name.Attribute: '#4F9FCF', + Name.Builtin: '#366', + Name.Class: '#0A8', + Name.Constant: '#360', + Name.Decorator: '#99F', + Name.Entity: '#999', + Name.Exception: '#C00', + Name.Function: '#C0F', + Name.Label: '#99F', + Name.Namespace: '#0CF', + Name.Tag: '#2F6F9F', + Name.Variable: '#033', + + String: '#d44950', + String.Backtick: '#C30', + String.Char: '#C30', + String.Doc: 'italic #C30', + String.Double: '#C30', + String.Escape: '#C30', + String.Heredoc: '#C30', + String.Interol: '#C30', + String.Other: '#C30', + String.Regex: '#3AA', + String.Single: '#C30', + String.Symbol: '#FC3', + + Number: '#F60', + + Operator: '#555', + Operator.Word: '#000', + + Comment: '#999', + Comment.Preproc: '#099', + + Generic.Deleted: 'bg:#FCC border:#c00', + Generic.Emph: 'italic', + Generic.Error: '#F00', + Generic.Heading: '#030', + Generic.Inserted: 'bg:#CFC border:#0C0', + Generic.Output: '#AAA', + Generic.Prompt: '#009', + Generic.Strong: '', + Generic.Subheading: '#030', + Generic.Traceback: '#9C6', + } + + +modname = 'pygments.styles.odoo' +m = imp.new_module(modname) +m.OdooStyle = OdooStyle +sys.modules[modname] = m diff --git a/doc/_themes/odoodoc/sphinx_monkeypatch.py b/doc/_themes/odoodoc/sphinx_monkeypatch.py new file mode 100644 index 00000000000..60b8b115b66 --- /dev/null +++ b/doc/_themes/odoodoc/sphinx_monkeypatch.py @@ -0,0 +1,85 @@ +# -*- coding: utf-8 -*- +import sphinx.roles +import sphinx.environment +from sphinx.builders.html import StandaloneHTMLBuilder +from sphinx.writers.html import HTMLTranslator +from docutils.writers.html4css1 import HTMLTranslator as DocutilsTranslator + +def patch(): + # navify toctree (oh god) + @monkey(sphinx.environment.BuildEnvironment) + def resolve_toctree(old_resolve, self, *args, **kwargs): + """ If main_navbar, bootstrapify TOC to yield a navbar + + """ + main_navbar = kwargs.pop('main_navbar', False) + toc = old_resolve(self, *args, **kwargs) + if toc is None: + return None + + if main_navbar: + navbarify(toc[0]) + return toc + + @monkey(StandaloneHTMLBuilder) + def _get_local_toctree(old_local, self, *args, **kwargs): + """ _get_local_toctree generates a documentation toctree for the local + document (?), called from handle_page + """ + return old_local(self, *args, main_navbar=True, **kwargs) + + # monkeypatch visit_table to remove border and add .table + HTMLTranslator.visit_table = visit_table + # disable colspec crap + HTMLTranslator.write_colspecs = lambda self: None + # copy data- attributes straight from source to dest + HTMLTranslator.starttag = starttag_data + +def navbarify(node): + # add classes to toplevel + node['classes'].extend(['nav', 'navbar-nav', 'navbar-right']) + for list_item in node.children: + # bullet_list + # list_item + # compact_paragraph + # reference + # bullet_list + # list_item + # compact_paragraph + # reference + list_item['classes'].append('dropdown') + # list_item.compact_paragraph.reference + link = list_item.children[0].children[0] + link['classes'].append('dropdown-toggle') + link.attributes['data-toggle'] = 'dropdown' + # list_item.bullet_list + list_item.children[1]['classes'].append('dropdown-menu') + +def visit_table(self, node): + """ + * remove border + * add table class + """ + self._table_row_index = 0 + self.context.append(self.compact_p) + self.compact_p = True + classes = ' '.join({'table', self.settings.table_style}).strip() + self.body.append(self.starttag(node, 'table', CLASS=classes)) + +def starttag_data(self, node, tagname, suffix='\n', empty=False, **attributes): + attributes.update( + (k, v) for k, v in node.attributes.iteritems() + if k.startswith('data-') + ) + # oh dear + return DocutilsTranslator.starttag( + self, node, tagname, suffix=suffix, empty=empty, **attributes) + +class monkey(object): + def __init__(self, obj): + self.obj = obj + def __call__(self, fn): + name = fn.__name__ + old = getattr(self.obj, name) + setattr(self.obj, name, lambda self_, *args, **kwargs: \ + fn(old, self_, *args, **kwargs)) diff --git a/doc/_themes/odoodoc/static/ZeroClipboard.min.js b/doc/_themes/odoodoc/static/ZeroClipboard.min.js new file mode 100644 index 00000000000..56402340713 --- /dev/null +++ b/doc/_themes/odoodoc/static/ZeroClipboard.min.js @@ -0,0 +1,9 @@ +/*! +* ZeroClipboard +* The ZeroClipboard library provides an easy way to copy text to the clipboard using an invisible Adobe Flash movie and a JavaScript interface. +* Copyright (c) 2014 Jon Rohan, James M. Greene +* Licensed MIT +* http://zeroclipboard.org/ +* v1.3.5 +*/ +!function(a){"use strict";function b(a){return a.replace(/,/g,".").replace(/[^0-9\.]/g,"")}function c(a){return parseFloat(b(a))>=10}var d,e={bridge:null,version:"0.0.0",disabled:null,outdated:null,ready:null},f={},g=0,h={},i=0,j={},k=null,l=null,m=function(){var a,b,c,d,e="ZeroClipboard.swf";if(document.currentScript&&(d=document.currentScript.src));else{var f=document.getElementsByTagName("script");if("readyState"in f[0])for(a=f.length;a--&&("interactive"!==f[a].readyState||!(d=f[a].src)););else if("loading"===document.readyState)d=f[f.length-1].src;else{for(a=f.length;a--;){if(c=f[a].src,!c){b=null;break}if(c=c.split("#")[0].split("?")[0],c=c.slice(0,c.lastIndexOf("/")+1),null==b)b=c;else if(b!==c){b=null;break}}null!==b&&(d=b)}}return d&&(d=d.split("#")[0].split("?")[0],e=d.slice(0,d.lastIndexOf("/")+1)+e),e}(),n=function(){var a=/\-([a-z])/g,b=function(a,b){return b.toUpperCase()};return function(c){return c.replace(a,b)}}(),o=function(b,c){var d,e,f;return a.getComputedStyle?d=a.getComputedStyle(b,null).getPropertyValue(c):(e=n(c),d=b.currentStyle?b.currentStyle[e]:b.style[e]),"cursor"!==c||d&&"auto"!==d||(f=b.tagName.toLowerCase(),"a"!==f)?d:"pointer"},p=function(b){b||(b=a.event);var c;this!==a?c=this:b.target?c=b.target:b.srcElement&&(c=b.srcElement),K.activate(c)},q=function(a,b,c){a&&1===a.nodeType&&(a.addEventListener?a.addEventListener(b,c,!1):a.attachEvent&&a.attachEvent("on"+b,c))},r=function(a,b,c){a&&1===a.nodeType&&(a.removeEventListener?a.removeEventListener(b,c,!1):a.detachEvent&&a.detachEvent("on"+b,c))},s=function(a,b){if(!a||1!==a.nodeType)return a;if(a.classList)return a.classList.contains(b)||a.classList.add(b),a;if(b&&"string"==typeof b){var c=(b||"").split(/\s+/);if(1===a.nodeType)if(a.className){for(var d=" "+a.className+" ",e=a.className,f=0,g=c.length;g>f;f++)d.indexOf(" "+c[f]+" ")<0&&(e+=" "+c[f]);a.className=e.replace(/^\s+|\s+$/g,"")}else a.className=b}return a},t=function(a,b){if(!a||1!==a.nodeType)return a;if(a.classList)return a.classList.contains(b)&&a.classList.remove(b),a;if(b&&"string"==typeof b||void 0===b){var c=(b||"").split(/\s+/);if(1===a.nodeType&&a.className)if(b){for(var d=(" "+a.className+" ").replace(/[\n\t]/g," "),e=0,f=c.length;f>e;e++)d=d.replace(" "+c[e]+" "," ");a.className=d.replace(/^\s+|\s+$/g,"")}else a.className=""}return a},u=function(){var a,b,c,d=1;return"function"==typeof document.body.getBoundingClientRect&&(a=document.body.getBoundingClientRect(),b=a.right-a.left,c=document.body.offsetWidth,d=Math.round(b/c*100)/100),d},v=function(b,c){var d={left:0,top:0,width:0,height:0,zIndex:B(c)-1};if(b.getBoundingClientRect){var e,f,g,h=b.getBoundingClientRect();"pageXOffset"in a&&"pageYOffset"in a?(e=a.pageXOffset,f=a.pageYOffset):(g=u(),e=Math.round(document.documentElement.scrollLeft/g),f=Math.round(document.documentElement.scrollTop/g));var i=document.documentElement.clientLeft||0,j=document.documentElement.clientTop||0;d.left=h.left+e-i,d.top=h.top+f-j,d.width="width"in h?h.width:h.right-h.left,d.height="height"in h?h.height:h.bottom-h.top}return d},w=function(a,b){var c=null==b||b&&b.cacheBust===!0&&b.useNoCache===!0;return c?(-1===a.indexOf("?")?"?":"&")+"noCache="+(new Date).getTime():""},x=function(b){var c,d,e,f=[],g=[],h=[];if(b.trustedOrigins&&("string"==typeof b.trustedOrigins?g.push(b.trustedOrigins):"object"==typeof b.trustedOrigins&&"length"in b.trustedOrigins&&(g=g.concat(b.trustedOrigins))),b.trustedDomains&&("string"==typeof b.trustedDomains?g.push(b.trustedDomains):"object"==typeof b.trustedDomains&&"length"in b.trustedDomains&&(g=g.concat(b.trustedDomains))),g.length)for(c=0,d=g.length;d>c;c++)if(g.hasOwnProperty(c)&&g[c]&&"string"==typeof g[c]){if(e=E(g[c]),!e)continue;if("*"===e){h=[e];break}h.push.apply(h,[e,"//"+e,a.location.protocol+"//"+e])}return h.length&&f.push("trustedOrigins="+encodeURIComponent(h.join(","))),"string"==typeof b.jsModuleId&&b.jsModuleId&&f.push("jsModuleId="+encodeURIComponent(b.jsModuleId)),f.join("&")},y=function(a,b,c){if("function"==typeof b.indexOf)return b.indexOf(a,c);var d,e=b.length;for("undefined"==typeof c?c=0:0>c&&(c=e+c),d=c;e>d;d++)if(b.hasOwnProperty(d)&&b[d]===a)return d;return-1},z=function(a){if("string"==typeof a)throw new TypeError("ZeroClipboard doesn't accept query strings.");return a.length?a:[a]},A=function(b,c,d,e){e?a.setTimeout(function(){b.apply(c,d)},0):b.apply(c,d)},B=function(a){var b,c;return a&&("number"==typeof a&&a>0?b=a:"string"==typeof a&&(c=parseInt(a,10))&&!isNaN(c)&&c>0&&(b=c)),b||("number"==typeof N.zIndex&&N.zIndex>0?b=N.zIndex:"string"==typeof N.zIndex&&(c=parseInt(N.zIndex,10))&&!isNaN(c)&&c>0&&(b=c)),b||0},C=function(a,b){if(a&&b!==!1&&"undefined"!=typeof console&&console&&(console.warn||console.log)){var c="`"+a+"` is deprecated. See docs for more info:\n https://github.com/zeroclipboard/zeroclipboard/blob/master/docs/instructions.md#deprecations";console.warn?console.warn(c):console.log(c)}},D=function(){var a,b,c,d,e,f,g=arguments[0]||{};for(a=1,b=arguments.length;b>a;a++)if(null!=(c=arguments[a]))for(d in c)if(c.hasOwnProperty(d)){if(e=g[d],f=c[d],g===f)continue;void 0!==f&&(g[d]=f)}return g},E=function(a){if(null==a||""===a)return null;if(a=a.replace(/^\s+|\s+$/g,""),""===a)return null;var b=a.indexOf("//");a=-1===b?a:a.slice(b+2);var c=a.indexOf("/");return a=-1===c?a:-1===b||0===c?null:a.slice(0,c),a&&".swf"===a.slice(-4).toLowerCase()?null:a||null},F=function(){var a=function(a,b){var c,d,e;if(null!=a&&"*"!==b[0]&&("string"==typeof a&&(a=[a]),"object"==typeof a&&"length"in a))for(c=0,d=a.length;d>c;c++)if(a.hasOwnProperty(c)&&(e=E(a[c]))){if("*"===e){b.length=0,b.push("*");break}-1===y(e,b)&&b.push(e)}},b={always:"always",samedomain:"sameDomain",never:"never"};return function(c,d){var e,f=d.allowScriptAccess;if("string"==typeof f&&(e=f.toLowerCase())&&/^always|samedomain|never$/.test(e))return b[e];var g=E(d.moviePath);null===g&&(g=c);var h=[];a(d.trustedOrigins,h),a(d.trustedDomains,h);var i=h.length;if(i>0){if(1===i&&"*"===h[0])return"always";if(-1!==y(c,h))return 1===i&&c===g?"sameDomain":"always"}return"never"}}(),G=function(a){if(null==a)return[];if(Object.keys)return Object.keys(a);var b=[];for(var c in a)a.hasOwnProperty(c)&&b.push(c);return b},H=function(a){if(a)for(var b in a)a.hasOwnProperty(b)&&delete a[b];return a},I=function(){try{return document.activeElement}catch(a){}return null},J=function(){var a=!1;if("boolean"==typeof e.disabled)a=e.disabled===!1;else{if("function"==typeof ActiveXObject)try{new ActiveXObject("ShockwaveFlash.ShockwaveFlash")&&(a=!0)}catch(b){}!a&&navigator.mimeTypes["application/x-shockwave-flash"]&&(a=!0)}return a},K=function(a,b){return this instanceof K?(this.id=""+g++,h[this.id]={instance:this,elements:[],handlers:{}},a&&this.clip(a),"undefined"!=typeof b&&(C("new ZeroClipboard(elements, options)",N.debug),K.config(b)),this.options=K.config(),"boolean"!=typeof e.disabled&&(e.disabled=!J()),e.disabled===!1&&e.outdated!==!0&&null===e.bridge&&(e.outdated=!1,e.ready=!1,O()),void 0):new K(a,b)};K.prototype.setText=function(a){return a&&""!==a&&(f["text/plain"]=a,e.ready===!0&&e.bridge&&"function"==typeof e.bridge.setText?e.bridge.setText(a):e.ready=!1),this},K.prototype.setSize=function(a,b){return e.ready===!0&&e.bridge&&"function"==typeof e.bridge.setSize?e.bridge.setSize(a,b):e.ready=!1,this};var L=function(a){e.ready===!0&&e.bridge&&"function"==typeof e.bridge.setHandCursor?e.bridge.setHandCursor(a):e.ready=!1};K.prototype.destroy=function(){this.unclip(),this.off(),delete h[this.id]};var M=function(){var a,b,c,d=[],e=G(h);for(a=0,b=e.length;b>a;a++)c=h[e[a]].instance,c&&c instanceof K&&d.push(c);return d};K.version="1.3.5";var N={swfPath:m,trustedDomains:a.location.host?[a.location.host]:[],cacheBust:!0,forceHandCursor:!1,zIndex:999999999,debug:!0,title:null,autoActivate:!0};K.config=function(a){"object"==typeof a&&null!==a&&D(N,a);{if("string"!=typeof a||!a){var b={};for(var c in N)N.hasOwnProperty(c)&&(b[c]="object"==typeof N[c]&&null!==N[c]?"length"in N[c]?N[c].slice(0):D({},N[c]):N[c]);return b}if(N.hasOwnProperty(a))return N[a]}},K.destroy=function(){K.deactivate();for(var a in h)if(h.hasOwnProperty(a)&&h[a]){var b=h[a].instance;b&&"function"==typeof b.destroy&&b.destroy()}var c=P(e.bridge);c&&c.parentNode&&(c.parentNode.removeChild(c),e.ready=null,e.bridge=null)},K.activate=function(a){d&&(t(d,N.hoverClass),t(d,N.activeClass)),d=a,s(a,N.hoverClass),Q();var b=N.title||a.getAttribute("title");if(b){var c=P(e.bridge);c&&c.setAttribute("title",b)}var f=N.forceHandCursor===!0||"pointer"===o(a,"cursor");L(f)},K.deactivate=function(){var a=P(e.bridge);a&&(a.style.left="0px",a.style.top="-9999px",a.removeAttribute("title")),d&&(t(d,N.hoverClass),t(d,N.activeClass),d=null)};var O=function(){var b,c,d=document.getElementById("global-zeroclipboard-html-bridge");if(!d){var f=K.config();f.jsModuleId="string"==typeof k&&k||"string"==typeof l&&l||null;var g=F(a.location.host,N),h=x(f),i=N.moviePath+w(N.moviePath,N),j=' ';d=document.createElement("div"),d.id="global-zeroclipboard-html-bridge",d.setAttribute("class","global-zeroclipboard-container"),d.style.position="absolute",d.style.left="0px",d.style.top="-9999px",d.style.width="15px",d.style.height="15px",d.style.zIndex=""+B(N.zIndex),document.body.appendChild(d),d.innerHTML=j}b=document["global-zeroclipboard-flash-bridge"],b&&(c=b.length)&&(b=b[c-1]),e.bridge=b||d.children[0].lastElementChild},P=function(a){for(var b=/^OBJECT|EMBED$/,c=a&&a.parentNode;c&&b.test(c.nodeName)&&c.parentNode;)c=c.parentNode;return c||null},Q=function(){if(d){var a=v(d,N.zIndex),b=P(e.bridge);b&&(b.style.top=a.top+"px",b.style.left=a.left+"px",b.style.width=a.width+"px",b.style.height=a.height+"px",b.style.zIndex=a.zIndex+1),e.ready===!0&&e.bridge&&"function"==typeof e.bridge.setSize?e.bridge.setSize(a.width,a.height):e.ready=!1}return this};K.prototype.on=function(a,b){var c,d,f,g={},i=h[this.id]&&h[this.id].handlers;if("string"==typeof a&&a)f=a.toLowerCase().split(/\s+/);else if("object"==typeof a&&a&&"undefined"==typeof b)for(c in a)a.hasOwnProperty(c)&&"string"==typeof c&&c&&"function"==typeof a[c]&&this.on(c,a[c]);if(f&&f.length){for(c=0,d=f.length;d>c;c++)a=f[c].replace(/^on/,""),g[a]=!0,i[a]||(i[a]=[]),i[a].push(b);g.noflash&&e.disabled&&T.call(this,"noflash",{}),g.wrongflash&&e.outdated&&T.call(this,"wrongflash",{flashVersion:e.version}),g.load&&e.ready&&T.call(this,"load",{flashVersion:e.version})}return this},K.prototype.off=function(a,b){var c,d,e,f,g,i=h[this.id]&&h[this.id].handlers;if(0===arguments.length)f=G(i);else if("string"==typeof a&&a)f=a.split(/\s+/);else if("object"==typeof a&&a&&"undefined"==typeof b)for(c in a)a.hasOwnProperty(c)&&"string"==typeof c&&c&&"function"==typeof a[c]&&this.off(c,a[c]);if(f&&f.length)for(c=0,d=f.length;d>c;c++)if(a=f[c].toLowerCase().replace(/^on/,""),g=i[a],g&&g.length)if(b)for(e=y(b,g);-1!==e;)g.splice(e,1),e=y(b,g,e);else i[a].length=0;return this},K.prototype.handlers=function(a){var b,c=null,d=h[this.id]&&h[this.id].handlers;if(d){if("string"==typeof a&&a)return d[a]?d[a].slice(0):null;c={};for(b in d)d.hasOwnProperty(b)&&d[b]&&(c[b]=d[b].slice(0))}return c};var R=function(b,c,d,e){var f=h[this.id]&&h[this.id].handlers[b];if(f&&f.length){var g,i,j,k=c||this;for(g=0,i=f.length;i>g;g++)j=f[g],c=k,"string"==typeof j&&"function"==typeof a[j]&&(j=a[j]),"object"==typeof j&&j&&"function"==typeof j.handleEvent&&(c=j,j=j.handleEvent),"function"==typeof j&&A(j,c,d,e)}return this};K.prototype.clip=function(a){a=z(a);for(var b=0;bd;d++)f=h[c[d]].instance,f&&f instanceof K&&g.push(f);return g};N.hoverClass="zeroclipboard-is-hover",N.activeClass="zeroclipboard-is-active",N.trustedOrigins=null,N.allowScriptAccess=null,N.useNoCache=!0,N.moviePath="ZeroClipboard.swf",K.detectFlashSupport=function(){return C("ZeroClipboard.detectFlashSupport",N.debug),J()},K.dispatch=function(a,b){if("string"==typeof a&&a){var c=a.toLowerCase().replace(/^on/,"");if(c)for(var e=d&&N.autoActivate===!0?S(d):M(),f=0,g=e.length;g>f;f++)T.call(e[f],c,b)}},K.prototype.setHandCursor=function(a){return C("ZeroClipboard.prototype.setHandCursor",N.debug),a="boolean"==typeof a?a:!!a,L(a),N.forceHandCursor=a,this},K.prototype.reposition=function(){return C("ZeroClipboard.prototype.reposition",N.debug),Q()},K.prototype.receiveEvent=function(a,b){if(C("ZeroClipboard.prototype.receiveEvent",N.debug),"string"==typeof a&&a){var c=a.toLowerCase().replace(/^on/,"");c&&T.call(this,c,b)}},K.prototype.setCurrent=function(a){return C("ZeroClipboard.prototype.setCurrent",N.debug),K.activate(a),this},K.prototype.resetBridge=function(){return C("ZeroClipboard.prototype.resetBridge",N.debug),K.deactivate(),this},K.prototype.setTitle=function(a){if(C("ZeroClipboard.prototype.setTitle",N.debug),a=a||N.title||d&&d.getAttribute("title")){var b=P(e.bridge);b&&b.setAttribute("title",a)}return this},K.setDefaults=function(a){C("ZeroClipboard.setDefaults",N.debug),K.config(a)},K.prototype.addEventListener=function(a,b){return C("ZeroClipboard.prototype.addEventListener",N.debug),this.on(a,b)},K.prototype.removeEventListener=function(a,b){return C("ZeroClipboard.prototype.removeEventListener",N.debug),this.off(a,b)},K.prototype.ready=function(){return C("ZeroClipboard.prototype.ready",N.debug),e.ready===!0};var T=function(a,g){a=a.toLowerCase().replace(/^on/,"");var h=g&&g.flashVersion&&b(g.flashVersion)||null,i=d,j=!0;switch(a){case"load":if(h){if(!c(h))return T.call(this,"onWrongFlash",{flashVersion:h}),void 0;e.outdated=!1,e.ready=!0,e.version=h}break;case"wrongflash":h&&!c(h)&&(e.outdated=!0,e.ready=!1,e.version=h);break;case"mouseover":s(i,N.hoverClass);break;case"mouseout":N.autoActivate===!0&&K.deactivate();break;case"mousedown":s(i,N.activeClass);break;case"mouseup":t(i,N.activeClass);break;case"datarequested":if(i){var k=i.getAttribute("data-clipboard-target"),l=k?document.getElementById(k):null;if(l){var m=l.value||l.textContent||l.innerText;m&&this.setText(m)}else{var n=i.getAttribute("data-clipboard-text");n&&this.setText(n)}}j=!1;break;case"complete":H(f),i&&i!==I()&&i.focus&&i.focus()}var o=i,p=[this,g];return R.call(this,a,o,p,j)};"function"==typeof define&&define.amd?define(["require","exports","module"],function(a,b,c){return k=c&&c.id||null,K}):"object"==typeof module&&module&&"object"==typeof module.exports&&module.exports&&"function"==typeof a.require?(l=module.id||null,module.exports=K):a.ZeroClipboard=K}(function(){return this}()); \ No newline at end of file diff --git a/doc/_themes/odoodoc/static/ZeroClipboard.swf b/doc/_themes/odoodoc/static/ZeroClipboard.swf new file mode 100644 index 00000000000..55ccf9608ed Binary files /dev/null and b/doc/_themes/odoodoc/static/ZeroClipboard.swf differ diff --git a/doc/_themes/odoodoc/static/app.js b/doc/_themes/odoodoc/static/app.js new file mode 100644 index 00000000000..3619cd9cff1 --- /dev/null +++ b/doc/_themes/odoodoc/static/app.js @@ -0,0 +1,79 @@ +$(function () { + var $body = $(document.body); + $body.scrollspy({ target: '.sphinxsidebarwrapper' }); + $(window).on('load', function () { + $body.scrollspy('refresh'); + }); + + // Sidenav affixing + setTimeout(function () { + var $sideBar = $('.sphinxsidebarwrapper'); + + $sideBar.affix({ + offset: { + top: function () { + var offsetTop = $sideBar.offset().top; + var sideBarMargin = parseInt($sideBar.children(0).css('margin-top'), 10); + var navOuterHeight = $('.docs-nav').height(); + + return (this.top = offsetTop - navOuterHeight - sideBarMargin); + }, + bottom: function () { + return (this.bottom = $('div.footer').outerHeight(true)); + } + } + }); + }, 100); + + // Config ZeroClipboard + ZeroClipboard.config({ + moviePath: '_static/ZeroClipboard.swf', + hoverClass: 'btn-clipboard-hover' + }); + + // Insert copy to clipboard button before .highlight or .example + $('.highlight-html, .highlight-scss').each(function () { + var highlight = $(this); + var previous = highlight.prev(); + var btnHtml = '
Copy
'; + + if (previous.hasClass('example')) { + previous.before(btnHtml.replace(/btn-clipboard/, 'btn-clipboard with-example')); + } else { + highlight.before(btnHtml); + } + }); + var zeroClipboard = new ZeroClipboard($('.btn-clipboard')); + var htmlBridge = $('#global-zeroclipboard-html-bridge'); + + // Handlers for ZeroClipboard + zeroClipboard.on('load', function () { + htmlBridge + .data('placement', 'top') + .attr('title', 'Copy to clipboard') + .tooltip(); + }); + + // Copy to clipboard + zeroClipboard.on('dataRequested', function (client) { + var highlight = $(this).parent().nextAll('.highlight').first(); + client.setText(highlight.text()); + }); + + // Notify copy success and reset tooltip title + zeroClipboard.on('complete', function () { + htmlBridge + .attr('title', 'Copied!') + .tooltip('fixTitle') + .tooltip('show') + .attr('title', 'Copy to clipboard') + .tooltip('fixTitle'); + }); + + // Notify copy failure + zeroClipboard.on('noflash wrongflash', function () { + htmlBridge.attr('title', 'Flash required') + .tooltip('fixTitle') + .tooltip('show'); + }); +}); diff --git a/doc/_themes/odoodoc/static/bootstrap/js/affix.js b/doc/_themes/odoodoc/static/bootstrap/js/affix.js new file mode 100644 index 00000000000..7d404ebee58 --- /dev/null +++ b/doc/_themes/odoodoc/static/bootstrap/js/affix.js @@ -0,0 +1,142 @@ +/* ======================================================================== + * Bootstrap: affix.js v3.2.0 + * http://getbootstrap.com/javascript/#affix + * ======================================================================== + * Copyright 2011-2014 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + * ======================================================================== */ + + ++function ($) { + 'use strict'; + + // AFFIX CLASS DEFINITION + // ====================== + + var Affix = function (element, options) { + this.options = $.extend({}, Affix.DEFAULTS, options) + + this.$target = $(this.options.target) + .on('scroll.bs.affix.data-api', $.proxy(this.checkPosition, this)) + .on('click.bs.affix.data-api', $.proxy(this.checkPositionWithEventLoop, this)) + + this.$element = $(element) + this.affixed = + this.unpin = + this.pinnedOffset = null + + this.checkPosition() + } + + Affix.VERSION = '3.2.0' + + Affix.RESET = 'affix affix-top affix-bottom' + + Affix.DEFAULTS = { + offset: 0, + target: window + } + + Affix.prototype.getPinnedOffset = function () { + if (this.pinnedOffset) return this.pinnedOffset + this.$element.removeClass(Affix.RESET).addClass('affix') + var scrollTop = this.$target.scrollTop() + var position = this.$element.offset() + return (this.pinnedOffset = position.top - scrollTop) + } + + Affix.prototype.checkPositionWithEventLoop = function () { + setTimeout($.proxy(this.checkPosition, this), 1) + } + + Affix.prototype.checkPosition = function () { + if (!this.$element.is(':visible')) return + + var scrollHeight = $(document).height() + var scrollTop = this.$target.scrollTop() + var position = this.$element.offset() + var offset = this.options.offset + var offsetTop = offset.top + var offsetBottom = offset.bottom + + if (typeof offset != 'object') offsetBottom = offsetTop = offset + if (typeof offsetTop == 'function') offsetTop = offset.top(this.$element) + if (typeof offsetBottom == 'function') offsetBottom = offset.bottom(this.$element) + + var affix = this.unpin != null && (scrollTop + this.unpin <= position.top) ? false : + offsetBottom != null && (position.top + this.$element.height() >= scrollHeight - offsetBottom) ? 'bottom' : + offsetTop != null && (scrollTop <= offsetTop) ? 'top' : false + + if (this.affixed === affix) return + if (this.unpin != null) this.$element.css('top', '') + + var affixType = 'affix' + (affix ? '-' + affix : '') + var e = $.Event(affixType + '.bs.affix') + + this.$element.trigger(e) + + if (e.isDefaultPrevented()) return + + this.affixed = affix + this.unpin = affix == 'bottom' ? this.getPinnedOffset() : null + + this.$element + .removeClass(Affix.RESET) + .addClass(affixType) + .trigger($.Event(affixType.replace('affix', 'affixed'))) + + if (affix == 'bottom') { + this.$element.offset({ + top: scrollHeight - this.$element.height() - offsetBottom + }) + } + } + + + // AFFIX PLUGIN DEFINITION + // ======================= + + function Plugin(option) { + return this.each(function () { + var $this = $(this) + var data = $this.data('bs.affix') + var options = typeof option == 'object' && option + + if (!data) $this.data('bs.affix', (data = new Affix(this, options))) + if (typeof option == 'string') data[option]() + }) + } + + var old = $.fn.affix + + $.fn.affix = Plugin + $.fn.affix.Constructor = Affix + + + // AFFIX NO CONFLICT + // ================= + + $.fn.affix.noConflict = function () { + $.fn.affix = old + return this + } + + + // AFFIX DATA-API + // ============== + + $(window).on('load', function () { + $('[data-spy="affix"]').each(function () { + var $spy = $(this) + var data = $spy.data() + + data.offset = data.offset || {} + + if (data.offsetBottom) data.offset.bottom = data.offsetBottom + if (data.offsetTop) data.offset.top = data.offsetTop + + Plugin.call($spy, data) + }) + }) + +}(jQuery); diff --git a/doc/_themes/odoodoc/static/bootstrap/js/alert.js b/doc/_themes/odoodoc/static/bootstrap/js/alert.js new file mode 100644 index 00000000000..0efd92cba8b --- /dev/null +++ b/doc/_themes/odoodoc/static/bootstrap/js/alert.js @@ -0,0 +1,92 @@ +/* ======================================================================== + * Bootstrap: alert.js v3.2.0 + * http://getbootstrap.com/javascript/#alerts + * ======================================================================== + * Copyright 2011-2014 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + * ======================================================================== */ + + ++function ($) { + 'use strict'; + + // ALERT CLASS DEFINITION + // ====================== + + var dismiss = '[data-dismiss="alert"]' + var Alert = function (el) { + $(el).on('click', dismiss, this.close) + } + + Alert.VERSION = '3.2.0' + + Alert.prototype.close = function (e) { + var $this = $(this) + var selector = $this.attr('data-target') + + if (!selector) { + selector = $this.attr('href') + selector = selector && selector.replace(/.*(?=#[^\s]*$)/, '') // strip for ie7 + } + + var $parent = $(selector) + + if (e) e.preventDefault() + + if (!$parent.length) { + $parent = $this.hasClass('alert') ? $this : $this.parent() + } + + $parent.trigger(e = $.Event('close.bs.alert')) + + if (e.isDefaultPrevented()) return + + $parent.removeClass('in') + + function removeElement() { + // detach from parent, fire event then clean up data + $parent.detach().trigger('closed.bs.alert').remove() + } + + $.support.transition && $parent.hasClass('fade') ? + $parent + .one('bsTransitionEnd', removeElement) + .emulateTransitionEnd(150) : + removeElement() + } + + + // ALERT PLUGIN DEFINITION + // ======================= + + function Plugin(option) { + return this.each(function () { + var $this = $(this) + var data = $this.data('bs.alert') + + if (!data) $this.data('bs.alert', (data = new Alert(this))) + if (typeof option == 'string') data[option].call($this) + }) + } + + var old = $.fn.alert + + $.fn.alert = Plugin + $.fn.alert.Constructor = Alert + + + // ALERT NO CONFLICT + // ================= + + $.fn.alert.noConflict = function () { + $.fn.alert = old + return this + } + + + // ALERT DATA-API + // ============== + + $(document).on('click.bs.alert.data-api', dismiss, Alert.prototype.close) + +}(jQuery); diff --git a/doc/_themes/odoodoc/static/bootstrap/js/button.js b/doc/_themes/odoodoc/static/bootstrap/js/button.js new file mode 100644 index 00000000000..dc3164f866f --- /dev/null +++ b/doc/_themes/odoodoc/static/bootstrap/js/button.js @@ -0,0 +1,110 @@ +/* ======================================================================== + * Bootstrap: button.js v3.2.0 + * http://getbootstrap.com/javascript/#buttons + * ======================================================================== + * Copyright 2011-2014 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + * ======================================================================== */ + + ++function ($) { + 'use strict'; + + // BUTTON PUBLIC CLASS DEFINITION + // ============================== + + var Button = function (element, options) { + this.$element = $(element) + this.options = $.extend({}, Button.DEFAULTS, options) + this.isLoading = false + } + + Button.VERSION = '3.2.0' + + Button.DEFAULTS = { + loadingText: 'loading...' + } + + Button.prototype.setState = function (state) { + var d = 'disabled' + var $el = this.$element + var val = $el.is('input') ? 'val' : 'html' + var data = $el.data() + + state = state + 'Text' + + if (data.resetText == null) $el.data('resetText', $el[val]()) + + $el[val](data[state] == null ? this.options[state] : data[state]) + + // push to event loop to allow forms to submit + setTimeout($.proxy(function () { + if (state == 'loadingText') { + this.isLoading = true + $el.addClass(d).attr(d, d) + } else if (this.isLoading) { + this.isLoading = false + $el.removeClass(d).removeAttr(d) + } + }, this), 0) + } + + Button.prototype.toggle = function () { + var changed = true + var $parent = this.$element.closest('[data-toggle="buttons"]') + + if ($parent.length) { + var $input = this.$element.find('input') + if ($input.prop('type') == 'radio') { + if ($input.prop('checked') && this.$element.hasClass('active')) changed = false + else $parent.find('.active').removeClass('active') + } + if (changed) $input.prop('checked', !this.$element.hasClass('active')).trigger('change') + } + + if (changed) this.$element.toggleClass('active') + } + + + // BUTTON PLUGIN DEFINITION + // ======================== + + function Plugin(option) { + return this.each(function () { + var $this = $(this) + var data = $this.data('bs.button') + var options = typeof option == 'object' && option + + if (!data) $this.data('bs.button', (data = new Button(this, options))) + + if (option == 'toggle') data.toggle() + else if (option) data.setState(option) + }) + } + + var old = $.fn.button + + $.fn.button = Plugin + $.fn.button.Constructor = Button + + + // BUTTON NO CONFLICT + // ================== + + $.fn.button.noConflict = function () { + $.fn.button = old + return this + } + + + // BUTTON DATA-API + // =============== + + $(document).on('click.bs.button.data-api', '[data-toggle^="button"]', function (e) { + var $btn = $(e.target) + if (!$btn.hasClass('btn')) $btn = $btn.closest('.btn') + Plugin.call($btn, 'toggle') + e.preventDefault() + }) + +}(jQuery); diff --git a/doc/_themes/odoodoc/static/bootstrap/js/carousel.js b/doc/_themes/odoodoc/static/bootstrap/js/carousel.js new file mode 100644 index 00000000000..b7da1ba53e2 --- /dev/null +++ b/doc/_themes/odoodoc/static/bootstrap/js/carousel.js @@ -0,0 +1,223 @@ +/* ======================================================================== + * Bootstrap: carousel.js v3.2.0 + * http://getbootstrap.com/javascript/#carousel + * ======================================================================== + * Copyright 2011-2014 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + * ======================================================================== */ + + ++function ($) { + 'use strict'; + + // CAROUSEL CLASS DEFINITION + // ========================= + + var Carousel = function (element, options) { + this.$element = $(element).on('keydown.bs.carousel', $.proxy(this.keydown, this)) + this.$indicators = this.$element.find('.carousel-indicators') + this.options = options + this.paused = + this.sliding = + this.interval = + this.$active = + this.$items = null + + this.options.pause == 'hover' && this.$element + .on('mouseenter.bs.carousel', $.proxy(this.pause, this)) + .on('mouseleave.bs.carousel', $.proxy(this.cycle, this)) + } + + Carousel.VERSION = '3.2.0' + + Carousel.DEFAULTS = { + interval: 5000, + pause: 'hover', + wrap: true + } + + Carousel.prototype.keydown = function (e) { + switch (e.which) { + case 37: this.prev(); break + case 39: this.next(); break + default: return + } + + e.preventDefault() + } + + Carousel.prototype.cycle = function (e) { + e || (this.paused = false) + + this.interval && clearInterval(this.interval) + + this.options.interval + && !this.paused + && (this.interval = setInterval($.proxy(this.next, this), this.options.interval)) + + return this + } + + Carousel.prototype.getItemIndex = function (item) { + this.$items = item.parent().children('.item') + return this.$items.index(item || this.$active) + } + + Carousel.prototype.to = function (pos) { + var that = this + var activeIndex = this.getItemIndex(this.$active = this.$element.find('.item.active')) + + if (pos > (this.$items.length - 1) || pos < 0) return + + if (this.sliding) return this.$element.one('slid.bs.carousel', function () { that.to(pos) }) // yes, "slid" + if (activeIndex == pos) return this.pause().cycle() + + return this.slide(pos > activeIndex ? 'next' : 'prev', $(this.$items[pos])) + } + + Carousel.prototype.pause = function (e) { + e || (this.paused = true) + + if (this.$element.find('.next, .prev').length && $.support.transition) { + this.$element.trigger($.support.transition.end) + this.cycle(true) + } + + this.interval = clearInterval(this.interval) + + return this + } + + Carousel.prototype.next = function () { + if (this.sliding) return + return this.slide('next') + } + + Carousel.prototype.prev = function () { + if (this.sliding) return + return this.slide('prev') + } + + Carousel.prototype.slide = function (type, next) { + var $active = this.$element.find('.item.active') + var $next = next || $active[type]() + var isCycling = this.interval + var direction = type == 'next' ? 'left' : 'right' + var fallback = type == 'next' ? 'first' : 'last' + var that = this + + if (!$next.length) { + if (!this.options.wrap) return + $next = this.$element.find('.item')[fallback]() + } + + if ($next.hasClass('active')) return (this.sliding = false) + + var relatedTarget = $next[0] + var slideEvent = $.Event('slide.bs.carousel', { + relatedTarget: relatedTarget, + direction: direction + }) + this.$element.trigger(slideEvent) + if (slideEvent.isDefaultPrevented()) return + + this.sliding = true + + isCycling && this.pause() + + if (this.$indicators.length) { + this.$indicators.find('.active').removeClass('active') + var $nextIndicator = $(this.$indicators.children()[this.getItemIndex($next)]) + $nextIndicator && $nextIndicator.addClass('active') + } + + var slidEvent = $.Event('slid.bs.carousel', { relatedTarget: relatedTarget, direction: direction }) // yes, "slid" + if ($.support.transition && this.$element.hasClass('slide')) { + $next.addClass(type) + $next[0].offsetWidth // force reflow + $active.addClass(direction) + $next.addClass(direction) + $active + .one('bsTransitionEnd', function () { + $next.removeClass([type, direction].join(' ')).addClass('active') + $active.removeClass(['active', direction].join(' ')) + that.sliding = false + setTimeout(function () { + that.$element.trigger(slidEvent) + }, 0) + }) + .emulateTransitionEnd($active.css('transition-duration').slice(0, -1) * 1000) + } else { + $active.removeClass('active') + $next.addClass('active') + this.sliding = false + this.$element.trigger(slidEvent) + } + + isCycling && this.cycle() + + return this + } + + + // CAROUSEL PLUGIN DEFINITION + // ========================== + + function Plugin(option) { + return this.each(function () { + var $this = $(this) + var data = $this.data('bs.carousel') + var options = $.extend({}, Carousel.DEFAULTS, $this.data(), typeof option == 'object' && option) + var action = typeof option == 'string' ? option : options.slide + + if (!data) $this.data('bs.carousel', (data = new Carousel(this, options))) + if (typeof option == 'number') data.to(option) + else if (action) data[action]() + else if (options.interval) data.pause().cycle() + }) + } + + var old = $.fn.carousel + + $.fn.carousel = Plugin + $.fn.carousel.Constructor = Carousel + + + // CAROUSEL NO CONFLICT + // ==================== + + $.fn.carousel.noConflict = function () { + $.fn.carousel = old + return this + } + + + // CAROUSEL DATA-API + // ================= + + $(document).on('click.bs.carousel.data-api', '[data-slide], [data-slide-to]', function (e) { + var href + var $this = $(this) + var $target = $($this.attr('data-target') || (href = $this.attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '')) // strip for ie7 + if (!$target.hasClass('carousel')) return + var options = $.extend({}, $target.data(), $this.data()) + var slideIndex = $this.attr('data-slide-to') + if (slideIndex) options.interval = false + + Plugin.call($target, options) + + if (slideIndex) { + $target.data('bs.carousel').to(slideIndex) + } + + e.preventDefault() + }) + + $(window).on('load', function () { + $('[data-ride="carousel"]').each(function () { + var $carousel = $(this) + Plugin.call($carousel, $carousel.data()) + }) + }) + +}(jQuery); diff --git a/doc/_themes/odoodoc/static/bootstrap/js/collapse.js b/doc/_themes/odoodoc/static/bootstrap/js/collapse.js new file mode 100644 index 00000000000..e4e6d793339 --- /dev/null +++ b/doc/_themes/odoodoc/static/bootstrap/js/collapse.js @@ -0,0 +1,170 @@ +/* ======================================================================== + * Bootstrap: collapse.js v3.2.0 + * http://getbootstrap.com/javascript/#collapse + * ======================================================================== + * Copyright 2011-2014 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + * ======================================================================== */ + + ++function ($) { + 'use strict'; + + // COLLAPSE PUBLIC CLASS DEFINITION + // ================================ + + var Collapse = function (element, options) { + this.$element = $(element) + this.options = $.extend({}, Collapse.DEFAULTS, options) + this.transitioning = null + + if (this.options.parent) this.$parent = $(this.options.parent) + if (this.options.toggle) this.toggle() + } + + Collapse.VERSION = '3.2.0' + + Collapse.DEFAULTS = { + toggle: true + } + + Collapse.prototype.dimension = function () { + var hasWidth = this.$element.hasClass('width') + return hasWidth ? 'width' : 'height' + } + + Collapse.prototype.show = function () { + if (this.transitioning || this.$element.hasClass('in')) return + + var startEvent = $.Event('show.bs.collapse') + this.$element.trigger(startEvent) + if (startEvent.isDefaultPrevented()) return + + var actives = this.$parent && this.$parent.find('> .panel > .in') + + if (actives && actives.length) { + var hasData = actives.data('bs.collapse') + if (hasData && hasData.transitioning) return + Plugin.call(actives, 'hide') + hasData || actives.data('bs.collapse', null) + } + + var dimension = this.dimension() + + this.$element + .removeClass('collapse') + .addClass('collapsing')[dimension](0) + + this.transitioning = 1 + + var complete = function () { + this.$element + .removeClass('collapsing') + .addClass('collapse in')[dimension]('') + this.transitioning = 0 + this.$element + .trigger('shown.bs.collapse') + } + + if (!$.support.transition) return complete.call(this) + + var scrollSize = $.camelCase(['scroll', dimension].join('-')) + + this.$element + .one('bsTransitionEnd', $.proxy(complete, this)) + .emulateTransitionEnd(350)[dimension](this.$element[0][scrollSize]) + } + + Collapse.prototype.hide = function () { + if (this.transitioning || !this.$element.hasClass('in')) return + + var startEvent = $.Event('hide.bs.collapse') + this.$element.trigger(startEvent) + if (startEvent.isDefaultPrevented()) return + + var dimension = this.dimension() + + this.$element[dimension](this.$element[dimension]())[0].offsetHeight + + this.$element + .addClass('collapsing') + .removeClass('collapse') + .removeClass('in') + + this.transitioning = 1 + + var complete = function () { + this.transitioning = 0 + this.$element + .trigger('hidden.bs.collapse') + .removeClass('collapsing') + .addClass('collapse') + } + + if (!$.support.transition) return complete.call(this) + + this.$element + [dimension](0) + .one('bsTransitionEnd', $.proxy(complete, this)) + .emulateTransitionEnd(350) + } + + Collapse.prototype.toggle = function () { + this[this.$element.hasClass('in') ? 'hide' : 'show']() + } + + + // COLLAPSE PLUGIN DEFINITION + // ========================== + + function Plugin(option) { + return this.each(function () { + var $this = $(this) + var data = $this.data('bs.collapse') + var options = $.extend({}, Collapse.DEFAULTS, $this.data(), typeof option == 'object' && option) + + if (!data && options.toggle && option == 'show') option = !option + if (!data) $this.data('bs.collapse', (data = new Collapse(this, options))) + if (typeof option == 'string') data[option]() + }) + } + + var old = $.fn.collapse + + $.fn.collapse = Plugin + $.fn.collapse.Constructor = Collapse + + + // COLLAPSE NO CONFLICT + // ==================== + + $.fn.collapse.noConflict = function () { + $.fn.collapse = old + return this + } + + + // COLLAPSE DATA-API + // ================= + + $(document).on('click.bs.collapse.data-api', '[data-toggle="collapse"]', function (e) { + var href + var $this = $(this) + var target = $this.attr('data-target') + || e.preventDefault() + || (href = $this.attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '') // strip for ie7 + var $target = $(target) + var data = $target.data('bs.collapse') + var option = data ? 'toggle' : $this.data() + var parent = $this.attr('data-parent') + var $parent = parent && $(parent) + + if (!data || !data.transitioning) { + if ($parent) $parent.find('[data-toggle="collapse"][data-parent="' + parent + '"]').not($this).addClass('collapsed') + $this[$target.hasClass('in') ? 'addClass' : 'removeClass']('collapsed') + } + + Plugin.call($target, option) + }) + +}(jQuery); diff --git a/doc/_themes/odoodoc/static/bootstrap/js/dropdown.js b/doc/_themes/odoodoc/static/bootstrap/js/dropdown.js new file mode 100644 index 00000000000..88f118c2d39 --- /dev/null +++ b/doc/_themes/odoodoc/static/bootstrap/js/dropdown.js @@ -0,0 +1,151 @@ +/* ======================================================================== + * Bootstrap: dropdown.js v3.2.0 + * http://getbootstrap.com/javascript/#dropdowns + * ======================================================================== + * Copyright 2011-2014 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + * ======================================================================== */ + + ++function ($) { + 'use strict'; + + // DROPDOWN CLASS DEFINITION + // ========================= + + var backdrop = '.dropdown-backdrop' + var toggle = '[data-toggle="dropdown"]' + var Dropdown = function (element) { + $(element).on('click.bs.dropdown', this.toggle) + } + + Dropdown.VERSION = '3.2.0' + + Dropdown.prototype.toggle = function (e) { + var $this = $(this) + + if ($this.is('.disabled, :disabled')) return + + var $parent = getParent($this) + var isActive = $parent.hasClass('open') + + clearMenus() + + if (!isActive) { + if ('ontouchstart' in document.documentElement && !$parent.closest('.navbar-nav').length) { + // if mobile we use a backdrop because click events don't delegate + $('