From 21ce634de532ba39db9cd976f74a6eb49a9cf066 Mon Sep 17 00:00:00 2001 From: Ivan Sokolov Date: Wed, 17 Jul 2024 14:12:39 +0200 Subject: [PATCH] Updated from template --- .copier-answers.yml | 4 +- .gitignore | 9 ++ .pre-commit-config.yaml | 3 +- sign_oca/README.rst | 128 ++++++++++-------- sign_oca/readme/CONFIGURE.md | 5 + sign_oca/readme/CONFIGURE.rst | 4 - sign_oca/readme/CONTRIBUTORS.md | 3 + sign_oca/readme/CONTRIBUTORS.rst | 6 - .../{DESCRIPTION.rst => DESCRIPTION.md} | 3 +- sign_oca/readme/ROADMAP.md | 5 + sign_oca/readme/ROADMAP.rst | 6 - sign_oca/readme/USAGE.md | 57 ++++++++ sign_oca/readme/USAGE.rst | 55 -------- sign_oca/static/description/index.html | 62 +++++---- 14 files changed, 190 insertions(+), 160 deletions(-) create mode 100644 sign_oca/readme/CONFIGURE.md delete mode 100644 sign_oca/readme/CONFIGURE.rst create mode 100644 sign_oca/readme/CONTRIBUTORS.md delete mode 100644 sign_oca/readme/CONTRIBUTORS.rst rename sign_oca/readme/{DESCRIPTION.rst => DESCRIPTION.md} (84%) create mode 100644 sign_oca/readme/ROADMAP.md delete mode 100644 sign_oca/readme/ROADMAP.rst create mode 100644 sign_oca/readme/USAGE.md delete mode 100644 sign_oca/readme/USAGE.rst diff --git a/.copier-answers.yml b/.copier-answers.yml index 54ddff2a..fcda6b00 100644 --- a/.copier-answers.yml +++ b/.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: {} diff --git a/.gitignore b/.gitignore index 0090721f..2b045db3 100644 --- a/.gitignore +++ b/.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 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f89ce3dc..cf7c5093 100644 --- a/.pre-commit-config.yaml +++ b/.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: diff --git a/sign_oca/README.rst b/sign_oca/README.rst index d080ff41..09957960 100644 --- a/sign_oca/README.rst +++ b/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 `_: +- Enric Tobella (`www.dixmit.com `__) +- `Tecnativa `__: - * Víctor Martínez + - Víctor Martínez Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. diff --git a/sign_oca/readme/CONFIGURE.md b/sign_oca/readme/CONFIGURE.md new file mode 100644 index 00000000..f06941c2 --- /dev/null +++ b/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). diff --git a/sign_oca/readme/CONFIGURE.rst b/sign_oca/readme/CONFIGURE.rst deleted file mode 100644 index 7c42a833..00000000 --- a/sign_oca/readme/CONFIGURE.rst +++ /dev/null @@ -1,4 +0,0 @@ -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). diff --git a/sign_oca/readme/CONTRIBUTORS.md b/sign_oca/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..d4491d4f --- /dev/null +++ b/sign_oca/readme/CONTRIBUTORS.md @@ -0,0 +1,3 @@ +- Enric Tobella (www.dixmit.com) +- [Tecnativa](https://www.tecnativa.com): + - Víctor Martínez diff --git a/sign_oca/readme/CONTRIBUTORS.rst b/sign_oca/readme/CONTRIBUTORS.rst deleted file mode 100644 index f9748b2e..00000000 --- a/sign_oca/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,6 +0,0 @@ -* Enric Tobella (www.dixmit.com) - - -* `Tecnativa `_: - - * Víctor Martínez diff --git a/sign_oca/readme/DESCRIPTION.rst b/sign_oca/readme/DESCRIPTION.md similarity index 84% rename from sign_oca/readme/DESCRIPTION.rst rename to sign_oca/readme/DESCRIPTION.md index e24bf705..aa9a46e0 100644 --- a/sign_oca/readme/DESCRIPTION.rst +++ b/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. diff --git a/sign_oca/readme/ROADMAP.md b/sign_oca/readme/ROADMAP.md new file mode 100644 index 00000000..c4bd097d --- /dev/null +++ b/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. diff --git a/sign_oca/readme/ROADMAP.rst b/sign_oca/readme/ROADMAP.rst deleted file mode 100644 index 3391c0b0..00000000 --- a/sign_oca/readme/ROADMAP.rst +++ /dev/null @@ -1,6 +0,0 @@ -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. diff --git a/sign_oca/readme/USAGE.md b/sign_oca/readme/USAGE.md new file mode 100644 index 00000000..45b3bd53 --- /dev/null +++ b/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. diff --git a/sign_oca/readme/USAGE.rst b/sign_oca/readme/USAGE.rst deleted file mode 100644 index 2bff80d4..00000000 --- a/sign_oca/readme/USAGE.rst +++ /dev/null @@ -1,55 +0,0 @@ -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. diff --git a/sign_oca/static/description/index.html b/sign_oca/static/description/index.html index 5158e67c..0676dc6a 100644 --- a/sign_oca/static/description/index.html +++ b/sign_oca/static/description/index.html @@ -370,7 +370,8 @@

Sign Oca

!! source digest: sha256:a098eb84435c16ecba8db145623adef17af21f5f3dadfe1d997b12d3c733c57a !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->

Beta License: AGPL-3 OCA/sign Translate me on Weblate Try me on Runboat

-

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

    @@ -398,70 +399,81 @@

    Sign Oca

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
    • +
  • 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
    • +
  • Click on the field in order to delete or edit some configuration of +it
  • The template is autosaved

Sign role

    -
  • Access Sign / Settings / 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
    • +
  • 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
    • +
  • 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)
    • +
  • 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
    • +
  • 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
    • +
  • 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
    • +
  • 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
    • +
  • 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.
    • +
  • 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.
    • +
  • 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.
@@ -470,9 +482,9 @@

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.
@@ -495,7 +507,7 @@

Authors

Contributors