muk_web/muk_web_preview/doc/index.rst

===========
MuK Preview
===========

MuK Preview enables support to preview binary files directly in Odoo. It adds a
button to the binary field, which opens a file preview dialog. The preview can
be easily extended by adding new Handlers to the Preview Generator.

Installation
============

To install this module, you need to:

Download the module and add it to your Odoo addons folder. Afterward, log on to
your Odoo server and go to the Apps menu. Trigger the debug mode and update the
list by clicking on the "Update Apps List" link. Now install the module by
clicking on the install button.

Another way to install this module is via the package management for Python
(`PyPI <https://pypi.org/project/pip/>`_).

To install our modules using the package manager make sure
`odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed
correctly. Then open a console and install the module by entering the following
command:

``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``

The module name consists of the Odoo version and the module name, where
underscores are replaced by a dash.

**Module:** 

``odoo<version>-addon-<module_name>``

**Example:**

``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils``

Once the installation has been successfully completed, the app is already in the
correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the 
debug mode and update the list by clicking on the "Update Apps List" link. Now
install the module by clicking on the install button.

The biggest advantage of this variant is that you can now also update the app
using the "pip" command. To do this, enter the following command in your console:

``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``

When the process is finished, restart your server and update the application in 
Odoo. The steps are the same as for the installation only the button has changed
from "Install" to "Upgrade".

You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_
and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.

For modules licensed under OPL-1, you will receive access data when you purchase
the module. If the modules were not purchased directly from
`MuK IT <https://www.mukit.at/>`_ please contact our support (support@mukit.at)
with a confirmation of purchase to receive the corresponding access data.

Upgrade
============

To upgrade this module, you need to:

Download the module and add it to your Odoo addons folder. Restart the server
and log on to your Odoo server. Select the Apps menu and upgrade the module by
clicking on the upgrade button.

If you installed the module using the "pip" command, you can also update the
module in the same way. Just type the following command into the console:

``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``

When the process is finished, restart your server and update the application in 
Odoo, just like you would normally.

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

No additional configuration is needed to use this module.

Usage
=============

To each Binary Field Widget a button is added, which opens the Preview Dialog.

Framework
=============

To extend the preview a new "PreviewHandler" has to be created and subsequently added to the "PreviewGenerator". 
The following steps show the implementation of the image preview.

PreviewHandler
--------------

.. code-block:: javascript

    odoo.define('muk_preview_image.PreviewHandler', function (require) {
	"use strict";
	
	var core = require('web.core');
	
	var PreviewHandler = require('muk_preview.PreviewHandler');
	
	var QWeb = core.qweb;
	var _t = core._t;
	
	var ImageHandler = PreviewHandler.BaseHandler.extend({
		checkExtension: function(extension) {
			return ['.cod', '.ras', '.fif', '.gif', ...].includes(extension);
	    },
	    checkType: function(mimetype) {
			return ['image/cis-cod', 'image/fif', ...].includes(mimetype);
	    },
	    createHtml: function(url, mimetype, extension, title) {
	    	var result = $.Deferred();
			var $content = $(QWeb.render('ImageHTMLContent', {url: url, alt: title}));
			$content.find('img').click(function (e) {
				ImageViewer().show(this.src, this.src);
		    });
	        result.resolve($content);
			return $.when(result);
	    },
	});
	
	return {
		ImageHandler: ImageHandler,
	}
	
	});

PreviewGenerator
----------------

.. code-block:: javascript
	
	odoo.define('muk_preview_image.PreviewGenerator', function (require) {
	"use strict";
	
	var core = require('web.core');
	
	var PreviewGenerator = require('muk_preview.PreviewGenerator');
	var PreviewHandler = require('muk_preview_image.PreviewHandler');
	
	var QWeb = core.qweb;
	var _t = core._t;
	
	PreviewGenerator.include({
		init: function(widget, additional_handler) {
			this._super(widget, additional_handler);
			this.handler = _.extend(this.handler, {
				"ImageHandler": new PreviewHandler.ImageHandler(widget),
			});
		},
	});
	
	});
	
Credits
=======

Contributors
------------

* Mathias Markl <mathias.markl@mukit.at>

Author & Maintainer
-------------------

This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.

MuK IT is an Austrian company specialized in customizing and extending Odoo.
We develop custom solutions for your individual needs to help you focus on
your strength and expertise to grow your business.

If you want to get in touch please contact us via mail
(sale@mukit.at) or visit our website (https://mukit.at).