Collapsed Topics course format
Note: You are currently viewing documentation for Moodle 2.3. Up-to-date documentation for the latest stable version is available here: Collapsed Topics course format.
The Collapsed Topics course format is a contributed code module. The format is similar to the standard Topics format except that all topics (except '0') can be 'toggled' on and off. This reduces clutter in courses that have a large number of topics, lots of content in the topics or a combination of the two.
You can download the format from the Modules and Plugins Database or by going to GitHub and cloning the repository alternatively by selecting one of the downloads for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.
Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:
To select the format, simply choose it from the list of course formats in the course settings. To show / hide a topic just click on its toggle.
Setting the Toggle Text
Tick off 'Use default section name' and type in the 'Section name' box. This allows the summary to be shown as it normally is in the Topics course format (Course_homepage#Topic_format_example).
When refreshing the page, the state of the 'toggles' is remembered. This is on a per browser session per course basis for as long as the browser remains open. If you would like it to persist longer, please follow the instructions in the included 'Readme.txt' file.
Changing the look
Since versions 188.8.131.52, 184.108.40.206, 220.127.116.11, 18.104.22.168 and 22.214.171.124 for Moodle 1.9.14+, 2.0.5+, 2.1.2+, 2.2+ and 2.3+ respectively, which were released on the 5th March 2012 the format now incorporates a means of customising the 'elements' and 'structure' of the course within Moodle on a course by course basis. The 'elements' are such things as the 'Toggle' word showing / not showing. The 'structure' is the way the sections are presented, in effect the ability to switch to the 'Collapsed Weeks' format without installing another course format. Two other structures 'Latest Week First' and 'Current Topic First' have also been added.
For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:
- 'Topics' - Where each section is presented as a topic in section number order. This is identical to previous versions of the format.
- 'Weeks' - Where each section is presented as a week in ascending week order. This is identical to the 'Collapsed Weeks' course format.
- 'Latest Week First' - The same as 'Weeks' but the current week is shown at the top and preceding weeks in decending order are displayed below execpt in editing mode where the structure is the same as 'Weeks'.
- 'Current Topic First' - The same as 'Topics' except that the current topic is shown at the top if it has been set.
- 'Day' - where each section is presented as a day in ascending day order from the start date of the course.
Collapsed Topics specific settings
The format's settings are accessed through the 'settings' icon that appears in editing mode:
which gives the form:
where you can change on a per course basis various elements like not displaying the 'Toggle' word. Note: The 'reset all' functionality is only available to administrators.
Per Course Colours
You can set a different look on a per course basis by changing the format's settings (using the 'settings' icon):
If you wish to use the same colours in all new courses then set the colour values in the 'config.php' file in the format's folder. To have all collapsed topics courses use the same colours, tick 'Reset colours for all Collapsed Topics courses' as shown in the screen shot above.
In the settings form you can choose between one to four columns for the layout:
which in this example gives:
User Settings My Profile Settings: Screen reader must = NO. If Yes, this will over-ride the collapsed topic and display in standard topic or weekly format.
Fine tuning the look
Most of the formatting is contained within the file 'styles.css' which is fully commented to facilitate easy manipulation of specific elements. For example, if you found that in your particular web browser the 'Topic x ' text was too big...
Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:
If you want to change the look and style of the arrow you can either change 'arrow_down.png' and 'arrow_up.png' in the 'pix' folder or if you would like a per theme look then override the CSS in your theme. To change the up and down arrow for the toggle you need to override some or all of the following depending on the size of your arrow:
To override the 'Open / Close all sections' arrows you need to override some or all of the following depending on the size of your arrow:
In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.
Q. How do I report an issue with Collapsed Topics?
- A. Yes. It incorporates a change where the section name of the topic summary is used instead of the summary itself to form the words on the toggle.
Collapsed Topics has been developed by and is maintained by Gareth Barnard with invaluable input from:
- Anthony Borrow
- Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the Developer Forum
- Craig Grannell - Snub Communications who wrote the article 'Collapsed Tables' in .Net Magazine Issue 186
- Collapsed Topics is the Modules and plugins database page for downloads and more information on this module. There are versions for Moodle 1.9, 2.0, 2.1, 2.2 and 2.3. The Moodle 1.8 version for reference and legacy use is available from GitHub and in the downloads.
- Discussions: please create or find a discussion topic in the Moodle Course Formats Forum
- Bugs can be reported on Moodle Tracker
- Collapsed Weeks course format is a similar contributed code module.