Managing Blocks
This article describes how to create and manage Blocks on your Learn Totara site.
TOPICS
Introduction to Blocks
Blocks are items which may be added to almost any page in Totara and can be used to add additional content or functionality to pages throughout your Totara site that are useful to users.
For example, a Course completion status block may be added to a course page so that learners can quickly access and view their course progress, or a Calendar block might be added to the site front page so that site users can see a list of events.
Back to TOPICS
Manage Blocks
Blocks are managed by a site administrator or another role with the Manage blocks (site:manageblocks) capability. To manage which blocks are available on your site and to access block settings access Site Administration >Plugins > Blocks > Manage blocks.
A list of blocks will be presented in a table providing information about each block, including additional options (where applicable):
| Name |
Displays the default name of the block.
This block name can be overridden at the site level via Language editing or at the block instance via block configuration.
|
| Instances |
Displays the total number of specific blocks created on your site. |
| Version |
Displays the version number of the block. |
| Hide/Show |
Click the eye icon to hide or show a specific block. |
| Protect instances |
Use this option to lock a particular type of block. Once locked, no-one will be able to add or delete instances. You can, of course, unlock again if you need to edit instances.
This is intended to protect blocks from deletion, like the Navigation block which can be difficult to reinstate if accidentally deleted.
|
| Settings |
Some blocks provide a Settings link so that the defaults and other options for that block can be configured. |
| Uninstall |
Select the Uninstall link to uninstall a specific block.
Uninstalling a block will completely delete everything in the database associated with the plugin, including its configuration, log records, user files managed by the plugin etc. There is no way back and Totara itself does not create any.
|
There are a number of blocks available which are standalone, such as the HTML or Featured Links blocks, and some that work with content, such as the Quiz results or Current Learning blocks.
Back to TOPICS
Adding Blocks
To add a block to the front page or a course page follow these steps:
- Select Turn editing on for the particular page.
- Select the Add block icon (
) in an available block region (these are indicated by a rectangle with a dotted outline).
- Select the required block from the list - either by scrolling down the list of available blocks or entering the name of the block in the Search field.
Back to TOPICS
Configuring Blocks
After adding a block, click the edit icon in the block header to configure it.
All blocks have a set of common configurations and some blocks have settings specific to the block type. Both the common and specific (Custom) block configurations can be accessed when editing is turned on, by clicking the cog icon (
) and then selecting Configure [ name ] block.
Block configurations are broken into sections:
|
Block Configuration Sections
|
 |
 |
|
Where this block appears
Depending upon the context and user permissions, this area determines where this block will appear.
|
 |
 |
|
On this page
These control the visibility and positioning of a block.
|
|
|
|
Common block settings
The settings in this section allow the renaming of the block's default title, enable users to collapse a block in their personal view, and the ability for users to reposition the block to the left or right of the page.
|
➖ |
|
|
Block appearance
Allows you to hide the block headers as well as hide the theme-based border/outline on the block.
|
➖ |
|
Where this Block Appears
Configure the default display location and positioning for all instances of this block type.
| Original block location |
This describes where the block was first displayed.
This field is for information purposes only and cannot be changed.
|
| Display on page types |
This varies depending on the block context:
- Any page
- Any course page
- Any type of course main page
|
| Default region |
Select in which region this block should, by default, be displayed.
Themes may define one or more named block regions where blocks are displayed. This setting defines which of these you want this block to appear in by default. The region may be overridden on specific pages if required.
| Page Region |
|
|
| Left |
|
|
| Main |
|
|
| Right |
|
|
| Top |
➖ |
|
| Bottom |
➖ |
|
For additional information on regions for block placement, see BLOCK REGIONS below.
|
| Default weight |
The default weight allows you to choose roughly where you want the block to appear in the chosen region, either at the top or the bottom.
The final location is calculated from all the blocks in that region (for example, only one block can actually be at the top). This value can be overridden on specific pages if required.
|
 |
NOTE |
|
The options for a region where a block can be placed on a page is defined by the type of page it is being added on.
A block can only be added to the Main region, the central area of a page, in a Dashboard.
For more information on Dashboard configuration and management, click on the appropriate article link below:
 Managing Your Dashboards (Moodle)
 Managing & Customizing Your Dashboards (Totara)
|
On This Page
| Visible |
Choose whether this block will be visible to users.
Administrators and other users with sufficient access rights can see hidden blocks in a collapsed form.
|
| Region |
Select which block region or column this block will be added to.
A block can be subsequently moved by site administrators and users with the capability /site:manageblocks .
|
| Weight |
Choose the default weight or listing order for this block.
A block can be subsequently moved by site administrators and users with the capability /site:manageblocks .
|
Common Block Settings
| Block title |
The title or name of the block.
The block title can be changed when the option to Override default block title has been enabled.
|
|
Override default block title
|
Check this option to change or remove the default block title.
A block title will only be displayed when the header is displayed.
|
|
Allow block hiding
|
Enable this option to allow individual users to hide (collapse) a block from their personal view.
Please see HIDING BLOCKS for more information.
|
|
Allow block docking
|
Enable this option to allow individual users to move this block to the docking area on the left-hand side of the screen.
This is a user specific display option. Please see DOCKING BLOCKS for more information.
|
Block Appearance
| Show header |
Enabled this option to remove the block's header.
A headerless block will not display the block title or the space above the block unless editing it turned on.
Please see BLOCK HEADERS for more information.
|
| Show border |
Allows you to choose whether or not to show the block's border.
A borderless block will not have the theme based border or outline around the block. This is especially useful for display and navigation blocks such as the Featured Links and HTML blocks.
Please see BLOCK BORDERS for more information.
|
Hiding Blocks
A user can choose to hide a block from their own display by selecting the Hide icon (
) within the header of the corresponding block. The Hide option collapses the content of the block but the block header (where shown) will still display. Blocks can be re-added by using the Show icon (
).
|
Block when Show option is selected.
|
Block when Hide option is selected.
|
Individual Blocks can be prevented from being hidden by users via the block Configuration settings.
Back to TOPICS
Docking Blocks
A user can also choose to move a block to the Docking area by selecting the Dock icon (
) within the corresponding block header. A docked block can be viewed by clicking on it's title within the docking area. Blocks can be moved back to main area of the page using the Undock icon (
).
Individual Blocks can be prevented from being docked by users via the block
Configuration settings.
Block Headers
The block header area is where (by default) a Block Title displays and where the Hide, Show, Move and Configure icons are located. A block header can be removed from all user's view within the Block's Configuration settings under Block appearance (when in editing mode).
Block Borders
A block border is the outline around the contents of a Block. A block border can be removed from all user's view within the Block's Configuration settings under Block appearance (when in editing mode).
Back to TOPICS
Moving Blocks
Blocks within the front page, courses or Dashboards, can be moved to other available block regions using the following steps:
- Select Turn editing on for the particular page
- Select and hold the Move icon (
) within the block header
- Drag and drop the selected block to it's new location
If a block can be moved to a new region, it will display in preview before you confirm its location by releasing the block.
Back to TOPICS
Deleting Blocks
Blocks can be removed from a page using the Delete block option within the block Action options. When editing is turned on, by clicking the cog icon ( ) and then selecting Delete [ name ] block.
%20and%20SITE%20SETTINGS/images%20screenshots%20icons/Blocks%20Management.png?width=688&name=Blocks%20Management.png)
%20and%20SITE%20SETTINGS/images%20screenshots%20icons/Block%20configuration%20button.png?width=300&name=Block%20configuration%20button.png)
%20and%20SITE%20SETTINGS/images%20screenshots%20icons/Screen%20Shot%202020-10-08%20at%205.59.19%20PM.png?width=576&name=Screen%20Shot%202020-10-08%20at%205.59.19%20PM.png)
%20and%20SITE%20SETTINGS/images%20screenshots%20icons/Screen%20Shot%202020-10-08%20at%206.18.35%20PM.png?width=600&name=Screen%20Shot%202020-10-08%20at%206.18.35%20PM.png)
%20and%20SITE%20SETTINGS/images%20screenshots%20icons/block%20appearance.png?width=400&name=block%20appearance.png)
