Giter Club home page Giter Club logo

moodle-tiny_edusharing's Introduction

edu-sharing Tiny-Editor

The edu-sharing tiny editor plugin is used to add edu-sharing content when using tiny.

The plugin adds a button to the tiny button bar. After clicking it, the user can open the connected edu-sharing repository and choose or upload a file of his choice. Having done so, they can choose from some display options, such as size and version, and add the content to the editor body.

Furthermore, the user can edit properties of their inserted objects such as caption, width and height.

Dependencies

The edu-sharing tiny editor plugin depends on the edu-sharing activity plugin.

Installing from moodle plugin directory

  1. Log in to your Moodle site as admin and go to Site administration > Plugins > Install plugins.
  2. Click the button to Install plugins from the Moodle plugins directory
  3. Search for the edusharing tiny plugin
  4. Finish the installation

Installing via uploaded ZIP file

  1. Log in to your Moodle site as an admin and go to Site administration > Plugins > Install plugins.
  2. Upload the ZIP file with the plugin code. You should only be prompted to add extra details if your plugin type is not automatically detected.
  3. Check the plugin validation report and finish the installation.

Installing manually

The plugin can be also installed by putting the contents of this directory to

{your/moodle/dirroot}/lib/editor/tiny/plugins/edusharing

Afterward, log in to your Moodle site as an admin and go to Site administration > Notifications to complete the installation.

Alternatively, you can run

$ php admin/cli/upgrade.php

to complete the installation from the command line.

License

2023 metaVentis GmbH http://metaventis.com

This program is free software: you can redistribute it and/or modify it under the terms of the GNU 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

moodle-tiny_edusharing's People

Contributors

zieglermarian avatar ernst-metaventis avatar

Watchers

avatar Frank Thomschke avatar Matthias Hupfer avatar avatar

moodle-tiny_edusharing's Issues

Missing string $string['helplinktext'] required by tiny plugins

The function getPluginMetadata in
https://github.com/moodle/moodle/blob/b798633ae074eddd581724d0c5b1cdba01b9d909/lib/editor/tiny/amd/src/utils.js#L242-L250
expects the tiny plugins to define $string['helplinktext']. This leads to the following error then the function is invoked:

Got error 'PHP message: Debugging: Invalid get_string() identifier: 'helplinktext' or component 'tiny_edusharing'. Perhaps you are missing $string['helplinktext'] = ''; in /moodle/apache2/htdocs/lib/editor/tiny/plugins/edusharing/lang/en/tiny_edusharing.php? in
line 356 of /lib/classes/string_manager_standard.php: call to debugging()
line 109 of /lib/external/externallib.php: call to core_string_manager_standard->get_string()
line ? of unknownfile: call to core_external::get_string()
line 253 of /lib/external/classes/external_api.php: call to call_user_func_array()
line 83 of /lib/ajax/service.php: call to core_external\\external_api::call_external_function()
line 33 of /lib/ajax/service-nologin.php: call to require_once()
', referer: MYMOODLE

Most tiny plugins just use the plugin name for this string so adding $string['helplinktext'] = 'Edusharing'; to lang/en/tiny_edusharing.php and lang/en/tiny_edusharing.php will fix this issue.

Your repository name should use the standard frankenstyle Moodle naming convention

Your repository name should use the standard frankenstyle Moodle naming convention which makes it easy for moodle admins to identify your plugin.

the correct format to use is moodle-{frankenstylepluginname}
eg if your plugin was "mod_attendance" the correct name to use would be: "moodle-mod_attendance"

also - put your files in the "root" of the repo - don't put them inside a folder called "moodle-mod_attendance" that way admins can use git submodules or subtrees to install your plugin in their sites.

not a blocker for approval - but really good to do.

Use of incorrect namespace

https://github.com/edu-sharing/-plugin-moodle-edu-sharing-tiny-editor/blob/6bf65a20646b5142b80b79c1220b372ca32aebc6/classes/privacy/provider.php#L25

Please refer to https://moodledev.io/general/development/policies/codingstyle#rules-for-level2

Your custom namespaces like fonts, help, model, pdf, report or privacy violate this naming rule. There are good reasons why it should be followed, mainly to avoid potential conflicts in the future. All these should be under classes/local/ namespace.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.