diff --git a/web_warning_sound/README.rst b/web_warning_sound/README.rst deleted file mode 100644 index a0a71f11..00000000 --- a/web_warning_sound/README.rst +++ /dev/null @@ -1,28 +0,0 @@ -This plugin allows to create modules that can play sound files. -It can be used in on_change methods or when raising an orm_except. - -The sound files need to be located in the module's static directory:: - -module_name/static/path/to/audio/file/mysound.wav - -Then the web client can access these files using the url path:: - -/module_name/static/path/to/audio/file/mysound.wav - - -To use it in on_change methods just add the the url path of the -audio file in the result dictionary under the key 'sound'. Example:: - - res['sound'] = '/module_name/static/path/to/audio/file/mysound.wav' - res['warning'] = { - 'title': _('Cannot do something'), - 'message': _('The reason why...'), - } - return res - -On orm_except put the url path of the file inside '{{}}' as in this example:: - - raise orm_except( - 'Cannot do something', - 'The reason why... {{ sound: /module_name/static/path/to/audio/file/mysound.wav }}' - )