Minor - Update plugins README files - refs #2200
	
		
	
				
					
				
			
							parent
							
								
									e29d9356b9
								
							
						
					
					
						commit
						ec4bf0821a
					
				@ -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,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,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…
					
					
				
		Reference in new issue