You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

85 lines
3.0 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ==============================
  5. Custom shortcut icon (favicon)
  6. ==============================
  7. This module was written to allow you to customize your Odoo instance's shortcut
  8. icon (aka favicon). This is useful for branding purposes, but also for
  9. integrators who have many different Odoo instances running and need to see at a
  10. glance which browser tab does what.
  11. More info about favicon: https://en.wikipedia.org/wiki/Favicon
  12. Configuration
  13. =============
  14. Upload your favicon (16x16, 32x32, 64x64 or "as big as possible") on the
  15. company form. The file format would be ico, gif or png with 16x16, 32x32 or
  16. 64x64 pixels and 16 colors. Highers resolutions or colors support depends on
  17. the used browser, but most modern browsers do.
  18. Note that most browsers cache favicons basically forever, so if you want your
  19. icon to show up, you'll most probably have to delete you browser cache.
  20. Some browsers can refresh the favicon, accessing the URL
  21. <base_url>/web_favicon/favicon.
  22. You have a sample SVG that can be used as template for generating your icon
  23. in /static/src/img/master_original_favicon.svg. You can also search for some
  24. favicon generators across the web.
  25. To allow a user to edit the favicon it has to be member of group "Administration / Settings".
  26. Usage
  27. =====
  28. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  29. :alt: Try me on Runbot
  30. :target: https://runbot.odoo-community.org/runbot/162/10.0
  31. Known issues / Roadmap
  32. ======================
  33. * Allow to upload some big icon (preferrably SVG or the like) and generate
  34. all the icons from it
  35. * Generate icons suitable for mobile devices and web apps (see /static/src/img/
  36. folder inside the module for a sample of the possible current formats.
  37. * Put the icon definition at system level, not at company level. It doesn't
  38. make sense (as the icon is cached) to have a different icon per company.
  39. Bug Tracker
  40. ===========
  41. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  42. In case of trouble, please check there if your issue has already been reported.
  43. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  44. `here <https://github.com/OCA/web/issues/new?body=module:%20
  45. web_favicon%0Aversion:%20
  46. 10.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  47. Credits
  48. =======
  49. Contributors
  50. ------------
  51. * Holger Brunn <hbrunn@therp.nl>
  52. * Pedro M. Baeza <pedro.baeza@gmail.com>
  53. * Dennis Sluijk <d.sluijk@onestein.nl>
  54. Maintainer
  55. ----------
  56. .. image:: https://odoo-community.org/logo.png
  57. :alt: Odoo Community Association
  58. :target: https://odoo-community.org
  59. This module is maintained by the OCA.
  60. OCA, or the Odoo Community Association, is a nonprofit organization whose
  61. mission is to support the collaborative development of Odoo features and
  62. promote its widespread use.
  63. To contribute to this module, please visit https://odoo-community.org.