diff --git a/web_widget_text_markdown/README.rst b/web_widget_text_markdown/README.rst new file mode 100644 index 000000000..37b308350 --- /dev/null +++ b/web_widget_text_markdown/README.rst @@ -0,0 +1,44 @@ +============================== +Add new text field form widget +============================== + +Description +----------- + +This modules add a new widget for text field in form view on Odoo: + +- In readonly mode, it uses marked to parse and render to html markdown syntax. +- In write mode, use [bootstrap-markdown][1] + +[1]: http://www.codingdrama.com/bootstrap-markdown/ "bootstrap-markdown" + +Requirements +------------ + +Was tested on openerp trunk, 8.0 branch. + +Example +------- + +Your XML form view definition should contain:: + + ... + + ... + +Note / Todo +----------- + +- Improve user experience with Odoo specific syntax +- Improve user experience with Github specific syntax +- Add a working parsed field in tree view +- Add ir.attachment support +- Add images support (with drag'n'drop) +- ... + +Thanks to +--------- + +- Nicolas JEUDY + +If you have questions, please email one of them, or report issue on github diff --git a/web_widget_text_markdown/__init__.py b/web_widget_text_markdown/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/web_widget_text_markdown/__openerp__.py b/web_widget_text_markdown/__openerp__.py new file mode 100644 index 000000000..d3ad525b7 --- /dev/null +++ b/web_widget_text_markdown/__openerp__.py @@ -0,0 +1,37 @@ +# -*- coding: utf-8 -*- +############################################################################## +# +# Copyright (C) 2014 Sudokeys () +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published +# by the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## + +{ + 'name': 'web_widget_text_markdown', + 'version': '1.0', + 'author': 'Sudokeys', + 'maintainer': 'Sudokeys', + 'category': '', + 'license': 'AGPL-3', + 'depends': ['base', 'web'], + 'website': 'http://www.sudokey.com', + 'data': ['views/main.xml', ], + "qweb": ["static/src/xml/bootstrap_markdown.xml", + ], + 'demo': [], + 'installable': True, + 'auto_install': False, + 'application': False +} diff --git a/web_widget_text_markdown/static/lib/bootstrap-markdown/bootstrap-markdown.js b/web_widget_text_markdown/static/lib/bootstrap-markdown/bootstrap-markdown.js new file mode 100644 index 000000000..66ad62f19 --- /dev/null +++ b/web_widget_text_markdown/static/lib/bootstrap-markdown/bootstrap-markdown.js @@ -0,0 +1,1344 @@ +/* =================================================== + * bootstrap-markdown.js v2.7.0 + * http://github.com/toopay/bootstrap-markdown + * =================================================== + * Copyright 2013-2014 Taufan Aditya + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ========================================================== */ + +!function ($) { + + "use strict"; // jshint ;_; + + + /* MARKDOWN CLASS DEFINITION + * ========================== */ + + var Markdown = function (element, options) { + // Class Properties + this.$ns = 'bootstrap-markdown' + this.$element = $(element) + this.$editable = {el:null, type:null,attrKeys:[], attrValues:[], content:null} + this.$options = $.extend(true, {}, $.fn.markdown.defaults, options, this.$element.data(), this.$element.data('options')) + this.$oldContent = null + this.$isPreview = false + this.$isFullscreen = false + this.$editor = null + this.$textarea = null + this.$handler = [] + this.$callback = [] + this.$nextTab = [] + + this.showEditor() + } + + Markdown.prototype = { + + constructor: Markdown + + , __alterButtons: function(name,alter) { + var handler = this.$handler, isAll = (name == 'all'),that = this + + $.each(handler,function(k,v) { + var halt = true + if (isAll) { + halt = false + } else { + halt = v.indexOf(name) < 0 + } + + if (halt == false) { + alter(that.$editor.find('button[data-handler="'+v+'"]')) + } + }) + } + + , __buildButtons: function(buttonsArray, container) { + var i, + ns = this.$ns, + handler = this.$handler, + callback = this.$callback + + for (i=0;i', { + 'class': 'btn-group' + }) + + for (z=0;z'); + buttonContainer.text(' ' + this.__localize(btnText)).addClass('btn-default btn-sm').addClass(btnClass); + if(btnClass.match(/btn\-(primary|success|info|warning|danger|link)/)){ + buttonContainer.removeClass('btn-default'); + } + buttonContainer.attr({ + 'type': 'button', + 'title': this.__localize(button.title) + hotkeyCaption, + 'tabindex': tabIndex, + 'data-provider': ns, + 'data-handler': buttonHandler, + 'data-hotkey': hotkey + }); + if (button.toggle == true){ + buttonContainer.attr('data-toggle', 'button'); + } + buttonIconContainer = $(''); + buttonIconContainer.addClass(buttonIcon); + buttonIconContainer.prependTo(buttonContainer); + + // Attach the button object + btnGroupContainer.append(buttonContainer); + + // Register handler and callback + handler.push(buttonHandler); + callback.push(button.callback); + } + + // Attach the button group into container dom + container.append(btnGroupContainer); + } + } + + return container; + } + , __setListener: function() { + // Set size and resizable Properties + var hasRows = typeof this.$textarea.attr('rows') != 'undefined', + maxRows = this.$textarea.val().split("\n").length > 5 ? this.$textarea.val().split("\n").length : '5', + rowsVal = hasRows ? this.$textarea.attr('rows') : maxRows + + this.$textarea.attr('rows',rowsVal) + if (this.$options.resize) { + this.$textarea.css('resize',this.$options.resize) + } + + this.$textarea + .on('focus', $.proxy(this.focus, this)) + .on('keypress', $.proxy(this.keypress, this)) + .on('keyup', $.proxy(this.keyup, this)) + .on('change', $.proxy(this.change, this)) + + if (this.eventSupported('keydown')) { + this.$textarea.on('keydown', $.proxy(this.keydown, this)) + } + + // Re-attach markdown data + this.$textarea.data('markdown',this) + } + + , __handle: function(e) { + var target = $(e.currentTarget), + handler = this.$handler, + callback = this.$callback, + handlerName = target.attr('data-handler'), + callbackIndex = handler.indexOf(handlerName), + callbackHandler = callback[callbackIndex] + + // Trigger the focusin + $(e.currentTarget).focus() + + callbackHandler(this) + + // Trigger onChange for each button handle + this.change(this); + + // Unless it was the save handler, + // focusin the textarea + if (handlerName.indexOf('cmdSave') < 0) { + this.$textarea.focus() + } + + e.preventDefault() + } + + , __localize: function(string) { + var messages = $.fn.markdown.messages, + language = this.$options.language + if ( + typeof messages !== 'undefined' && + typeof messages[language] !== 'undefined' && + typeof messages[language][string] !== 'undefined' + ) { + return messages[language][string]; + } + return string; + } + + , __getIcon: function(src) { + return typeof src == 'object' ? src[this.$options.iconlibrary] : src; + } + + , setFullscreen: function(mode) { + var $editor = this.$editor, + $textarea = this.$textarea + + if (mode === true) { + $editor.addClass('md-fullscreen-mode') + $('body').addClass('md-nooverflow') + this.$options.onFullscreen(this) + } else { + $editor.removeClass('md-fullscreen-mode') + $('body').removeClass('md-nooverflow') + } + + this.$isFullscreen = mode; + $textarea.focus() + } + + , showEditor: function() { + var instance = this, + textarea, + ns = this.$ns, + container = this.$element, + originalHeigth = container.css('height'), + originalWidth = container.css('width'), + editable = this.$editable, + handler = this.$handler, + callback = this.$callback, + options = this.$options, + editor = $( '
', { + 'class': 'md-editor', + click: function() { + instance.focus() + } + }) + + // Prepare the editor + if (this.$editor == null) { + // Create the panel + var editorHeader = $('
', { + 'class': 'md-header btn-toolbar' + }) + + // Merge the main & additional button groups together + var allBtnGroups = [] + if (options.buttons.length > 0) allBtnGroups = allBtnGroups.concat(options.buttons[0]) + if (options.additionalButtons.length > 0) allBtnGroups = allBtnGroups.concat(options.additionalButtons[0]) + + // Reduce and/or reorder the button groups + if (options.reorderButtonGroups.length > 0) { + allBtnGroups = allBtnGroups + .filter(function(btnGroup) { + return options.reorderButtonGroups.indexOf(btnGroup.name) > -1 + }) + .sort(function(a, b) { + if (options.reorderButtonGroups.indexOf(a.name) < options.reorderButtonGroups.indexOf(b.name)) return -1 + if (options.reorderButtonGroups.indexOf(a.name) > options.reorderButtonGroups.indexOf(b.name)) return 1 + return 0 + }) + } + + // Build the buttons + if (allBtnGroups.length > 0) { + editorHeader = this.__buildButtons([allBtnGroups], editorHeader) + } + + if (options.fullscreen.enable) { + editorHeader.append('
').on('click', '.md-control-fullscreen', function(e) { + e.preventDefault(); + instance.setFullscreen(true) + }) + } + + editor.append(editorHeader) + + // Wrap the textarea + if (container.is('textarea')) { + container.before(editor) + textarea = container + textarea.addClass('md-input') + editor.append(textarea) + } else { + var rawContent = (typeof toMarkdown == 'function') ? toMarkdown(container.html()) : container.html(), + currentContent = $.trim(rawContent) + + // This is some arbitrary content that could be edited + textarea = $(' + + + + +
+ + + +
+
+ + + diff --git a/web_widget_text_markdown/views/main.xml b/web_widget_text_markdown/views/main.xml new file mode 100644 index 000000000..e8a8ab26f --- /dev/null +++ b/web_widget_text_markdown/views/main.xml @@ -0,0 +1,18 @@ + + + + + + +