.. _Conditional Module:
Conditional Module
###################
.. tags:: educator, reference
A conditional module controls the content that learners see after a response
that they make meets a certain condition. For example, learners who answer
"Yes" to a poll question see a different block of text from the learners who
answered "No" to the same question.
******************
Format Description
******************
The main tag of conditional module input is ``conditional``.
.. code-block:: xml
...
``conditional`` can include any number of any Xmodule tags (``html``,
``video``, ``poll``, etc.) or ``show`` tags.
===================
``conditional`` Tag
===================
The main container for a single instance of a conditional module. The
following attributes can be specified for this tag.
.. code-block:: xml
sources - location id of required modules, separated by ';'
[message | ""] - message for case, where one or more are not passed. Here you can use variable {link}, which generate link to required module.
[submitted] - map to `is_submitted` module method.
(pressing RESET button makes this function to return False.)
[correct] - map to `is_correct` module method
[attempted] - map to `is_attempted` module method
[poll_answer] - map to `poll_answer` module attribute
[voted] - map to `voted` module attribute
============
``show`` Tag
============
Symlink to some set of Xmodules. The following attribute can be specified for
this tag.
.. code-block:: xml
sources - location id of modules, separated by ';'
********
Examples
********
====================================
Example: Conditional Depends on Poll
====================================
.. code-block:: xml
You see this because your vote value for "First question" was "man"
=====================================================
Example: Conditional Depends on Poll (Use Tag)
=====================================================
.. code-block:: xml
==========================================
Examples of Conditional Depends on Problem
==========================================
.. code-block:: xml
You see this because "lec27_Q1" was attempted.
You see this because "lec27_Q1" was not attempted.
.. seealso::
:ref:`add-tags-to-a-course` (how-to)
**Maintenance chart**
+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------+
| | | | |
+--------------+-------------------------------+----------------+--------------------------------+