Merge PR #57 into 16.0

Signed-off-by etobella

.copier-answers.yml

@@ -1,8 +1,8 @@
 # Do NOT update manually; changes here will be overwritten by Copier
-_commit: v1.21.1
+_commit: v1.24-1-gf8cceac
 _src_path: https://github.com/OCA/oca-addons-repo-template.git
 ci: GitHub
-convert_readme_fragments_to_markdown: false
+convert_readme_fragments_to_markdown: true
 generate_requirements_txt: true
 github_check_license: true
 github_ci_extra_env: {}

.gitignore

@@ -25,6 +25,15 @@ var/
 *.egg
 *.eggs
 
+# Debian packages
+*.deb
+
+# Redhat packages
+*.rpm
+
+# MacOS packages
+*.dmg
+
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt

.pre-commit-config.yaml

@@ -39,7 +39,7 @@ repos:
         language: fail
         files: '[a-zA-Z0-9_]*/i18n/en\.po$'
   - repo: https://github.com/oca/maintainer-tools
-    rev: 9a170331575a265c092ee6b24b845ec508e8ef75
+    rev: d5fab7ee87fceee858a3d01048c78a548974d935
     hooks:
       # update the NOT INSTALLABLE ADDONS section above
       - id: oca-update-pre-commit-excluded-addons
@@ -53,6 +53,7 @@ repos:
           - --repo-name=sign
           - --if-source-changed
           - --keep-source-digest
+          - --convert-fragments-to-markdown
   - repo: https://github.com/OCA/odoo-pre-commit-hooks
     rev: v0.0.25
     hooks:

sign_oca/README.rst

@@ -28,7 +28,8 @@ Sign Oca
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-This module allows to create documents for signature inside Odoo using OWL.
+This module allows to create documents for signature inside Odoo using
+OWL.
 
 **Table of contents**
 
@@ -38,79 +39,88 @@ This module allows to create documents for signature inside Odoo using OWL.
 Configuration
 =============
 
-There is a wizard (sign.oca.template.generate.multi) that can be used for any model needed.
-If there is a template without a linked model or linked to a model (res.partner for example)
-an action will be automatically displayed in the tree and form view (only for users
-with Sign permissions).
+There is a wizard (sign.oca.template.generate.multi) that can be used
+for any model needed. If there is a template without a linked model or
+linked to a model (res.partner for example) an action will be
+automatically displayed in the tree and form view (only for users with
+Sign permissions).
 
 Usage
 =====
 
 Creation of templates
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
 
-*  Access `Sign / Templates`
-*  Create a new template
-*  Add a PDF File
-*  Access the configuration menu
-*  You can add a field by doing a right click inside a page
-*  Click on the field in order to delete or edit some configuration of it
-*  The template is autosaved
+-  Access Sign / Templates
+-  Create a new template
+-  Add a PDF File
+-  Access the configuration menu
+-  You can add a field by doing a right click inside a page
+-  Click on the field in order to delete or edit some configuration of
+   it
+-  The template is autosaved
 
 Sign role
-~~~~~~~~~~
-
-*  Access `Sign / Settings / Roles`
-*  Create a new role (Equipment employee for example)
-*  You can set the Partner type you need (empty, default or expression).
-*  With the expression option you can set: ${object.field_name.id}
-*  If you create a sign request from template signer will be auto-create according to roles
+---------
 
+-  Access Sign / Settings / Roles
+-  Create a new role (Equipment employee for example)
+-  You can set the Partner type you need (empty, default or expression).
+-  With the expression option you can set: ${object.field_name.id}
+-  If you create a sign request from template signer will be auto-create
+   according to roles
 
 Sign a document from template
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-*  Access `Sign / Templates`
-*  Press the `Sign` button from a template
-*  Fill all the possible partners that will sign the document
-*  You can link the template to a model (maintenance.equipment for example)
-*  The signature action will be opened.
-*  There, you can fill all the data you need.
-*  Once you finish, press the sign button on the top
-*  When the last signer signs it, the final file will be generated as a PDF
-
+-----------------------------
+
+-  Access Sign / Templates
+-  Press the Sign button from a template
+-  Fill all the possible partners that will sign the document
+-  You can link the template to a model (maintenance.equipment for
+   example)
+-  The signature action will be opened.
+-  There, you can fill all the data you need.
+-  Once you finish, press the sign button on the top
+-  When the last signer signs it, the final file will be generated as a
+   PDF
 
 Sign a pending document
-~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------
 
-*  Go to the pencil icon in the upper right corner (systray) of the sign request to access the pending signatures.
-*  Press the `Sign` button from signer request
-*  The signature action will be opened.
-*  There, you can fill all the data you need.
-*  Once you finish, press the sign button on the top
-*  When the last signer signs it, the final file will be generated as a PDF
+-  Go to the pencil icon in the upper right corner (systray) of the sign
+   request to access the pending signatures.
+-  Press the Sign button from signer request
+-  The signature action will be opened.
+-  There, you can fill all the data you need.
+-  Once you finish, press the sign button on the top
+-  When the last signer signs it, the final file will be generated as a
+   PDF
 
 Sign from template
-~~~~~~~~~~~~~~~~~~
-
-* Go to any list view or form view (except sign.oca models), e.g.: Contacts
-* Select multiple records (3 for example).
-* The "Sign from template" action will be available if there are any sign templates
-  created that are not linked to any model and/or any linked to the corresponding model.
-* Select a template.
-* Click on the "Generate" button.
-* 3 requests will be created (each linked to each selected record) BUT no signer will be set.
-* Some extra modules (e.g. maintenance_sign_oca) will automatically set the signers for each request.
+------------------
+
+-  Go to any list view or form view (except sign.oca models), e.g.:
+   Contacts
+-  Select multiple records (3 for example).
+-  The "Sign from template" action will be available if there are any
+   sign templates created that are not linked to any model and/or any
+   linked to the corresponding model.
+-  Select a template.
+-  Click on the "Generate" button.
+-  3 requests will be created (each linked to each selected record) BUT
+   no signer will be set.
+-  Some extra modules (e.g. maintenance_sign_oca) will automatically set
+   the signers for each request.
 
 Known issues / Roadmap
 ======================
 
 Tasks
-~~~~~
+-----
 
-*  Ensure that the signature is inalterable.
-   Maybe we might need to use some tools like endevise or pyHanko with a certificate.
-   Signer can be authenticated using OTP.
+-  Ensure that the signature is inalterable. Maybe we might need to use
+   some tools like endevise or pyHanko with a certificate. Signer can be
+   authenticated using OTP.
 
 Bug Tracker
 ===========
@@ -126,22 +136,20 @@ Credits
 =======
 
 Authors
-~~~~~~~
+-------
 
 * Dixmit
 
 Contributors
-~~~~~~~~~~~~
-
-* Enric Tobella (www.dixmit.com)
-
+------------
 
-* `Tecnativa <https://www.tecnativa.com>`_:
+-  Enric Tobella (`www.dixmit.com <http://www.dixmit.com>`__)
+-  `Tecnativa <https://www.tecnativa.com>`__:
 
-  * Víctor Martínez
+   -  Víctor Martínez
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 

sign_oca/readme/CONFIGURE.md

@@ -0,0 +1,5 @@
+There is a wizard (sign.oca.template.generate.multi) that can be used
+for any model needed. If there is a template without a linked model or
+linked to a model (res.partner for example) an action will be
+automatically displayed in the tree and form view (only for users with
+Sign permissions).

sign_oca/readme/CONTRIBUTORS.md

@@ -0,0 +1,3 @@
+- Enric Tobella (www.dixmit.com)
+- [Tecnativa](https://www.tecnativa.com):
+  - Víctor Martínez

sign_oca/readme/DESCRIPTION.rst → sign_oca/readme/DESCRIPTION.md

@@ -1 +1,2 @@
-This module allows to create documents for signature inside Odoo using OWL.
+This module allows to create documents for signature inside Odoo using
+OWL.

sign_oca/readme/ROADMAP.md

@@ -0,0 +1,5 @@
+## Tasks
+
+- Ensure that the signature is inalterable. Maybe we might need to use
+  some tools like endevise or pyHanko with a certificate. Signer can be
+  authenticated using OTP.

sign_oca/readme/USAGE.md

@@ -0,0 +1,57 @@
+## Creation of templates
+
+- Access Sign / Templates
+- Create a new template
+- Add a PDF File
+- Access the configuration menu
+- You can add a field by doing a right click inside a page
+- Click on the field in order to delete or edit some configuration of it
+- The template is autosaved
+
+## Sign role
+
+- Access Sign / Settings / Roles
+- Create a new role (Equipment employee for example)
+- You can set the Partner type you need (empty, default or expression).
+- With the expression option you can set: \${object.field_name.id}
+- If you create a sign request from template signer will be auto-create
+  according to roles
+
+## Sign a document from template
+
+- Access Sign / Templates
+- Press the Sign button from a template
+- Fill all the possible partners that will sign the document
+- You can link the template to a model (maintenance.equipment for
+  example)
+- The signature action will be opened.
+- There, you can fill all the data you need.
+- Once you finish, press the sign button on the top
+- When the last signer signs it, the final file will be generated as a
+  PDF
+
+## Sign a pending document
+
+- Go to the pencil icon in the upper right corner (systray) of the sign
+  request to access the pending signatures.
+- Press the Sign button from signer request
+- The signature action will be opened.
+- There, you can fill all the data you need.
+- Once you finish, press the sign button on the top
+- When the last signer signs it, the final file will be generated as a
+  PDF
+
+## Sign from template
+
+- Go to any list view or form view (except sign.oca models), e.g.:
+  Contacts
+- Select multiple records (3 for example).
+- The "Sign from template" action will be available if there are any
+  sign templates created that are not linked to any model and/or any
+  linked to the corresponding model.
+- Select a template.
+- Click on the "Generate" button.
+- 3 requests will be created (each linked to each selected record) BUT
+  no signer will be set.
+- Some extra modules (e.g. maintenance_sign_oca) will automatically set
+  the signers for each request.