Collapsed Weeks course format: Difference between revisions

Latest revision as of 19:30, 10 December 2011

The Collapsed Weeks course format is a contributed code module. It is similar to the standard Weekly format for a course. The current week is always toggled on.

The code was based on the Collapsed Topics contributed code module.

Download

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.

Usage

Selecting

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.

Toggle State

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

The Arrow If you want to change the look and style of the arrow, simply change 'arrow_down.png' and 'arrow_up.png'.

FAQ

Q. How do I report an issue with Collapsed Weeks?

A. Raise an issue on Moodle Tracker or post a discussion on the Moodle Course Formats Forum

Q. Is Collapsed Weeks Moodle 2.0, Moodle 2.1 & Moodle 2.2 compatible?

A. Yes. It incorporates a change where the section name of the week summary is used instead of the summary itself to form the words on the toggle.

Credits

Collapsed Weeks 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

@@ Line 1: / Line 1: @@
 The '''Collapsed Weeks''' course format is a contributed code module.  It is similar to the standard [[Course_sections#Weekly_format|Weekly format]] for a course.  The current week is always toggled on.
+[[Image:Collapsed_weeks_image1.png|center|Collapsed Topics format example]]
 The code was based on the [[Collapsed_Topics_course_format|Collapsed Topics]] contributed code module.
-== Version notes ==
+== Download ==
-There are versions for 1.8, 1.9 and 2.0 .   The Moodle 2.0 version is still in development.  Read the "Read me" file with each version for cautions and installation instructions.
+You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_weekcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_weekcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_weekcoll/tags downloads] for your version of Moodle if the database is unavailable.  Full installation instructions are in the included 'Readme.txt' file.
 == Usage ==
@@ Line 14: / Line 17: @@
 ===Toggle State===
-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.
+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 ==
@@ Line 26: / Line 29: @@
 :A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10530 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]
-Q. Is Collapsed Weeks [https://docs.moodle.org/en/Moodle_2.0_release_notes Moodle 2.0] compatible?
+Q. Is Collapsed Weeks [https://docs.moodle.org/en/Moodle_2.0_release_notes Moodle 2.0], [https://docs.moodle.org/en/Moodle_2.1_release_notes Moodle 2.1] & [https://docs.moodle.org/en/Moodle_2.2_release_notes Moodle 2.2] compatible?
-:A. The latest version is getting there, but please use at your own risk.  It does not have all of the desired changes to make it fully 2.0 compliant as I maintain it whilst Moodle 2.0 is still changing as development progresses.
+:A. Yes.  It incorporates a change where the section name of the week summary is used instead of the summary itself to form the words on the toggle.
 == Credits ==
@@ Line 37: / Line 40: @@
 ==See also==
-*[http://moodle.org/mod/data/view.php?rid=2849  Collapsed weeks] is the Modules and plugins database page for downloads and more information.
+*[http://moodle.org/plugins/view.php?plugin=format_weekcoll Collapsed weeks] is the Modules and plugins database page for downloads and more information.  There are versions for Moodle 1.9, 2.0, 2.1 and 2.2.  The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_weekcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_weekcoll/downloads downloads].
 *Discussions: please create or find a discussion topic in the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]
 *[http://tracker.moodle.org/browse/CONTRIB/component/10530 Moodle Tracker] to report an issue.
+*[[Collapsed Topics course format]] is a similar contributed code module.
 [[Category:Contributed code]]
 [[Category:Course format]]

Documentation