diff --git a/plugin/formLogin_hide_unhide/README.md b/plugin/formLogin_hide_unhide/README.md new file mode 100755 index 0000000000..7493ed5bfb --- /dev/null +++ b/plugin/formLogin_hide_unhide/README.md @@ -0,0 +1,7 @@ +Hide/Show login form plugin +=== + +If you use another way of authentication than local, you may want to hide the Login/Password default Form to avoid user mistakes. +This plugin replaces the Login/Password form with a text that shows the Login/Password form if you click on it. + +This plugin has been done to be added in the login_top region. \ No newline at end of file diff --git a/plugin/formLogin_hide_unhide/readme.txt b/plugin/formLogin_hide_unhide/readme.txt deleted file mode 100755 index 693ce1dca8..0000000000 --- a/plugin/formLogin_hide_unhide/readme.txt +++ /dev/null @@ -1,4 +0,0 @@ -README -

-If you use another way of authentication than local, you may want to hide the Login/Password default Form to avoid users mistakes. This plugin replace the Login/Password form with a text that unhide the Login/Password form if you click on it.

-This plugin has been done to be added in the login_top region.
\ No newline at end of file diff --git a/plugin/hello_world/README.md b/plugin/hello_world/README.md new file mode 100755 index 0000000000..57cd065da7 --- /dev/null +++ b/plugin/hello_world/README.md @@ -0,0 +1,6 @@ +Hello world plugin +=== + +This plugin is a minimal code to serve as example of what a plugin has to contain. + +This file will be linked in the plugin settings page through a README button. \ No newline at end of file diff --git a/plugin/hello_world/readme.txt b/plugin/hello_world/readme.txt deleted file mode 100755 index 875b09eeec..0000000000 --- a/plugin/hello_world/readme.txt +++ /dev/null @@ -1,3 +0,0 @@ -README - -This file will be linked in the plugin settings page \ No newline at end of file diff --git a/plugin/ims_lti/README.md b/plugin/ims_lti/README.md new file mode 100644 index 0000000000..d8f9c96f37 --- /dev/null +++ b/plugin/ims_lti/README.md @@ -0,0 +1,8 @@ +IMS/LTI plugin +=== + +This plugin is meant to be later integrated into Chamilo (in a major version release). + +IMS/LTI defines the possibility to integrate tools or content into Chamilo. +This plugin allows the integration of a new tool into courses, without (for now) obtaining any data back from those tools. +It will gradually be developed to support IMS/LTI content items. \ No newline at end of file diff --git a/plugin/jcapture/README.md b/plugin/jcapture/README.md new file mode 100644 index 0000000000..e2eb327dc2 --- /dev/null +++ b/plugin/jcapture/README.md @@ -0,0 +1,6 @@ +JCapture +=== + +The jCapture plugin integrates a set of JavaScript and Java Applet files that enable the recording of desktop screencasts directly into the Chamilo documents tool. + +By enabling the plugin, a new icon will appear in the action bar of the documents tool. \ No newline at end of file diff --git a/plugin/kannelsms/README.md b/plugin/kannelsms/README.md new file mode 100644 index 0000000000..0ca15db7aa --- /dev/null +++ b/plugin/kannelsms/README.md @@ -0,0 +1,10 @@ +Kannel SMS plugin +=== + +This plugin enables Chamilo to send SMS messages to Chamilo users when a notification email is sent. + +SMS message types (a new course is created, an account is approved and so on) can be enabled or disabled from its plugin configuration option. + +Kannel SMS requires a Kannel server (software) to be installed on the machine and a cellphone to be connected to this server (usually through a USB cable). The communication is thus made through the cellphone itself. + +This is only for one-way communication from the Chamilo server to students cellphones. diff --git a/plugin/kannelsms/readme.txt b/plugin/kannelsms/readme.txt deleted file mode 100644 index 134ff5a8d1..0000000000 --- a/plugin/kannelsms/readme.txt +++ /dev/null @@ -1,3 +0,0 @@ -This plugin enables Chamilo to send SMS messages to Chamilo users when a notification email is sent. - -SMS message types (a new course is created, an account is approved and so on) can be enabled or disabled from it's plugin configuration option. \ No newline at end of file diff --git a/plugin/maintenancemode/README.txt b/plugin/maintenancemode/README.txt new file mode 100644 index 0000000000..c00e87643d --- /dev/null +++ b/plugin/maintenancemode/README.txt @@ -0,0 +1,9 @@ +Maintenance Mode plugin +=== + +This plugin allows administrators to set the portal in maintenance mode through the change of the .htaccess file located +in the root folder of Chamilo. + +As such, it requires the web server (user www-data, httpd or nobody) to temporarily have write access to the .htaccess +file. Maintaining write access on this file is a security vulnerability, so please only set those permissions for the +required time to put your site in maintenance mode, and then return them to non-writable by the web server. \ No newline at end of file diff --git a/plugin/olpc_peru_filter/README.md b/plugin/olpc_peru_filter/README.md index 04610009ae..d5b72ee0c6 100644 --- a/plugin/olpc_peru_filter/README.md +++ b/plugin/olpc_peru_filter/README.md @@ -1,5 +1,11 @@ +OLPC Peru plugin +=== + ## English +This plugin is scheduled for deprecation. As far as we understand, the OLPC project in Peru is not being maintained in a relevant way anymore. +This plugin being only an integration to the specific context of OLPC *XS servers* in Peru (rules to integrate with Squid to filter content), and this XS server not supporting PHP 5.6 (which is now a requirement for Chamilo) we do not feel it has the usefulness that would justify its maintenance in Chamilo. + This plugin will create administration settings to configure the content filtering on OLPC Peru's XS servers (uses Squid). diff --git a/plugin/pens/readme.txt b/plugin/pens/README.md similarity index 85% rename from plugin/pens/readme.txt rename to plugin/pens/README.md index 0566345f0f..0320c8c987 100755 --- a/plugin/pens/readme.txt +++ b/plugin/pens/README.md @@ -1,23 +1,28 @@ -

Introduction

+PENS plugin +=== This plugin implements PENS in Chamilo, using the library php-pens available here: http://github.com/guillaumev/php-pens -

Requirements

+Requirements +--- You need the curl extension installed to use this library. -

How to install ?

+How to install +--- Install the plugin and create a file at the root of your chamilo server called pens.php. Put the following code in the pens.php file you created: -
+```
 require_once __DIR__ . '/plugin/pens/pens.php';
-
+``` -

Licence

+Licence +--- The chamilo-pens plugin is published under the GNU/GPLv3+ licence (see COPYING) -

Credits

+Credits +--- The original author of the plugin is Guillaume Viguier-Just . diff --git a/plugin/rss/README.md b/plugin/rss/README.md new file mode 100755 index 0000000000..44969403fc --- /dev/null +++ b/plugin/rss/README.md @@ -0,0 +1,6 @@ +RSS plugin +=== + +This plugin displays RSS feeds using the Google Dynamic Feed control. + +See http://www.google.com/uds/solutions/dynamicfeed/index.html for further information. \ No newline at end of file diff --git a/plugin/rss/readme.txt b/plugin/rss/readme.txt deleted file mode 100755 index 1ebcbe17b1..0000000000 --- a/plugin/rss/readme.txt +++ /dev/null @@ -1,4 +0,0 @@ -Display RSS feeds using the Google Dynamic Feed control. -

-See http://www.google.com/uds/solutions/dynamicfeed/index.html for further information. -

\ No newline at end of file diff --git a/plugin/search_course/README.md b/plugin/search_course/README.md new file mode 100755 index 0000000000..431fbc6ef9 --- /dev/null +++ b/plugin/search_course/README.md @@ -0,0 +1,4 @@ +Search courses plugin +=== + +Search courses in the main catalogue and register. \ No newline at end of file diff --git a/plugin/search_course/readme.txt b/plugin/search_course/readme.txt deleted file mode 100755 index 386c386c14..0000000000 --- a/plugin/search_course/readme.txt +++ /dev/null @@ -1 +0,0 @@ -Search courses in the main catalogue and register. \ No newline at end of file diff --git a/plugin/sepe/README.md b/plugin/sepe/README.md new file mode 100644 index 0000000000..907ddcf2eb --- /dev/null +++ b/plugin/sepe/README.md @@ -0,0 +1,35 @@ +SEPE plugin +=== + +This plugin is specific to the Spanish context. As such, most of its documentation and code might include Spanish language. + +Plugin que conecta el SEPE con la plataforma de formación Chamilo +--- + +*Integra*: + +- Conexiones SOAP +- Formularios para editar datos + +*Instrucciones*: + +- Instalar plugin +- En configuración del plugin: Habilitar Sepe -> SI -> Guardar +- Seleccionar una región del plugin -> menu_administrator +- Crear un usuario llamado SEPE con perfil de recursos humanos. +- Ir al menú del plugin Sepe (en la sección de plugin activos en administración) y seleccionar el link de "Configuración" -> Generar API key. Usar esta clave para realizar pruebas con el SOAP. +- En el fichero /plugin/sepe/ws/ProveedorCentroTFWS.wsdl modificar la linea 910 para indicar el dominio de la plataforma. + +*Composer*: + +- Es necesario incluir en el fichero composer.json en el apartado de "require" bajo la linea "zendframework/zend-config": "2.3.3", insertar "zendframework/zend-soap": "2.*", +- A continuación habrá que actualizar desde la linea de comandos el directorio vendor, usando la orden 'composer update' + +*Verificación del WebService*: + +- Para verificar que el webservice está activo, habrá que entrar desde un navegador web a la siguiente dirección: +http://dominioquecorresponda/plugin/sepe/ws/service.php + + +Icons made by Freepik from www.flaticon.com is licensed by CC BY 3.0 + diff --git a/plugin/sepe/readme.txt b/plugin/sepe/readme.txt deleted file mode 100644 index 4e56101bdb..0000000000 --- a/plugin/sepe/readme.txt +++ /dev/null @@ -1,24 +0,0 @@ -Plugin que conecta el SEPE con la plataforma de formación Chamilo.
-
-Integra:
-- Conexiones SOAP
-- Formularios para editar datos
-
-Instrucciones:
-- Instalar plugin -- En configuración del plugin: Habilitar Sepe -> SI -> Guardar
-- Seleccionar una región del plugin -> menu_administrator
-- Crear un usuario llamado SEPE con perfil de recursos humanos.
-- Ir al menú del plugin Sepe (en la sección de plugin activos en administración) y seleccionar el link de "Configuración" -> Generar API key. Usar esta clave para realizar pruebas con el SOAP.
-- En el fichero /plugin/sepe/ws/ProveedorCentroTFWS.wsdl modificar la linea 910 para indicar el dominio de la plataforma.
-
-Composer:
-- Es necesario incluir en el fichero composer.json en el apartado de "require" bajo la linea "zendframework/zend-config": "2.3.3", insertar "zendframework/zend-soap": "2.*",
-- A continuación habrá que actualizar desde la linea de comandos el directorio vendor, usando la orden 'composer update'
-
-Verificación del Webservices:
-- Para verificar que el webservice está activo, habrá que entrar desde un navegador web a la siguiente dirección: -http://dominioquecorresponda/plugin/sepe/ws/service.php
-
-
Icons made by Freepik from www.flaticon.com is licensed by CC BY 3.0
- diff --git a/plugin/share_buttons/README.md b/plugin/share_buttons/README.md new file mode 100755 index 0000000000..3e0871fac5 --- /dev/null +++ b/plugin/share_buttons/README.md @@ -0,0 +1,6 @@ +Share buttons plugin +=== + +This plugin could slow down your website because it will load a javascript file from the addthis.com server. + +This plugin is very close to the Follow Buttons plugin. \ No newline at end of file diff --git a/plugin/share_buttons/readme.txt b/plugin/share_buttons/readme.txt deleted file mode 100755 index dbf12b49ae..0000000000 --- a/plugin/share_buttons/readme.txt +++ /dev/null @@ -1,3 +0,0 @@ -README - -It can slow down your website because it will load a javascript file from the addthis.com server \ No newline at end of file diff --git a/plugin/show_regions/README.md b/plugin/show_regions/README.md new file mode 100755 index 0000000000..64a55af262 --- /dev/null +++ b/plugin/show_regions/README.md @@ -0,0 +1,4 @@ +Show Regions plugin +=== + +This plugin fills the different regions to make it easier to understand what regions are and where they are located in Chamilo. \ No newline at end of file diff --git a/plugin/show_regions/readme.txt b/plugin/show_regions/readme.txt deleted file mode 100755 index 875b09eeec..0000000000 --- a/plugin/show_regions/readme.txt +++ /dev/null @@ -1,3 +0,0 @@ -README - -This file will be linked in the plugin settings page \ No newline at end of file diff --git a/plugin/show_user_info/README.md b/plugin/show_user_info/README.md new file mode 100755 index 0000000000..383761cafc --- /dev/null +++ b/plugin/show_user_info/README.md @@ -0,0 +1,5 @@ +Show User Info plugin +=== + +This plugin shows the current user information in a selected region. +Make sure you select a region in which you want to show this information. \ No newline at end of file diff --git a/plugin/show_user_info/readme.txt b/plugin/show_user_info/readme.txt deleted file mode 100755 index c4649eafd2..0000000000 --- a/plugin/show_user_info/readme.txt +++ /dev/null @@ -1,3 +0,0 @@ -README - -This plugin show the current user information \ No newline at end of file diff --git a/plugin/static/README.md b/plugin/static/README.md new file mode 100755 index 0000000000..758f3f3827 --- /dev/null +++ b/plugin/static/README.md @@ -0,0 +1,4 @@ +Static plugin +=== + +Displays static content in a selected region. \ No newline at end of file diff --git a/plugin/static/readme.txt b/plugin/static/readme.txt deleted file mode 100755 index 74b109273a..0000000000 --- a/plugin/static/readme.txt +++ /dev/null @@ -1 +0,0 @@ -Display static content. \ No newline at end of file diff --git a/plugin/studentfollowup/README.md b/plugin/studentfollowup/README.md new file mode 100644 index 0000000000..1f7f643388 --- /dev/null +++ b/plugin/studentfollowup/README.md @@ -0,0 +1,15 @@ +Student Follow Up plugin +=== + +This plugin builds the basic pieces of a Student Information System +to enable teachers to give the right user experience to long-term students (and generally +life-long learners) while studying. + +This means teachers can pass along information to their pears about the difficulties a student +has in studying some topics or some challenges they face that might affect their learning. + +This plugin is in an early stage of development and should later (once mainstreamed) be fully + integrated into Chamilo. + +The plugin installation requires the manual creation of a folder or a change in permissions. +Please mind the installation instructions when enabling it. \ No newline at end of file diff --git a/plugin/text/README.md b/plugin/text/README.md new file mode 100644 index 0000000000..227ef5f68f --- /dev/null +++ b/plugin/text/README.md @@ -0,0 +1,5 @@ +Text plugin +=== + +Displays a text in a region. +This plugin is similar to the "Static" plugin. diff --git a/plugin/text/readme.txt b/plugin/text/readme.txt deleted file mode 100644 index 789b4b4a89..0000000000 --- a/plugin/text/readme.txt +++ /dev/null @@ -1,3 +0,0 @@ -README - -Display a text in a region.