Skip to content

Commit

Permalink
[IMP] improves module dms_version with new design
Browse files Browse the repository at this point in the history
  • Loading branch information
yweng8111 committed Feb 21, 2024
1 parent fff41ed commit 579eb60
Show file tree
Hide file tree
Showing 23 changed files with 908 additions and 354 deletions.
93 changes: 80 additions & 13 deletions dms_version/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,87 @@
Document Management System Version
==================================

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:39946e391a475497d7ae597769f6afbd59096ac771cd4518b7a6c433995828cf
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fdms-lightgray.png?logo=github
:target: https://github.com/OCA/dms/tree/13.0/dms_version
:target: https://github.com/OCA/dms/tree/14.0/dms_version
:alt: OCA/dms
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/dms-13-0/dms-13-0-dms_version
:target: https://translation.odoo-community.org/projects/dms-14-0/dms-14-0-dms_version
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/292/13.0
:alt: Try me on Runbot
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/dms&target_branch=14.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|
|badge1| |badge2| |badge3| |badge4| |badge5|

Documents Versioning enables version control for the document management system.

Configuration
~~~~~~~~~~~~~

* allow versioning on storage level (only for type "database" and "filestore" -> NOT "attachment" currently)
* allow versioning on directory level
* allow versioning on file level
* allow changing the versioning setting later only for people with special group + track change in chatter of dms file

DMS Files
~~~~~~~~~

* link the "origin" file when creating a new version
* If a file is newly created, origin is self
* If a version is created for a file, origin is copied (so that the entire history of a file knows which file was the origin)
* use active-boolean to mark newest version
* There is only one active file for all files with the same origin (unique contraint).
* Files with active = False are readonly to avoid creating new versions from archived files.
* link the "parent" file when creating a new version
* If a file is newly created, parent is False.
* If a version is created for a file, parent is the "old" file.
* count the number of versions for files with the same origin_id (unique contraint for version number and origin)
* only show files with active=True in tree and kanban views
* track changes of almost all fields of a file
* add a smartbutton in file form view to show all versions with the same orgin (attention: show archived files)
* add icon in kanban view if a file is not the origin (to mark a file as modified)
* color file in yellow in tree view that is not the origin (to mark a file as modified)
* add a filter to show all modified files (parent != False)
* add a filter to show all not-modified files (parent = False)
* add a filter to show all archived files (active=False)
* do not allow to use the usual action "Unarchive" - instead use the restore button in archived files

Versioning
~~~~~~~~~~

* change the content field of a file to create a new version
* do not allow to change the content if the file is active=False
* The old file is the parent of the new file.
* The old file is now active=False.
* The new file is active=True.
* A chatter message is created in the new file to know from which file it was created.
* A chatter message is created in the parent file to know which file was generated from it.
* A chatter message is created in the origin file (if origin != parent) to see the entire history of all versions in the origin file.

Restoring
~~~~~~~~~

* click a button in form or tree view to restore an archived file
* The old archived file is now active=True.
* If an active=True file existed with the same origin it now is active=False.
* A chatter message is created in the previously archived and now restored file.
* A chatter message is created in the previously active and now archived file (if one existed).
* A chatter message is created in the origin file (if origin != restored file and origin != previous active file).

**Table of contents**

.. contents::
Expand All @@ -47,8 +103,8 @@ Bug Tracker

Bugs are tracked on `GitHub Issues <https://github.com/OCA/dms/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/dms/issues/new?body=module:%20dms_version%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/dms/issues/new?body=module:%20dms_version%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Expand All @@ -60,6 +116,7 @@ Authors

* MuK IT
* Tecnativa
* elego Software Solutions Gmbh

Contributors
~~~~~~~~~~~~
Expand All @@ -68,6 +125,8 @@ Contributors
* `Tecnativa <https://www.tecnativa.com>`_:",

* Víctor Martínez
* Maria Sparenberg <[email protected]>
* Yu Weng <[email protected]>

Maintainers
~~~~~~~~~~~
Expand All @@ -82,6 +141,14 @@ 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.

This module is part of the `OCA/dms <https://github.com/OCA/dms/tree/13.0/dms_version>`_ project on GitHub.
.. |maintainer-victoralmau| image:: https://github.com/victoralmau.png?size=40px
:target: https://github.com/victoralmau
:alt: victoralmau

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-victoralmau|

This module is part of the `OCA/dms <https://github.com/OCA/dms/tree/14.0/dms_version>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions dms_version/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

from . import models
from . import wizard
9 changes: 8 additions & 1 deletion dms_version/__manifest__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,17 @@
"category": "Document Management",
"license": "AGPL-3",
"website": "https://github.com/OCA/dms",
"author": "MuK IT, Tecnativa, Odoo Community Association (OCA)",
"author": """MuK IT,
Tecnativa,
elego Software Solutions Gmbh,
Odoo Community Association (OCA)""",
"depends": ["dms", "base_revision"],
"data": [
"security/ir.model.access.csv",
"security/security.xml",
"wizard/restore_old_revision_view.xml",
"views/dms_file_view.xml",
"views/dms_directory_view.xml",
"views/dms_storage_view.xml",
],
"maintainers": ["victoralmau"],
Expand Down
125 changes: 0 additions & 125 deletions dms_version/i18n/dms_version.pot

This file was deleted.

Loading

0 comments on commit 579eb60

Please sign in to comment.