Commit 594c0383 authored by Kristina Hoeppner's avatar Kristina Hoeppner
Browse files

Initial commit for Mahara 22.04

parent e299a687
Subproject commit 6fabf45006e6729893ca8cb5257b5df1a8659c38
Subproject commit d96c1bb119a8a49147681d28a6bea3633612321e
......@@ -251,7 +251,7 @@ The options you have are:
* Institution messages
#. **Comment**: These are notifications about any comments received on pages, artefacts or journal posts.
#. **Contact us**: Site administrators or |new in Mahara 21.10| institution administrators see this notification type. These are messages sent via the 'Contact us' form that can be accessed in the footer of the site if the site administrator :ref:`decided to display this link <footer>`.
#. **Contact us**: Site administrators or institution administrators see this notification type. These are messages sent via the 'Contact us' form that can be accessed in the footer of the site if the site administrator :ref:`decided to display this link <footer>`.
.. note::
Institution administrators only receive these notifications if an institution member who is logged in sends a notification. In all other cases the site administrators will receive them.
......@@ -671,7 +671,7 @@ You have control over which links are displayed in the footer on each page.
You can change the text in :ref:`Static pages <edit_site_pages>` if you don't already have an existing text to link to.
#. If you have an existing page, you can provide the link here.
#. **Contact us**: Set the switch to 'Yes' if you want to display a link to a contact form in the footer. Site administrators or |new in Mahara 21.10| :index:`institution administrators <single: New in Mahara 21.10; 'Contact us' to institution administrators>` receive these notifications.
#. **Contact us**: :index:`Set <single: Contact form>` the switch to 'Yes' if you want to display a link to a contact form in the footer. Site administrators or institution administrators receive these notifications.
.. note::
Institution administrators only receive these notifications if an institution member who is logged in sends a notification. In all other cases the site administrators will receive them.
......
......@@ -6,7 +6,7 @@
.. _development:
|new in Mahara 21.10| Development
Development
-------------------------------------------
*Administration menu → Development*
......@@ -21,7 +21,7 @@ This administration section includes tools for developers to make them easily ac
.. _behat_steps:
|new in Mahara 21.10| Behat steps
Behat steps
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Administration menu → Development → Behat steps*
......@@ -33,7 +33,7 @@ This administration section includes tools for developers to make them easily ac
Mahara comes with a `Behat automation test suite <https://wiki.mahara.org/wiki/Testing/Behat_Testing>`_ that makes it possible to automate a lot of manual testing.
:index:`On <single: New in Mahara 21.10; Behat step register>` this page you see the Behat steps that you can use in Mahara out of the box. They are listed as a reference so you can see how they are being used.
On this page you see the Behat steps that you can use in Mahara out of the box. They are listed as a reference so you can see how they are being used.
#. A warning is displayed if the permissions on the Behat folder in your dataroot are not correct and the steps can't be read. Some steps are always displayed, but not the majority of them unless you have the permissions correct.
#. Click the text of a step or the chevron |menu open| to see all instances where this step is used.
......@@ -46,7 +46,7 @@ Mahara comes with a `Behat automation test suite <https://wiki.mahara.org/wiki/T
.. _components_library:
|new in Mahara 21.10| Components library
Components library
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Administration menu → Development → Components library*
......@@ -56,7 +56,7 @@ Mahara comes with a `Behat automation test suite <https://wiki.mahara.org/wiki/T
List of all third-party plugins in Mahara
:index:`Mahara <single: New in Mahara 21.10; Components library>` uses a number of third-party plugins that deliver JavaScript, filtering, templating, and many more. On this page you see them all listed along with their version number in this particular version of Mahara and the path to their project site. That information is taken from the 'Readme.mahara' files available in each plugin in the code base.
Mahara uses a number of third-party plugins that deliver JavaScript, filtering, templating, and many more. On this page you see them all listed along with their version number in this particular version of Mahara and the path to their project site. That information is taken from the 'Readme.mahara' files available in each plugin in the code base.
#. **Plugin**: The name of the plugin.
#. **Path**: Where you can find the code in the Mahara code base.
......
......@@ -721,10 +721,10 @@ You can activate the LTI API in order to use the :ref:`LTI integration <lti>`.
.. _ltiadvantage_activation:
|new in Mahara 21.10| Module: LTI Advantage
Module: LTI Advantage
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:index:`You <single: New in Mahara 21.10; LTI Advantage support>` can activate the LTI API in order to use the :ref:`LTI integration <lti>`.
You can activate the LTI API in order to use the :ref:`LTI integration <lti>`.
.. note::
LTI Advantage is an **experimental** feature and has not yet been tested with LMS other than Brightspace.
......
......@@ -276,7 +276,7 @@ Certain settings are only available to staff, institution administrators, or sit
.. _current_submissions:
|new in Mahara 21.10| Current submissions
Current submissions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Administration menu → Groups → Current submissions*
......@@ -284,7 +284,7 @@ Certain settings are only available to staff, institution administrators, or sit
.. note::
Only site administrators see this menu item, but institution administrators have also access to it via *Archived submissions*. There is a `bug report <https://bugs.launchpad.net/mahara/+bug/1949421>`_ to fix that.
:index:`When <single: New in Mahara 21.10; Current submissions report>` an author submits a portfolio to a group in Mahara or the an assignment in the LMS, it is displayed here.
When an author submits a portfolio to a group in Mahara or the an assignment in the LMS, it is displayed here.
An administrator can release portfolios to authors who accidentally submitted their portfolios and want to rectify a mistake.
......
......@@ -1139,7 +1139,7 @@ Admin notifications
*Administration menu → Institutions → Admin notifications*
.. warning::
The administrator notifications are site administrator notifications, yet institution administrators are listed as well even though they do not receive these types of notifications. There is an open `wishlist item <https://bugs.launchpad.net/mahara/+bug/1922513>`_ to deal with this.
The administrator notifications are site administrator notifications, yet institution administrators are listed as well even though they do not receive these types of notifications. There is an `open wishlist item <https://bugs.launchpad.net/mahara/+bug/1922513>`_ to deal with this.
The *Admin notifications* page lists all people with institution and site administrator access on your site. It shows their selected notification preferences for all administrator notifications. There should be at least one administrator receiving each type of message generated.
......
......@@ -3,9 +3,9 @@
# built documents.
#
# The short X.Y version.
version = '20.04'
version = '22.04'
# The full version, including alpha/beta/rc tags.
release = '20.04'
release = '22.04'
#We get most of config from conf-common.py
exec(open("conf-common.py").read())
......@@ -138,7 +138,7 @@ Conventions
* An index entry should be created for each section.
* New features receive an index entry as well in the form 'single: New in Mahara x, [the functionality that is new]'. Index entries can be placed either above an entire section or inline. Inline is preferable for small functional changes so that readers are directly taken to the new functionality. This can be done like so:
| ``:index:`Decide on the sort order <single: New in Mahara 21.10; Sort order of files in the 'Folder' block>```
| ``:index:`Decide on the sort order <single: New in Mahara 22.04; Sort order of files in the 'Folder' block>```
.. warning::
If there is not a punctuation mark just before ':index:' and/or after '>`', you have to insert a space just before ':index:' and/or after '>`'.
......
......@@ -13,7 +13,7 @@ You can use :ref:`web services <webservices>` and authentication methods to conn
`Learning Tools Interoperability <http://www.imsglobal.org/activity/learning-tools-interoperability>`_ (LTI) allows learning applications like learning management systems (LMS) to talk to each other and exchange information in a standard way making it possible to connect the systems without extensive configuration each time.
Mahara supports LTI for authentication purposes and for assignment submission. Mahara has the LTI 1.1 standard implemented and |new in Mahara 21.10| an experimental implementation of LTI (1.3) Advantage.
Mahara supports LTI for authentication purposes and for assignment submission. Mahara has the LTI 1.1 standard implemented and an experimental implementation of LTI (1.3) Advantage.
Instructions for setting up Mahara with Moodle, Canvas, OLAT, and Blackboard are provided. If you want to have instructions for other learning management systems added, please `contact us <mailto:info@mahara.org>`_.
......
......@@ -2,13 +2,14 @@
.. index::
pair: LTI setup; Brightspace
pair: LTI Advantage setup; Brightspace
.. _ltiadvantage_brightspace:
Setup in Brightspace
----------------------
:index:`You <single: New in Mahara 21.10; Setup of LTI Advantage in Brightspace>` can connect Mahara with Brightspace via :ref:`LTI Advantage <enable_ltiadvantage>`.
You can connect Mahara with Brightspace via :ref:`LTI Advantage <enable_ltiadvantage>`.
.. note::
This documentation assumes that you have site administrator permissions in Brightspace. The instruction here provide the minimum steps, assuming Brightspace has ben configured already. You may wish to consult your Brightspace support team for Brightspace specific questions.
......
......@@ -8,7 +8,7 @@ Setup of LTI 1.1 in Mahara
In order to use LTI, complete the setup in Mahara as well as in the LMS that you want to connect.
Mahara supports LTI 1.1 and |new in Mahara 21.10| **experimentally** :ref:`LTI (1.3) Advantage <enable_ltiadvantage>`.
Mahara supports LTI 1.1 and **experimentally** :ref:`LTI (1.3) Advantage <enable_ltiadvantage>`.
.. index::
single: LTI; Enable LTI 1.1 in Mahara
......
......@@ -6,7 +6,7 @@
.. _enable_ltiadvantage:
|new in Mahara 21.10| Setup of LTI Advantage in Mahara
Setup of LTI Advantage in Mahara
---------------------------------------------------------
The recording showcases the three main functionalities that are achieved via LTI Advantage when connecting to Brightspace:
......@@ -24,9 +24,9 @@ Enable LTI Advantage
*Administration menu → Extensions → Plugin administration → ltiadvantage*
:index:`In <single: New in Mahara 21.10; Enable LTI Advantage>` order to use LTI, complete the setup in Mahara as well as in the LMS that you want to connect.
In order to use LTI, complete the setup in Mahara as well as in the LMS that you want to connect.
Mahara supports :ref:`LTI 1.1 <enable_lti>` and |new in Mahara 21.10| **experimentally** LTI (1.3) Advantage.
Mahara supports :ref:`LTI 1.1 <enable_lti>` and **experimentally** LTI (1.3) Advantage.
.. note::
LTI Advantage is an **experimental** feature and has not yet been tested with LMS other than Brightspace.
......
......@@ -594,7 +594,7 @@ When you create or edit a group page, you can decide whether only the administra
:index:`When a group page is created <single: Notification to group members when new group page is created>`, group members (except the page creator) receive a notification unless the group administrator switched the setting **Shared page notifications** to 'No' in the group settings.
|new in Mahara 21.10| :index:`If a <single: New in Mahara 21.10; SmartEvidence in group collections>` group is set up in an institution that allows the use of :ref:`SmartEvidence <smartevidence>`, you can add a SmartEvidence framework to a collection. When this collection is copied into a personal account, the framework is copied as well, and the portfolio creator can use it.
If a group is set up in an institution that allows the use of :ref:`SmartEvidence <smartevidence>`, you can add a SmartEvidence framework to a collection. When this collection is copied into a personal account, the framework is copied as well, and the portfolio creator can use it.
.. note::
SmartEvidence cannot be used in a group itself. It can only be added to a collection that is then copied into a personal account, facilitating the creation of templates.
......
......@@ -3,10 +3,10 @@
.. include:: shortcuts.rstext
Mahara 21.10 manual
Mahara 22.04 manual
==================================
This is the manual for Mahara 21.10, which was `released on 29 October 2021 <https://mahara.org/interaction/forum/topic.php?id=8955>`_. When you see the 'New in Mahara 21.10' icon |new in Mahara 21.10|, a feature was introduced in Mahara 21.10 or changed from Mahara 21.04.
This is the manual for Mahara 22.04, which will be released at the end of April 2022. When you see the 'New in Mahara 22.04' icon |new in Mahara 22.04|, a feature was introduced in Mahara 22.04 or changed from Mahara 21.10.
.. note::
......
......@@ -2,72 +2,9 @@
.. _new:
What's new in Mahara 21.10?
What's new in Mahara 22.04?
-------------------------------------------------------
Mahara is being improved from version to version. On this page, you see the **highlights** for the latest release of Mahara.
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/rYrI4YQ_TjY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
You can see a `list of all new features on Launchpad <https://bugs.launchpad.net/mahara/+bugs?field.searchtext=&orderby=-importance&field.status%3Alist=FIXCOMMITTED&field.status%3Alist=FIXRELEASED&field.milestone%3Alist=92879&field.tag=newfeature&&search=Search>`_ or check out the features via the |new in Mahara 21.10| 'New in Mahara 21.10' `index entries <genindex.html#N>`_.
'Contact us' notifications to institution administrator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|contact us| Notifications sent by logged-in institution members go to the respective institution administrators instead of the site administrator. That way, site administrators do not have to forward requests meant for institution administrators as frequently. Notifications sent by someone not logged in still go to the site administrator.
SmartEvidence for group templates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|SmartEvidence| If an institution allows to use SmartEvidence, a framework can be added to a :ref:`group portfolio <group_portfolios>` used as template for the creation of personal portfolios.
Include or exclude private comments from export
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|private comments| Decide whether you want to include or exclude private comments from your portfolio :ref:`export <export>` to retain the original setting on private comments and not make them viewable by others.
Collapsible page comments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|comments| When you open a page, the comments area at the bottom of a page, when the portfolio author allowed comments, is collapsed per default to save space.
.. figure:: /images/new/collapsed_comments.*
:alt: Collapsed comments area on a page
Collapsed comments area on a page
Skin stays with copied page
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|skin| When you copy a page or a collection that has one or more skins applied to its pages, the skins come along with the pages if they are public or site skins that you are allowed to use.
LTI Advantage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|LTI| :ref:`LTI Advantage <enable_ltiadvantage>` is implemented as **experimental feature**. At the moment, it has been tested with the Brightspace learning management system. The recording showcases the three main functionalities that are achieved:
* Authentication
* Setup of groups based on courses and enrolment information
* Portfolio submission
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/B3V_ykQO268?start=1267" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Current submissions across the site
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|current submissions| :ref:`View current submissions <current_submissions>` to the site from groups or external hosts that use LTI Advantage. The overview page allows site and institution administrators to quickly release portfolios that were submitted accidentally.
Developer functionalities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|developer| There are a few pages that make it easier for developers to have access to information they may want to check out when upgrading Mahara or developer new or changed functionalities:
* :ref:`Behat steps <behat_steps>`: A list of available Behat steps in Mahara.
* :ref:`Components library <components_library>`: List of all third-party plugins used in Mahara.
* :ref:`Style guide <styleguide>`: Inventory of the visual elements in Mahara.
Additionally, if you want to install Mahara with default text in your preferred language, provided a :`translation <https://translations.launchpad.net/mahara-lang/>`_ exists, :ref:`set your browsing language <installation>`.
You can see a `list of all new features on Launchpad <https://bugs.launchpad.net/mahara/+bugs?field.searchtext=&orderby=-importance&field.status%3Alist=FIXCOMMITTED&field.status%3Alist=FIXRELEASED&field.milestone%3Alist=93805&field.tag=newfeature&&search=Search>`_ or check out the features via the |new in Mahara 22.04| 'New in Mahara 22.04' `index entries <genindex.html#N>`_.
......@@ -54,7 +54,7 @@ To export your portfolio on *Manage → Export*:
#. Use the buttons *Select all* or *Reverse selection* to quickly choose the portfolio pages or collections to include in your export.
#. Click the *Click to preview* link to preview a page (or collection) before you select it.
#. Decide whether you want to *Include comments* in your export. They are then visible in the HTML export. In order to do so, set the switch to 'Yes'.
#. |new in Mahara 21.10| *Include private comments*: :index:`Switch this <single: New in Mahara 21.10; Include / exclude private comments when exporting>` option to 'Yes' if you want to include any private comments in the export. Use this option when you share your portfolio archive with other people who should not be able to see comments meant for your eyes only though.
#. *Include private comments*: Switch this option to 'Yes' if you want to include any private comments in the export. Use this option when you share your portfolio archive with other people who should not be able to see comments meant for your eyes only though.
.. note::
You can always make two separate exports: One with and one without private comments to be more flexible later on with whom you want to share the archive.
......
......@@ -39,7 +39,7 @@ You can see the comments left so far at the bottom of each portfolio page or the
View comments on a page
#. |new in Mahara 21.10| :index:`The <single: New in Mahara 21.10; Comments section is collapsed>` comments section is collapsed when you view the page. You only see 'Comments' and the number of comments already left on the page. If there are no comments yet, you will see 'Add comment'. Click the 'Comments' or 'Add comment' heading or the chevon |menu open| to see comments and add new ones if you are allowed to.
#. The comments section is collapsed when you view the page. You only see 'Comments' and the number of comments already left on the page. If there are no comments yet, you will see 'Add comment'. Click the 'Comments' or 'Add comment' heading or the chevon |menu open| to see comments and add new ones if you are allowed to.
#. The profile picture and name of the author of the comment are shown. The name links to the author's profile.
#. You can see when the comment author wrote the comment and also when the last change to it was made.
#. The comment is displayed.
......
......@@ -222,10 +222,10 @@ This is what a skin applied to a page could look like.
#. *Normal link colour* and decision on whether to underline the link or not
#. The bottom of the page is not changed either.
|new in Mahara 21.10| Copy a page with a skin
Copy a page with a skin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:index:`When <single: New in Mahara 21.10; Copy skin with page>` you copy a page or a collection that has one or more skins applied to its pages, the skins come along with the pages if they are public or site skins that you are allowed to use.
When you copy a page or a collection that has one or more skins applied to its pages, the skins come along with the pages if they are public or site skins that you are allowed to use.
What is the difference between themes and page skins?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment