Minor - Update plugins README files - refs #2200

pull/2487/head
Yannick Warnier 8 years ago
parent e29d9356b9
commit ec4bf0821a
  1. 7
      plugin/formLogin_hide_unhide/README.md
  2. 4
      plugin/formLogin_hide_unhide/readme.txt
  3. 6
      plugin/hello_world/README.md
  4. 3
      plugin/hello_world/readme.txt
  5. 8
      plugin/ims_lti/README.md
  6. 6
      plugin/jcapture/README.md
  7. 10
      plugin/kannelsms/README.md
  8. 3
      plugin/kannelsms/readme.txt
  9. 9
      plugin/maintenancemode/README.txt
  10. 6
      plugin/olpc_peru_filter/README.md
  11. 19
      plugin/pens/README.md
  12. 6
      plugin/rss/README.md
  13. 4
      plugin/rss/readme.txt
  14. 4
      plugin/search_course/README.md
  15. 1
      plugin/search_course/readme.txt
  16. 35
      plugin/sepe/README.md
  17. 24
      plugin/sepe/readme.txt
  18. 6
      plugin/share_buttons/README.md
  19. 3
      plugin/share_buttons/readme.txt
  20. 4
      plugin/show_regions/README.md
  21. 3
      plugin/show_regions/readme.txt
  22. 5
      plugin/show_user_info/README.md
  23. 3
      plugin/show_user_info/readme.txt
  24. 4
      plugin/static/README.md
  25. 1
      plugin/static/readme.txt
  26. 15
      plugin/studentfollowup/README.md
  27. 5
      plugin/text/README.md
  28. 3
      plugin/text/readme.txt

@ -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.

@ -1,4 +0,0 @@
README
<br/><br/>
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.<br/><br/>
This plugin has been done to be added in the login_top region.<br/>

@ -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.

@ -1,3 +0,0 @@
README
This file will be linked in the plugin settings page

@ -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.

@ -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.

@ -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.

@ -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.

@ -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.

@ -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).

@ -1,23 +1,28 @@
<h1>Introduction</h1>
PENS plugin
===
This plugin implements PENS in Chamilo, using the library php-pens available here: http://github.com/guillaumev/php-pens
<h1>Requirements</h1>
Requirements
---
You need the curl extension installed to use this library.
<h1>How to install ?</h1>
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:
<pre>
```
require_once __DIR__ . '/plugin/pens/pens.php';
</pre>
```
<h1>Licence</h1>
Licence
---
The chamilo-pens plugin is published under the GNU/GPLv3+ licence (see COPYING)
<h1>Credits</h1>
Credits
---
The original author of the plugin is Guillaume Viguier-Just <guillaume@viguierjust.com>.

@ -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.

@ -1,4 +0,0 @@
Display RSS feeds using the Google Dynamic Feed control.
<p>
See http://www.google.com/uds/solutions/dynamicfeed/index.html for further information.
</p>

@ -0,0 +1,4 @@
Search courses plugin
===
Search courses in the main catalogue and register.

@ -1 +0,0 @@
Search courses in the main catalogue and register.

@ -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 <em>/plugin/sepe/ws/ProveedorCentroTFWS.wsdl</em> modificar la linea 910 para indicar el dominio de la plataforma.
*Composer*:
- Es necesario incluir en el fichero <i>composer.json</i> en el apartado de "require" bajo la linea <em>"zendframework/zend-config": "2.3.3",</em> insertar <em>"zendframework/zend-soap": "2.*",</em>
- 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:
<em>http://dominioquecorresponda/plugin/sepe/ws/service.php</em>
Icons made by <a href="http://www.flaticon.com/authors/freepik" title="Freepik">Freepik</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0">CC BY 3.0</a>

@ -1,24 +0,0 @@
Plugin que conecta el SEPE con la plataforma de formación Chamilo.<br>
<br>
<b>Integra:</b><br>
- Conexiones SOAP<br>
- Formularios para editar datos<br>
<br>
<b>Instrucciones:</b><br>
- Instalar plugin
- En configuración del plugin: Habilitar Sepe -> SI -> Guardar <br>
- Seleccionar una región del plugin -> menu_administrator <br>
- Crear un usuario llamado SEPE con perfil de recursos humanos.<br>
- 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.<br>
- En el fichero <em>/plugin/sepe/ws/ProveedorCentroTFWS.wsdl</em> modificar la linea 910 para indicar el dominio de la plataforma.<br>
<br>
<b>Composer:</b><br>
- Es necesario incluir en el fichero <i>composer.json</i> en el apartado de "require" bajo la linea <em>"zendframework/zend-config": "2.3.3",</em> insertar <em>"zendframework/zend-soap": "2.*",</em> <br>
- A continuación habrá que actualizar desde la linea de comandos el directorio vendor, usando la orden 'composer update'<br>
<br>
<b>Verificación del Webservices:</b><br>
- Para verificar que el webservice está activo, habrá que entrar desde un navegador web a la siguiente dirección:
<em>http://dominioquecorresponda/plugin/sepe/ws/service.php</em><br>
<br>
<div>Icons made by <a href="http://www.flaticon.com/authors/freepik" title="Freepik">Freepik</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0">CC BY 3.0</a></div>

@ -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.

@ -1,3 +0,0 @@
README
It can slow down your website because it will load a javascript file from the addthis.com server

@ -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.

@ -1,3 +0,0 @@
README
This file will be linked in the plugin settings page

@ -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.

@ -1,3 +0,0 @@
README
This plugin show the current user information

@ -0,0 +1,4 @@
Static plugin
===
Displays static content in a selected region.

@ -1 +0,0 @@
Display static content.

@ -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.

@ -0,0 +1,5 @@
Text plugin
===
Displays a text in a region.
This plugin is similar to the "Static" plugin.

@ -1,3 +0,0 @@
README
Display a text in a region.
Loading…
Cancel
Save