Skip to content
Permalink
Browse files

📖 doc refactoring (#760)

  • Loading branch information...
Mirgalimova authored and yelizariev committed Aug 11, 2019
1 parent 455729a commit f83410822c89f65e1018a5e1dabe1f052fd5ec82
@@ -1,100 +1,48 @@
Backend debranding
==================

Removes references to odoo.com:

1. Deletes Odoo label in footer
2. Replaces "Odoo" in page title
3. Replaces "Odoo" in help message for empty list
4. *(feature is not required in 9.0+ versions)*
5. Deletes Documentation, Support, About links. Adds "Developer mode" link to the top right-hand User Menu.
6. Replaces default logo by empty image
7. Replaces "Odoo" in Dialog Box
8. Replaces "Odoo" in strings marked for translation.
9. Replaces default favicon to a custom one
10. **Hides Apps menu** (by default, only admin (superuser) can see Apps menu. You could change it via tick "Show Modules Menu" in user's access rights tab)
11. Disables server requests to odoo.com (publisher_warranty_url) - optional. Works only for non-enterprise versions of odoo, check `note <#enterprise-users-notice>`__ below.
12. Deletes "My odoo.com account" button
13. Deletes Apps and other blocks from Settings/Dashboard
14. Replaces "Odoo" in planner
15. Replaces footer in planner to a custom one.
16. Deletes "Odoo" in a request message for permission desktop notifications. Replaces "Odoo" and icon in desktop notifications
17. [ENTERPRISE] Deletes odoo logo in application switcher
18. Hides Enterprise features in Settings
19. Replaces "Odoo" in all backend qweb templates (e.g. FAQ in import tool)
20. Replaces "odoo.com" in hints, examples, etc.
21. Rename "OdooBot" to "Bot". Use company's logo as bot avatar
22. [ENTERPRISE] Replaces icons for android and apple devices with custom url
23. Replaces links to `documentation <https://www.odoo.com/documentation>`__ (e.g. "Help" in Import tool, "How-to" in paypal, etc.) to custom website
24. Removes official videos in planner
25. Replaces "Odoo" in *application installed* mails

Configuration
=============

By default the module replaces "Odoo" to "Software". To configure
module open Settings\\System Parameters and modify

* ``web_debranding.new_title`` (put space in value if you don't need Brand in Title)
* ``web_debranding.new_name`` (your Brand)
* ``web_debranding.new_website`` (your website)
* ``web_debranding.new_documentation_website`` (website with documentation instead of official one)
* ``web_debranding.favicon_url``
* ``web_debranding.send_publisher_warranty_url`` - set 0 to disable server requests to odoo.com and 1 otherwise (useful for enterprise contractors). Works only for non-enterprise versions of odoo, check `note <#enterprise-users-notice>`__ below.
* ``web_debranding.planner_footer``
* ``web_debranding.icon_url`` - icon for mobile devices. recommended size :192x192
* ``web_debranding.apple_touch_icon_url`` - icon for IOS Safari. recommended size :152x152


Note. More user friendly way to configure the module is available in `Brand Kit <https://apps.odoo.com/apps/modules/9.0/theme_kit/>`__.

Further debranding
==================

* open addons/mail/data/mail_data.xml and edit Template "Notification Email" -- delete "using Odoo"
* open addons/website_livechat/website_livechat_data.xml and edit in "im_livechat_channel_data_website" record YourWebsiteWithOdoo.com string
* install **website_debranding** module if module "Website Builder" is installed in your system
* install **pos_debranding** module if module "POS" is installed in your system
* delete "Odoo.com Accounts" record at Settings\\Users\\OAuth Providers if module "OAuth2 Authentication" is installed. in your system
* to debrand **/web/database/manager**:

* edit addons/web/views/database_manager.html file:

* delete or modify <title> tag
* delete or modify favicon
* delete or modify <img> tag with logo2.png
* delete or modify paragraph <p>Fill in this form to create an Odoo database...</p>
* delete or modify warning <div class="alert alert-warning">Warning, your Odoo database ...</div>

Auto-debrand new databases
==========================
To automatically install this module for every new databases set **'auto_install': True** in __openerp__.py files of following modules:

* web_debranding
* ir_rule_protected
* access_restricted
* access_apps
* access_settings_menu
* mail (built-in)
* base_setup (built-in)
* bus (built-in)

Tested on Odoo 10.0 b2804b1d2ae5fd7ec5c0eca79a8db77476badc84

Enterprise users notice
=======================

* `Terms of Odoo Enterprise Subscription Agreement <https://www.odoo.com/documentation/user/9.0/legal/terms/enterprise.html#customer-obligations>`_ don't allow to disable server requests to odoo.com. For this reason feature #11 doesn't work in Enterprise version.

Note
====

* You can also use our new extended `Brand Kit module <https://www.odoo.com/apps/modules/10.0/theme_kit>`_ to brand your odoo instance and create your theme in few clicks.

Need our service?
=================

Contact us by `email <mailto:apps@it-projects.info>`__ or fill out `request form <https://www.it-projects.info/page/website.contactus>`__:

* apps@it-projects.info
* https://www.it-projects.info/page/website.contactus
.. image:: https://img.shields.io/badge/license-LGPL--3-blue.png
:target: https://www.gnu.org/licenses/lgpl
:alt: License: LGPL-3

====================
Backend debranding
====================

Build and enhance your Brand by removing references to `odoo.com <https://www.odoo.com/>`__ and customizing company logo, favicon, page title, etc.

Credits
=======

Contributors
------------
* `Ivan Yelizariev <https://it-projects.info/team/yelizariev>`__

Sponsors
--------
* `IT-Projects LLC <https://it-projects.info>`__

Maintainers
-----------
* `IT-Projects LLC <https://it-projects.info>`__

To get a guaranteed support
you are kindly requested to purchase the module
at `odoo apps store <https://apps.odoo.com/apps/modules/10.0/web_debranding/>`__.

Thank you for understanding!

`IT-Projects Team <https://www.it-projects.info/team>`__


Further information
===================

Demo: http://runbot.it-projects.info/demo/website-addons/10.0

HTML Description: https://www.odoo.com/apps/modules/10.0/web_debranding/

Usage instructions: `<doc/index.rst>`__

Changelog: `<doc/changelog.rst>`__

Notifications on updates: `via Atom <https://github.com/it-projects-llc/misc-addons/commits/10.0/web_debranding.atom>`_, `by Email <https://blogtrottr.com/?subscribe=https://github.com/it-projects-llc/misc-addons/commits/10.0/web_debranding.atom>`_

Tested on Odoo 10.0 d7b9d141b7c40cfd3f9a53a0aa9e73551ddd01a5
@@ -2,10 +2,114 @@
Backend debranding
====================

For installation and configuration instructions see README.rst
Installation
============

* `Install <https://odoo-development.readthedocs.io/en/latest/odoo/usage/install-module.html>`__ this module in a usual way

Configuration
=============

By default the module replaces ``Odoo`` to ``Software``.

* * Switch to Developer mode
* Open ``[[ General Settings ]] >> Technical >> Parameters >> System Parameters`` and modify:

* ``web_debranding.new_title`` (put space in value if you don't need Brand in Title)
* ``web_debranding.new_name`` (your Brand)
* ``web_debranding.new_website`` (your website)
* ``web_debranding.new_documentation_website`` (website with documentation instead of official one)
* ``web_debranding.favicon_url``
* ``web_debranding.send_publisher_warranty_url`` - set 0 to disable server requests to odoo.com and 1 otherwise (useful for enterprise contractors). Works only for non-enterprise versions of odoo, check `note <https://www.odoo.com/apps/modules/12.0/web_debranding/#enterprise-users-notice>`__ below.
* ``web_debranding.icon_url`` - icon for mobile devices. recommended size :192x192
* ``web_debranding.apple_touch_icon_url`` - icon for IOS Safari. recommended size :152x152

*Note. More user friendly way to configure the module is available in* `Brand Kit <https://apps.odoo.com/apps/modules/11.0/theme_kit/>`__.

Further debranding
==================

* Open *addons/mail/data/mail_data.xml* and edit Template **Notification Email** - delete ``using Odoo``
* Open *addons/website_livechat/data/website_livechat_data.xml* and edit in ``im_livechat_channel_data_website`` record *YourWebsiteWithOdoo.com* string
* Install ``website_debranding`` `module <https://apps.odoo.com/apps/modules/10.0/website_debranding/>`__ if module *Website Builder* has been already installed in your system
* Install ``pos_debranding`` `module <https://apps.odoo.com/apps/modules/10.0/pos_debranding/>`__ if module `POS` has been already installed in your system
* Delete *Odoo.com Accounts* record at *Settings\Users & Companies\OAuth Providers* if module ``OAuth2 Authentication`` has been already installed in your system
* To debrand ``/web/database/manager``:

* edit *addons/web/views/database_manager.html* file:

* delete or modify **<title>** tag
* delete or modify favicon
* delete or modify **<img>** tag with ``logo2.png``
* delete or modify warning **<div class="alert alert-warning"> Warning, your Odoo database ...</div>**
* delete or modify **<small class="text-muted">** To enhance your experience, some data may be sent to *Odoo online services*. See our `Privacy Policy <https://www.odoo.com/privacy>`__
* delete or modify **<p class="form-text"> In order to avoid conflicts between databases, Odoo needs ...</p>**

Auto-debrand new databases
==========================

To automatically install this module for every new databases set 'auto_install': True in **__openerp__.py** files of following modules:

* ``web_debranding``
* ``ir_rule_protected``
* ``access_restricted``
* ``access_apps``
* ``access_settings_menu``
* ``mail (built-in)``
* ``base_setup (built-in)``
* ``bus (built-in)``

Usage
=====

* Open Odoo
* RESULT: All reference to Odoo are gone in UI
* Open *Backend*

RESULT: Odoo is replaced to Your Brand in footer, Dialog Box, within phrases, empty messages, all backend qweb templates, hints, examples, Settings and Bot open menu (*Odoo Bot -> Bot*), etc.

Other debranded phrases can be found the following way ``[[ Settings ]] >> Translations >> Application Terms``.

The cases above, listed by way of the following examples:

Examples
========

* The module deletes Odoo label in footer

Powered by Odoo

* Search a random string at the menu ``[[ Settings ]] >> Users & Copanies >> Companies``

Create and manage the companies that will be managed by Odoo from here. Shops or subsidiaries can be created and maintained from here.

* Remove Administrator via menu ``[[ Settings ]] >> Users & Copanies >> Users``

You can not remove the admin user as it is used internally for resources created by Odoo (updates, module installation, ...).

* ``[[ Settings ]] >> Dashboard >> Companies``
* When you create new company it shows placeholder for field Website

e.g. www.odoo.com

* Open menu``[[ Settings ]] >> General Settings``

Use external pads in Odoo Notes.
Extract and analyze Odoo data from Google Spreadsheet.

* Open menu ``[[ Settings ]] >> Dashboard >> *Implementation* section``

Follow these implementation guides to get the most out of Odoo.

* Open menu ``[[ Discuss ]] >> CHANNELS >> #general``
* Send ``/help`` to the chat

OdooBot - now

You are in channel #general.

You can mention someone by typing @username, this will grab its attention.

You can mention a channel by typing #channel.

You can execute a command by typing /command.

You can insert canned responses in your message by typing :shortcut.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 comments on commit f834108

Please sign in to comment.
You can’t perform that action at this time.