.. image:: https://img.shields.io/badge/license-LGPL--3-blue.png
:target: https://www.gnu.org/licenses/lgpl
:alt: License: LGPL-3
======================
Kanban - Stage Support
======================
This module provides a stage model compatible with Kanban views and the
standard views needed to manage these stages. It also provides the
``base.kanban.abstract`` model, which can be inherited to add support for
Kanban views with stages to any other model. Lastly, it includes a base Kanban
view that can be extended as needed.
Installation
============
To install this module, simply follow the standard install process.
Configuration
=============
No configuration is needed or possible.
Usage
=====
* Inherit from ``base.kanban.abstract`` to add Kanban stage functionality to
the child model:
.. code-block:: python
class MyModel(models.Model):
_name = 'my.model'
_inherit = 'base.kanban.abstract'
* Extend the provided base Kanban view (``base_kanban_abstract_view_kanban``)
as needed by the child model while making sure to set the ``mode`` to
``primary`` so that inheritance works properly. The base view has four
``name`` attributes intended to provide convenient XPath access to different
parts of the Kanban card. They are ``card_dropdown_menu``, ``card_header``,
``card_body``, and ``card_footer``:
.. code-block:: xml
<record id="my_model_view_kanban" model="ir.ui.view">
<field name="name">My Model - Kanban View</field>
<field name="model">my.model</field>
<field name="mode">primary</field>
<field name="inherit_id" ref="base_kanban_stage.base_kanban_abstract_view_kanban"/>
<field name="arch" type="xml">
<xpath expr="//div[@name='card_header']">
<!-- Add header content here -->
</xpath>
<xpath expr="//div[@name='card_body']">
<!-- Add body content here -->
</xpath>
</field>
</record>
* To manage stages, go to Settings > Technical > Kanban > Stages.
.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
:alt: Try me on Runbot
:target: https://runbot.odoo-community.org/runbot/162/13.0
Known Issues / Roadmap
======================
* The grouping logic used by ``base.kanban.abstract`` currently does not
support additional domains and alternate sort orders
Bug Tracker
===========
Bugs are tracked on `GitHub Issue
<https://github.com/OCA/server-tools/issues>`_. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.
Credits
=======
Images
------
* Odoo Community Association: `Icon <https://odoo-community.org/logo.png>`_.
Contributors
------------
* Dave Lasley <dave@laslabs.com>
* Oleg Bulkin <obulkin@laslabs.com>
* Daniel Reis <dreis.pt@hotmail.com>
* Alex Comba <alex.comba@agilebg.com>
* Miquel Raïch <miquel.raich@forgeflow.com>
* Helly kapatel <helly.kapatel@initos.com>
Maintainer
----------
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.
To contribute to this module, please visit http://odoo-community.org.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/server-tools",
"name": "odoo-addon-base-kanban-stage",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "LasLabs, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": "",
"platform": null,
"description": ".. image:: https://img.shields.io/badge/license-LGPL--3-blue.png\n :target: https://www.gnu.org/licenses/lgpl\n :alt: License: LGPL-3\n\n======================\nKanban - Stage Support\n======================\n\nThis module provides a stage model compatible with Kanban views and the\nstandard views needed to manage these stages. It also provides the\n``base.kanban.abstract`` model, which can be inherited to add support for\nKanban views with stages to any other model. Lastly, it includes a base Kanban\nview that can be extended as needed.\n\nInstallation\n============\n\nTo install this module, simply follow the standard install process.\n\nConfiguration\n=============\n\nNo configuration is needed or possible.\n\nUsage\n=====\n\n* Inherit from ``base.kanban.abstract`` to add Kanban stage functionality to\n the child model:\n\n .. code-block:: python\n\n class MyModel(models.Model):\n _name = 'my.model'\n _inherit = 'base.kanban.abstract'\n\n* Extend the provided base Kanban view (``base_kanban_abstract_view_kanban``)\n as needed by the child model while making sure to set the ``mode`` to\n ``primary`` so that inheritance works properly. The base view has four\n ``name`` attributes intended to provide convenient XPath access to different\n parts of the Kanban card. They are ``card_dropdown_menu``, ``card_header``,\n ``card_body``, and ``card_footer``:\n\n .. code-block:: xml\n\n <record id=\"my_model_view_kanban\" model=\"ir.ui.view\">\n <field name=\"name\">My Model - Kanban View</field>\n <field name=\"model\">my.model</field>\n <field name=\"mode\">primary</field>\n <field name=\"inherit_id\" ref=\"base_kanban_stage.base_kanban_abstract_view_kanban\"/>\n <field name=\"arch\" type=\"xml\">\n <xpath expr=\"//div[@name='card_header']\">\n <!-- Add header content here -->\n </xpath>\n <xpath expr=\"//div[@name='card_body']\">\n <!-- Add body content here -->\n </xpath>\n </field>\n </record>\n\n* To manage stages, go to Settings > Technical > Kanban > Stages.\n\n.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas\n :alt: Try me on Runbot\n :target: https://runbot.odoo-community.org/runbot/162/13.0\n\nKnown Issues / Roadmap\n======================\n\n* The grouping logic used by ``base.kanban.abstract`` currently does not\n support additional domains and alternate sort orders\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issue\n<https://github.com/OCA/server-tools/issues>`_. In case of trouble, please\ncheck there if your issue has already been reported. If you spotted it first,\nhelp us smash it by providing detailed and welcomed feedback.\n\nCredits\n=======\n\nImages\n------\n\n* Odoo Community Association: `Icon <https://odoo-community.org/logo.png>`_.\n\nContributors\n------------\n\n* Dave Lasley <dave@laslabs.com>\n* Oleg Bulkin <obulkin@laslabs.com>\n* Daniel Reis <dreis.pt@hotmail.com>\n* Alex Comba <alex.comba@agilebg.com>\n* Miquel Ra\u00efch <miquel.raich@forgeflow.com>\n* Helly kapatel <helly.kapatel@initos.com>\n\nMaintainer\n----------\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nThis module is maintained by the OCA.\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nTo contribute to this module, please visit http://odoo-community.org.\n\n\n",
"bugtrack_url": null,
"license": "LGPL-3",
"summary": "Provides stage model and abstract logic for inheritance",
"version": "15.0.1.0.2.1",
"project_urls": {
"Homepage": "https://github.com/OCA/server-tools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c2a5d5fc0f30038502c9101a5ede60fd5a122d69c0d181063f1720830a9c502",
"md5": "01cba80c1033fc88d33bdfe1116b65d7",
"sha256": "dfa1179a38e5eec7fa947cc22f96d0eff3162a8de7fa42aa660fef09e240292d"
},
"downloads": -1,
"filename": "odoo_addon_base_kanban_stage-15.0.1.0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "01cba80c1033fc88d33bdfe1116b65d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 179626,
"upload_time": "2023-10-12T05:15:31",
"upload_time_iso_8601": "2023-10-12T05:15:31.299180Z",
"url": "https://files.pythonhosted.org/packages/6c/2a/5d5fc0f30038502c9101a5ede60fd5a122d69c0d181063f1720830a9c502/odoo_addon_base_kanban_stage-15.0.1.0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-12 05:15:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "server-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "odoo-addon-base-kanban-stage"
}
JSON
