Update readmes

pull/2487/head
jmontoyaa 10 years ago
parent 5aafc8f461
commit db1216b43c
  1. 99
      plugin/advanced_subscription/readme.txt
  2. 20
      plugin/courseblock/README.md
  3. 4
      plugin/openmeetings/README.md
  4. 2
      plugin/openmeetings/config.php
  5. 2
      plugin/openmeetings/plugin.php
  6. 2
      plugin/skype/readme.txt
  7. 25
      plugin/tour/readme.txt

@ -1,99 +0,0 @@
<h1>
<a id="user-content-advanced-subscription-plugin-for-chamilo-lms" class="anchor" href="#advanced-subscription-plugin-for-chamilo-lms" aria-hidden="true"><span class="octicon octicon-link"></span></a>Advanced subscription plugin for Chamilo LMS</h1>
<p>Plugin for managing the registration queue and communication to sessions
from an external website creating a queue to control session subscription
and sending emails to approve student subscription request</p>
<h1>
<a id="user-content-requirements" class="anchor" href="#requirements" aria-hidden="true"><span class="octicon octicon-link"></span></a>Requirements</h1>
<p>Chamilo LMS 1.10 or greater</p>
<h1>
<a id="user-content-settings" class="anchor" href="#settings" aria-hidden="true"><span class="octicon octicon-link"></span></a>Settings</h1>
<table>
<thead>
<tr>
<th>Parameters</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Webservice url</td>
<td>Url to external website to get user profile (SOAP)</td>
</tr>
<tr>
<td>Induction requirement</td>
<td>Checkbox to enable induction as requirement</td>
</tr>
<tr>
<td>Courses count limit</td>
<td>Number of times a student is allowed at most to course by year</td>
</tr>
<tr>
<td>Yearly hours limit</td>
<td>Teaching hours a student is allowed at most to course by year</td>
</tr>
<tr>
<td>Yearly cost unit converter</td>
<td>The cost of a taxation unit value (TUV)</td>
</tr>
<tr>
<td>Yearly cost limit</td>
<td>Number of TUV student courses is allowed at most to cost by year</td>
</tr>
<tr>
<td>Year start date</td>
<td>Date (dd/mm) when the year limit is renewed</td>
</tr>
<tr>
<td>Minimum percentage profile</td>
<td>Minimum percentage required from external website profile</td>
</tr>
</tbody>
</table>
<h1>
<a id="user-content-hooks" class="anchor" href="#hooks" aria-hidden="true"><span class="octicon octicon-link"></span></a>Hooks</h1>
<p>This plugin use the next hooks:</p>
<ul class="task-list">
<li>HookAdminBlock</li>
<li>HookWSRegistration</li>
<li>HookNotificationContent</li>
<li>HookNotificationTitle</li>
</ul>
<h1>
<a id="user-content-web-services" class="anchor" href="#web-services" aria-hidden="true"><span class="octicon octicon-link"></span></a>Web services</h1>
<ul class="task-list">
<li>HookAdvancedSubscription..WSSessionListInCategory</li>
<li>HookAdvancedSubscription..WSSessionGetDetailsByUser</li>
<li>HookAdvancedSubscription..WSListSessionsDetailsByCategory</li>
</ul>
<p>See <code>/plugin/advanced_subscription/src/HookAdvancedSubscription.php</code> to check Web services inputs and outputs</p>
<h1>
<a id="user-content-how-plugin-works" class="anchor" href="#how-plugin-works" aria-hidden="true"><span class="octicon octicon-link"></span></a>How plugin works?</h1>
<p>After install plugin, fill the parameters needed (described above)
Use Web services to communicate course session inscription from external website
This allow to student to search course session and subscribe if is qualified
and allowed to subscribe.
The normal process is:</p>
<ul class="task-list">
<li>Student search course session</li>
<li>Student read session info depending student data</li>
<li>Student request a subscription</li>
<li>A confirmation email is send to student</li>
<li>An email is send to users (superior or admins) who will accept or reject student request</li>
<li>When the user aceept o reject, an email will be send to student, superior or admins respectively</li>
<li>To complete the subscription, the request must be validated and accepted by an admin</li>
</ul>

@ -2,21 +2,7 @@
2. Click "Configure" once the plugin was enabled.
3. Select tool_enable = Yes and save.
4. Go into a *course* (not course session) and enter the Settings tool.
5. In the "Course access" section select "Enable legal terms" and
change the course visibility to "Private" and save.
6. Go to a course or a course in a session a new button "Legal" will appear
in the course home.
7. Click the button "Legal". Fill the form with the content and a file you want
to be shown to the students. There are other options in the form, like:
- Send an email to all users.
- Delete all previous agreements
- Delete the file.
5. In the "Course block" section fill the footer options.
6. Once the form was saved, you will notice that the text you fill in step .5
will appear in the Chamilo footer.
The file are saved in courses/XX/courselegal/
8. Once the form was saved, a new form will appear for the registered users.
The student has to accept the form.
When the form is accepted an email will be sent to the user via email and
then Chamilo message tool
9. The user has to click in the URL. Once the user clicked to the URL the user
will have access to the course.

@ -4,11 +4,15 @@ settings to configure this tool.
More info on OpenMeetings: http://openmeetings.apache.org/
More info on Chamilo: http://www.chamilo.org
The tasks related to the development of this plugin:
* https://support.chamilo.org/issues/5491
* (private system access) https://task.beeznest.com/issues/7046
* https://issues.apache.org/jira/browse/OPENMEETINGS-802
People involved:
* Financed by the Commission Scolaire des Hautes-Rivières, Québec, Canada (and coordinated/executed by the TICFP team)
* First draft developed by Francis Gonzales Tello - Independent (at the time)
* First stable version published by Yannick Warnier - BeezNest/Chamilo team

@ -3,7 +3,7 @@
/* Openmeetings parameters that will be registered in the course settings */
require_once '../../main/inc/global.inc.php';
require_once __DIR__.'/../../main/inc/global.inc.php';
require_once 'lib/openmeetings.class.php';
require_once 'lib/openmeetings_plugin.class.php';

@ -1,5 +1,5 @@
<?php
require_once dirname(__FILE__).'/config.php';
require_once __DIR__.'/config.php';
$plugin_info = openmeetingsPlugin::create()->get_info();

@ -1,2 +0,0 @@
<h1>Skype Plugin</h1>
<p>Create Skype user field</p>

@ -1,25 +0,0 @@
<h1>Chamilo Tour Plugin</h1>
<p>Shows people how to use your Chamilo LMS</p>
<h2>Set the blocks for the tour</h2>
<p>Edit the <code>plugin/tour/config/tour.json</code> file adding the page classes and steps</p>
<p>To set the steps in a page, add an object like this:</p>
<pre>
{
"pageClass": "page unique class selector",
"steps": [
{
"elementSelector": "element class or id",
"message": "LanguageVariable"
},
{
"elementSelector": "element class or id",
"message": "LanguageVariable"
},
]
}
</pre>
Then set the language variables inside the <code>plugin/tour/lang/$language.php</code> file<br>
<h2>Set a region to plugin</h2>
<p>You must assign a Region to Tour plugin in the Configuration Settings</p>
<p>Choose preferably <code>header_right</code></p>
<br>
Loading…
Cancel
Save