MoodleDocs - User contributions [en]

Customlabel subtype development framework

2015-04-18T11:46:56Z

Valeryf: /* Field type : list */

[[Customlabel module (Course elements)| Back to index]]

The customlabel subtype development framework is a set of writting and development rules which will make easy making new subtypes for use in course contents.

The customlabel concept is to centralize all mechanical aspects in the customlabel module, thus keeping writing of a subtype minimalist.

==What is a subtype?==

A subtype is a cutomlabel subplugin handled by the generic subplugin API of Moodle.

A subtype is essentially :

* a directory in the mod/customlabel/type directory
* a subclass of the customlabel_type (@see /mod/customlabel/type/customtype.class.php)
* a file version.php to handle subplugin verisonning
* a lang directory for storing templates and language dependant strings
* a local css file for preseting default styling

==The customlabel_type class==

The customlabel_type class describes what is the internal information model of the customlabel. The custom type must require the geenric customlabel_type implementation to extend the parent class :

require_once ($CFG->dirroot."/mod/customlabel/type/customtype.class.php");

class customlabel_type_coursedata extends customlabel_type{
... implementation ...
}

Just three methods are enough to build the customtype :

===The class constructor===

Defines all information fields used by the customlabel templates. The class stores the type information and builds the $this->fields array that defines each field.

function __construct($data){
parent::__construct($data);
$this->type = 'coursedata';
$this->fields = array();

The constructor will define fields using the following code template :

unset($field);
$field->name = 'fieldname';
$field->type = 'textfield';
$this->fields['fieldname'] = $field;

Field type drives how the instance setting form will require information from the editing teacher. Depending on the type accessory attributes can be used to control specific aspects of the settings form.

====Field type : choiceyesno====

unset($field);
$field->name = 'choiceyesnoname';
$field->type = 'choiceyesno';
$this->fields['choiceyesnoname'] = $field;

Provides a boolean selector as a yes/no list

====Field type : textfield====

unset($field);
$field->name = 'textfieldname';
$field->type = 'textfield';
$field->size = 40; // optional
$field->mawlength = 40; // optional
$this->fields['textfieldname'] = $field;

Provides a simple textfield to get a simple string

====Field type : htmlarea or editor====

unset($field);
$field->name = 'textareafieldname';
$field->type = 'textarea';
$field->size = 80;
$this->fields['textareafieldname'] = $field;

Provides an editable textarea or html editor (depending on site settings) for inpting a formatted multiline content.

====Field type : list====

unset($field);
$field->name = 'datafieldname';
$field->type = 'list';
$field->options = 'comma,separated,list,of,option,keys';
$field->multiple = 'multiple'; // adds multiple choice capability
$this->fields['datafieldname'] = $field;

Provides a select list keyed by the option list and labelled with option key tranlsations in the active language. Translations must
be provided in lang files of the subtype plugin.

There are a set of additional optional attributes that can help in some situations:

$field->straightoptions = true;

The effect will be that the values given in the option list will be presented litteraly, without translation, the same value being used for both key and option value.

Usually, all list shaped attributes will generate two variables for the template : <fieldname> and <fieldname>option. The former one contains the translated value
in the user language of the option value. The latter contains the original key value that was stored by the teacher's choice when setting the instance.

====Field type : datasource====

unset($field);
$field->name = 'datafieldname';
$field->type = 'datasource';
$field->source = 'dbfieldkeyed'; // source mode
$field->table = 'tablename where to get data from';
$field->field = 'sourcefieldname';
$field->select = 'some select clause';
$field->multiple = 'multiple'; // adds multiple choice capability (defaults to : no)
$field->constraintson = 'level1,level2';
$field->mandatory = true; // (defaults to : false)
$this->fields['datafieldname'] = $field;

Datasource field allows data stored in any part of Moodle to serve as information reference for the field. Data source can feed the list with value or keys depending the table can provide keys or both keys and labels. This selection is driven by the 'source" attribute that can
be :

* '''dbfieldkey''' : get a value set from a given field in a given table directly from field values, keys by the 'id' primary key of the table.

Declaration sample :

$field->name = 'courseselectorbyid';
$field->type = 'datasource';
$field->source = 'dbfieldkey';
$field->table = 'course';
$field->field = 'fullname';
$field->ordering = 'sortorder';
$field->select = ' visible = 1 ';
$this->fields['courseselectorbyid'] = $field;

* '''dbfieldkeyed''' : get a value set from a given field in a given table from field values keyed by a given key.

Declaration sample :

$field->name = 'courseselectorbyshortname';
$field->type = 'datasource';
$field->source = 'dbfieldkeyed';
$field->table = 'course';
$field->field = 'fullname';
$field->key = 'shortname';
$field->select = ' visible = 1 ';
$field->ordering = 'sortorder';
$this->fields['courseselectorbyshortname'] = $field;

* '''function''' : get a value set as a result of a given function call. The function is called without any arguments (could be amended).

$field->name = 'selectorbyfunction';
$field->type = 'datasource';
$field->source = 'function';
$field->file = 'sourcefile/path/from/dirroot';
$field->function = 'functionname';
$this->fields['selectorbyfunction'] = $field;

===Preprocessing and postprocessing overrides===

When composing the content of the label from the templates and the available data, the processing runs four steps :

* Preprocessing override (if implemented in the subtype)
* processing options from lists
* processing datasources
* Postprocessing override (if implemented in the subtype)

Typical post processing action could be to amend the production of lists and datasources to get special data setup.

function preprocess_data(){
}

function postprocess_data(){
}

Use $this->data to alter the available data before template production.

==Templates==

Customlabels are preprocessed in order to cache the content for better output performance. The content is calculated from templates when the instance is added or updated. The output is computed from templates available in language directories.

===Template format===

Templates are piece of HTML with placeholders for customlabel internal available information (resulting of the internal data prcoessing. See above). Placeholders are tags of the form %%attributename%%.

Example :

<div class="custombox-commentbox">
<%%comment%%>
</div>

The Comment box customlabel only defines a single textarea attribute named 'comment', that is "callable" by the template.

From Moodle 2 migration, customlabel now accepts elementary conditional syntax :

<%if %%attribute%% %>
.... conditional tempalte code....
<%endif %>

The tested attribute considered as a boolean (empty or not empty) test.

===Language resolution===

The course elements are compatible with multiple language content writing. As some elements are open to really free formatted content, the success of dealing with translations is obtained by providing templates for each language, and inject filtered information comming from element internal storage model.

The way language tagging is performed using <span class="multilang"> tags is sadly not compatible with the standard multilanguage filter, that fails often parsing content when some parts of the content get locally formated with internal spans. Thus the customlabel module needs to be used with the special "multilang enchanced" filter, that will be fully compatible with other multilingual content of Moodle.

Customlabel subtype development framework

2013-01-16T22:03:09Z

Valeryf: /* Preprocessing and postprocessing overrides */

[[Customlabel module (Course elements)| Back to index]]

The customlabel subtype development framework is a set of writting and development rules which will make easy making new subtypes for use in course contents.

The customlabel concept is to centralize all mechanical aspects in the customlabel module, thus keeping writing of a subtype minimalist.

==What is a subtype?==

A subtype is a cutomlabel subplugin handled by the generic subplugin API of Moodle.

A subtype is essentially :

* a directory in the mod/customlabel/type directory
* a subclass of the customlabel_type (@see /mod/customlabel/type/customtype.class.php)
* a file version.php to handle subplugin verisonning
* a lang directory for storing templates and language dependant strings
* a local css file for preseting default styling

==The customlabel_type class==

The customlabel_type class describes what is the internal information model of the customlabel. The custom type must require the geenric customlabel_type implementation to extend the parent class :

require_once ($CFG->dirroot."/mod/customlabel/type/customtype.class.php");

class customlabel_type_coursedata extends customlabel_type{
... implementation ...
}

Just three methods are enough to build the customtype :

===The class constructor===

Defines all information fields used by the customlabel templates. The class stores the type information and builds the $this->fields array that defines each field.

function __construct($data){
parent::__construct($data);
$this->type = 'coursedata';
$this->fields = array();

The constructor will define fields using the following code template :

unset($field);
$field->name = 'fieldname';
$field->type = 'textfield';
$this->fields['fieldname'] = $field;

Field type drives how the instance setting form will require information from the editing teacher. Depending on the type accessory attributes can be used to control specific aspects of the settings form.

====Field type : choiceyesno====

unset($field);
$field->name = 'choiceyesnoname';
$field->type = 'choiceyesno';
$this->fields['choiceyesnoname'] = $field;

Provides a boolean selector as a yes/no list

====Field type : textfield====

unset($field);
$field->name = 'textfieldname';
$field->type = 'textfield';
$field->size = 40; // optional
$field->mawlength = 40; // optional
$this->fields['textfieldname'] = $field;

Provides a simple textfield to get a simple string

====Field type : htmlarea or editor====

unset($field);
$field->name = 'textareafieldname';
$field->type = 'textarea';
$field->size = 80;
$this->fields['textareafieldname'] = $field;

Provides an editable textarea or html editor (depending on site settings) for inpting a formatted multiline content.

====Field type : list====

unset($field);
$field->name = 'datafieldname';
$field->type = 'list';
$field->options = 'comma,separated,list,of,option,keys';
$field->multiple = 'multiple'; // adds multiple choice capability
$this->fields['datafieldname'] = $field;

Provides a select list keyed by the option list and labelled with option key tranlsations in the active language. Translations must
be provided in lang files of the subtype plugin.

====Field type : datasource====

unset($field);
$field->name = 'datafieldname';
$field->type = 'datasource';
$field->source = 'dbfieldkeyed'; // source mode
$field->table = 'tablename where to get data from';
$field->field = 'sourcefieldname';
$field->select = 'some select clause';
$field->multiple = 'multiple'; // adds multiple choice capability (defaults to : no)
$field->constraintson = 'level1,level2';
$field->mandatory = true; // (defaults to : false)
$this->fields['datafieldname'] = $field;

Datasource field allows data stored in any part of Moodle to serve as information reference for the field. Data soruce can feed the list with value or keys depending the table can provide keys or both keys and labels. This selection is driven by the 'source" attribute that can
be :

* '''dbfieldkey''' : get a value set from a given field in a given table directly from field values, keys by the 'id' primary key of the table.

Declaration sample :

$field->name = 'courseselectorbyid';
$field->type = 'datasource';
$field->source = 'dbfieldkey';
$field->table = 'course';
$field->field = 'fullname';
$field->ordering = 'sortorder';
$field->select = ' visible = 1 ';
$this->fields['courseselectorbyid'] = $field;

* '''dbfieldkeyed''' : get a value set from a given field in a given table from field values keyed by a given key.

Declaration sample :

$field->name = 'courseselectorbyshortname';
$field->type = 'datasource';
$field->source = 'dbfieldkeyed';
$field->table = 'course';
$field->field = 'fullname';
$field->key = 'shortname';
$field->select = ' visible = 1 ';
$field->ordering = 'sortorder';
$this->fields['courseselectorbyshortname'] = $field;

* '''function''' : get a value set as a result of a given function call. The function is called without any arguments (could be amended).

$field->name = 'selectorbyfunction';
$field->type = 'datasource';
$field->source = 'function';
$field->file = 'sourcefile/path/from/dirroot';
$field->function = 'functionname';
$this->fields['selectorbyfunction'] = $field;

===Preprocessing and postprocessing overrides===

When composing the content of the label from the templates and the available data, the processing runs four steps :

* Preprocessing override (if implemented in the subtype)
* processing options from lists
* processing datasources
* Postprocessing override (if implemented in the subtype)

Typical post processing action could be to amend the production of lists and datasources to get special data setup.

function preprocess_data(){
}

function postprocess_data(){
}

Use $this->data to alter the available data before template production.

==Templates==

Customlabels are preprocessed in order to cache the content for better output performance. The content is calculated from templates when the instance is added or updated. The output is computed from templates available in language directories.

===Template format===

Templates are piece of HTML with placeholders for customlabel internal available information (resulting of the internal data prcoessing. See above). Placeholders are tags of the form %%attributename%%.

Example :

<div class="custombox-commentbox">
<%%comment%%>
</div>

The Comment box customlabel only defines a single textarea attribute named 'comment', that is "callable" by the template.

From Moodle 2 migration, customlabel now accepts elementary conditional syntax :

<%if %%attribute%% %>
.... conditional tempalte code....
<%endif %>

The tested attribute considered as a boolean (empty or not empty) test.

===Language resolution===

Course element : Contact Point

2013-01-15T22:46:54Z

Valeryf:

[[Customlabel module (Course elements)| Back to index]]

The element "Contact Point" is a simple text of instructions associated to a contact mode to inform remote students that at this point of the progression a communication with the teacher (coach) is expected or suggested. The text should provide sufficiant practical information to realize this connection (procedure, expected schedule, URL for communication tools, etc.).

==User Side==

[[Image:ContactPoint_generic_sample.jpg|||center]]

====Derivated forms====

[[Image:ContactPoint_icon_samples.jpg|||center]]

===Settings form===

[[Image:ContactPoint_settings.jpg|||center]]

==Integrator Corner==

===Default Template===

<table class="custombox-contactpoint" cellspacing="0" width="100%">
<tr valign="middle">
<td class="custombox-header-thumb contactpoint <%%contacttypeoption%%>" width="2%" rowspan="4">
</td>
<td class="custombox-header-caption contactpoint" width="98%" colspan="2">
Contact point...<br/>
<span class="custombox-header-method contacttype">Method : <%%contacttype%%></span>
</td>
</tr>
<tr>
<td class="custombox-content contactpoint" colspan="2">
<%%instructions%%>
</td>
</tr>
</table>

===CSS Element list===

.custombox-contactpoint (TABLE) : Overal container

.custombox-header-thumb.contactpoint (TD) : Left Icon container

.custombox-header-caption.contactpoint (TD) : Right caption container

.custombox-header-method.contactpoint (SPAN) : Right caption container

.custombox-content.contactpoint (TD) : Message container

Customlabel module (Course elements)

2013-01-15T22:45:02Z

Valeryf: /* Pedagogical bricks */

The customlabel module is a specialisation of the core label module to improve content writing in course main pages.

The customlabel module proposes a set (extensible) of subtypes that match well known uses of the learning editorial activity. Subtypes are essentially small parts of content rendered through a predefined html template fo layout (internal renderer), applying a subtype specific small stylesheet (overridable) and using a small predefined dataset.

When adding a new instance of a customlabel (called Course Element in the GUI) to a course, the activity settings usual form can change of aspect depending on the choosen subtype. The form will self-adapt to the requirements of the element internal information model.

This plugin has two effects on content handling and management :

* '''productivity effect''' : teachers do not nead to bother with styling and aspect consistency, as they just need to enter the adequate payload into the presented fields.
* '''stability effect''' : Any of the course elements will be rendered and layout the same way, thus keeping the same graphical aspect whoever authors a course. This is a good point for an institutional LMS that needs to keep content consistant although deferred to many contributors of distinct IT addition skills.

==Installation==

Available archive : https://github.com/vfremaux/moodle-mod_customlabel

Unpack the customlabel package into the 'mod' directory of your Moodle installation.

Browse to the Administration -> Notification service to proceed to logical install.

===Dependancies===

To process accurately the multiple language content, a modified version of the multilang filter
is necessary to process nested spans in content.

Get the filter MultilangEnhanced and install it along to customlabel.

Disable the standard multilang filter and activate the enhanced filter (he enhanced filter will process all other lang selection strings as required).

==Features summary==

* High semantic level course elements
* Style preset by integrator/styler
* Role sensible elements can hide for some roles (role conditional content)
* Easy extensible subtype model

==Using labels==

Course elements are known as enhanced labels. So adding a course element is just like adding a label, and filling information parts.

On Moodle versions < 2.2, you'll find the 'Course element' choice in the "Add a ressource" menu.

On Moodle versions > 2.3, activities and resources have been unified.

When displaying the setting form, check the first dropdown list for a subtype of label you need (See the above section about subtypes). Let the setting form reload with modified field list and complete the required information. you will notice that when changing the type of a customlabel, the content is not keeped, as there are low chances the semantic is consistant between distinct types.

The label will layout the content in the course sequence.

==Subtypes==

===Generic bricks===

* [[Course element : Text| "Text"]]
* [[Course element : Comment Box| "Comment Box"]]

===Pedagogical bricks===

* [[Course element : Definition| "Definition"]]
* [[Course element : Example| "Example']]
* [[Course element : Important| "Important"]]
* [[Course element : Key points| "Key Points"]]
* [[Course element : Local goals| "Local goals"]]
* [[Course element : See Also| "See Also"]]
* [[Course element : Soluce| "Soluce"]]
* [[Course element : Theorema| "Theorema"]]
* [[Course element : Tips and tricks| "Tips and tricks"]]
* [[Course element : Work to do| "Work to do"]]

===Role conditioned bricks===

* [[Course element : Pedagogical Advice| "Pedagogical advice"]]
* [[Course element : Authoring Note| "Authoring Note"]]

===Structural bricks===

* [[Course element : Course Heading| "Course Heading"]]
* [[Course element : Section Heading| "Section Heading"]]
* [[Course element : Sequence Heading| "Sequence Heading"]]
* [[Course element : Course Classifier| "Course Classifier"]]
* [[Course element : Course information| "Course Information"]]

===Utilties bricks===

* [[Course element : Contact Point| "Contact Point"]]

==Integrator corner==

Customlabel is built to easily add new custom subtypes as required by the context and the pedagogical local project. Following documents give some reference upon how to build new types.

[[Customlabel subtype development framework]]

==Credits==

Valery Fremaux (2008 original) valery.fremaux@gmail.com

The customlabel content strategy was developped to serve the Governement Level Public Teacher PD program (Ministère de l'Education Nationale) in France (called Pairformance) with Intel support.

[[fr:Elements de cours]]

File:SectionHeading settings.jpg

2013-01-15T14:55:54Z

Valeryf:

File:SectionHeading sample.jpg

2013-01-15T14:55:31Z

Valeryf:

Course element : Section Heading

2013-01-15T14:28:19Z

Valeryf: /* CSS Element list */

[[Customlabel module (Course elements)| Back to index]]

The Section Heading is very similar to seqence heading, but setup for a slightly different purpose. Sections are "Chapters in the course" that may assemble sequences. In flexipage formats, section headers may be used in a single page, to introduce a page break between two dense content section.

The defaut version of the Section Heading keeps very close to the Sequence Heading element, and keeps focussing an 'in page' use (cv. full screen). It is provided for common course structure needs, to differenciate the stylesheet application to this organisation level of the course.

==User Side==

[[Image:SectionHeading_sample.jpg|||center]]

===Settings form===

[[Image:SectionHeading_settings.jpg|||center]]

==Integrator Corner==

===Default Template===

<table class="custombox-sectionheading" width="100%">
<tr valign="middle" class="custombox-icon sectionheading">
<%%imageL%%>
<td>
<h1 class="custombox-sectionheading"><%%heading%%></h1>
<p class="custombox-sectionheading"><%%shortdesc%%></p>
</td>
<%%imageR%%>
</tr>
</table>

===CSS Element list===

.custombox-sectionheading (TABLE) : Overal container

.custombox-header.sectionheading (H1) : Section Caption container

.custombox-description.sectionheading (P) : Section Description (summary) container

.custombox-icon.sectionheading (TR) : Section row container

.custombox-icon-left.sectionheading (TD) : Section left icon container

.custombox-icon-right.sectionheading (TD) : Section right icon container

==Element evolution prospective==

This element is probably mostly dedicated to make "chapter" cover pages. The probable evolution of the element will be to add a data table of information relative to the local section, as "section goals", "section objectives", "section duration", "section weight". Etc. This evolution is NOT YET perceived (not mature) in user queries i can collect upon all integration programs.

Course element : Section Heading

2013-01-15T14:24:25Z

Valeryf: /* Element evolution prospecitve */

[[Customlabel module (Course elements)| Back to index]]

The Section Heading is very similar to seqence heading, but setup for a slightly different purpose. Sections are "Chapters in the course" that may assemble sequences. In flexipage formats, section headers may be used in a single page, to introduce a page break between two dense content section.

The defaut version of the Section Heading keeps very close to the Sequence Heading element, and keeps focussing an 'in page' use (cv. full screen). It is provided for common course structure needs, to differenciate the stylesheet application to this organisation level of the course.

==User Side==

[[Image:SectionHeading_sample.jpg|||center]]

===Settings form===

[[Image:SectionHeading_settings.jpg|||center]]

==Integrator Corner==

===Default Template===

<table class="custombox-sectionheading" width="100%">
<tr valign="middle" class="custombox-icon sectionheading">
<%%imageL%%>
<td>
<h1 class="custombox-sectionheading"><%%heading%%></h1>
<p class="custombox-sectionheading"><%%shortdesc%%></p>
</td>
<%%imageR%%>
</tr>
</table>

===CSS Element list===

.custombox-sectionheading (TABLE) : Overal container

.custombox-heading.sectionheading H1 (DIV) : Section Caption container

.custombox-description.sectionheading (DIV) : Section Description (summary) container

==Element evolution prospective==

This element is probably mostly dedicated to make "chapter" cover pages. The probable evolution of the element will be to add a data table of information relative to the local section, as "section goals", "section objectives", "section duration", "section weight". Etc. This evolution is NOT YET perceived (not mature) in user queries i can collect upon all integration programs.

Course element : Section Heading

2013-01-15T14:24:02Z

Valeryf:

[[Customlabel module (Course elements)| Back to index]]

The Section Heading is very similar to seqence heading, but setup for a slightly different purpose. Sections are "Chapters in the course" that may assemble sequences. In flexipage formats, section headers may be used in a single page, to introduce a page break between two dense content section.

The defaut version of the Section Heading keeps very close to the Sequence Heading element, and keeps focussing an 'in page' use (cv. full screen). It is provided for common course structure needs, to differenciate the stylesheet application to this organisation level of the course.

==User Side==

[[Image:SectionHeading_sample.jpg|||center]]

===Settings form===

[[Image:SectionHeading_settings.jpg|||center]]

==Integrator Corner==

===Default Template===

<table class="custombox-sectionheading" width="100%">
<tr valign="middle" class="custombox-icon sectionheading">
<%%imageL%%>
<td>
<h1 class="custombox-sectionheading"><%%heading%%></h1>
<p class="custombox-sectionheading"><%%shortdesc%%></p>
</td>
<%%imageR%%>
</tr>
</table>

===CSS Element list===

.custombox-sectionheading (TABLE) : Overal container

.custombox-heading.sectionheading H1 (DIV) : Section Caption container

.custombox-description.sectionheading (DIV) : Section Description (summary) container

==Element evolution prospecitve==

This element is probably mostly dedicated to make "chpater" cover pages. The probable evolution of the element will be to add a data table of information relative to the local section, as "section goals", "section objectives", "section duration", "section weight". Etc. This evolution is NOT YET perceived (not mature) in user queries i can collect upon all integration programs.

Course element : Section Heading

2013-01-15T14:20:57Z

Valeryf: Created page with " Back to index The Section Heading is very similar to seqence heading, but setup for a slightly different purpose. Sections are "Chapter..."

Course element : Course information

2013-01-15T13:42:06Z

Valeryf: /* Internal Variables */

[[Customlabel module (Course elements)| Back to index]]

The Course Information (Course data) is a tabular element providing meta data about the course volume to the reader. Each items can be hidden or shown.

==User side==

[[Image:CourseData_sample.jpg|||center]]

===Settings form===

[[Image:CourseData_settings.jpg|||center]]

(Partial view)

==Integrator Corner==

===Internal Variables===

* ''%%tablecaption%%'' : Caption for the whole table
* ''%%goals%%'' : Teaching Goals of the course
* ''%%objectives%%'' : Objectives of the student
* ''%%concepts%%'' : Concepts (major) learned
* ''%%duration%%'' : Course duration for the student
* ''%%teachingorganization%%'' : Teaching organisation and methods (summary)
* ''%%prerequisites%%'' : Prerequisites (courses or skills) required to complete the course
* ''%%followers%%'' : Some other courses that could complete the curriculum

Activators :

* ''%%showgoals%%'' : Activator for goals
* ''%%showobjectives%%'' : Activator for objectives
* ''%%showconcepts%%'' : Activztor for concepts
* ''%%showduration%%'' : Activator for duration
* ''%%showteachingorganization%%'' : Activator for teaching organisation
* ''%%showprerequisites%%'' : Activator for prerequisites
* ''%%showfollowers%%'' : Activator for followers

===Default Template===

<table class="custombox-coursedata">
<%if %%tablecaption%% %>
<tr valign="top">
<th class="custombox-title coursedata" colspan="2">
<%%tablecaption%%>
</th>
</tr>
<%endif %>
<%if %%showPARAM%% %>
<tr valign="top">
<td class="custombox-param coursedata">
PARAM:
</td>
<td class="custombox-value coursedata">
<%%PARAM%%>
</td>
</tr>
<%endif %>

...

</table>

===CSS Element list===

.custombox-coursedata(TABLE) : Overal container

.custombox-title.coursedata (TH) : Table title container

.custombox-param.coursedata (TD) : Data Name container

.custombox-value.coursedata (TD) : Data Value container

Course element : Course information

2013-01-15T13:41:01Z

Valeryf:

[[Customlabel module (Course elements)| Back to index]]

The Course Information (Course data) is a tabular element providing meta data about the course volume to the reader. Each items can be hidden or shown.

==User side==

[[Image:CourseData_sample.jpg|||center]]

===Settings form===

[[Image:CourseData_settings.jpg|||center]]

(Partial view)

==Integrator Corner==

===Internal Variables===

* '''%%tablecaption%%''' : Caption for the whole table
* '''%%goals%%''' : Teaching Goals of the course
* '''%%objectives%%''' : Objectives of the student
* '''%%concepts%%''' : Concepts (major) learned
* '''%%duration%%''' : Course duration for the student
* '''%%teachingorganization%%''' : Teaching organisation and methods (summary)
* '''%%prerequisites%%''' : Prerequisites (courses or skills) required to complete the course
* '''%%followers%%''' : Some other courses that could complete the curriculum

Activators :

* '''%%showgoals%%''' : Activator for goals
* '''%%showobjectives%%''' : Activator for objectives
* '''%%showconcepts%%''' : Activztor for concepts
* '''%%showduration%%''' : Activator for duration
* '''%%showteachingorganization%%''' : Activator for teaching organisation
* '''%%showprerequisites%%''' : Activator for prerequisites
* '''%%showfollowers%%''' : Activator for followers

===Default Template===

<table class="custombox-coursedata">
<%if %%tablecaption%% %>
<tr valign="top">
<th class="custombox-title coursedata" colspan="2">
<%%tablecaption%%>
</th>
</tr>
<%endif %>
<%if %%showPARAM%% %>
<tr valign="top">
<td class="custombox-param coursedata">
PARAM:
</td>
<td class="custombox-value coursedata">
<%%PARAM%%>
</td>
</tr>
<%endif %>

...

</table>

===CSS Element list===

.custombox-coursedata(TABLE) : Overal container

.custombox-title.coursedata (TH) : Table title container

.custombox-param.coursedata (TD) : Data Name container

.custombox-value.coursedata (TD) : Data Value container

Course element : Course information

2013-01-15T13:34:02Z

Valeryf:

Course element : Sequence Heading

2013-01-15T09:33:00Z

Valeryf:

[[Customlabel module (Course elements)| Back to index]]

The Sequence Heading is a simple element that provides standard layout and styling for a sequence heading. Sequences are usually used
in multipaged formats, introducing a new working sequence with a new course page. You may use sequence headings in place of a section
caption if required.

==User Side==

[[Image:SequenceHeading_sample.jpg|||center]]

===Settings form===

[[Image:SequenceHeading_settings.jpg|||center]]

==Integrator Corner==

===Default Template===

<table class="custombox-sequenceheading">
<tr valign="top">
<%%imageL%%>
<td><div class="custombox-heading sequenceheading"><h2><<%%heading%%></h2></div>
<div class="custombox-description sequenceheading"><%%shortdesc%%></div>
</td>
<%%imageR%%>
</tr>
</table>

===CSS Element list===

.custombox-sequenceheading (TABLE) : Overal container

.custombox-heading.sequenceheading H2 (DIV) : Sequence Caption container

.custombox-description.sequenceheading (DIV) : Sequence Description (summary) container

Course element : Course Heading

2013-01-15T09:32:00Z

Valeryf:

[[Customlabel module (Course elements)| Back to index]]

==User side==

The Course Heading is a simple element that provides standard layout and styling for whole course main caption.

[[Image:CourseHeading_sample.jpg|||center]]

===Settings form===

[[Image:CourseHeading_settings.jpg|||center]]

==Integrator corner==

===Internal Variables===

* ''%%imageL%%'' : Provides icon bloc at left pos when set to left
* ''%%imageR%%'' : Provides icon bloc at right pos when set to right
* ''%%category%%'' : Category name
* ''%%shortname%%'' : Course short name
* ''%%courseheading%%'' : Course full name
* ''%%idnumber%%'' : Course ID number
* ''%%coursedesc%%'' : Course description (same as used in course lists)

* ''%%imagepositionioption%%' : Image switch : left, right, none
* ''%%showidnumber%%'' : Course ID number activator
* ''%%showshortname%%'' : Course shortname activator
* ''%%showdescription%%'' : Course description activator

===Default Template===

<table class="custombox-courseheading">
<tr valign="middle" class="custombox-icon courseheading">
<%%imageL%%>
</td>
<td width="*">
<%if %%showcategory%% %><div class="custombox-category courseheading"><%%category%%></div><%endif %>
<div class="custombox-preheading courseheading"><%%moduletype%%></div>
<div class="custombox-heading courseheading"><%if %%showshortname%% %>(<%%shortname%%>)<%endif %>
<%%courseheading%%> <%if %%showidnumber%% %>(<%%idnumber%%>)<%endif %></div>
<%if %%showdescription%% %><div class="custombox-description courseheading"><%%coursedesc%%></<%endif %>
</td>
<%%imageR%%>
</tr>
</table>

===CSS Element list===

.custombox-courseheading(TABLE) : Overal container

.custombox-heading.courseheading (DIV) : Course Caption container

.custombox-idnumber.courseheading (DIV) : ID Number container

.custombox-category.courseheading (DIV) : Category Name container

.custombox-description.courseheading (TD) : Course Description (summary) container

File:CourseHeading settings.jpg

2013-01-15T09:13:51Z

Valeryf: uploaded a new version of "File:CourseHeading settings.jpg"

File:CourseHeading sample.jpg

2013-01-15T09:13:18Z

Valeryf: uploaded a new version of "File:CourseHeading sample.jpg"

Course element : Course Heading

2013-01-15T08:54:14Z

Valeryf:

[[Customlabel module (Course elements)| Back to index]]

==User side==

The Course Heading is a simple element that provides standard layout and styling for whole course main caption.

[[Image:CourseHeading_sample.jpg|||center]]

===Settings form===

[[Image:CourseHeading_settings.jpg|||center]]

==Integrator corner==

===Internal Variables===

* ''%%imageL%%'' : Provides icon bloc at left pos when set to left
* ''%%imageR%%'' : Provides icon bloc at right pos when set to right
* ''%%category%%'' : Category name
* ''%%shortname%%'' : Course short name
* ''%%courseheading%%'' : Course full name
* ''%%idnumber%%'' : Course ID number
* ''%%shortname%%'' : Course shortname
* ''%%coursedesc%%'' : Course description (same as used in course lists)

* ''%%imagepositionioption%%' : Image switch : left, right, none
* ''%%showidnumber%%'' : Course ID number activator
* ''%%showshortname%%'' : Course shortname activator
* ''%%showdescription%%'' : Course description activator

===Default Template===

<table class="custombox-courseheading">
<tr valign="middle" class="custombox-icon courseheading">
<%%imageL%%>
</td>
<td width="*">
<%if %%showcategory%% %><div class="custombox-category courseheading"><%%category%%></div><%endif %>
<div class="custombox-preheading courseheading"><%%moduletype%%></div>
<div class="custombox-heading courseheading"><%if %%showshortname%% %>(<%%shortname%%>)<%endif %>
<%%courseheading%%> <%if %%showidnumber%% %>(<%%idnumber%%>)<%endif %></div>
<%if %%showdescription%% %><div class="custombox-description courseheading"><%%coursedesc%%></<%endif %>
</td>
<%%imageR%%>
</tr>
</table>

===CSS Element list===

.custombox-courseheading(TABLE) : Overal container

.custombox-heading.courseheading (DIV) : Course Caption container

.custombox-idnumber.courseheading (DIV) : ID Number container

.custombox-category.courseheading (DIV) : Category Name container

.custombox-description.courseheading (TD) : Course Description (summary) container

Course element : Course Heading

2013-01-15T08:53:15Z

Valeryf: /* Default Template */

[[Customlabel module (Course elements)| Back to index]]

The Course Heading is a simple element that provides standard layout and styling for whole course main caption.

[[Image:CourseHeading_sample.jpg|||center]]

===Settings form===

[[Image:CourseHeading_settings.jpg|||center]]

===Internal Variables===

* ''%%imageL%%'' : Provides icon bloc at left pos when set to left
* ''%%imageR%%'' : Provides icon bloc at right pos when set to right
* ''%%category%%'' : Category name
* ''%%shortname%%'' : Course short name
* ''%%courseheading%%'' : Course full name
* ''%%idnumber%%'' : Course ID number
* ''%%shortname%%'' : Course shortname
* ''%%coursedesc%%'' : Course description (same as used in course lists)

* ''%%imagepositionioption%%' : Image switch : left, right, none
* ''%%showidnumber%%'' : Course ID number activator
* ''%%showshortname%%'' : Course shortname activator
* ''%%showdescription%%'' : Course description activator

===Default Template===

<table class="custombox-courseheading">
<tr valign="middle" class="custombox-icon courseheading">
<%%imageL%%>
</td>
<td width="*">
<%if %%showcategory%% %><div class="custombox-category courseheading"><%%category%%></div><%endif %>
<div class="custombox-preheading courseheading"><%%moduletype%%></div>
<div class="custombox-heading courseheading"><%if %%showshortname%% %>(<%%shortname%%>)<%endif %>
<%%courseheading%%> <%if %%showidnumber%% %>(<%%idnumber%%>)<%endif %></div>
<%if %%showdescription%% %><div class="custombox-description courseheading"><%%coursedesc%%></<%endif %>
</td>
<%%imageR%%>
</tr>
</table>

===CSS Element list===

.custombox-courseheading(TABLE) : Overal container

.custombox-heading.courseheading (DIV) : Course Caption container

.custombox-idnumber.courseheading (DIV) : ID Number container

.custombox-category.courseheading (DIV) : Category Name container

.custombox-description.courseheading (TD) : Course Description (summary) container

Course element : Course Heading

2013-01-15T08:46:59Z

Valeryf: /* Default Template */

Course element : Course Heading

2013-01-15T08:45:24Z

Valeryf:

Course element : Work to do

2013-01-12T16:58:24Z

Valeryf:

[[Customlabel module (Course elements)| Back to index]]

The element "Work to do" is a description that will be visually styled to describe a requirement for work. This may complete or precede an assignment activity to give pedagogic instructions, while the assignment desctiption can focus on practicla file format and delivery constraints notices.

Work to do requirement can be qualified with three attributes, and can be assigned an indicative work time slot.

Work qualification domain should be edited and entered in the site wide settings for customlabels, using the classification management interface.

Default qualifiers :

* '''WORKEFFORT''' (filter) : a scale of increasing workeffort
* '''WORKMODE''' (filter) : a set of working modes (f.e. lonely work, team work, synchronous online, team scrub, etc.)
* '''WORKTYPE''' (filter) : a set of attribute values defining the nature of the operations needed by this working sequence (writing, quest, training, synthesis, exploration, etc.)

[[Image:Worktodo_sample.jpg|||center]]

===Qualifier===

Qualifier values ARE set to default values in the site settings after installation. Here are the default values, that might be altered and changed by an administrator in global settings for the Customlabel plugin.

====Work Effort====

* NQ => Unqualified
* VERYEASY => Trivial work
* EASY => Easy work
* MEDIUM => Work neading a "normal effort"
* HARD => Work neading an additional effort than the common effort
* VERYHARD => Work neading an particular effort or skill to be performed. Needs intensive training or involvement.

====Work Type====

* NQ => Unqualified
* TRAINING => Training, skill reinforcement
* WRITING => Memo writing
* INFOQUEST => Information quest
* EXERCISE => Exercice, application
* PROJECT => Project
* EXPERIMENT => Experience, experimentation
* SYNTHESIS => Synthesis writing, reflexive writing

====Work Mode====

* NQ => Unqualified
* ALONEONLINE => Alone work on online resources
* ALONEOFFLINE => Alone work on offline resources
* TEAMONLINE => Group work (synchronous collective work)
* TEAMOFFLINE => Group work on off line ressources
* COURSEONLINE => Work involving all course participants on online resources or activities
* COURSEOFFLINE => Group work in off line working situation
* COACHSYNCHRONOUS => Face to face work with a peer teacher in synchronouos mode (same time slot)
* COACHASYNCHRONOUS => Face to face work with a peer teacher in asynchronouos mode (material exchange)

===Settings form===

[[Image:Worktodo_settings.jpg|||center]]

===Default Template===

<table class="custombox-worktodo" cellspacing="0" width="100%">
<tr valign="middle">
<td class="custombox-header-thumb worktodo" width="2%" rowspan="3">
</td>
<td class="custombox-worktype worktodo">
<b>Nature: </b> <span class="custom-worktype"><%%worktype%%></span>
</td>
<td class="custombox-timeexpected worktodo" align="right">
<img src="/mod/customlabel/type/worktodo/clock.jpg" /> <%%estimatedworktime%%>
</td>
</tr>
<tr valign="top">
<td class="custombox-worktype worktodo">
<b>Effort: </b> <span class="custombox-workeffort"><%%workeffort%%></span>
</td>
<td class="custombox-workmode worktodo" align="right">
<b>Mode: </b> <span class="custombox-workmode"><%%workmode%%></span>
</td>
</tr>
<tr>
<td class="custombox-content worktodo" colspan="2">
<%%worktodo%%>
</td>
</tr>
</table>

===CSS Element list===

.custombox-worktodo (TABLE) : Overal container

.custombox-header-thumb.worktodo (TD) : Left Icon container

.custombox-header-caption.worktodo (TD) : Right caption container

.custombox-content.worktodo (TD) : Message container

.custombox-worktype.worktodo (TD) : Work type indicator container

.custombox-workeffort.worktodo (TD) : Work effort indicator container

.custombox-workmode.worktodo (TD) : Work mode indicator container

.custombox-timeexpected.worktodo (TD) : Work type indicator container

Customlabel module (Course elements)

2013-01-12T15:50:06Z

Valeryf: /* Installation */

The customlabel module is a specialisation of the core label module to improve content writing in course main pages.

The customlabel module proposes a set (extensible) of subtypes that match well known uses of the learning editorial activity. Subtypes are essentially small parts of content rendered through a predefined html template fo layout (internal renderer), applying a subtype specific small stylesheet (overridable) and using a small predefined dataset.

When adding a new instance of a customlabel (called Course Element in the GUI) to a course, the activity settings usual form can change of aspect depending on the choosen subtype. The form will self-adapt to the requirements of the element internal information model.

This plugin has two effects on content handling and management :

* '''productivity effect''' : teachers do not nead to bother with styling and aspect consistency, as they just need to enter the adequate payload into the presented fields.
* '''stability effect''' : Any of the course elements will be rendered and layout the same way, thus keeping the same graphical aspect whoever authors a course. This is a good point for an institutional LMS that needs to keep content consistant although deferred to many contributors of distinct IT addition skills.

==Installation==

Available archive : https://github.com/vfremaux/moodle-mod_customlabel

Unpack the customlabel package into the 'mod' directory of your Moodle installation.

Browse to the Administration -> Notification service to proceed to logical install.

===Dependancies===

To process accurately the multiple language content, a modified version of the multilang filter
is necessary to process nested spans in content.

Get the filter MultilangEnhanced and install it along to customlabel.

Disable the standard multilang filter and activate the enhanced filter (he enhanced filter will process all other lang selection strings as required).

==Features summary==

* High semantic level course elements
* Style preset by integrator/styler
* Role sensible elements can hide for some roles (role conditional content)
* Easy extensible subtype model

==Using labels==

Course elements are known as enhanced labels. So adding a course element is just like adding a label, and filling information parts.

On Moodle versions < 2.2, you'll find the 'Course element' choice in the "Add a ressource" menu.

On Moodle versions > 2.3, activities and resources have been unified.

When displaying the setting form, check the first dropdown list for a subtype of label you need (See the above section about subtypes). Let the setting form reload with modified field list and complete the required information. you will notice that when changing the type of a customlabel, the content is not keeped, as there are low chances the semantic is consistant between distinct types.

The label will layout the content in the course sequence.

==Subtypes==

===Generic bricks===

* [[Course element : Text| "Text"]]
* [[Course element : Comment Box| "Comment Box"]]

===Pedagogical bricks===

* [[Course element : Important| "Important"]]
* [[Course element : Tips and tricks| "Tips and tricks"]]
* [[Course element : See Also| "See Also"]]
* [[Course element : Key points| "Key Points"]]
* [[Course element : Local goals| "Local goals"]]
* [[Course element : Example| "Example']]
* [[Course element : Work to do| "Work to do"]]
* [[Course element : Soluce| "Soluce"]]

===Role conditioned bricks===

* [[Course element : Pedagogical Advice| "Pedagogical advice"]]
* [[Course element : Authoring Note| "Authoring Note"]]

===Structural bricks===

* [[Course element : Course Heading| "Course Heading"]]
* [[Course element : Section Heading| "Section Heading"]]
* [[Course element : Sequence Heading| "Sequence Heading"]]
* [[Course element : Course Classifier| "Course Classifier"]]
* [[Course element : Course information| "Course Information"]]

===Utilties bricks===

* [[Course element : Contact Point| "Contact Point"]]

==Integrator corner==

Customlabel is built to easily add new custom subtypes as required by the context and the pedagogical local project. Following documents give some reference upon how to build new types.

[[Customlabel subtype development framework]]

==Credits==

Valery Fremaux (2008 original) valery.fremaux@gmail.com

The customlabel content strategy was developped to serve the Governement Level Public Teacher PD program (Ministère de l'Education Nationale) in France (called Pairformance) with Intel support.

[[fr:Elements de cours]]

Customlabel module (Course elements)

2013-01-12T14:50:29Z

Valeryf:

The customlabel module is a specialisation of the core label module to improve content writing in course main pages.

The customlabel module proposes a set (extensible) of subtypes that match well known uses of the learning editorial activity. Subtypes are essentially small parts of content rendered through a predefined html template fo layout (internal renderer), applying a subtype specific small stylesheet (overridable) and using a small predefined dataset.

When adding a new instance of a customlabel (called Course Element in the GUI) to a course, the activity settings usual form can change of aspect depending on the choosen subtype. The form will self-adapt to the requirements of the element internal information model.

This plugin has two effects on content handling and management :

* '''productivity effect''' : teachers do not nead to bother with styling and aspect consistency, as they just need to enter the adequate payload into the presented fields.
* '''stability effect''' : Any of the course elements will be rendered and layout the same way, thus keeping the same graphical aspect whoever authors a course. This is a good point for an institutional LMS that needs to keep content consistant although deferred to many contributors of distinct IT addition skills.

==Installation==

Unpack the customlabel package into the 'mod' directory of your Moodle installation.

Browse to the Administration -> Notification service to proceed to logical install.

===Dependancies===

To process accurately the multiple language content, a modified version of the multilang filter
is necessary to process nested spans in content.

Get the filter MultilangEnhanced and install it along to customlabel.

Disable the standard multilang filter and activate the enhanced filter (he enhanced filter will process all other lang selection strings as required).

==Features summary==

* High semantic level course elements
* Style preset by integrator/styler
* Role sensible elements can hide for some roles (role conditional content)
* Easy extensible subtype model

==Using labels==

Course elements are known as enhanced labels. So adding a course element is just like adding a label, and filling information parts.

On Moodle versions < 2.2, you'll find the 'Course element' choice in the "Add a ressource" menu.

On Moodle versions > 2.3, activities and resources have been unified.

When displaying the setting form, check the first dropdown list for a subtype of label you need (See the above section about subtypes). Let the setting form reload with modified field list and complete the required information. you will notice that when changing the type of a customlabel, the content is not keeped, as there are low chances the semantic is consistant between distinct types.

The label will layout the content in the course sequence.

==Subtypes==

===Generic bricks===

* [[Course element : Text| "Text"]]
* [[Course element : Comment Box| "Comment Box"]]

===Pedagogical bricks===

* [[Course element : Important| "Important"]]
* [[Course element : Tips and tricks| "Tips and tricks"]]
* [[Course element : See Also| "See Also"]]
* [[Course element : Key points| "Key Points"]]
* [[Course element : Local goals| "Local goals"]]
* [[Course element : Example| "Example']]
* [[Course element : Work to do| "Work to do"]]
* [[Course element : Soluce| "Soluce"]]

===Role conditioned bricks===

* [[Course element : Pedagogical Advice| "Pedagogical advice"]]
* [[Course element : Authoring Note| "Authoring Note"]]

===Structural bricks===

* [[Course element : Course Heading| "Course Heading"]]
* [[Course element : Section Heading| "Section Heading"]]
* [[Course element : Sequence Heading| "Sequence Heading"]]
* [[Course element : Course Classifier| "Course Classifier"]]
* [[Course element : Course information| "Course Information"]]

===Utilties bricks===

* [[Course element : Contact Point| "Contact Point"]]

==Integrator corner==

Customlabel is built to easily add new custom subtypes as required by the context and the pedagogical local project. Following documents give some reference upon how to build new types.

[[Customlabel subtype development framework]]

==Credits==

Valery Fremaux (2008 original) valery.fremaux@gmail.com

The customlabel content strategy was developped to serve the Governement Level Public Teacher PD program (Ministère de l'Education Nationale) in France (called Pairformance) with Intel support.

[[fr:Elements de cours]]

Customlabel module (Course elements)

2013-01-12T14:49:09Z

Valeryf:

The customlabel module is a specialisation of the core label module to improve content writing in course main pages.

The customlabel module proposes a set (extensible) of subtypes that match well known uses of the learning editorial activity. Subtypes are essentially small parts of content rendered through a predefined html template fo layout (internal renderer), applying a subtype specific small stylesheet (overridable) and using a small predefined dataset.

When adding a new instance of a customlabel (called Course Element in the GUI) to a course, the activity settings usual form can change of aspect depending on the choosen subtype. The form will self-adapt to the requirements of the element internal information model.

This plugin has two effects on content handling and management :

* '''productivity effect''' : teachers do not nead to bother with styling and aspect consistency, as they just need to enter the adequate payload into the presented fields.
* '''stability effect''' : Any of the course elements will be rendered and layout the same way, thus keeping the same graphical aspect whoever authors a course. This is a good point for an institutional LMS that needs to keep content consistant although deferred to many contributors of distinct IT addition skills.

==Installation==

Unpack the customlabel package into the 'mod' directory of your Moodle installation.

Browse to the Administration -> Notification service to proceed to logical install.

===Dependancies===

To process accurately the multiple language content, a modified version of the multilang filter
is necessary to process nested spans in content.

Get the filter MultilangEnhanced and install it along to customlabel.

Disable the standard multilang filter and activate the enhanced filter (he enhanced filter will process all other lang selection strings as required).

==Features summary==

* High semantic level course elements
* Style preset by integrator/styler
* Role sensible elements can hide for some roles (role conditional content)
* Easy extensible subtype model

==Using labels==

Course elements are known as enhanced labels. So adding a course element is just like adding a label, and filling information parts.

On Moodle versions < 2.2, you'll find the 'Course element' choice in the "Add a ressource" menu.

On Moodle versions > 2.3, activities and resources have been unified.

When displaying the setting form, check the first dropdown list for a subtype of label you need (See the above section about subtypes). Let the setting form reload with modified field list and complete the required information. you will notice that when changing the type of a customlabel, the content is not keeped, as there are low chances the semantic is consistant between distinct types.

The label will layout the content in the course sequence.

==Subtypes==

===Generic bricks===

* [[Course element : Text| "Text"]]
* [[Course element : Comment Box| "Comment Box"]]

===Pedagogical bricks===

* [[Course element : Important| "Important"]]
* [[Course element : Tips and tricks| "Tips and tricks"]]
* [[Course element : See Also| "See Also"]]
* [[Course element : Key points| "Key Points"]]
* [[Course element : Local goals| "Local goals"]]
* [[Course element : Example| "Example']]
* [[Course element : Work to do| "Work to do"]]
* [[Course element : Soluce| "Soluce"]]

===Role conditioned bricks===

* [[Course element : Pedagogical Advice| "Pedagogical advice"]]
* [[Course element : Authoring Note| "Authoring Note"]]

===Structural bricks===

* [[Course element : Course Heading| "Course Heading"]]
* [[Course element : Section Heading| "Section Heading"]]
* [[Course element : Sequence Heading| "Sequence Heading"]]
* [[Course element : Course Classifier| "Course Classifier"]]
* [[Course element : Course information| "Course Information"]]

===Utilties bricks===

* [[Course element : Contact Point| "Contact Point"]]

==Integrator corner==

Customlabel is built to easily add new custom subtypes as required by the context and the pedagogical local project. Following documents give some reference upon how to build new types.

[[Customlabel subtype development framework]]

==Credits==

Valery Fremaux (2008 original) valery.fremaux@gmail.com

The customlabel content strategy was developped to serve the Governement Level Public Teacher PD program (Ministère de l'Education Nationale) in France (called Pairformance) with Intel support.

{{fr:Elements de cours}}

Profile field enrolment

2013-01-12T13:53:43Z

Valeryf:

{{Enrolment}}
Location: External database edit settings link in ''Settings > Site administration > Plugins > Enrolments > Manage enrol plugins'' (once installed)

==Plugin availability==

Get the plugin archive in the [https://moodle.org/plugins/view.php?plugin=mod_customlabel | Moodle PLugin Database].

==Documentation Location==

The full documentation of this enrolment contributive plugin is in the [https://docs.moodle.org/22/en/Profile_field_enrolment | Moodle Documentation 2.2 volume ]

Profile field enrolment

2013-01-12T13:52:56Z

Valeryf:

{{Enrolment}}
Location: External database edit settings link in ''Settings > Site administration > Plugins > Enrolments > Manage enrol plugins'' (once installed)

==Plugin availability==

https://moodle.org/plugins/view.php?plugin=mod_customlabel

==Documentation Location==

The full documentation of this enrolment contributive plugin is in the [https://docs.moodle.org/22/en/Profile_field_enrolment | Moodle Documentation 2.2 volume ]

Profile field enrolment

2013-01-12T12:24:54Z

Valeryf:

The full documentation of this enrolment contributive plugin is in the [https://docs.moodle.org/22/en/Profile_field_enrolment | Moodle Documentation 2.2 volume ]

Profile field enrolment

2013-01-12T12:24:39Z

Valeryf:

The full documentation of this enrolment contributive plugin is in the [https://docs.moodle.org/22/en/Profile_field_enrolment| Moodle Documentation 2.2 volume ]

Profile field enrolment

2013-01-12T12:24:17Z

Valeryf:

The full documentation of this enrolment contributive plugin is in the [https://docs.moodle.org/22/en/Profile_field_enrolment| Moodle Documentation 2.2 volume]

Profile field enrolment

2013-01-12T12:23:49Z

Valeryf: Created page with "The full documentation of this enrolment contributive plugin is in the Moodle Documentation 2.2 volume"

The full documentation of this enrolment contributive plugin is in the [[https://docs.moodle.org/22/en/Profile_field_enrolment| Moodle Documentation 2.2 volume]]

Splitset question configuration screen

2012-12-24T14:16:48Z

Valeryf: /* Question elements */

[[Splitset_question_type| back to index]]

This is the specific part of the question setting relative to the Splitset feature:

[[Image:Splitset_configuration.jpg|||center]]

==Configuration fields==

===Question mark (common question model)===

How many marks the question will add to global quiz score.

===General feedback (common question model)===

A feedback witch is given for any result of the question

===Nunber of sets===

The number of answers in the output set. Note that when you increase this number, you may store the question once and edit back to get the question result mapping lists refreshed.

'''TODO : find a way to dynamically refresh those lists'''

===Set <n> name===

The answer option label for this choice.

===Numbering style===

The style of question item numbering as displayed in the quiz panel.

===Shuffle set elements===

If enabled, the order of the questions will be randomized at each new attempt.

==Feedbacks==

[[Image:Splitset_feedbacks.jpg|||center]]

==Question elements==

[[Image:Splitset_elements.jpg|||center]]

===Element===

this is the text of the question item appearing on the left.

===Correct Answer===

The expected set number for this element.

File:Splitset elements.jpg

2012-12-24T14:15:34Z

Valeryf:

Splitset question configuration screen

2012-12-24T14:15:22Z

Valeryf: /* Question elements */

Splitset question configuration screen

2012-12-24T14:15:11Z

Valeryf: /* Feedbacks */

File:Splitset feedbacks.jpg

2012-12-24T14:14:55Z

Valeryf:

Splitset question configuration screen

2012-12-24T14:14:40Z

Valeryf:

[[Splitset_question_type| back to index]]

This is the specific part of the question setting relative to the Splitset feature:

[[Image:Splitset_configuration.jpg|||center]]

==Configuration fields==

===Question mark (common question model)===

How many marks the question will add to global quiz score.

===General feedback (common question model)===

A feedback witch is given for any result of the question

===Nunber of sets===

The number of answers in the output set. Note that when you increase this number, you may store the question once and edit back to get the question result mapping lists refreshed.

'''TODO : find a way to dynamically refresh those lists'''

===Set <n> name===

The answer option label for this choice.

===Numbering style===

The style of question item numbering as displayed in the quiz panel.

===Shuffle set elements===

If enabled, the order of the questions will be randomized at each new attempt.

==Feedbacks==

[[Image:Splitset_feedbacks.jpg]]

==Question elements==

[[Image:Splitset_elements.jpg]]

Splitset question configuration screen

2012-12-24T14:12:20Z

Valeryf:

File:Splitset configuration.jpg

2012-12-24T14:06:16Z

Valeryf:

Splitset question configuration screen

2012-12-24T14:05:56Z

Valeryf:

[[Splitset_question_type| back to index]]

This is the specific part of the question setting relative to the Splitset feature:

[[Image:Splitset_configuration.jpg|||center]]

Splitset question configuration screen

2012-12-24T13:35:47Z

Valeryf: Created page with " back to index Image:Splitset_configugation.jpg"

[[Splitset_question_type| back to index]]

[[Image:Splitset_configugation.jpg]]

Splitset question type

2012-12-24T13:35:12Z

Valeryf: /* Summary */

==Status==

This code is a contributed code.

==Summary==

The split set question type implements a quiz question based on
list splitting activity.

You may define from 2 to 5 output sets where a list of items can
be split in.

the activity consists in defining which output suits to each item,
collecting a fraction of the maximum grade for each correct subanswer.

Typical use with 2 sets :

A multiple true/false question array.
A allowed/forbidden quiz with multiple actions proposal

==Installation==

Unpack the archive within the question/type directory of Moodle and run the administration notifications.

==Setup==

[[Splitset question configuration screen]]

==Credits==

This question type was programmed vy Valery Fremaux for the Institut Iperia (homecare workers professional developement organization)

Splitset question type

2012-12-24T13:34:25Z

Valeryf: /* Installation */

==Summary==

The split set question type implements a quiz question based on
list splitting activity.

You may define from 2 to 5 output sets where a list of items can
be split in.

the activity consists in defining which output suits to each item,
collecting a fraction of the maximum grade for each correct subanswer.

Typical use with 2 sets :

A multiple true/false question array.
A allowed/forbidden quiz with multiple actions proposal

==Installation==

Unpack the archive within the question/type directory of Moodle and run the administration notifications.

==Setup==

[[Splitset question configuration screen]]

==Credits==

This question type was programmed vy Valery Fremaux for the Institut Iperia (homecare workers professional developement organization)

Splitset question type

2012-12-24T13:33:51Z

Valeryf: /* Installation */

==Summary==

The split set question type implements a quiz question based on
list splitting activity.

You may define from 2 to 5 output sets where a list of items can
be split in.

the activity consists in defining which output suits to each item,
collecting a fraction of the maximum grade for each correct subanswer.

Typical use with 2 sets :

A multiple true/false question array.
A allowed/forbidden quiz with multiple actions proposal

==Installation==

Unpack the archive within the question/type directory of Moodle and run the administration notifications.

==Credits==

This question type was programmed vy Valery Fremaux for the Institut Iperia (homecare workers professional developement organization)

Splitset question type

2012-12-24T13:32:55Z

Valeryf: Created page with "==Summary== The split set question type implements a quiz question based on list splitting activity. You may define from 2 to 5 output sets where a list of items can be split ..."

Super-administration

2012-12-21T23:28:28Z

Valeryf:

[[VMoodle_Block|Back to index]]

==General principles for MNET super-administration==

MNET super-administration is a feature allowing to massively play some administration commands on a set of virtualized Moodle platforms. The commands are transmitted to each nodes using a dedicated MNET function attached to the VMoodle block scope. The emitting platform should subscribe to the super-administration service, receiving nodes should publish the super-administration service.

The MNET super-administration will provide a unique process for executing any network administration command :

# Building the command : Mostly SQL orders, build manually or through some command preset.
# Choosing targets.
# Command execution and getting results.

Tip !! : command and targets are stored in session, thus it will be easy to play the same command on another target set, or keeping the target set and making a new command on it.

Super-administration main screen provides several command sets. As super-administration is a fully extensible architeture, developpers and integrators may easily add command blocks and define new command templates.

===Advanced mode===

The advanced mode will allow an administator to write a full SQL query to be played on all target moodles. Note that the SQL must be independant of local context to have chancs to proceed with success.

[[fr:Super-administration]]

Super-administration

2012-12-21T23:28:15Z

Valeryf: Created page with "Back to index ==General principles for MNET super-administration== MNET super-administration is a feature allowing to massively play some administration commands on..."

[[VMoodle|Back to index]]

==General principles for MNET super-administration==

MNET super-administration is a feature allowing to massively play some administration commands on a set of virtualized Moodle platforms. The commands are transmitted to each nodes using a dedicated MNET function attached to the VMoodle block scope. The emitting platform should subscribe to the super-administration service, receiving nodes should publish the super-administration service.

The MNET super-administration will provide a unique process for executing any network administration command :

# Building the command : Mostly SQL orders, build manually or through some command preset.
# Choosing targets.
# Command execution and getting results.

Tip !! : command and targets are stored in session, thus it will be easy to play the same command on another target set, or keeping the target set and making a new command on it.

Super-administration main screen provides several command sets. As super-administration is a fully extensible architeture, developpers and integrators may easily add command blocks and define new command templates.

===Advanced mode===

The advanced mode will allow an administator to write a full SQL query to be played on all target moodles. Note that the SQL must be independant of local context to have chancs to proceed with success.

[[fr:Super-administration]]

Moodle Instance Management

2012-12-21T23:27:15Z

Valeryf: /* Setup */

[[VMoodle_Block|Back to index]]

The infrastructure for Moodle instances management and deployment allows an easy management of multiple virtualized Moodle instances within the same physical hosting.

==Virtualization principles==

Moodle virtuazlization is simple. It mostly consists of no longer relying on the physical configration file config.php for absolute initial paths and DB definition, but dynamically building a set of configuration values from a table in the database. The set of main configuration parameter values will be chosen depending on the domain name (virtual host).

For integrating the whole virtualization process within Moodle itself, the virtualization table is held by a Moodle block.

==Virtualization process==

The overall lifecycle of a virtualized Moodle array is usually as follows:

===Setup===

The whole set of used domain names must be available and pointed to the same DocumentRoot in Apache. This also can be obtained using a wildcard DNS mapping pointing to such a Virtual Host setting:

<VirtualHost XXX.XXX.XXX.XXX>
ServerName mastermoodle.mydomain.com
ServerAlias *.mydomain.com
...
</VirtualHost>

Once these prerequisites are available, and the PHP volume correctly accessible:

# proceed to the installation of the main Moodle instance (Moodle master, bound to standard configuration).
# install the VMoodle block as a standard block
# place the VMoodle configuration hook in standard config
# configure the master Moodle, insert generic content, make common settings
# IMPORTANT : place an instance of a VMoodle block somewhere so you can browse to VMoodle administration!

You now should have this somewhere in your Moodle:

[[image:Vmoodle_added.jpg|||center]]

Note: an adequate location is in an administration block in administration pages, but you may also use a special "administration" course in your Moodle.

===Deploying virtual instances from a physically setup Moodle===

# make a first snapshot of the master moodle. This will store a replicable backup of the whole platform.
# deploy a first virtual node
# setup and tune the first virtual node
# snapshot the first vitual node as node template
# deploy any amount of nodes using this template.

The following image gives an idea of the virtualization benefit.

[[Image:Vmoodle architecture.jpg|||center]]

==VMoodle Configuration==

To configure the VMoodle block, browse to the VMoodle block settings in Administration menu:

# Define a naming schema for presetting the platform deployment form.
# Define information for connection to database.
# Define information for setting up MNET.
# Proceed to MNET peer key renewal.

1. Defining schema

The naming schema preset allows an easy setup of master information defining a new Moodle platform. The purpose of this automation is to speed up the setup of a new Moodle instance, reduce error when entering information, and promote a consistent naming ruleset for defining multiple Moodle hosts.

[[Image:Vmoodle_config_p1.jpg|||center]]

Schema fields:

o Automate schema : Tells VMoodle to preset the deployment form.
o Virtual host: Gives the pattern for generating new Moodle host names.
o Database type: Preset the type of database used (MySQL or Postgres).
o Database host: Preset value for the database hostname.
o Database login: Preset value for the database user login.
o Database password: Preset value for the database user password.
o Database name: Preset a generation pattern for naming the database.
o Table prefix: Preset value for the table name prefix.
o Persistant connection: Preset value. Persistant connections will not
close at end of the PHP script and be reused.
o Moodledata path: Preset the generation pattern for the Moodledata path.

When a schema is automated, entering the platform token will automatically provide adequate name to host, database and moodle data path.

To setup patterns, use the <%%INSTANCE%%> tag within the pattern to be replaced with the host token.

Example :

If you set the hostname pattern such as :

<nowiki>http://<%%INSTANCE%%>.mydomain.com</nowiki>

And you enter a token with value "moodle1", than the deployment form will replace the pattern with the final value :

<nowiki>http://moodle1.mydomain.com</nowiki>

Same is performed with the database name field and the Moodledata path.

2. Setting up the path to database executables

[[Image:Vmoodle_config_p3.jpg|||center]]

You may only provide system path of executable for the database you want to use (MySQL or Postgres)

Path to executable will surely have to be double quoted.

o Path to mysql terminal : full path to the mysql (Linux) command or mysql.exe (Windows)
o Path to mysql dump : full path to mysqldump (Linux) or mysqldump.exe (Windows)
o Path to postgres terminal : full path to psql (Linux) psql.exe (Windows)
o Path to postgres dump : full path to pg_dump (Linux) or pg_dump.exe (Windows)

Configuration note:

On Linux common location for mySQL is:

/usr/bin/mysql
/usr/bin/mysqldump

For PostGreSQL :

You may get client executables by installing the client packages for PostGreSQL.

/usr/bin/psql
/usr/bin/pg_dump

On PostGreSQL you might use a superuser setup in the PGPASS file to allow complete execution of PG commands in a non interactive mode.

3. Configuring MNET.

[[Image:Vmoodle_config_p2.jpg|||center]]

4. MNET keys automated renewal.

VMoodle is often used for Moodle arrays operating the same teaching environment, thus making big use of MNET functions.
The distributed strategy of Moodle will call for developing XML-RPC adds-on for enhancing the overall behaviour. Although Moodle maintains key consistency when users roam from one Moodle to another (using jump/land mechanism), this is not the case for XML-RPC MNET calls. the risk of having broken services every 28 days is high.

This section setup an automated key renewal within a VMoodle network so there is no more fear to get web services broken by key loss. When configuring this feature, each Moodle getting awareness of his key being obsolete will renew it and force all peers to accept this renewed key. The whole VMoodle MNET network will auto-repair continuously his consistency.

o Autorenew enable: enables or disables the key autorenewal.
o Key obsolecence look forward delay : a delay og forwarding the Moodle cron will detect
that his own MNET key is about to fall out of calendar.
o Time for renewal: the time the renewal will be proceeded after obsolescence look forward
has been triggered.

Using the last parameter, you will setup a renewal time in a suitable time range so minimizing risk of users being bothered during key exchange.

[[Image:Vmoodle_config_p4.jpg|||center]]

==Virtualizing moodles: the starting point==

[[Image:Vmoodle_start_point.jpg|||center]]

The above picture shows the VMoodle administration GUI just after the first Moodle host (Master Moodle) has been installed.

At this time, the only possibility you will have is to snapshot the Master Moodle for further deployment. This makes a stored copy of all the Master Moodle database and stored files which other Moodle can be deployed from. You can control
that the snapshot has succeeded in the "moodledata/vmoodle" directory: you should have two directories (one for SQL capture and one for all moodledata files).

The snapshot procedure is a 3 step wizard.

1st step: Setting up the storage directories.

[[Image:Snapshot_1.png|||center]]

2nd step: Dumping the database.

[[Image:Snapshot_2.png|||center]]

3rd step: Getting a copy of moodledata.

[[Image:Snapshot_3.png|||center]]

Once you get the first Moodle template stored, you will be able to make your first Virtual Moodle.

==Define a new VMoodle instance==

To deploy a new Moodle instance, enter with an admin account to your Master Moodle and browse to the location of your VMoodle block. Click on the 'Administrate' link.

Click upon "Define a new virtual platform" in the "Pool Management" screen.

[[Image:add_moodle_1.png]]

First form part:

[[Image:add_moodle_3.png]]

Fields:

o Name: Usual name of the new Moodle. Will be setup in the site course parameters.
o Shortname: Shortname for the new host. Use a token here that will change the
schema automated patterns if enabled.
o Description : A description that will be added to Moodle site course.
o Host: If schema is automated, you should not have to change this.

[[Image:add_moodle_4.png]]

o Database type: Change the type as desired (MySQL / PostgreSQL)
o Database host: Change here for local reasons.
o Database user login: Login d'accès à la base de données.
o Database user password: Password d'accès à la base de données.
o Database name: You may not have to change this if schema is automated. Note that
this database MUST NOT be created (Mysql).
o Table prefix.
o connection persistance: Change here for local reasons.

Most of those fields are already setup from your default settings.

[[Image:add_moodle_5.png]]

[[fr:Gestion des instances]]

Moodle Instance Management

2012-12-21T23:26:59Z

Valeryf: /* Deploying virtual instances from a physically setup Moodle */

[[VMoodle_Block|Back to index]]

The infrastructure for Moodle instances management and deployment allows an easy management of multiple virtualized Moodle instances within the same physical hosting.

==Virtualization principles==

Moodle virtuazlization is simple. It mostly consists of no longer relying on the physical configration file config.php for absolute initial paths and DB definition, but dynamically building a set of configuration values from a table in the database. The set of main configuration parameter values will be chosen depending on the domain name (virtual host).

For integrating the whole virtualization process within Moodle itself, the virtualization table is held by a Moodle block.

==Virtualization process==

The overall lifecycle of a virtualized Moodle array is usually as follows:

===Setup===

The whole set of used domain names must be available and pointed to the same DocumentRoot in Apache. This also can be obtained using a wildcard DNS mapping pointing to such a Virtual Host setting:

<VirtualHost XXX.XXX.XXX.XXX>
ServerName mastermoodle.mydomain.com
ServerAlias *.mydomain.com
...
</VirtualHost>

Once these prerequisites are available, and the PHP volume correctly accessible:

# proceed to the installation of the main Moodle instance (Moodle master, bound to standard configuration).
# install the VMoodle block as a standard block
# place the VMoodle configuration hook in standard config
# configure the master Moodle, insert generic content, make common settings
# IMPORTANT : place an instance of a VMoodle block somewhere so you can browse to VMoodle administration!

You now should have this somewhere in your Moodle:

[[image:Vmoodle_added.jpg]]

Note: an adequate location is in an administration block in administration pages, but you may also use a special "administration" course in your Moodle.

===Deploying virtual instances from a physically setup Moodle===

# make a first snapshot of the master moodle. This will store a replicable backup of the whole platform.
# deploy a first virtual node
# setup and tune the first virtual node
# snapshot the first vitual node as node template
# deploy any amount of nodes using this template.

The following image gives an idea of the virtualization benefit.

[[Image:Vmoodle architecture.jpg|||center]]

==VMoodle Configuration==

To configure the VMoodle block, browse to the VMoodle block settings in Administration menu:

# Define a naming schema for presetting the platform deployment form.
# Define information for connection to database.
# Define information for setting up MNET.
# Proceed to MNET peer key renewal.

1. Defining schema

The naming schema preset allows an easy setup of master information defining a new Moodle platform. The purpose of this automation is to speed up the setup of a new Moodle instance, reduce error when entering information, and promote a consistent naming ruleset for defining multiple Moodle hosts.

[[Image:Vmoodle_config_p1.jpg|||center]]

Schema fields:

o Automate schema : Tells VMoodle to preset the deployment form.
o Virtual host: Gives the pattern for generating new Moodle host names.
o Database type: Preset the type of database used (MySQL or Postgres).
o Database host: Preset value for the database hostname.
o Database login: Preset value for the database user login.
o Database password: Preset value for the database user password.
o Database name: Preset a generation pattern for naming the database.
o Table prefix: Preset value for the table name prefix.
o Persistant connection: Preset value. Persistant connections will not
close at end of the PHP script and be reused.
o Moodledata path: Preset the generation pattern for the Moodledata path.

When a schema is automated, entering the platform token will automatically provide adequate name to host, database and moodle data path.

To setup patterns, use the <%%INSTANCE%%> tag within the pattern to be replaced with the host token.

Example :

If you set the hostname pattern such as :

<nowiki>http://<%%INSTANCE%%>.mydomain.com</nowiki>

And you enter a token with value "moodle1", than the deployment form will replace the pattern with the final value :

<nowiki>http://moodle1.mydomain.com</nowiki>

Same is performed with the database name field and the Moodledata path.

2. Setting up the path to database executables

[[Image:Vmoodle_config_p3.jpg|||center]]

You may only provide system path of executable for the database you want to use (MySQL or Postgres)

Path to executable will surely have to be double quoted.

o Path to mysql terminal : full path to the mysql (Linux) command or mysql.exe (Windows)
o Path to mysql dump : full path to mysqldump (Linux) or mysqldump.exe (Windows)
o Path to postgres terminal : full path to psql (Linux) psql.exe (Windows)
o Path to postgres dump : full path to pg_dump (Linux) or pg_dump.exe (Windows)

Configuration note:

On Linux common location for mySQL is:

/usr/bin/mysql
/usr/bin/mysqldump

For PostGreSQL :

You may get client executables by installing the client packages for PostGreSQL.

/usr/bin/psql
/usr/bin/pg_dump

On PostGreSQL you might use a superuser setup in the PGPASS file to allow complete execution of PG commands in a non interactive mode.

3. Configuring MNET.

[[Image:Vmoodle_config_p2.jpg|||center]]

4. MNET keys automated renewal.

VMoodle is often used for Moodle arrays operating the same teaching environment, thus making big use of MNET functions.
The distributed strategy of Moodle will call for developing XML-RPC adds-on for enhancing the overall behaviour. Although Moodle maintains key consistency when users roam from one Moodle to another (using jump/land mechanism), this is not the case for XML-RPC MNET calls. the risk of having broken services every 28 days is high.

This section setup an automated key renewal within a VMoodle network so there is no more fear to get web services broken by key loss. When configuring this feature, each Moodle getting awareness of his key being obsolete will renew it and force all peers to accept this renewed key. The whole VMoodle MNET network will auto-repair continuously his consistency.

o Autorenew enable: enables or disables the key autorenewal.
o Key obsolecence look forward delay : a delay og forwarding the Moodle cron will detect
that his own MNET key is about to fall out of calendar.
o Time for renewal: the time the renewal will be proceeded after obsolescence look forward
has been triggered.

Using the last parameter, you will setup a renewal time in a suitable time range so minimizing risk of users being bothered during key exchange.

[[Image:Vmoodle_config_p4.jpg|||center]]

==Virtualizing moodles: the starting point==

[[Image:Vmoodle_start_point.jpg|||center]]

The above picture shows the VMoodle administration GUI just after the first Moodle host (Master Moodle) has been installed.

At this time, the only possibility you will have is to snapshot the Master Moodle for further deployment. This makes a stored copy of all the Master Moodle database and stored files which other Moodle can be deployed from. You can control
that the snapshot has succeeded in the "moodledata/vmoodle" directory: you should have two directories (one for SQL capture and one for all moodledata files).

The snapshot procedure is a 3 step wizard.

1st step: Setting up the storage directories.

[[Image:Snapshot_1.png|||center]]

2nd step: Dumping the database.

[[Image:Snapshot_2.png|||center]]

3rd step: Getting a copy of moodledata.

[[Image:Snapshot_3.png|||center]]

Once you get the first Moodle template stored, you will be able to make your first Virtual Moodle.

==Define a new VMoodle instance==

To deploy a new Moodle instance, enter with an admin account to your Master Moodle and browse to the location of your VMoodle block. Click on the 'Administrate' link.

Click upon "Define a new virtual platform" in the "Pool Management" screen.

[[Image:add_moodle_1.png]]

First form part:

[[Image:add_moodle_3.png]]

Fields:

o Name: Usual name of the new Moodle. Will be setup in the site course parameters.
o Shortname: Shortname for the new host. Use a token here that will change the
schema automated patterns if enabled.
o Description : A description that will be added to Moodle site course.
o Host: If schema is automated, you should not have to change this.

[[Image:add_moodle_4.png]]

o Database type: Change the type as desired (MySQL / PostgreSQL)
o Database host: Change here for local reasons.
o Database user login: Login d'accès à la base de données.
o Database user password: Password d'accès à la base de données.
o Database name: You may not have to change this if schema is automated. Note that
this database MUST NOT be created (Mysql).
o Table prefix.
o connection persistance: Change here for local reasons.

Most of those fields are already setup from your default settings.

[[Image:add_moodle_5.png]]

[[fr:Gestion des instances]]

Moodle Instance Management

2012-12-21T23:26:37Z

Valeryf: /* VMoodle Configuration */

[[VMoodle_Block|Back to index]]

The infrastructure for Moodle instances management and deployment allows an easy management of multiple virtualized Moodle instances within the same physical hosting.

==Virtualization principles==

Moodle virtuazlization is simple. It mostly consists of no longer relying on the physical configration file config.php for absolute initial paths and DB definition, but dynamically building a set of configuration values from a table in the database. The set of main configuration parameter values will be chosen depending on the domain name (virtual host).

For integrating the whole virtualization process within Moodle itself, the virtualization table is held by a Moodle block.

==Virtualization process==

The overall lifecycle of a virtualized Moodle array is usually as follows:

===Setup===

The whole set of used domain names must be available and pointed to the same DocumentRoot in Apache. This also can be obtained using a wildcard DNS mapping pointing to such a Virtual Host setting:

<VirtualHost XXX.XXX.XXX.XXX>
ServerName mastermoodle.mydomain.com
ServerAlias *.mydomain.com
...
</VirtualHost>

Once these prerequisites are available, and the PHP volume correctly accessible:

# proceed to the installation of the main Moodle instance (Moodle master, bound to standard configuration).
# install the VMoodle block as a standard block
# place the VMoodle configuration hook in standard config
# configure the master Moodle, insert generic content, make common settings
# IMPORTANT : place an instance of a VMoodle block somewhere so you can browse to VMoodle administration!

You now should have this somewhere in your Moodle:

[[image:Vmoodle_added.jpg]]

Note: an adequate location is in an administration block in administration pages, but you may also use a special "administration" course in your Moodle.

===Deploying virtual instances from a physically setup Moodle===

# make a first snapshot of the master moodle. This will store a replicable backup of the whole platform.
# deploy a first virtual node
# setup and tune the first virtual node
# snapshot the first vitual node as node template
# deploy any amount of nodes using this template.

The following image gives an idea of the virtualization benefit.

[[Image:Vmoodle architecture.jpg]]

==VMoodle Configuration==

To configure the VMoodle block, browse to the VMoodle block settings in Administration menu:

# Define a naming schema for presetting the platform deployment form.
# Define information for connection to database.
# Define information for setting up MNET.
# Proceed to MNET peer key renewal.

1. Defining schema

The naming schema preset allows an easy setup of master information defining a new Moodle platform. The purpose of this automation is to speed up the setup of a new Moodle instance, reduce error when entering information, and promote a consistent naming ruleset for defining multiple Moodle hosts.

[[Image:Vmoodle_config_p1.jpg|||center]]

Schema fields:

o Automate schema : Tells VMoodle to preset the deployment form.
o Virtual host: Gives the pattern for generating new Moodle host names.
o Database type: Preset the type of database used (MySQL or Postgres).
o Database host: Preset value for the database hostname.
o Database login: Preset value for the database user login.
o Database password: Preset value for the database user password.
o Database name: Preset a generation pattern for naming the database.
o Table prefix: Preset value for the table name prefix.
o Persistant connection: Preset value. Persistant connections will not
close at end of the PHP script and be reused.
o Moodledata path: Preset the generation pattern for the Moodledata path.

When a schema is automated, entering the platform token will automatically provide adequate name to host, database and moodle data path.

To setup patterns, use the <%%INSTANCE%%> tag within the pattern to be replaced with the host token.

Example :

If you set the hostname pattern such as :

<nowiki>http://<%%INSTANCE%%>.mydomain.com</nowiki>

And you enter a token with value "moodle1", than the deployment form will replace the pattern with the final value :

<nowiki>http://moodle1.mydomain.com</nowiki>

Same is performed with the database name field and the Moodledata path.

2. Setting up the path to database executables

[[Image:Vmoodle_config_p3.jpg|||center]]

You may only provide system path of executable for the database you want to use (MySQL or Postgres)

Path to executable will surely have to be double quoted.

o Path to mysql terminal : full path to the mysql (Linux) command or mysql.exe (Windows)
o Path to mysql dump : full path to mysqldump (Linux) or mysqldump.exe (Windows)
o Path to postgres terminal : full path to psql (Linux) psql.exe (Windows)
o Path to postgres dump : full path to pg_dump (Linux) or pg_dump.exe (Windows)

Configuration note:

On Linux common location for mySQL is:

/usr/bin/mysql
/usr/bin/mysqldump

For PostGreSQL :

You may get client executables by installing the client packages for PostGreSQL.

/usr/bin/psql
/usr/bin/pg_dump

On PostGreSQL you might use a superuser setup in the PGPASS file to allow complete execution of PG commands in a non interactive mode.

3. Configuring MNET.

[[Image:Vmoodle_config_p2.jpg|||center]]

4. MNET keys automated renewal.

VMoodle is often used for Moodle arrays operating the same teaching environment, thus making big use of MNET functions.
The distributed strategy of Moodle will call for developing XML-RPC adds-on for enhancing the overall behaviour. Although Moodle maintains key consistency when users roam from one Moodle to another (using jump/land mechanism), this is not the case for XML-RPC MNET calls. the risk of having broken services every 28 days is high.

This section setup an automated key renewal within a VMoodle network so there is no more fear to get web services broken by key loss. When configuring this feature, each Moodle getting awareness of his key being obsolete will renew it and force all peers to accept this renewed key. The whole VMoodle MNET network will auto-repair continuously his consistency.

o Autorenew enable: enables or disables the key autorenewal.
o Key obsolecence look forward delay : a delay og forwarding the Moodle cron will detect
that his own MNET key is about to fall out of calendar.
o Time for renewal: the time the renewal will be proceeded after obsolescence look forward
has been triggered.

Using the last parameter, you will setup a renewal time in a suitable time range so minimizing risk of users being bothered during key exchange.

[[Image:Vmoodle_config_p4.jpg|||center]]

==Virtualizing moodles: the starting point==

[[Image:Vmoodle_start_point.jpg|||center]]

The above picture shows the VMoodle administration GUI just after the first Moodle host (Master Moodle) has been installed.

At this time, the only possibility you will have is to snapshot the Master Moodle for further deployment. This makes a stored copy of all the Master Moodle database and stored files which other Moodle can be deployed from. You can control
that the snapshot has succeeded in the "moodledata/vmoodle" directory: you should have two directories (one for SQL capture and one for all moodledata files).

The snapshot procedure is a 3 step wizard.

1st step: Setting up the storage directories.

[[Image:Snapshot_1.png|||center]]

2nd step: Dumping the database.

[[Image:Snapshot_2.png|||center]]

3rd step: Getting a copy of moodledata.

[[Image:Snapshot_3.png|||center]]

Once you get the first Moodle template stored, you will be able to make your first Virtual Moodle.

==Define a new VMoodle instance==

To deploy a new Moodle instance, enter with an admin account to your Master Moodle and browse to the location of your VMoodle block. Click on the 'Administrate' link.

Click upon "Define a new virtual platform" in the "Pool Management" screen.

[[Image:add_moodle_1.png]]

First form part:

[[Image:add_moodle_3.png]]

Fields:

o Name: Usual name of the new Moodle. Will be setup in the site course parameters.
o Shortname: Shortname for the new host. Use a token here that will change the
schema automated patterns if enabled.
o Description : A description that will be added to Moodle site course.
o Host: If schema is automated, you should not have to change this.

[[Image:add_moodle_4.png]]

o Database type: Change the type as desired (MySQL / PostgreSQL)
o Database host: Change here for local reasons.
o Database user login: Login d'accès à la base de données.
o Database user password: Password d'accès à la base de données.
o Database name: You may not have to change this if schema is automated. Note that
this database MUST NOT be created (Mysql).
o Table prefix.
o connection persistance: Change here for local reasons.

Most of those fields are already setup from your default settings.

[[Image:add_moodle_5.png]]

[[fr:Gestion des instances]]