Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[17.0][MIG] website_sale_product_attachment #945

Closed
Closed
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
4800aae
[ADD] website_sale_product_attachment: add attachments to products in…
Jun 11, 2020
1120734
[FIX] website_sale_product_attachment: autogenerate index.html
Jun 12, 2020
4263bb1
[FIX] website_sale_product_attachment: role warning
chienandalu Jun 17, 2020
f64811f
website_sale_product_attachment 12.0.1.1.0
OCA-git-bot Jun 17, 2020
de16c50
[FIX] website_sale_product_attachment: sort attachments, support long…
Jun 22, 2020
3993c5f
Translated using Weblate (Spanish)
Jun 22, 2020
da398d9
Added translation using Weblate (French)
kh-badep Aug 19, 2020
e13fb4a
Translated using Weblate (French)
kh-badep Aug 19, 2020
aeb4a22
Translated using Weblate (French)
ypapouin Nov 23, 2020
7fbd8ba
Added translation using Weblate (Dutch)
bosd Dec 15, 2020
030798d
Translated using Weblate (Dutch)
bosd Dec 15, 2020
d37fcb2
Added translation using Weblate (Catalan)
claudiagn Jan 20, 2021
ae87f15
Translated using Weblate (Catalan)
claudiagn Jan 20, 2021
839b8d3
[IMP] website_sale_product_attachment: black, isort, prettier
victoralmau Feb 25, 2021
c6742cb
[MIG] website_sale_product_attachment: Migration to 13.0
victoralmau Feb 25, 2021
16d0682
[FIX] website_sale_product_attachment: Read attachment metadata with …
pedrobaeza Sep 17, 2021
a279a75
[IMP] website_sale_product_attachment: Introduce website name
pedrobaeza Sep 24, 2021
79bc9c5
Translated using Weblate (Catalan)
Noel000 Mar 2, 2022
f38d800
[MIG] website_sale_product_attachment: Migration to 16.0
ernesto-garcia-tecnativa Aug 21, 2023
0f989b6
[UPD] Update website_sale_product_attachment.pot
Sep 6, 2023
f6c023e
[UPD] README.rst
OCA-git-bot Sep 6, 2023
86b96cf
Update translation files
weblate Oct 9, 2023
6199b49
Translated using Weblate (Spanish)
Ivorra78 Oct 12, 2023
86aab2c
Added translation using Weblate (Italian)
mymage May 8, 2024
ad21e0e
[IMP] update dotfiles
OCA-git-bot Jul 6, 2024
40b4f75
Translated using Weblate (Italian)
mymage May 8, 2024
14cdd5f
[16.0][FIX] website_sale_product_attachment: product template view ad…
miguelcb2003 Jun 19, 2024
3c67185
[IMP] website_sale_product_attachment: pre-commit auto fixes
adriresu Jun 26, 2024
cdc6985
[MIG] website_sale_product_attachment: Migration to 17.0
adriresu Jun 27, 2024
7974e6f
[FIX] Test
Anxo82 Aug 28, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[IMP] website_sale_product_attachment: pre-commit auto fixes
adriresu authored and dalonsod committed Jul 11, 2024
commit 3c67185323da29fdc3ac51d20256bec131464740
108 changes: 56 additions & 52 deletions website_sale_product_attachment/README.rst
Original file line number Diff line number Diff line change
@@ -17,21 +17,21 @@ eCommerce product attachments
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fe--commerce-lightgray.png?logo=github
:target: https://github.com/OCA/e-commerce/tree/16.0/website_sale_product_attachment
:target: https://github.com/OCA/e-commerce/tree/17.0/website_sale_product_attachment
:alt: OCA/e-commerce
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/e-commerce-16-0/e-commerce-16-0-website_sale_product_attachment
:target: https://translation.odoo-community.org/projects/e-commerce-17-0/e-commerce-17-0-website_sale_product_attachment
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/e-commerce&target_branch=16.0
:target: https://runboat.odoo-community.org/builds?repo=OCA/e-commerce&target_branch=17.0
:alt: Try me on Runboat

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

This module lets you publish downloadable attachments in a product page.

This is useful if you want to publish firmwares, manuals, specs, warranties,
or whatever document related to the product.
This is useful if you want to publish firmwares, manuals, specs,
warranties, or whatever document related to the product.

**Table of contents**

@@ -41,99 +41,103 @@ or whatever document related to the product.
Configuration
=============

Instead of configuring attachments per product, to configure products per attachment:
Instead of configuring attachments per product, to configure products
per attachment:

#. You need permissions to access system settings.
#. Go to *Settings > Dashboard > Activate the developer mode*.
#. Go to *Settings > Technical > Database Structure > Attachments*.
#. Pick or create one.
#. Enable *Attached To > Is public document*.
#. Use the field *Attached in products* to choose the products.
1. You need permissions to access system settings.
2. Go to *Settings > Dashboard > Activate the developer mode*.
3. Go to *Settings > Technical > Database Structure > Attachments*.
4. Pick or create one.
5. Enable *Attached To > Is public document*.
6. Use the field *Attached in products* to choose the products.

.. figure:: https://raw.githubusercontent.com/OCA/e-commerce/16.0/website_sale_product_attachment/static/description/backend-attachment.png
:alt: Attachments view in backend
|image1|

To be able to filter attachments per website:

#. Go to *Website > Configuration > Settings > Website*.
#. Create more than one.
#. Go to *Settings > Technical > Database Structure > Attachments*
#. Pick or create one.
#. Select a website.
#. Save
1. Go to *Website > Configuration > Settings > Website*.
2. Create more than one.
3. Go to *Settings > Technical > Database Structure > Attachments*
4. Pick or create one.
5. Select a website.
6. Save

To toggle attachment icons in the website:

#. Go to any product in your eCommerce.
#. Toggle *Customize > Product downloads > Download icons*.
1. Go to any product in your eCommerce.
2. Toggle *Customize > Product downloads > Download icons*.

.. figure:: https://raw.githubusercontent.com/OCA/e-commerce/16.0/website_sale_product_attachment/static/description/frontend-icons.png
:alt: Toggle icons in frontend
|image2|

.. |image1| image:: https://raw.githubusercontent.com/OCA/e-commerce/17.0/website_sale_product_attachment/static/description/backend-attachment.png
.. |image2| image:: https://raw.githubusercontent.com/OCA/e-commerce/17.0/website_sale_product_attachment/static/description/frontend-icons.png

Usage
=====

To add publicly downloadable attachments to a product template:

#. Go to a *Website > Products > Products* in backend.
#. Pick or create one.
#. Go to the *eCommerce* tab > *Website Attachments*.
#. Add any downloadable attachments you want there. They can exist before or be new.
They must be public.
#. Save.
1. Go to a *Website > Products > Products* in backend.
2. Pick or create one.
3. Go to the *eCommerce* tab > *Website Attachments*.
4. Add any downloadable attachments you want there. They can exist
before or be new. They must be public.
5. Save.

|image1|

.. figure:: https://raw.githubusercontent.com/OCA/e-commerce/16.0/website_sale_product_attachment/static/description/backend-product.png
:alt: Products view in backend
Once you set up the product attachments, public users will be able to
download them:

Once you set up the product attachments, public users will be able to download them:
1. Go to the product eCommerce page.
2. Below the product price and description, you will find a dropdown
labeled as *Product downloads*. Click it.
3. Users will download those attachments from there.
4. Attachments will appear in name order.

#. Go to the product eCommerce page.
#. Below the product price and description, you will find a dropdown labeled as *Product downloads*. Click it.
#. Users will download those attachments from there.
#. Attachments will appear in name order.
|image2|

.. figure:: https://raw.githubusercontent.com/OCA/e-commerce/16.0/website_sale_product_attachment/static/description/frontend-download.gif
:alt: Attachments view in backend
.. |image1| image:: https://raw.githubusercontent.com/OCA/e-commerce/17.0/website_sale_product_attachment/static/description/backend-product.png
.. |image2| image:: https://raw.githubusercontent.com/OCA/e-commerce/17.0/website_sale_product_attachment/static/description/frontend-download.gif

Known issues / Roadmap
======================

- Make translatable the name of the attachment in the e-commerce. This will
mean to deal with the sorting of the translated terms.
- Make translatable the name of the attachment in the e-commerce. This
will mean to deal with the sorting of the translated terms.

Bug Tracker
===========

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

Credits
=======

Authors
~~~~~~~
-------

* Tecnativa

Contributors
~~~~~~~~~~~~

* `Tecnativa <https://www.tecnativa.com>`_:
------------

* Jairo Llopis
* Víctor Martínez
- `Tecnativa <https://www.tecnativa.com>`__:

- Jairo Llopis
- Víctor Martínez

* `Sygel <https://www.sygel.es>`_:
- `Sygel <https://www.sygel.es>`__:

* Ángel García de la Chica Herrera
- Ángel García de la Chica Herrera

Maintainers
~~~~~~~~~~~
-----------

This module is maintained by the OCA.

@@ -153,6 +157,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-Yajo|

This module is part of the `OCA/e-commerce <https://github.com/OCA/e-commerce/tree/16.0/website_sale_product_attachment>`_ project on GitHub.
This module is part of the `OCA/e-commerce <https://github.com/OCA/e-commerce/tree/17.0/website_sale_product_attachment>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions website_sale_product_attachment/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
27 changes: 27 additions & 0 deletions website_sale_product_attachment/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Instead of configuring attachments per product, to configure products
per attachment:

1. You need permissions to access system settings.
2. Go to *Settings \> Dashboard \> Activate the developer mode*.
3. Go to *Settings \> Technical \> Database Structure \> Attachments*.
4. Pick or create one.
5. Enable *Attached To \> Is public document*.
6. Use the field *Attached in products* to choose the products.

![](../static/description/backend-attachment.png)

To be able to filter attachments per website:

1. Go to *Website \> Configuration \> Settings \> Website*.
2. Create more than one.
3. Go to *Settings \> Technical \> Database Structure \> Attachments*
4. Pick or create one.
5. Select a website.
6. Save

To toggle attachment icons in the website:

1. Go to any product in your eCommerce.
2. Toggle *Customize \> Product downloads \> Download icons*.

![](../static/description/frontend-icons.png)
28 changes: 0 additions & 28 deletions website_sale_product_attachment/readme/CONFIGURE.rst

This file was deleted.

5 changes: 5 additions & 0 deletions website_sale_product_attachment/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- [Tecnativa](https://www.tecnativa.com):
- Jairo Llopis
- Víctor Martínez
- [Sygel](https://www.sygel.es):
- Ángel García de la Chica Herrera
9 changes: 0 additions & 9 deletions website_sale_product_attachment/readme/CONTRIBUTORS.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This module lets you publish downloadable attachments in a product page.

This is useful if you want to publish firmwares, manuals, specs, warranties,
or whatever document related to the product.
This is useful if you want to publish firmwares, manuals, specs,
warranties, or whatever document related to the product.
2 changes: 2 additions & 0 deletions website_sale_product_attachment/readme/ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Make translatable the name of the attachment in the e-commerce. This
will mean to deal with the sorting of the translated terms.
2 changes: 0 additions & 2 deletions website_sale_product_attachment/readme/ROADMAP.rst

This file was deleted.

21 changes: 21 additions & 0 deletions website_sale_product_attachment/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
To add publicly downloadable attachments to a product template:

1. Go to a *Website \> Products \> Products* in backend.
2. Pick or create one.
3. Go to the *eCommerce* tab \> *Website Attachments*.
4. Add any downloadable attachments you want there. They can exist
before or be new. They must be public.
5. Save.

![](../static/description/backend-product.png)

Once you set up the product attachments, public users will be able to
download them:

1. Go to the product eCommerce page.
2. Below the product price and description, you will find a dropdown
labeled as *Product downloads*. Click it.
3. Users will download those attachments from there.
4. Attachments will appear in name order.

![](../static/description/frontend-download.gif)
21 changes: 0 additions & 21 deletions website_sale_product_attachment/readme/USAGE.rst

This file was deleted.