MoodleDocs - User contributions [en]

Adaptable theme

2022-06-15T18:08:23Z

Gb2048: Update details

{{Themes}}
{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/theme_adaptable
|tracker = https://gitlab.com/jezhops/moodle-theme_adaptable/-/issues
|discussion = [https://moodle.org/mod/forum/view.php?id=46 Themes Forum]
|maintainer = [[User:Jez H|Jez H]],[[User:Gareth_Barnard|G Barnard]]
|float = right
}}
This is a [[:Category:Contributed code|contributed (third party)]] highly customisable two column theme designed to work in a range of different situations. It is based on the popular [https://moodle.org/plugins/theme_bcu BCU theme]. '''Adaptable has all the features of BCU''' along with many new features.
==Features==
'''Layout Builders!''' You can now define a custom layout in the admin settings for:
* Block Regions (drag and drop)
* Marketing Blocks
* Footer Blocks
* Fully Customisable:
** Fonts
** Colors
** Block styles (including icons)
** Buttons (including radius)
* Choice of two [https://en.wikipedia.org/wiki/JQuery JQuery] sliders on [[My home|home page]] with customisable colors
* News / Announcements Ticker on [[My home|home]] / [[Dashboard]]
* Multiple [[Front page]] course styles
* Extensive custom menus (can be targeted to different users based on custom profile field)
* "My Courses" list can be organised to put older courses in sub menu item
* Dismissible Bootstrap Alerts
** Display sitewide notices using different Bootstrap styles
** Allow users to dismiss alerts once read (persistent between page loads / login)
** Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
* Additional layout settings for width, slider width, padding of various elements
* Social icons or Search box in header (admin can choose between the two)
* Support for [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (thanks to Chris Kenniburg for help on this)
* Mobile settings (greater control of how the theme looks on mobile devices)
* Option to add login form in header on front page
* [https://en.wikipedia.org/wiki/Favicon Favicon] uploader
* Background image uploader
In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, [[My home|home pages]] only, sitewide) using custom profile fields.
==Demo Video==
[https://youtu.be/7bSDmp_gYqw YouTube video]
==Demo site==
[http://3-bits.com/demo/adaptable/ http://3-bits.com/demo/adaptable/]
==Screenshots==
<gallery mode=packed heights=300px style="text-align:left">
File: adaptable_layout.png|Adaptable theme layout
File:adaptable-select.png|Adaptable select
File:adaptable-front-page.png|adaptable-front-page
File:adaptable-alerts.PNG|adaptable-alerts
File:reduced_adaptable-colors.png|reduced_adaptable-colors
File:adaptable-fonts.png|adaptable-fonts
File:block-region-builder.png|block-region-builder
File:block-region-front-page.png|block-region-front-page
File:adaptable-mobile-social-on.PNG|adaptable-mobile-social-on
</gallery>
==Download==
From the [https://moodle.org/plugins/theme_adaptable Moodle plugins database].
==Installation==
There are several ways to install the Adaptable theme.
* Review [[Installing plugins#Installing a plugin]] Plugin installation section
* Make sure the Adaptable theme is compatible with your Moodle version
* After installing the Adaptable theme, [[Installing a new theme|change the site theme]] on one or more devices to the Adaptable theme
==Configuration==
Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting ''theme=adaptable'' or ''theme=clean'' into the URL. See [[Allow theme change by URL]].
==Theme settings that will be linked to by 'Moodle Docs for this page'==
===Colours===
You can select the colours that you would like to use throughout the theme. Use [https://en.wikipedia.org/wiki/Web_colors Hexadecimal color notation] or any other standard notation. As an alternate option you can use transparent and inherited as a value
===Fonts===
You can select the [https://en.wikipedia.org/wiki/Google_Fonts Google Fonts] that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.
===Buttons===
Alter the appearance of buttons used in this theme. Configure as needed.
===Header===
* Customize the header of this theme.
* Upload your [https://en.wikipedia.org/wiki/Favicon favicon], logo, set login form in header, adjust titles in header.
* You can set font size and styles for titles in the "fonts" settings page.
===Header Menus===
* Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
* To add a restriction enter the name of the profile field and expected value.
* Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/
* General settings for Top Menu visibility
** These settings allow you to control where menus appear and optionally allow users to customise their settings
===Header User===
Allows you to control all of the elements that appear in the user navigation dropdown.
===Header Social===
* You can disable the sitewide search box and enable social icons / links in its place.
* To setup icons enter a de-limited list into the "Social Icon List" field below.
* This should be in the format:
url|title|icon
** For example:
http://localhost/moodle/course/search.php|Search Moodle|fa-search
http://facebook.com/|Facebook|fa-facebook-square
http://twitter.com/|Twitter|fa-twitter-square
http://instagram.com|Instagram|fa-instagram
* For reference you can find the full [http://fortawesome.github.io/Font-Awesome/icons/ list of Font Awesome Icons Here]
===Header Navbar===
... customize as needed ...
===Header Tools Menu===
... customize as needed ...
===Block Settings===
... customize as needed ...
===Block Region Builder===
* You can build your own layout for block regions on the [[Front page]].
* To add content these regions you will need to [[Turn editing on]] on the [[Front page]] of Moodle.
* Then you can begin to drag/drop blocks into the regions you create!
===Course Sections===
... customize as needed ...
===Marketing Blocks===
* There are two full width info boxes with differing styles you can use.
* In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
* Please see the README file that comes with this theme.
===Front page Courses===
Configure the way that the course boxes are rendered on the [[Front page]].
===Frontpage Ticker===
* Here you can set a news ticker to run across the [[Front page]] of your Moodle site.
* It is intended as a less intrusive alternative to the slider, taking up very little space.
* To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
* Note: you must not put ul tags around our list, only li. Moodles [[Text editor]] tends to add ul tags.
* If your ticker does not load properly, switch to [[HTML]] view and ensure you have only li tags:
<code php>
<li>News item one.....</li>
<li>News item two.....</li>
</code>
===Frontpage Slider===
* Upload the images, add the links and description for the carousel on the [[Front page]].
* Sample [[HTML]] for Slider Captions:
<code php>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>
</code>
===Alert Box===
* Enter and customize a text to be displayed in the top of the site as an alert.
* It is possible to set more than one alert to target different user types.
* You also have the option of showing alerts sitewide or on [[My home|homepages]] only.
===Layout===
Set the default layout that users see.
===Footer===
Set the content that should appear in the footer
===Mobile Settings===
Control how your site looks on mobile devices
===Social Wall===
Customise the appearance of the [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (if in use on your site)
===Custom CSS & JS===
Here you can find various settings to add your own [[CSS]] and [https://en.wikipedia.org/wiki/JavaScript JavaScript] code to the theme.
===Analytics===
You can setup multiple codes for [https://en.wikipedia.org/wiki/Google_Analytics Google Analytics] and targed them to user profile fields.
==Migration from BCU to Adaptable==
Advice on migrating from BCU to Adaptable can be found [https://moodle.org/mod/forum/discuss.php?d=326470 here]
==[[HTML]] code for settings and block areas==
Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any [[HTML]] tag to customize the [[Front page]] blocks. Use a <nowiki> <div> </nowiki> as a main container and add the
height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/.
You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/

===Front Page Slider Styles===

There are two possible slider styles each with different markup required:
====Original BCU Slider Markup====
<code css>
<div class="span9">
<h4>Information</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
</div>
<div class="span3">
<a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>
</div>
</code>
====Coventry Style Slider Markup====
<code css>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>
</code>
===Frontpage Marketing Block HTML structure Coventry===
<code css>
<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>
</code>
===Front page Info Block===
There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png

===Simple box with solid background and using a default heading===
<code css>
<div style="text-align:center; background: #f0f0f0;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>
===Simple box with solid background colour, default heading h3 and white text colour===
<code css>
<div style="text-align:center; background: #009688; color: #ffffff;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>
===Front Page Secondary Info Block Example===

You can apply additional styles to the secondary info block:

<code css>
<div class="span2 personpic">
<div id="person" class="spn5">
<img src="/urltoanimage.jpg" alt="person">
</div>
</div>
<div class="span10">
<h4>School of Jewelry</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>
</code>
===Frontpage Marketing Block HTML===
You can add up to 12 Marketing Blocks in the [[Front page]].
The blocks are located automatically in rows, with a maximum of 4 blocks per row.
The full width is divided equally between the blocks.
===Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading===
<code css>
<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-font fa-5x"></i>
<h3 style="color: #333333;">TITLE</h3>
<div style="text-align:center;">Add your text here</div>
</div>
</code>
===Block with solid background colour, white text colour and Font Awesome icon===
<code css>
<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-th fa-5x"></i>
<h3 style="color: #ffffff;">TITLE</h3>
<div style="text-align:center; padding: 5px;">Add your text here</div>
</div>
</code>
===Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)===
<code css>
<div style="background: #c2185b; height: 120px;">
<h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>
</code>
===Footer Blocks===
Contact information
<code css>
<i class="fa fa-building"></i> High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com
</code>

List with Chevron
<code css>
<ul class="block-list white">
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>
</code>
==Credits==
* Adaptable is a fork of [https://moodle.org/plugins/theme_bcu BCU theme] and owes its existence to all those credited on that theme
* Adaptable development was driven by [https://3-bits.com/en/ 3Bits E-Learning Solutions] and [https://en.wikipedia.org/wiki/Coventry_University Coventry University]
* Persistence of Bootstrap Alerts provided by [https://moodle.org/user/profile.php?id=14534 Justin Hunt] in between mowing lawns and brokering cease fires (see his [http://poodll.com/services/ Moodle Services page])
* Ideas on [https://moodle.org/plugins/format_socialwall Social Wall] support provided by [https://moodle.org/user/profile.php?id=26675 Chris Kenniburg]
* Help with renderers and other tricky stuff provided by [https://moodle.org/user/profile.php?id=713800 Mary Evans] and [https://moodle.org/user/profile.php?id=442195 Gareth J Barnard]
* Additional support provided by [http://www.newschoollearning.com/?from=@ New School Learning]
==Support==
Please post your questions in the [https://moodle.org/mod/forum/view.php?id=46 Themes Forum].
[[es:Tema Adaptable]]

User:Gareth Barnard

2022-06-15T18:06:43Z

Gb2048: Update details

I am a Moodle contrib developer and forum moderator.

Adaptable theme

2022-06-15T18:06:18Z

Gb2048: Missing comma

{{Themes}}
{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/theme_adaptable
|tracker = https://gitlab.com/jezhops/moodle-theme_adaptable/-/issues
|discussion = [https://moodle.org/mod/forum/view.php?id=46 Themes Forum]
|maintainer = [[User:Jez H|Jez H]],[[User:Gareth_Barnard|G Barnard]]
|float = right
}}
This is a [[:Category:Contributed code|contributed (third party)]] highly customisable two column theme designed to work in a range of different situations. It is based on the popular [https://moodle.org/plugins/theme_bcu BCU theme]. '''Adaptable has all the features of BCU''' along with many new features.
==Features==
'''Layout Builders!''' You can now define a custom layout in the admin settings for:
* Block Regions (drag and drop)
* Marketing Blocks
* Footer Blocks
* Fully Customisable:
** Fonts
** Colors
** Block styles (including icons)
** Buttons (including radius)
* Choice of two [https://en.wikipedia.org/wiki/JQuery JQuery] sliders on [[My home|home page]] with customisable colors
* News / Announcements Ticker on [[My home|home]] / [[Dashboard]]
* Multiple [[Front page]] course styles
* Extensive custom menus (can be targeted to different users based on custom profile field)
* "My Courses" list can be organised to put older courses in sub menu item
* Dismissible Bootstrap Alerts
** Display sitewide notices using different Bootstrap styles
** Allow users to dismiss alerts once read (persistent between page loads / login)
** Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
* Additional layout settings for width, slider width, padding of various elements
* Social icons or Search box in header (admin can choose between the two)
* Support for [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (thanks to Chris Kenniburg for help on this)
* Mobile settings (greater control of how the theme looks on mobile devices)
* Option to add login form in header on front page
* [https://en.wikipedia.org/wiki/Favicon Favicon] uploader
* Background image uploader
In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, [[My home|home pages]] only, sitewide) using custom profile fields.
==Demo Video==
[https://youtu.be/7bSDmp_gYqw YouTube video]
==Demo site==
[http://3-bits.com/demo/adaptable/ http://3-bits.com/demo/adaptable/]
==Screenshots==
<gallery mode=packed heights=300px style="text-align:left">
File: adaptable_layout.png|Adaptable theme layout
File:adaptable-select.png|Adaptable select
File:adaptable-front-page.png|adaptable-front-page
File:adaptable-alerts.PNG|adaptable-alerts
File:reduced_adaptable-colors.png|reduced_adaptable-colors
File:adaptable-fonts.png|adaptable-fonts
File:block-region-builder.png|block-region-builder
File:block-region-front-page.png|block-region-front-page
File:adaptable-mobile-social-on.PNG|adaptable-mobile-social-on
</gallery>
==Download==
From the [https://moodle.org/plugins/theme_adaptable Moodle plugins database].
==Installation==
There are several ways to install the Adaptable theme.
* Review [[Installing plugins#Installing a plugin]] Plugin installation section
* Make sure the Adaptable theme is compatible with your Moodle version
* After installing the Adaptable theme, [[Installing a new theme|change the site theme]] on one or more devices to the Adaptable theme
==Configuration==
Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting ''theme=adaptable'' or ''theme=clean'' into the URL. See [[Allow theme change by URL]].
==Theme settings that will be linked to by 'Moodle Docs for this page'==
===Colours===
You can select the colours that you would like to use throughout the theme. Use [https://en.wikipedia.org/wiki/Web_colors Hexadecimal color notation] or any other standard notation. As an alternate option you can use transparent and inherited as a value
===Fonts===
You can select the [https://en.wikipedia.org/wiki/Google_Fonts Google Fonts] that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.
===Buttons===
Alter the appearance of buttons used in this theme. Configure as needed.
===Header===
* Customize the header of this theme.
* Upload your [https://en.wikipedia.org/wiki/Favicon favicon], logo, set login form in header, adjust titles in header.
* You can set font size and styles for titles in the "fonts" settings page.
===Header Menus===
* Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
* To add a restriction enter the name of the profile field and expected value.
* Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/
* General settings for Top Menu visibility
** These settings allow you to control where menus appear and optionally allow users to customise their settings
===Header User===
Allows you to control all of the elements that appear in the user navigation dropdown.
===Header Social===
* You can disable the sitewide search box and enable social icons / links in its place.
* To setup icons enter a de-limited list into the "Social Icon List" field below.
* This should be in the format:
url|title|icon
** For example:
http://localhost/moodle/course/search.php|Search Moodle|fa-search
http://facebook.com/|Facebook|fa-facebook-square
http://twitter.com/|Twitter|fa-twitter-square
http://instagram.com|Instagram|fa-instagram
* For reference you can find the full [http://fortawesome.github.io/Font-Awesome/icons/ list of Font Awesome Icons Here]
===Header Navbar===
... customize as needed ...
===Header Tools Menu===
... customize as needed ...
===Block Settings===
... customize as needed ...
===Block Region Builder===
* You can build your own layout for block regions on the [[Front page]].
* To add content these regions you will need to [[Turn editing on]] on the [[Front page]] of Moodle.
* Then you can begin to drag/drop blocks into the regions you create!
===Course Sections===
... customize as needed ...
===Marketing Blocks===
* There are two full width info boxes with differing styles you can use.
* In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
* Please see the README file that comes with this theme.
===Front page Courses===
Configure the way that the course boxes are rendered on the [[Front page]].
===Frontpage Ticker===
* Here you can set a news ticker to run across the [[Front page]] of your Moodle site.
* It is intended as a less intrusive alternative to the slider, taking up very little space.
* To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
* Note: you must not put ul tags around our list, only li. Moodles [[Text editor]] tends to add ul tags.
* If your ticker does not load properly, switch to [[HTML]] view and ensure you have only li tags:
<code php>
<li>News item one.....</li>
<li>News item two.....</li>
</code>
===Frontpage Slider===
* Upload the images, add the links and description for the carousel on the [[Front page]].
* Sample [[HTML]] for Slider Captions:
<code php>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>
</code>
===Alert Box===
* Enter and customize a text to be displayed in the top of the site as an alert.
* It is possible to set more than one alert to target different user types.
* You also have the option of showing alerts sitewide or on [[My home|homepages]] only.
===Layout===
Set the default layout that users see.
===Footer===
Set the content that should appear in the footer
===Mobile Settings===
Control how your site looks on mobile devices
===Social Wall===
Customise the appearance of the [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (if in use on your site)
===Custom CSS & JS===
Here you can find various settings to add your own [[CSS]] and [https://en.wikipedia.org/wiki/JavaScript JavaScript] code to the theme.
===Analytics===
You can setup multiple codes for [https://en.wikipedia.org/wiki/Google_Analytics Google Analytics] and targed them to user profile fields.
==Migration from BCU to Adaptable==
Advice on migrating from BCU to Adaptable can be found [https://moodle.org/mod/forum/discuss.php?d=326470 here]
==[[HTML]] code for settings and block areas==
Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any [[HTML]] tag to customize the [[Front page]] blocks. Use a <nowiki> <div> </nowiki> as a main container and add the
height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/.
You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/

===Front Page Slider Styles===

There are two possible slider styles each with different markup required:
====Original BCU Slider Markup====
<code css>
<div class="span9">
<h4>Information</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
</div>
<div class="span3">
<a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>
</div>
</code>
====Coventry Style Slider Markup====
<code css>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>
</code>
===Frontpage Marketing Block HTML structure Coventry===
<code css>
<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>
</code>
===Front page Info Block===
There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png

===Simple box with solid background and using a default heading===
<code css>
<div style="text-align:center; background: #f0f0f0;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>
===Simple box with solid background colour, default heading h3 and white text colour===
<code css>
<div style="text-align:center; background: #009688; color: #ffffff;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>
===Front Page Secondary Info Block Example===

You can apply additional styles to the secondary info block:

<code css>
<div class="span2 personpic">
<div id="person" class="spn5">
<img src="/urltoanimage.jpg" alt="person">
</div>
</div>
<div class="span10">
<h4>School of Jewelry</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>
</code>
===Frontpage Marketing Block HTML===
You can add up to 12 Marketing Blocks in the [[Front page]].
The blocks are located automatically in rows, with a maximum of 4 blocks per row.
The full width is divided equally between the blocks.
===Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading===
<code css>
<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-font fa-5x"></i>
<h3 style="color: #333333;">TITLE</h3>
<div style="text-align:center;">Add your text here</div>
</div>
</code>
===Block with solid background colour, white text colour and Font Awesome icon===
<code css>
<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-th fa-5x"></i>
<h3 style="color: #ffffff;">TITLE</h3>
<div style="text-align:center; padding: 5px;">Add your text here</div>
</div>
</code>
===Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)===
<code css>
<div style="background: #c2185b; height: 120px;">
<h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>
</code>
===Footer Blocks===
Contact information
<code css>
<i class="fa fa-building"></i> High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com
</code>

List with Chevron
<code css>
<ul class="block-list white">
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>
</code>
==Credits==
* Adaptable is a fork of [https://moodle.org/plugins/theme_bcu BCU theme] and owes its existence to all those credited on that theme
* Adaptable development was driven by [https://3-bits.com/en/ 3Bits E-Learning Solutions] and [https://en.wikipedia.org/wiki/Coventry_University Coventry University]
* Persistence of Bootstrap Alerts provided by [https://moodle.org/user/profile.php?id=14534 Justin Hunt] in between mowing lawns and brokering cease fires (see his [http://poodll.com/services/ Moodle Services page])
* Ideas on [https://moodle.org/plugins/format_socialwall Social Wall] support provided by [https://moodle.org/user/profile.php?id=26675 Chris Kenniburg]
* Help with renderers and other tricky stuff provided by [https://moodle.org/user/profile.php?id=713800 Mary Evans] and [https://moodle.org/user/profile.php?id=442195 Gareth J BarnardH]
* Additional support provided by [http://www.newschoollearning.com/?from=@ New School Learning]
==Support==
Please post your questions in the [https://moodle.org/mod/forum/view.php?id=46 Themes Forum].

'''We do not provide direct support'''
==See also==
The authors documentation page at [https://bitbucket.org/covuni/moodle-theme_adaptable https://bitbucket.org/covuni/moodle-theme_adaptable]
[[es:Tema Adaptable]]

Adaptable theme

2022-06-15T18:05:45Z

Gb2048: Update details

{{Themes}}
{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/theme_adaptable
|tracker = https://gitlab.com/jezhops/moodle-theme_adaptable/-/issues
|discussion = [https://moodle.org/mod/forum/view.php?id=46 Themes Forum]
|maintainer = [[User:Jez H|Jez H]][[User:Gareth_Barnard|G Barnard]]
|float = right
}}
This is a [[:Category:Contributed code|contributed (third party)]] highly customisable two column theme designed to work in a range of different situations. It is based on the popular [https://moodle.org/plugins/theme_bcu BCU theme]. '''Adaptable has all the features of BCU''' along with many new features.
==Features==
'''Layout Builders!''' You can now define a custom layout in the admin settings for:
* Block Regions (drag and drop)
* Marketing Blocks
* Footer Blocks
* Fully Customisable:
** Fonts
** Colors
** Block styles (including icons)
** Buttons (including radius)
* Choice of two [https://en.wikipedia.org/wiki/JQuery JQuery] sliders on [[My home|home page]] with customisable colors
* News / Announcements Ticker on [[My home|home]] / [[Dashboard]]
* Multiple [[Front page]] course styles
* Extensive custom menus (can be targeted to different users based on custom profile field)
* "My Courses" list can be organised to put older courses in sub menu item
* Dismissible Bootstrap Alerts
** Display sitewide notices using different Bootstrap styles
** Allow users to dismiss alerts once read (persistent between page loads / login)
** Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
* Additional layout settings for width, slider width, padding of various elements
* Social icons or Search box in header (admin can choose between the two)
* Support for [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (thanks to Chris Kenniburg for help on this)
* Mobile settings (greater control of how the theme looks on mobile devices)
* Option to add login form in header on front page
* [https://en.wikipedia.org/wiki/Favicon Favicon] uploader
* Background image uploader
In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, [[My home|home pages]] only, sitewide) using custom profile fields.
==Demo Video==
[https://youtu.be/7bSDmp_gYqw YouTube video]
==Demo site==
[http://3-bits.com/demo/adaptable/ http://3-bits.com/demo/adaptable/]
==Screenshots==
<gallery mode=packed heights=300px style="text-align:left">
File: adaptable_layout.png|Adaptable theme layout
File:adaptable-select.png|Adaptable select
File:adaptable-front-page.png|adaptable-front-page
File:adaptable-alerts.PNG|adaptable-alerts
File:reduced_adaptable-colors.png|reduced_adaptable-colors
File:adaptable-fonts.png|adaptable-fonts
File:block-region-builder.png|block-region-builder
File:block-region-front-page.png|block-region-front-page
File:adaptable-mobile-social-on.PNG|adaptable-mobile-social-on
</gallery>
==Download==
From the [https://moodle.org/plugins/theme_adaptable Moodle plugins database].
==Installation==
There are several ways to install the Adaptable theme.
* Review [[Installing plugins#Installing a plugin]] Plugin installation section
* Make sure the Adaptable theme is compatible with your Moodle version
* After installing the Adaptable theme, [[Installing a new theme|change the site theme]] on one or more devices to the Adaptable theme
==Configuration==
Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting ''theme=adaptable'' or ''theme=clean'' into the URL. See [[Allow theme change by URL]].
==Theme settings that will be linked to by 'Moodle Docs for this page'==
===Colours===
You can select the colours that you would like to use throughout the theme. Use [https://en.wikipedia.org/wiki/Web_colors Hexadecimal color notation] or any other standard notation. As an alternate option you can use transparent and inherited as a value
===Fonts===
You can select the [https://en.wikipedia.org/wiki/Google_Fonts Google Fonts] that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.
===Buttons===
Alter the appearance of buttons used in this theme. Configure as needed.
===Header===
* Customize the header of this theme.
* Upload your [https://en.wikipedia.org/wiki/Favicon favicon], logo, set login form in header, adjust titles in header.
* You can set font size and styles for titles in the "fonts" settings page.
===Header Menus===
* Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
* To add a restriction enter the name of the profile field and expected value.
* Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/
* General settings for Top Menu visibility
** These settings allow you to control where menus appear and optionally allow users to customise their settings
===Header User===
Allows you to control all of the elements that appear in the user navigation dropdown.
===Header Social===
* You can disable the sitewide search box and enable social icons / links in its place.
* To setup icons enter a de-limited list into the "Social Icon List" field below.
* This should be in the format:
url|title|icon
** For example:
http://localhost/moodle/course/search.php|Search Moodle|fa-search
http://facebook.com/|Facebook|fa-facebook-square
http://twitter.com/|Twitter|fa-twitter-square
http://instagram.com|Instagram|fa-instagram
* For reference you can find the full [http://fortawesome.github.io/Font-Awesome/icons/ list of Font Awesome Icons Here]
===Header Navbar===
... customize as needed ...
===Header Tools Menu===
... customize as needed ...
===Block Settings===
... customize as needed ...
===Block Region Builder===
* You can build your own layout for block regions on the [[Front page]].
* To add content these regions you will need to [[Turn editing on]] on the [[Front page]] of Moodle.
* Then you can begin to drag/drop blocks into the regions you create!
===Course Sections===
... customize as needed ...
===Marketing Blocks===
* There are two full width info boxes with differing styles you can use.
* In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
* Please see the README file that comes with this theme.
===Front page Courses===
Configure the way that the course boxes are rendered on the [[Front page]].
===Frontpage Ticker===
* Here you can set a news ticker to run across the [[Front page]] of your Moodle site.
* It is intended as a less intrusive alternative to the slider, taking up very little space.
* To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
* Note: you must not put ul tags around our list, only li. Moodles [[Text editor]] tends to add ul tags.
* If your ticker does not load properly, switch to [[HTML]] view and ensure you have only li tags:
<code php>
<li>News item one.....</li>
<li>News item two.....</li>
</code>
===Frontpage Slider===
* Upload the images, add the links and description for the carousel on the [[Front page]].
* Sample [[HTML]] for Slider Captions:
<code php>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>
</code>
===Alert Box===
* Enter and customize a text to be displayed in the top of the site as an alert.
* It is possible to set more than one alert to target different user types.
* You also have the option of showing alerts sitewide or on [[My home|homepages]] only.
===Layout===
Set the default layout that users see.
===Footer===
Set the content that should appear in the footer
===Mobile Settings===
Control how your site looks on mobile devices
===Social Wall===
Customise the appearance of the [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (if in use on your site)
===Custom CSS & JS===
Here you can find various settings to add your own [[CSS]] and [https://en.wikipedia.org/wiki/JavaScript JavaScript] code to the theme.
===Analytics===
You can setup multiple codes for [https://en.wikipedia.org/wiki/Google_Analytics Google Analytics] and targed them to user profile fields.
==Migration from BCU to Adaptable==
Advice on migrating from BCU to Adaptable can be found [https://moodle.org/mod/forum/discuss.php?d=326470 here]
==[[HTML]] code for settings and block areas==
Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any [[HTML]] tag to customize the [[Front page]] blocks. Use a <nowiki> <div> </nowiki> as a main container and add the
height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/.
You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/

===Front Page Slider Styles===

There are two possible slider styles each with different markup required:
====Original BCU Slider Markup====
<code css>
<div class="span9">
<h4>Information</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
</div>
<div class="span3">
<a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>
</div>
</code>
====Coventry Style Slider Markup====
<code css>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>
</code>
===Frontpage Marketing Block HTML structure Coventry===
<code css>
<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>
</code>
===Front page Info Block===
There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png

===Simple box with solid background and using a default heading===
<code css>
<div style="text-align:center; background: #f0f0f0;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>
===Simple box with solid background colour, default heading h3 and white text colour===
<code css>
<div style="text-align:center; background: #009688; color: #ffffff;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>
===Front Page Secondary Info Block Example===

You can apply additional styles to the secondary info block:

<code css>
<div class="span2 personpic">
<div id="person" class="spn5">
<img src="/urltoanimage.jpg" alt="person">
</div>
</div>
<div class="span10">
<h4>School of Jewelry</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>
</code>
===Frontpage Marketing Block HTML===
You can add up to 12 Marketing Blocks in the [[Front page]].
The blocks are located automatically in rows, with a maximum of 4 blocks per row.
The full width is divided equally between the blocks.
===Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading===
<code css>
<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-font fa-5x"></i>
<h3 style="color: #333333;">TITLE</h3>
<div style="text-align:center;">Add your text here</div>
</div>
</code>
===Block with solid background colour, white text colour and Font Awesome icon===
<code css>
<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-th fa-5x"></i>
<h3 style="color: #ffffff;">TITLE</h3>
<div style="text-align:center; padding: 5px;">Add your text here</div>
</div>
</code>
===Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)===
<code css>
<div style="background: #c2185b; height: 120px;">
<h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>
</code>
===Footer Blocks===
Contact information
<code css>
<i class="fa fa-building"></i> High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com
</code>

List with Chevron
<code css>
<ul class="block-list white">
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>
</code>
==Credits==
* Adaptable is a fork of [https://moodle.org/plugins/theme_bcu BCU theme] and owes its existence to all those credited on that theme
* Adaptable development was driven by [https://3-bits.com/en/ 3Bits E-Learning Solutions] and [https://en.wikipedia.org/wiki/Coventry_University Coventry University]
* Persistence of Bootstrap Alerts provided by [https://moodle.org/user/profile.php?id=14534 Justin Hunt] in between mowing lawns and brokering cease fires (see his [http://poodll.com/services/ Moodle Services page])
* Ideas on [https://moodle.org/plugins/format_socialwall Social Wall] support provided by [https://moodle.org/user/profile.php?id=26675 Chris Kenniburg]
* Help with renderers and other tricky stuff provided by [https://moodle.org/user/profile.php?id=713800 Mary Evans] and [https://moodle.org/user/profile.php?id=442195 Gareth J BarnardH]
* Additional support provided by [http://www.newschoollearning.com/?from=@ New School Learning]
==Support==
Please post your questions in the [https://moodle.org/mod/forum/view.php?id=46 Themes Forum].

'''We do not provide direct support'''
==See also==
The authors documentation page at [https://bitbucket.org/covuni/moodle-theme_adaptable https://bitbucket.org/covuni/moodle-theme_adaptable]
[[es:Tema Adaptable]]

Installation on Ubuntu using Git

2020-09-11T17:35:06Z

Gb2048: /* Install Moodle code */

{{Installing Moodle}}
==Introduction==

This page gives the basic steps to install Moodle on Ubuntu using Moodle code from Git. This is generally a better idea than using the Ubuntu '.deb' package.

There was no intention to provide a fully secured production server. This just gets basic Moodle working on 'localhost'.

This should work on either Ubuntu Desktop or Server edition.

==Install Ubuntu==

* Install [http://ubuntu.org/ Ubuntu Desktop] or [http://www.ubuntu.com/download/server/download Ubuntu Server] using (if in doubt) default settings

==Basic Setup==
{{Note|This old documentation uses PHP 5, but current Moodle 3.5 should use PHP 7}}
* Open a terminal window (from Applications>Accessories) on Desktop or log into the terminal on Server.
* become root (and stay there right through this), install some additional software (git and php extras Moodle needs):
<pre>
sudo su (you will need to enter your password)
apt-get update
apt-get install git git-core git-doc
apt-get install php5-gd php5-curl php5-intl php5-xmlrpc
apt-get install php5 mysql-server mysql-client apache2 php5-mysql
apt-get install php5-json
</pre>

* (on Desktop) open a web browser and go to http://localhost/ and make sure you see 'It works!'.
* (on Server) open a web browser on a remote machine and go to http://name.or.ip.of.server/ and make sure you see 'It works!'.

==Install Moodle code==

We're going to use Git to pull the latest code. You could just download it, but this is more fun! The checkout switches to the latest (weekly) of the 2.6 branch. The chmod (temporarily) allows the installation script to write the config file. Still as superuser ('sudo su' from before):

<pre>
cd /var/www
git clone https://github.com/moodle/moodle.git
cd moodle
git checkout -t origin/MOODLE_39_STABLE
chmod 0777 /var/www/moodle
</pre>

* The moodle code location (for installation) is /var/www/moodle

==Create the data area==

You can create this where you like (more or less) but I will do (assuming you are still superuser)...

<pre>
mkdir /var/moodledata
chmod 0777 /var/moodledata
</pre>

* The moodle data location (for installation) is /var/moodledata

==Create the database==

You will need the root database password. Unless you have changed it, this is same as your login password (or whatever you set up when you installed MySQL above).

<pre>
mysql -u root -p
(asks for password here)
mysql> create database moodle default character set utf8;
mysql> grant all on moodle.* to moodleuser@localhost identified by 'mypassword';
mysql> exit
</pre>

'''Notes:'''
* don't type 'mysql>', that's just the prompt from the mysql client.
* The ''grant'' command creates the MySQL account 'moodleuser' with the supplied password and gives it rights to the moodle database all in one command.
* Set 'mypassword' to something you make up. This is the password for your moodle database
* When you install moodle the database is called 'moodle', the database user 'moodleuser' and the password as above

==Configure apache==

The standard configuration of Apache on Ubuntu should work fine and will give you a Moodle URL of http://name.or.ip.of.server/moodle (or http://localhost/moodle).

If you need other configurations or a different form of URL, now is the time to configure this. However, this is not covered here. There is lots of information online, although do note that the Ubuntu Apache configuration is rather different to the standard layout.

==Install Moodle==

Open Firefox and go to address http://localhost/moodle
You should be able to install Moodle using the information indicated above

==and finally==

Don't skip this step. This secures the Moodle code, preventing it being overwritten by hackers.

<pre>
chmod 0755 /var/www/moodle
exit
</pre>

==Don't forget==

* Set up [[Cron]]
* Check the [[Email settings]]

==a quick note on updating==

Because we installed using Git, updating Moodle (on the same stable branch) becomes surprisingly simple. Using the repository we did gives you the latest weekly at any time. If it matters, do a backup first then:

<pre>
sudo su
chmod /var/www/moodle
git pull
exit
</pre>

Then go to the Site administration > Notifications page in Moodle to complete the upgrade.

==Troubleshooting==

* If something goes wrong in the actual Moodle installation - switch on [[Debugging]]. You can create Moodle's config.php file by copying config-dist.php to config.php and editing it. It is very well documented by comments. Well down in the file you will find the options to turn on debugging. See [[Configuration file]]. If you create the file by hand, the installation will pick up from the correct place automatically.
* Most errors will turn up in the web server logs. Always check there first - /var/log/apache2/errors.log
* If you need to change things like file upload sizes you need to edit /etc/php5/apache2/php.ini and then restart the web server with 'sudo /etc/init.d/apache2 restart'

==See also==

* [https://help.ubuntu.com/community/Installation Installing Ubuntu]
* [https://help.ubuntu.com/community/ApacheMySQLPHP Ubuntu LAMP/Apache documentation]

course/view/grid

2019-08-26T16:25:43Z

Gb2048: Created page with "A topics based format that uses a grid of user selectable images to pop up a light box of the section."

A topics based format that uses a grid of user selectable images to pop up a light box of the section.

Talk:Collapsed Topics course format

2019-08-10T21:22:27Z

Gb2048:

This page probably needs new screenshots.

[[User:Luca Bösch|Luca Bösch]] ([[User talk:Luca Bösch|talk]]) 19:10, 10 August 2019 (UTC)

Please feel free to make them Luca, and amend the page.
--[[User:Gareth Barnard|Gareth Barnard]] ([[User talk:Gareth Barnard|talk]]) 21:22, 10 August 2019 (UTC)

Theme directory

2019-02-08T17:48:07Z

Gb2048: Removed Moodle 2.0 indicator

{{Themes}}In the standard Moodle distribution, all themes are placed in the theme/ directory.

More information about the content of a typical theme directory/folder can be found in [[:dev:Theme_basics#What_is_inside_a_theme_folder.3F|Theme basics]]

== Change themes default directory for site ==

The storage location of themes may be altered, using the variable ''$CFG->themedir''. Themes from placed in the directory specified by this variable will then be available for selection using the theme selector.

For example, should you wish to place themes in a subdirectory called 'my_moodle_themes', your 'config.php' file might look like this:
<pre>
$CFG->wwwroot = 'http://my.moodle.site.edu';
$CFG->dirroot = '/var/www/my.moodle.site.edu/public_html';
$CFG->themedir = $CFG->dirroot . '/my_moodle_themes';
</pre>

or any place that you have configured to be readable by your web server, for example:

<pre>
$CFG->wwwroot = 'http://my.moodle.site.edu';
$CFG->dirroot = '/var/www/my.moodle.site.edu/public_html';
$CFG->themedir = '/home/me/my_moodle_themes';
</pre>

== Theme directory for Developers ==

Developers should follow the [[:dev:Theme directory guide|Theme directory guide]]

== See also ==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=20152 Feature request: Themes path in a VAR]
*Moodle Tracker [http://tracker.moodle.org/browse/MDL-6784 MDL-6784]

[[Category:Administrator]]
[[Category:Themes]]

[[fr:Dossier de thèmes]]
[[ja:テーマディレクトリ]]
[[de:Design-Verzeichnis]]

Theme directory

2019-02-08T17:46:10Z

Gb2048: Removed 'themewww' as that was removed in Moodle 2.0.

{{Themes}}In the standard Moodle distribution, all themes are placed in the theme/ directory.

More information about the content of a typical theme directory/folder can be found in [[:dev:Theme_basics#What_is_inside_a_theme_folder.3F|Theme basics]]

{{Moodle 2.0}}
== Change themes default directory for site ==

The storage location of themes may be altered, using the variable ''$CFG->themedir''. Themes from placed in the directory specified by this variable will then be available for selection using the theme selector.

For example, should you wish to place themes in a subdirectory called 'my_moodle_themes', your 'config.php' file might look like this:
<pre>
$CFG->wwwroot = 'http://my.moodle.site.edu';
$CFG->dirroot = '/var/www/my.moodle.site.edu/public_html';
$CFG->themedir = $CFG->dirroot . '/my_moodle_themes';
</pre>

or any place that you have configured to be readable by your web server, for example:

<pre>
$CFG->wwwroot = 'http://my.moodle.site.edu';
$CFG->dirroot = '/var/www/my.moodle.site.edu/public_html';
$CFG->themedir = '/home/me/my_moodle_themes';
</pre>

== Theme directory for Developers ==

Developers should follow the [[:dev:Theme directory guide|Theme directory guide]]

== See also ==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=20152 Feature request: Themes path in a VAR]
*Moodle Tracker [http://tracker.moodle.org/browse/MDL-6784 MDL-6784]

[[Category:Administrator]]
[[Category:Themes]]

[[fr:Dossier de thèmes]]
[[ja:テーマディレクトリ]]
[[de:Design-Verzeichnis]]

PHP

2016-05-21T15:44:36Z

Gb2048: /* HTTP_RAW_POST_DATA errors */

{{Installing Moodle}}
PHP is the scripting language in which Moodle is developed. It is integrated with your web server. The web server detects php pages (by their extension) and sends them to PHP for execution. PHP must be installed and configured properly for Moodle to work effectively (or at all).

==PHP Settings==
Check these settings in your php.ini or .htaccess file (if you're using Apache). For settings which use ON/OFF as their values, you can substitute 1 for ON and 0 for OFF if you prefer. If you change php.ini, don't forget to restart the server.
* ''register_globals'' '''MUST''' be OFF - (Feature removed as of PHP 5.4. PHP 5.4 is a minimum requirement of Moodle 2.7)
* ''safe_mode'' needs to be OFF - (Feature removed as of PHP 5.4. PHP 5.4 is a minimum requirement of Moodle 2.7)
* ''memory_limit'' should be at least 64M (although some functions may not work if this low). 128M is recommended. Large systems may need an even higher setting.
* ''session.save_handler'' needs to be set to FILES.
* ''magic_quotes_gpc'' should be OFF - (Feature removed as of PHP 5.4. PHP 5.4 is a minimum requirement of Moodle 2.7)
* ''magic_quotes_runtime'' needs to be OFF.
* ''file_uploads'' needs to be ON.
* ''session.auto_start'' needs to be OFF.
* ''session.bug_compat_warn'' needs to be OFF - (Feature removed as of PHP 5.4. PHP 5.4 is a minimum requirement of Moodle 2.7)
* The temp folder must be defined and writeable by your webserver user
* Check the error display/logging section. Make sure the settings are appropriate for your server use.
* ''post_max_size'' and ''upload_max_filesize'' restrict the maximum file size that can be uploaded.
* Check the ''[mail function]'' and database section (for your chosen database) to make sure they match your server configuration.

==HTTP_RAW_POST_DATA errors==
Some users are experiencing $HTTP_RAW_POST_DATA related errors, when establishing connection between MNET servers or making AJAX web services requests.
<pre>
Request for server name returned empty response

line 134 of /mnet/lib.php: call to debugging()
line 115 of /admin/mnet/peers.php: call to mnet_get_public_key()
</pre>

These errors are affecting users running moodle on PHP 5.6 version and it's a PHP bug on the '''always_populate_raw_post_data''' setting the default value to 0.

To avoid the error messages above, please change the value following setting on your php.ini file:
* '''always_populate_raw_post_data''' should be changed to '''-1'''.

For more information about this bug, see: https://bugs.php.net/bug.php?id=66763

==Finding the correct php.ini==
Sometimes it is not obvious where the php.ini file is located or you may even find more than one. To be certain run 'phpinfo' - see below. The path of the php.ini file is a few lines down in the top section.

Note that if you are using command-line (CLI) PHP for running cron (or anything else) it may be configured with a ''different'' php.ini file. To check, run the following command:
<pre>
php -i | grep php.ini
</pre>

==PHP Extensions and libraries==
The following PHP extensions are required or recommended (some, e.g. iconv, ctype and tokenizer are now included in PHP by default). Others will need to be installed or selected.
* The '''iconv''' extension is required.
* The '''mbstring''' extension is recommended.
* The '''curl''' extension is required (required for networking and web services).
* The '''openssl''' extension is recommended (required for networking and web services).
* The '''tokenizer''' extension is recommended.
* The '''xmlrpc''' extension is recommended (required for networking and web services).
* The '''soap''' extension is recommended (required for web services).
* The '''ctype''' extension is required.
* The '''zip''' extension is required.
* The '''gd''' extension is recommended (required for manipulating images).
* The '''simplexml''' extension is required.
* The '''spl''' extension is required.
* The '''pcre''' extension is required.
* The '''dom''' extension is required.
* The '''xml''' extension is required.
* The '''intl''' extension is recommended.
* The '''json''' extension is required.
* '''The appropriate extension for your chosen database is also required.'''

* Other PHP extensions may be required to support optional Moodle functionality, especially external authentication and/or enrolment (e.g. LDAP extension for LDAP authentication and the sockets extension for Chat server).

==Installing (missing) extensions==

This depends on how PHP was installed on your machine and what access you have. Here are some possibilities:
* If this is a hosted server you are likely to have to ask the administrator or hosting company.
* If PHP was compiled from source you will need to recompile, changing the 'configure' settings - see [[Compiling PHP from source]].
* If it was installed using packages (typically Linux) you can install the required package (see your Linux distribution's documentation)
* If you are using Windows you just need to uncomment the appropriate DLL files in php.ini

After making any changes or additions, don't forget to re-start your web server.

== .htaccess files ==

If you don't have access to the php.ini file or there are conflicting requirements with other PHP applications on the same server you may be able to change PHP settings in an .htaccess file. This should be placed in the 'root' of your Moodle installation (i.e. the same place as the config.php file).

'''The file isn't always called .htaccess and may not work at all. Contact your server administrator to be sure'''

Settings are made by adding lines in one of two formats:
* php_value ''name value''
* php_flag ''name on/off''

Examples:
* '''php_value memory_limit 128M'''
* '''php_flag register_globals off'''

==PHP info==

The phpinfo display contains information about the configuration of your PHP installation. This is useful for checking:
* that your PHP installation meets Moodle's system requirements.
* the values that are currently applied to your server's PHP install, e.g. File upload limits
* that you have installed the required modules needed for Moodle to work, e.g. the LDAP module for LDAP authentication.

=== Displaying phpinfo in Moodle===

An administrator can find PHP info in ''Settings > Site administration > Server > PHP info''.

=== Displaying phpinfo outside of Moodle ===

To view the phpinfo information:
* Create a file called info.php using your text editor, containing this single line:

<code php>
<?php phpinfo(); ?>
</code>

* Save this file as info.php
* Upload this file into the root web accessible folder on your server.
* Now open this file in your browser. For example <nowiki>http://<server-name>/info.php</nowiki>.

==See also==

*[[Compiling PHP from source]]
* [https://docs.moodle.org/dev/Moodle_and_PHP7 Moodle and PHP7] in the developers documentation
*http://www.php.net/ - the PHP web site
*http://php.iis.net/ - Microsoft PHP Installer for IIS

[[de:PHP-Versionen für Moodle]]
[[es:PHP]]

Talk:Apache

2015-04-12T19:27:22Z

Gb2048: Created page with "Note: Apache directives are case sensitive: http://httpd.apache.org/docs/2.2/mod/core.html#acceptpathinfo - so be careful when using. I'm not sure if this extra information..."

Note:

Apache directives are case sensitive: http://httpd.apache.org/docs/2.2/mod/core.html#acceptpathinfo - so be careful when using. I'm not sure if this extra information is needed. I've corrected the 'AcceptPathInfo On' example - Gareth J Barnard.

Apache

2015-04-12T19:22:08Z

Gb2048: /* Slasharguments */

{{Installing Moodle}}
'''This article refers to the 'Apache HTTP server''''

The Apache HTTP server is the software that (along with the PHP scripting language) 'runs' Moodle. Note that there are alternatives (e.g. IIS on Windows) but the Apache HTTP Server is very popular on all platforms.

== Installing Apache ==
Installers are available for most platforms from http://httpd.apache.org/download.cgi. The official installation instructions are here: http://httpd.apache.org/docs/2.0/install.html. If you are running Linux then you are recommended to use the packaged version if you can. For example in Debian/Ubuntu it is simply:
<pre>
sudo apt-get install apache2
</pre>

See the documentation for your particular platform for the instructions. Apache is straightforward to build from source if you have to and the PHP documentation contains an article on building both Apache and PHP together - although you should rarely need to do that.

==Performance==

See [[Performance recommendations]]

==Slasharguments==

The function ''slash arguments'' is required for various features in Moodle to work correctly, as described in [[Using slash arguments]].

To turn it on, add this line to your ''httpd.conf'', or to a ''.htaccess'' file in your local directory:

AcceptPathInfo On

==SSL==

Moodle has an option to enable login pages to force the HTTPS protocol. This is recommended but requires that your web server is configured for SSL. It is possible to run the whole site over HTTPS (typically by configuring Apache to rewrite all http:// URLs to <nowiki>https://</nowiki>) but as this disables caching, there is a considerable performance hit. Only do this if you have a very good reason.

'''WARNING: Before switching on login over HTTPS, make very sure that HTTPS is working (just change the http:// to https:// in any Moodle URL). If not, you may lock yourself out'''

You have two options for obtaining an SSL certificate:
* generate a self-signed certificate. This is fine on (say) an Intranet but unsuitable for the public internet (except perhaps for testing). The user has no assurance that the certificate is legitimate.
* purchase a certificate from a vendor. There is a surprising range of prices and value-added services available. Some hosting companies even provide free certificates.

Below are instructions for install of a self-signed certificate. If you purchase a certificate you will normally receive instructions for installing it

===Debian and Apache2===

1. generate a certification:
<pre>
apache2-ssl-certificate
</pre>

for debian etch, apache2-ssl-certificate is no longer available, use make-ssl-cert instead:
<pre>
make-ssl-cert /usr/share/ssl-cert/ssleay.cnf /etc/apache2/ssl/apache.pem
</pre>
2. edit /etc/apache2/ports.conf:
<pre>
Listen 80
Listen 443
</pre>
3. copy /etc/apache)2/sites-available/default to /etc/apache2/sites-available/default-ssl, and change /etc/apache2/sites-available/default:
<pre>
NameVirtualHost *:80
<VirtualHost *:80>
...
</VirtualHost>
</pre>
and also /etc/apache2/sites-available/default-ssl:
<pre>
NameVirtualHost *:443
<VirtualHost *:443>
...
SSLEngine on
SSLCertificateFile /etc/apache2/ssl/apache.pem
...
</VirtualHost>
</pre>
4. symbolic link the ssl file:
<pre>
a2ensite default-ssl
</pre>
5. don't forget to symbolic link the ssl module:
<pre>
a2enmod ssl
</pre>
6. restart apache and '''test the connection''' (e.g. https://localhost/):
<pre>
/etc/init.d/apache2 restart
</pre>

== See also ==

* [http://httpd.apache.org/ The Apache HTTP Server Project homepage]
* [http://en.wikipedia.org/wiki/Apache_HTTP_Server Wikipedia article on the Apache HTTP Server]
* [http://httpd.apache.org/docs/2.0/misc/perf-tuning.html Apache Performance Tuning article at the official homepage]
* [https://els.earlham.edu/cayaraa/weblog/1468.html Making Moodle work with SSL]
* [http://www.krufix.de/ Using the same Moodle twice in local network and Internet via SSL-Proxy] (in German)

[[pl:Apache]]
[[ja:Apache]]
[[de:Apache]]

Language customisation

2014-01-02T13:51:13Z

Gb2048: /* Quick instructions for the impatient */

{{Language}}
Words or phrases (in any language) used on the site may be easily changed by an administrator using the language customization feature. For example, you may want to change the word "Course" to "Unit". The process consists of 4 steps:

# Check-out the strings
# Filter the strings you wish to customize
# Customize the strings
# Save and check-in the strings

== Quick instructions for the impatient ==

# Go to the ''Administration > Site administration > Language> Language customisation'' page.
# Pick the language to customise from the pull down list.
# Click on the "Open language pack for editing" button. This may take some time to process.
# Once the language pack has loaded, click on the "Continue" button.
# Click or Ctrl+Click to select the files in the "Show strings of these components" list. Notice that the files are grouped. For example, you will find the lesson strings under "mod" and moodle.php under "core".
# After selecting the file(s), it is possible to use the "Only strings containing" filter along with other filters. For example, to look at only the string text that has the word "teacher" the file(s) you selected.
# Click on "Show strings".
# Make your changes in the appropriate "Local customisation" box.
# Click on "Apply changes and continue editing" if you want to use another filter or edit other file(s).
# Click on "Save changes to the language pack" to save all of the changes you have made.

:''Tip:'' Do not see any string changes? Did you remember to use the "Save changes to the language pack" button? Did you refresh your browser so that it is not looking at a cached page? Did you edit the language file that is actually being used on your site, course or by the user?

:''Tip:'' Can't find the string you wish to change? Tick the 'Show origin of languages strings' checkbox in ''Administration > Site administration > Development > Debugging'' then visit the page containing the string you want to customise.

== Background ==

Moodle is translated into many languages - see [http://download.moodle.org/langpack/ Moodle.org: Language packs] for their list and the translation completion status. The translations are distributed in so called language packages (or just lang packs) that are maintained by kind volunteers, community contributors and Moodle partners. Please read the page [[Translation]] first to understand how the whole localization machinery works.

Moodle site administrators can customize any language pack to fit their individual needs (for example to use the term "Unit" instead of "Course"). You are discouraged from direct editing the files coming as a part official language pack. Such changes would be silently overwritten during the next upgrade. Instead, you should create a local language pack that holds all your changes from the official pack.

Local language packs have the same structure as the official ones. They are saved in your Moodle data directory in moodledata/lang/xx_local/ folder where 'xx' is the code of the language. You have to have the official language pack installed before you can customize it. Local language pack should contain just strings you have customized - you should not copy whole official language packs.

When displaying a string, Moodle first looks if a local customization of it exists in moodledata/lang/xx_local/component_file.php. If so, it is used. If not, the string from the official language pack is used (eventually, if the string has not been translated yet, the original English version is displayed). Please note that the strings are cached for better performance so you have to purge Moodle caches after you modify a file in your xx_local pack (caches are purged automatically if you use the tool described below).

== Using Language customization tool ==

Moodle comes with a tool that allows you to edit your local language pack via web interface. This tool is available for the site administrators in ''Settings > Site administration > Language > Language customization''. Please refer to the following workflow diagram.

[[image:customlang-process.png|800px|thumb|left|Workflow of the language customization (click to enlarge)]]
<br clear="both" />

=== Check out strings into translator ===

At the Language customization first page, select a language to customize and press the button 'Check out string into translator'. During the checkout, Moodle loads the language strings from PHP files into its database. The language customization tool works with this database so the files in your xx_local pack are not touched unless your proceed to the final step of this workflow. If the xx_local language pack does not exist yet, Moodle automatically creates an empty one for you.
:''Tip:'' There is currently a problem with "execution time". If you get the "Fatal error: Maximum execution time of 180 seconds exceeded" message, you will have to press the button 'Check out string into translator' several times to get the operation completed. See [http://moodle.org/mod/forum/discuss.php?d=163375 forum discussion].

=== Use filter to find the strings you want to customize ===

[[Image:Language_string_M2_filter.png|thumb|right|Moodle 2.0 language filter]]
After the checkout, use the "filter strings" form to find strings you want to customize for your site. Not selecting any filters will display all strings in the language pack.

* ''Show strings of these components'' - Click or Ctrl+click to select one or more files that contain the string you want.
* ''Customized only'' - check this field to display only those strings that are already present in your xx_local pack.
* ''Help only''' - check this field to display only help tooltips, that is the texts used when clicking the yellow question mark icon.
:''Note:'' Starting in Moodle 2.0, help string identifiers must end with _help suffix.
* ''Modified only'' - displays only the strings that are modified in the current session.
:''Note:'' The term 'customized' means strings that are saved on disk in your xx_local pack directory. The term 'modified' represents the changes made since the last checkin string into the language pack. Customized strings (already saved in a file) are highlighted with green. Modified strings (not saved in a file yet) are highlighted with blue.
:''Tip:'' You may want to use this option look at your current work before you check it in.
* ''Only strings containing'' - insert a phrase that must appear in the string. For example, if you put a word 'student' here, you will get only those strings that contain this word.
:''Tip:'' The 'Only strings' filter can be used for a total search for a term used in your Moodle site for the selected language pack.
* ''String identifier'' - if you know the string identifier (it is the first parameter of the get_string() function), type it here. For example, the names of activity modules are defined in strings 'modulename'. Finding where a particular string is saved can be difficult sometimes. The administrator can start a debugging function: Site administration>Development>Debugging and choose "Show origin of language strings". Then if you append "?strings=1" (or "&strings=1" if there is already a parameter) to the end of the page URL, beside each string will be shown something like "{rememberusername/admin}". The last part says which php file uses the string, so this one is in admin.php. If there is nothing after the / look in moodle.php. The first part, before the /, is the string identifier.

Use combination of filter settings to get the required set of strings.

Click button 'Show strings' for potential editing.

=== Input your own translation ===

The strings that pass all the conditions defined in the filter are displayed in a table. To replace the standard translation, put your own into the 'Local customization' field.
:''Tip:''If you want to delete your current customization , just delete the content of the 'Local customization' field and click the "Save and continue editing". The modifications that are going to be removed a customized string are highlighted in red. If you made changes to a field previously "Save and continue editing" it will be highlighted in blue.

Click "Save and continue" button before you change the filter settings and show a new set of strings.

=== Saving your work into files ===

As necessary, you may repeat the "show strings", "local customization" and "Save and continue" process. When you have made all the changes you want to make:

Click "Save and check in strings into files" to process all changes made in the translator database to your local language pack.

=== Writing the modifications into files ===

During the checkin, the contents of the translator database are dumped into files in moodledata/lang/xx_local/ directory.

Click "Save and check in strings into files" to process all changes made into your local language pack.
:''Note:'' this operation removes the directory first and then re-creates it with the actual data. Therefore it is reasonable to not to touch the files directly after you have checked out them into the translator.

==See also==

* Using Moodle [https://moodle.org/mod/forum/discuss.php?d=219504 Duplicate entry 'en-373-AM'] forum discussion about error when attempting to edit a lang pack

[[de:Sprachanpassung]]
[[es:Personalización del idioma]]

Windows installation using Git

2013-12-02T13:51:12Z

Gb2048: /* Getting hold of Moodle */

{{Installing Moodle}}
This page is for non-technical Windows users who would like to be able to keep a copy of Moodle on their computers that they can easily and regularly update.

'''NOTE:''' ''These guidelines are intended for a Standard Moodle installation on a Windows PC for a private or test Moodle installation, NOT a production (public) site or service. If you wish to install Moodle on a public site using Git then please see [[Git for Administrators]]''. ''If you wish to contribute fixes or improvements using Git please see [[Development: Git for developers]]''

If you prefer screencasts to reading, there is a [http://youtu.be/CORFciSlHuo youtube tutorial here]

==What you need to install Moodle on your Windows pc==
#somewhere on your pc to house it and keep it working,with a database to maintain its records. We will use [http://www.wampserver.com/en/ WAMP server]
#the Moodle files themselves. We will use [http://windows.github.com/ Github for Windows]

==What is Git and why use it?==
[http://en.wikipedia.org/wiki/Git_(software) Git] allows Moodlers not only to quickly download the latest versions of Moodle but also to [[File:git-pushpull-modelEDITED.png|200px|thumb|left|Git cycle]] download and test out fixes by developers and to share with others their own changes which may potentially get integrated into Moodle for the benefit of everyone. In this page we are merely going to use the system to download Moodle onto our computer- (see the cycle in yellow in the screenshot)Git makes it easy for us to update Moodle when new versions come out each week, and it gives you the potential when more familiar with it to grab other changes and help test it. However, if you merely want to have Moodle on your Windows pc to practise and try things out and are NOT really interested in having all the latest changes then it might be easier for you to use the [http://download.moodle.org/windows/ All in one Windows Installer package] instead.

==Getting the WAMP server==
[[File:wamplocation.png|200px|thumb|left|path to your wamp folder]]1. Go to [http://www.wampserver.com/en/ Wampserver] and click the Download button
2. You will probably need to click the button '''Wampserver (64 bits &PHP 5.3) 2.2E''' but to be sure, here is how to [http://tips4pc.com/computer_tips_and_tricks/do_i_have_a_32bit_or_64bit_operating_system.htm check if your pc is 64 bit or 32 bit])

3. You may get a warning '''You must install Visual C++ 2010 SP1 Redistributable Package x86 or x64''' - download the appropriate package for you. This may take some time.

4. When it is done, come back to [http://www.wampserver.com/en/ Wampserver] and click the Download button again.
Download, save and run the program, making sure you keep a note of where it has installed it on your computer. It will be in a folder called ''wamp.'' as in the screenshot to the left.

==Making the database==
Once wampserver is installed you will see a '''W''' icon, either on your desktop, start menu or taskbar (according to what you selected when installing.) Click it to bring up its options and then click PhpMyadmin as in Screenshot A below.

''Tip: You can also reach this screen by typing into your browser: http://localhost/phpmyadmin/''

1.Make sure that Server connection collation says "utf8_general_ci" (1 in Screenshot B below)

2.Click "databases" - (2 in Screenshot B below)

{|
| [[File:phpmyadminscreenshot.png|thumb|Screenshot A]]
| [[File:phpmyadmin12.png|thumb|Screenshot B]]
|}

3. Type a name for your database (how about "moodle"?) Make sure you remember its name. Ensure Collation is set to utf8_general-ci. Click "Create".
[[File:create database.png]]

4.Click the "check privileges" to the right of your database name and then click "add user".

5. Add your details as the database administrator. Choose "local" for the host Make sure you remember the name and password you set. Tick (check) all privileges and click "add user".

==Preparing to install Moodle==
[[File:moodledatascreenshot.png|200px|thumb|left|Where Moodle and Moodledata go]]

Along with the folder containing all the Moodle files, we need another folder to hold all the user data once Moodle is up and running. This is traditionally called the "moodledata" folder. We need to create a new folder for this before downloading Moodle.

#Find your wampserver on your computer - for instance, in C:\wamp.
#Note there is a folder called "www". We will install Moodle into there.
#If you wish, create a new folder called "moodledata" in the wampserver folder, as in the screenshot - but if not, Moodle will create it for you and suggest its name.

==Getting hold of Git==
#Go to [http://windows.github.com/ Github for Windows] and click the download button (currently in green, top right)
#You don't need to make an account but if you do, it will help you later if you wish to use Git at a more advanced level.
#Let Windows do its work; save it and run it. It might take some time.
#Once it is installed, you will have two cat-like creature icons on your desktop, taskbar or start menu (depending on what you selected)
#Click the one called "Git shell". It will bring up a black box:

[[File:gitshell.png|400px|Git shell]]

==Getting hold of Moodle==
The file path shown in your black box ("Windows power shell") is where Git has made your personal repository. You can download Moodle into there if you wish, but you will then have to copy the Moodle folder into your wampserver directory. Instead, we will download Moodle straight into the www folder of our wampserver directory.

1. Type <code>cd C:\wamp\www</code> (or whatever the path is to your wampserver directory and where you want to put Moodle)

2. Type <code>git clone -b MOODLE_26_STABLE git://git.moodle.org/moodle.git</code> (If you want a different version, see the [[#Troubleshooting and FAQ]] below.)

3. Wait! Lots of lines will appear and it might take a while. At the end you should see "Checking out files:100% done"

{|
| [[File:cdstep1.png|thumb|Step 1]]
| [[File:step2.png|thumb|Step2]]
| [[File:step3.png|thumb|Step3]]
|}

==Installing Moodle==
#In your browser, type ''localhost/moodle''
#The Moodle set up screen will appear.
#Much of this is straightforward form-filling. Pay attention to:
##the paths -does it know where to find your wampserver folder for Moodle and moodledata?
##the database details (which you should have remembered when setting up in section 4 above)
##the server check.

{|
| [[File:path.png|thumb|Check correct paths]]
| [[File:databaseremember.png|thumb|Database details]]
| [[File:serverchecks.png|thumb|Server check]]
|}

===What are server checks?===
Moodle needs to ensure our wampserver has all the features ("extensions") enabled to run it successfully.

Anything in green is fine. Anything in yellow is OK (but would be better in green). Anything in red will stop us installing Moodle.

#Make a note of the ones in yellow or red (names are under the Information column)
#Click your '''W''' wampserver icon and click "php extensions" (screenshot 1 below)
#Tick those extensions you noted were yellow or red (screenshot 2 below)

{|
| [[File:phpextensions1.png|thumb|Php extensions 1]]
| [[File:phpextensions2.png|thumb|Php extensions 2]]
|}

'''''Note:''' If you have problems enabling the curl extension, see the [[#Troubleshooting and FAQ]] below.''

==Completing the installation==
#Once your server checks page shows all green or all green with some yellow, you can click "Continue"
#Moodle will install - this will take some time. Be patient. When you see "workshop" you know you are nearly done.
#Complete details for your admin username and password (and remember them!)
#Complete details for your front page (name of your Moodle, etc)
#Give yourself a pat on the back!

==Updating your Moodle==
You can get a newer version of Moodle every Thursday. To do this using Git:
#Click the Git shell avatar to open up the Windows powershell black box.
#If it shows a different directory from where you installed Moodle, change the path by typing in <code>C:\wamp\www\moodle</code> or wherever the path to your Moodle folder is.
#You will see it now displays the name of the Moodle version you installed (Screenshot 1 below)
#Type <code>git pull</code>
#Lines will appear and your Moodle will update itself automatically!(Screenshot 2 below)
#Note that <code>git pull</code> will also tell you if your version is currently up to date (Screenshot 3 below)

{|
| [[File:updating1.png|thumb|1: Moodle folder ready for update ]]
| [[File:gitpullscreenshot.png|thumb|2: Moodle has been updated]]
| [[File:updating2.png|thumb|3: Currently up to date]]
|}

==Troubleshooting and FAQ==
===I can't get cURL extension to green (or even yellow) whatever I try.===
It could be your downloaded wampserver had a corrupted cURL extension (mine did). Go to [http://www.mediafire.com/?qwgdzgccthzwc15 mediafire.com] and download the cURL extenstion there. Unzip it and then add it into (for example) ''wamp>bin>php>php 5.3.13>ext.'' (The exact path will depend on where you saved your wampserver.) Let it override the original and try again.

===I type localhost/moodle but it doesn't work!===
Make sure your wampserver is working ("online") The '''W''' icon should be green. If it isn't, then click it and click "restart all services" or "start all services" and try again.

===I want a different version of Moodle===

If you want an earlier version such as Moodle 2.2 then type <code>git clone -b MOODLE_22_STABLE git://git.moodle.org/moodle.git</code>

If you want the latest, non-stable, development version of Moodle (currently 2.4) then type <code> git clone git://git.moodle.org/moodle.git</code>

===I want Moodle in localhost and NOT localhost/moodle===
In the [[#Getting hold of Moodle]] section, make sure your path does not include "www". It might be for instance "C:\wamp". Moodle will then download directly into your wampserver directory. Rename your "www" folder to "wwwOLD" and then rename your newly arrived moodle folder to "www".

==See also==
[http://youtu.be/CORFciSlHuo Video tutorial on youtube]

Using Moodle forum thread [http://moodle.org/mod/forum/discuss.php?d=208904 Git for Dummies]

Course settings

2013-09-25T09:00:00Z

Gb2048: /* Course layout */

{{Courses}}
A teacher, or other user with the [[Capabilities/moodle/course:update|update course settings capability]], can change course settings in ''Settings > Course administration > Edit settings''.

==General==
{|
|[[File:generalcourse25.png|thumb|General settings,expanded by default]]
|}

===Course full name===

This is the name of the course. It is displayed as a link on course lists on the [[Front page]] and on [[My home]] and in reports. It is also used in the browser title bar when the course is viewed.

The capability [[Capabilities/moodle/course:changefullname|moodle/course:changefullname]] controls whether a user can edit the course full name.

===Short name===
Many institutions have a shorthand way of referring to a course, such as BP102 or COMMS. Even if you do not already have such a name for your course, make one up here. It will be used in several places where the long name is not appropriate, such as the Navigation block.

The capability [[Capabilities/moodle/course:changeshortname|moodle/course:changeshortname]] controls whether a user can edit the short name field.

By default, only course full names are displayed in the list of courses. However an administrator can enable short names to be displayed too if required by ticking the checkbox in ''Settings > Site administration > Appearance > Courses''.

=== Course category===

The site administrator may have created course categories to help teachers and students find their courses easily. Course categories may be reflected in the [[Navigation block]].

The capability [[Capabilities/moodle/course:changecategory|moodle/course:changecategory]] controls whether a user can edit the course category.
===Course start date===
This setting affects the display of logs and the weekly format topic dates.

If you use the "Weekly" course format, the start date will appear in the first section of the course. For example selecting 27 July, will display "27 July - 2 August" in the first section (when default display is selected for that section).

This setting will have an effect on the display of logs. This will be the earliest possible date the log activity will display.

This setting will '''not''' affect courses using the 'social' or 'topics' formats.

:''TIP:'' If your institution runs on a weekly schedule, you may want to consider setting the start date for courses on the first day of the week, like a Monday.

:''TIP:'' In general, if your course does not have a real starting date then set the date to yesterday and use the availability setting to reveal the course to students.

:''TIP:'' See self enrolment course settings to prevent students from entering the course before a certain date/time.

===Visible===
Here you can "hide" your course completely. It will not appear on any course listings, except for managers, course creators, teachers and any other users with the [[Capabilities/moodle/course:viewhiddencourses|view hidden courses capability]]. Even if students try to access the course URL directly, they will not be allowed to enter.

=== Course ID number===
The ID number is an alphanumeric field. It has several potential uses. Generally, it is not displayed to students. However, it can be used to match this course against an external system's ID, as your course catalogue ID or can be used in the certificate module as a printed field.

The capability [[Capabilities/moodle/course:changeidnumber|moodle/course:changeidnumber]] controls whether a user can edit the ID number.

==Description==
{|
|[[File:descriptioncourse25.png|thumb|Description settings expanded by default]]
|}

===Course summary===

The summary appears on the course listings page. This field is searched when searching for a course and also appears in the Course/Site description block.

The capability [[Capabilities/moodle/course:changesummary|moodle/course:changesummary]] controls whether a user can edit the course summary.

===Course summary files===
{{New features}}
An image (and if allowed by the administrator, other file types) may be attached to the course summary. They will be accessible by anyone from outside of the course just like the course name and/or summary. Only users with permission moodle/course:changesummary are able to upload/change course summary files.
''Note that if this is not allowed by the administrator, then no box will appear to upload course summary files''.

==Course format==
(These settings are collapsed by default.)
{|
|[[File:coursefomat25.png|thumb|Course format settings expanded]]
|}

===Format===
See [[Course formats]]
===Number of sections===

This setting is only used by the 'weekly' and 'topics' course formats. In the 'weekly' format, it specifies the number of weeks that the course will run for, starting from the course starting date. In the 'topics' format, it specifies the number of topics in the course. Both of these translate to the number of "boxes" down the middle of the course page.

If the number of weeks/topics is changed for an existing course so that the number is less than the number of course sections containing activities (for example the course contains activities in 3 sections and the number or weeks/topics is set to 2) then when editing is turned on section(s) at the bottom of the course page will be shown with the title 'Orphaned activities'.

The number of weeks/topics may be set to 0, so that only the top general section is displayed on the course page and there are no numbered sections.

By default, the maximum number of weeks/topics is 52, but an administrator can set a different maximum number which will apply to all courses on the site (see below).
===Hidden sections===

This option allows you to decide how the hidden sections in your course are displayed to students. By default, a small area is shown (in collapsed form, usually grey) to indicate where the hidden section is, though they still cannot actually see the hidden activities and texts. This is particularly useful in the Weekly format, so that non-class weeks are clear, or if you have quizzes you don't want your students to see.

:''TIP:'' If you choose, these non-available items can be completely hidden, so that students do not even know that sections or an activity in the course are hidden.

===Course layout===

The Course layout setting determines whether the whole course is displayed on one page or split over several pages. The setting currently applies to the topics and weekly core course formats and contributed collapsed topics course format only.

Teachers choose from the dropdown whether they wish to "show all sections on one page" in the familiar scrolling format, or "show one section per page".

If one section per page is selected, the course page is abbreviated to a list of links to individual sections. If an individual section is shown, next and previous sections may be accessed via links above and below the section.

{|
| [[File:one section per page course format.png|thumb|Course page for course using one section per page course layout]]
| [[File:Single_section_page.png|thumb|Individual section of a course using one section per page course layout]]
|}

Visit the School demo site course [http://school.demo.moodle.net/course/view.php?id=96 The Types of Sport] to see the "Show one section per page" course layout in action!

For further details plus screenshots, see blog post [http://www.somerandomthoughts.com/blog/2012/05/08/moodle-2-3-section-per-page/ Moodle 2.3 – Section per page] by Gavin Henrick.

==Appearance==
(These settings are collapsed by default.)

{|
|[[File:appearancecourse252.png|thumb|Appearance settings expanded]]
|}

===Force theme===
If the site administrator has allowed the teacher to set a course [[Themes|theme]], this pull down menu will appear with a list of themes on the site. Teachers can use this to choose a different look for the course from the rest of the Moodle site.

=== Force language===
If you force a language in a course, the interface of Moodle in this course will be in this particular language, even if a student has selected a different preferred language in his/her personal profile.
===News items to show===
How many news items should show the [[Latest news block]]. Set it to 0 and Latest news block will not appear.

The Latest News block relies on the use of the associated News Forum. News posted in other forums do not display in the latest News block

===Show gradebook to students===
Here you can decide whether to allow students to see the link to [[Grades|grades]] in the Administration block. If your course doesn't use graded activities, it makes sense to disable this. If grades are used and this link is disabled, students can still see their grade from the actual activity itself, such as an [[Assignment|assignment]]

===Show activity reports===

Here you can decide whether to show students their [[Activity_report#Individual_Activity_Report|activity reports]]. Doing so places a load on the server however, which is why the setting is disabled by default.

==Files and uploads==
(These settings are collapsed by default.)
===Maximum upload size===
Here you can decide the largest size of file that students can upload to a course. The site administrator can determine [[Site_policies#Maximum_uploaded_file_sizefile |sizes available]] for the teacher to select.

Editing teachers or other users may be allowed to upload files larger than the maximum size by giving them the capability [[Capabilities/moodle/course:ignorefilesizelimits|moodle/course:ignorefilesizelimits]]

==Completion tracking==
(These settings are collapsed by default.)

Completion tracking must be enabled for [[Activity completion]]. [[Course completion]] criteria may also be based upon Activity completion values found in the activity's settings.

==Guest access==
(These settings are collapsed by default.)
{|
|[[File:guestaccess25.png|thumb|Guest access settings expanded]]
|}
Here you can decide whether to allow logged in users to access the course as a guest, and whether or not they need to enter a password. See [[Guest role|Guest role]] for more information.

==Groups==
(These settings are collapsed by default.)
{|
|[[File:coursegroups25.png|thumb|Groups settings expanded]]
|}
===Group mode===
Here you can define the [[Groups|group mode]] at the course level by a pull down menu. "[[Groups#No_groups|No groups]]", "[[Groups#Separate_groups|Separate groups]]" and "[[Groups#Visible_groups|Visible groups]]" are the choices. The selected setting will be the default group mode for all activities defined within that course. The group setting can affect what users see in the [[Participants]] list and who they can interact with in activities.

===Force===
If the group mode is "forced" at a course-level, then this particular group mode will be applied to every activity in that course. This will override any activities that may have a special group setting.

===Default grouping===

If [[Groupings|groupings]] are enabled, a default grouping for course activities and resources may be set.

==Role renaming==
(These settings are collapsed by default.)
{|
|[[File:rolerenaming.png|thumb|Role renaming settings expanded]]
|}
You can rename the [[Roles|roles]] used in your course. For example, you may wish to rename the [[Teacher role]] as "Facilitator", "Tutor" or "Guide". These new role names will appear within the course. For example on the [[Participants|participants]] and the override permissions pages.

Please note that the site administrator or a [[Manager |course manager]] may have changed the names or added new roles. These names will appear and the teacher may rename them.

== Site administration settings==

An administrator can set course default settings in ''Administration > Site administration > Courses > Course default settings''.

The maximum number of weeks/topics may be set for all courses on the site. The default value is 52.

==Preventing teachers from editing course settings==

Any/all of the following fields - course full name, short name, ID number and category, summary - may be locked to prevent teachers from editing them. To do so:

#Access ''Site Administration > Users > Permissions > Define roles''.
#Click the edit icon opposite the teacher role.
#Change any/all of the capabilities [[Capabilities/moodle/course:changefullname|moodle/course:changefullname]], [[Capabilities/moodle/course:changeshortname|moodle/course:changeshortname]], [[Capabilities/moodle/course:changeidnumber|moodle/course:changeidnumber]], [[Capabilities/moodle/course:changecategory|moodle/course:changecategory]], [[Capabilities/moodle/course:changesummary|moodle/course:changesummary]] from allow to not set.
#Click the "Save changes" button at the bottom of the page.

==See also==

[[de:Kurseinstellungen]]
[[es:Administración del curso]]
[[eu:Ikastaroaren_ezarpenak]]
[[fr:Paramètres du cours]]
[[ja:コース設定]]
[[ru:course/edit]]

Collapsed Topics course format

2013-05-21T12:47:46Z

Gb2048: /* See also */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Overview ==

For an overview please see this video:

<mediaplayer>https://www.youtube.com/watch?v=c9NaEAPPC5E</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

All of the settings can be changed through the course settings page as demonstrated on the overview video above.

=== Structure descriptions ===

* '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.

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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], [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3], [https://docs.moodle.org/en/Moodle_2.4_release_notes Moodle 2.4] & [https://docs.moodle.org/en/Moodle_2.5_release_notes Moodle 2.5] compatible?

: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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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, 2.3 , 2.4 and 2.5. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]

[[Category:Contributed code]]
[[Category:Course format]]

Collapsed Weeks course format

2013-05-21T12:47:05Z

Gb2048: Replaced content with "The '''Collapsed Weeks''' course format is a contributed code module for Moodle 1.9, 2.0, 2.1 and 2.2. It's functionality has now been placed in [[Collapsed_Topics_course_fo..."

The '''Collapsed Weeks''' course format is a contributed code module for Moodle 1.9, 2.0, 2.1 and 2.2. It's functionality has now been placed in [[Collapsed_Topics_course_format|Collapsed Topics]].

Course formats

2013-05-18T15:29:04Z

Gb2048: /* Collapsed Topics and its sister format, Collapsed Weeks */

{{Courses}}
A course format refers to the layout of a course. The course format can be selected in ''Administration > Course administration > Edit settings''.

An administrator can enable, disable or delete course formats for courses in ''Administration > Site administration > Plugins > Course formats > Manage course formats.'' They can also change the order in which available course formats are displayed to teachers in the course settings.

{|
|[[File:managecourseformats.png|thumb|Manage course formats screen for admins]]
|}

==Standard course formats==

===Weekly format===
[[Image:Weeklyoutline.png|thumb|Weekly format example]] The course is organized week by week, with a clear start date and a finish date. Moodle will create a section for each week of your course. You can add content, forums, quizzes, and so on in the section for each week.

:''TIP:'' If you want all your students to work on the same materials at the same time, this would be a good format to choose.

:''NOTE:'' Make sure your course start date is correct. If it is not your weeks will have the wrong date on it. This is especially important if you are restoring a course to use with a new section of students.

===Topics format===
[[Image:Topicoutline.png|thumb|Topic format example]]The course is organised into topic sections that a teacher can give titles to. Each topic section consists of activities, resources and labels.

TIP: This is great to use if your course is objective based and each objective may take different amounts of time to complete. An example of this would be scaffolding where the students are building upon the knowledge from earlier topics.

===="Show only one section"====

With the Weekly, Topics and any contributed format that implements the functionalty, it is possible via ''Administration > Course administration > Edit settings'' to "show one section per page". Here is a course with eight topics, with the third one currently shown. The links left and right lead to topics two and four:

[[Image:Single_section_page.png|frame|center|Single section page]]

''Notes:''
*The course home page shows just the section names and any text in the section description along with activity and resource numbers, with the names being click-able.
*If editing is ON, then the Main course page will display all the content in all the sections.
{{New features}}*There is a 'Jump to...' menu at the bottom of each single section page (new in 2.5).

===Social format===
[[Image:Socialformat.png|thumb|Social format example]] This format is oriented around one main [[Forum module|forum]], the social forum, which appears listed on the main page. It is useful for situations that are more free form. They may not even be courses. The [http://moodle.org/course/view.php?id=55 Moodle Lounge] is an example of a social format course.

The social forum can be edited by clicking the 'Update this forum' button on the social forum page. The forum introduction is displayed at the top of the course page.

===SCORM format===
The SCORM format only has 1 section, and allows teacher to insert a pre-built SCORM package. Moodle can use SCORM packages as a content type (see [[SCORM module]]), or as a course format.

An example of SCORM format is [http://school.demo.moodle.net/course/view.php?id=112 the New Staff Induction course on the School demo site]

Note: If you have a large SCORM object you want to use as an entire course, then you can select this course format and students will only be able to interact with the SCORM object, not the rest of the Moodle tools.

==Contributed Course Formats==
The Moodle community has developed a number of course formats, available in the [https://moodle.org/plugins/browse.php?list=category&id=19 plugins directory]. If you plan to create a new one, see [https://docs.moodle.org/dev/Course_formats Developers documentation].

See MDL-27646 and MDL-28555 and maybe the discussion http://moodle.org/mod/forum/discuss.php?d=175758#p770737

===Collapsed Topics===

This is a format that is essentially the same as the standard Topic and Weekly formats but with a 'toggle' for each section except '0'. The toggles' purpose is to reduce the amount of initial information presented to the user thus reducing the 'scroll of death' that can plague courses with a lot of content. The 'state' of the toggles is remembered on a per course per user basis. For more information, please visit [[Collapsed_Topics_course_format]].

==== Overview ====

For an overview of 'Collapsed Topics' please see this video:

<mediaplayer>https://www.youtube.com/watch?v=c9NaEAPPC5E</mediaplayer>

===Daily format===
The [https://moodle.org/plugins/view.php?plugin=format_days daily format] is a modification of the weekly format that shows sections by day rather than by week.

===Grid format===
The [https://moodle.org/plugins/view.php?plugin=format_grid grid format] is a modular and visual course format. Hides all topics and creates a grid of icons (one for each topic) with short titles. Clicking on an icon brings up the content from the corresponding topic in a "lightbox" style display.

===Menutopic format===
The [https://moodle.org/plugins/view.php?plugin=format_menutopic menutopic format] allows you to display the topics/sections in a menu.

===Noticeboard format===
The [https://moodle.org/plugins/view.php?plugin=format_noticebd Noticeboard format] presents the latest post in the news forum at the top of the course.

===Onetopic format===
The [https://moodle.org/plugins/view.php?plugin=format_onetopic onetopic format] shows each topic in a tab, keeping the current tab between calls to resources, in such a way that when it returns from a module as the blog or the glossary it returns to tab from where you started. This format is based on the Moodle standard format: “Topics”.

===Topic format (colors)===
The [https://moodle.org/plugins/view.php?plugin=format_colours colored topic format] is based on the 'Topics' standard format and allows a teacher to specify the foreground and background colours for each course section.

===Flexible sections format===
The [https://moodle.org/plugins/view.php?plugin=format_flexsections flexible sections format] for Moodle 2.4+ allows to have nested sections and each section may be displayed expanded (with all content on the parent section page) or collapsed (as a link to a separate page)

===Single activity format===
The [https://moodle.org/plugins/view.php?plugin=format_singleactivity single activity format] for Moodle 2.4+ does not have a course main page and immediately redirects to the activity. It is similar to SCORM format except that it can have any activity type.

Other contributed course formats are available from the [http://moodle.org/plugins modules and plugins database].

==See also==

*Using Moodle [http://moodle.org/mod/forum/view.php?id=47 Course formats forum]
*[http://www.moodleman.net/archives/47 Getting the most out of course design] blog post describing various contributed course formats

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=116428 Social format: where to put an introduction]
*[http://moodle.org/mod/forum/discuss.php?d=136453 RSS Feed for forum in a Social Format course]

[[de:Kursformate]]
[[es:FormatoCurso]]
[[fr:Formats de cours]]

Course formats

2013-05-18T15:27:45Z

Gb2048: /* Demonstration */

{{Courses}}
A course format refers to the layout of a course. The course format can be selected in ''Administration > Course administration > Edit settings''.

An administrator can enable, disable or delete course formats for courses in ''Administration > Site administration > Plugins > Course formats > Manage course formats.'' They can also change the order in which available course formats are displayed to teachers in the course settings.

{|
|[[File:managecourseformats.png|thumb|Manage course formats screen for admins]]
|}

==Standard course formats==

===Weekly format===
[[Image:Weeklyoutline.png|thumb|Weekly format example]] The course is organized week by week, with a clear start date and a finish date. Moodle will create a section for each week of your course. You can add content, forums, quizzes, and so on in the section for each week.

:''TIP:'' If you want all your students to work on the same materials at the same time, this would be a good format to choose.

:''NOTE:'' Make sure your course start date is correct. If it is not your weeks will have the wrong date on it. This is especially important if you are restoring a course to use with a new section of students.

===Topics format===
[[Image:Topicoutline.png|thumb|Topic format example]]The course is organised into topic sections that a teacher can give titles to. Each topic section consists of activities, resources and labels.

TIP: This is great to use if your course is objective based and each objective may take different amounts of time to complete. An example of this would be scaffolding where the students are building upon the knowledge from earlier topics.

===="Show only one section"====

With the Weekly, Topics and any contributed format that implements the functionalty, it is possible via ''Administration > Course administration > Edit settings'' to "show one section per page". Here is a course with eight topics, with the third one currently shown. The links left and right lead to topics two and four:

[[Image:Single_section_page.png|frame|center|Single section page]]

''Notes:''
*The course home page shows just the section names and any text in the section description along with activity and resource numbers, with the names being click-able.
*If editing is ON, then the Main course page will display all the content in all the sections.
{{New features}}*There is a 'Jump to...' menu at the bottom of each single section page (new in 2.5).

===Social format===
[[Image:Socialformat.png|thumb|Social format example]] This format is oriented around one main [[Forum module|forum]], the social forum, which appears listed on the main page. It is useful for situations that are more free form. They may not even be courses. The [http://moodle.org/course/view.php?id=55 Moodle Lounge] is an example of a social format course.

The social forum can be edited by clicking the 'Update this forum' button on the social forum page. The forum introduction is displayed at the top of the course page.

===SCORM format===
The SCORM format only has 1 section, and allows teacher to insert a pre-built SCORM package. Moodle can use SCORM packages as a content type (see [[SCORM module]]), or as a course format.

An example of SCORM format is [http://school.demo.moodle.net/course/view.php?id=112 the New Staff Induction course on the School demo site]

Note: If you have a large SCORM object you want to use as an entire course, then you can select this course format and students will only be able to interact with the SCORM object, not the rest of the Moodle tools.

==Contributed Course Formats==
The Moodle community has developed a number of course formats, available in the [https://moodle.org/plugins/browse.php?list=category&id=19 plugins directory]. If you plan to create a new one, see [https://docs.moodle.org/dev/Course_formats Developers documentation].

See MDL-27646 and MDL-28555 and maybe the discussion http://moodle.org/mod/forum/discuss.php?d=175758#p770737

===Collapsed Topics and its sister format, Collapsed Weeks===

These are formats that are essentially the same as the standard Topic and Weekly formats but with a 'toggle' for each section except '0'. The toggles' purpose is to reduce the amount of initial information presented to the user thus reducing the 'scroll of death' that can plague courses with a lot of content. The 'state' of the toggles is remembered on a per course per user basis. Collapsed Weeks automatically opens the current week. For more information, please visit [[Collapsed_Topics_course_format]] and [[Collapsed_Weeks_course_format]].

==== Overview ====

For an overview of 'Collapsed Topics' please see this video:

<mediaplayer>https://www.youtube.com/watch?v=c9NaEAPPC5E</mediaplayer>

===Daily format===
The [https://moodle.org/plugins/view.php?plugin=format_days daily format] is a modification of the weekly format that shows sections by day rather than by week.

===Grid format===
The [https://moodle.org/plugins/view.php?plugin=format_grid grid format] is a modular and visual course format. Hides all topics and creates a grid of icons (one for each topic) with short titles. Clicking on an icon brings up the content from the corresponding topic in a "lightbox" style display.

===Menutopic format===
The [https://moodle.org/plugins/view.php?plugin=format_menutopic menutopic format] allows you to display the topics/sections in a menu.

===Noticeboard format===
The [https://moodle.org/plugins/view.php?plugin=format_noticebd Noticeboard format] presents the latest post in the news forum at the top of the course.

===Onetopic format===
The [https://moodle.org/plugins/view.php?plugin=format_onetopic onetopic format] shows each topic in a tab, keeping the current tab between calls to resources, in such a way that when it returns from a module as the blog or the glossary it returns to tab from where you started. This format is based on the Moodle standard format: “Topics”.

===Topic format (colors)===
The [https://moodle.org/plugins/view.php?plugin=format_colours colored topic format] is based on the 'Topics' standard format and allows a teacher to specify the foreground and background colours for each course section.

===Flexible sections format===
The [https://moodle.org/plugins/view.php?plugin=format_flexsections flexible sections format] for Moodle 2.4+ allows to have nested sections and each section may be displayed expanded (with all content on the parent section page) or collapsed (as a link to a separate page)

===Single activity format===
The [https://moodle.org/plugins/view.php?plugin=format_singleactivity single activity format] for Moodle 2.4+ does not have a course main page and immediately redirects to the activity. It is similar to SCORM format except that it can have any activity type.

Other contributed course formats are available from the [http://moodle.org/plugins modules and plugins database].

==See also==

*Using Moodle [http://moodle.org/mod/forum/view.php?id=47 Course formats forum]
*[http://www.moodleman.net/archives/47 Getting the most out of course design] blog post describing various contributed course formats

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=116428 Social format: where to put an introduction]
*[http://moodle.org/mod/forum/discuss.php?d=136453 RSS Feed for forum in a Social Format course]

[[de:Kursformate]]
[[es:FormatoCurso]]
[[fr:Formats de cours]]

Collapsed Topics course format

2013-05-18T15:25:33Z

Gb2048: /* See also */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Overview ==

For an overview please see this video:

<mediaplayer>https://www.youtube.com/watch?v=c9NaEAPPC5E</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

All of the settings can be changed through the course settings page as demonstrated on the overview video above.

=== Structure descriptions ===

* '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.

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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], [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3], [https://docs.moodle.org/en/Moodle_2.4_release_notes Moodle 2.4] & [https://docs.moodle.org/en/Moodle_2.5_release_notes Moodle 2.5] compatible?

: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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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, 2.3 , 2.4 and 2.5. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Collapsed Topics course format

2013-05-18T15:23:44Z

Gb2048:

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Overview ==

For an overview please see this video:

<mediaplayer>https://www.youtube.com/watch?v=c9NaEAPPC5E</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

All of the settings can be changed through the course settings page as demonstrated on the overview video above.

=== Structure descriptions ===

* '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.

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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], [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3], [https://docs.moodle.org/en/Moodle_2.4_release_notes Moodle 2.4] & [https://docs.moodle.org/en/Moodle_2.5_release_notes Moodle 2.5] compatible?

: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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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, 2.3 and 2.4. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Collapsed Topics course format

2013-05-18T15:20:44Z

Gb2048: /* Structure descriptions */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Overview ==

For an overview please see this video:

<mediaplayer>https://www.youtube.com/watch?v=c9NaEAPPC5E</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

All of the settings can be changed through the course settings page as demonstrated on the overview video above.

=== Structure descriptions ===

* '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.

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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], [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3] & [https://docs.moodle.org/en/Moodle_2.4_release_notes Moodle 2.4] compatible?

: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.

Q. Will there be a Moodle 2.5 version?

:A. Yes. Shortly after the release of Moodle 2.5.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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, 2.3 and 2.4. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Collapsed Topics course format

2013-05-18T15:20:14Z

Gb2048: /* Overview = */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Overview ==

For an overview please see this video:

<mediaplayer>https://www.youtube.com/watch?v=c9NaEAPPC5E</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

All of the settings can be changed through the course settings page as demonstrated on the overview video above.

=== Structure descriptions ===

* '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.

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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], [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3] & [https://docs.moodle.org/en/Moodle_2.4_release_notes Moodle 2.4] compatible?

: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.

Q. Will there be a Moodle 2.5 version?

:A. Yes. Shortly after the release of Moodle 2.5.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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, 2.3 and 2.4. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Collapsed Topics course format

2013-05-18T15:19:49Z

Gb2048:

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Overview ===

For an overview please see this video:

<mediaplayer>https://www.youtube.com/watch?v=c9NaEAPPC5E</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

All of the settings can be changed through the course settings page as demonstrated on the overview video above.

=== Structure descriptions ===

* '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.

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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], [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3] & [https://docs.moodle.org/en/Moodle_2.4_release_notes Moodle 2.4] compatible?

: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.

Q. Will there be a Moodle 2.5 version?

:A. Yes. Shortly after the release of Moodle 2.5.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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, 2.3 and 2.4. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Collapsed Topics course format

2013-05-18T15:14:53Z

Gb2048: /* Demonstration */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>https://www.youtube.com/watch?v=c9NaEAPPC5E</mediaplayer>

=== Structure descriptions ===

* '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.

== Settings ==

'''Collapsed Topics specific settings'''

The format's settings are accessed through the 'settings' icon that appears in editing mode:

[[Image:ct23_settings.png|center|Settings]]

which gives the form:

[[Image:ct23_settings_form.png|center|Settings 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):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''Columns'''

In the settings form you can choose between one to four columns for the layout:

[[Image:ct23_columns_settings.png|center|Per course column settings]]

which in this example gives:

[[Image:ct23_columns.png|center|Per course columns]]

'''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 ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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], [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3] & [https://docs.moodle.org/en/Moodle_2.4_release_notes Moodle 2.4] compatible?

: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.

Q. Will there be a Moodle 2.5 version?

:A. Yes. Shortly after the release of Moodle 2.5.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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, 2.3 and 2.4. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Course formats

2013-04-24T17:29:18Z

Gb2048: /* "Show only one section" */

{{Courses}}
A course format refers to the layout of a course. The course format can be selected in ''Settings > Course administration > Edit settings''.

An administrator can enable, disable or delete course formats for courses in ''Settings>Site administration>Plugins>Courses>Course formats>Manage course formats.'' They can also change the order in which available course formats are displayed to teachers in the course settings.

{|
|[[File:managecourseformats.png|thumb|Manage course formats screen for admins]]
|}

==Standard course formats==

===Weekly format===
[[Image:Weeklyoutline.png|thumb|Weekly format example]] The course is organized week by week, with a clear start date and a finish date. Moodle will create a section for each week of your course. You can add content, forums, quizzes, and so on in the section for each week.

:''TIP:'' If you want all your students to work on the same materials at the same time, this would be a good format to choose.

:''NOTE:'' Make sure your course start date is correct. If it is not your weeks will have the wrong date on it. This is especially important if you are restoring a course to use with a new section of students.

===Topics format===
[[Image:Topicoutline.png|thumb|Topic format example]]The course is organised into topic sections that a teacher can give titles to. Each topic section consists of activities, resources and labels.

TIP: This is great to use if your course is objective based and each objective may take different amounts of time to complete. An example of this would be scaffolding where the students are building upon the knowledge from earlier topics.

===="Show only one section"====

With the Weekly, Topics and any contributed format that implements the functionalty, it is possible via ''Settings > Course administration > Edit settings'' to "show one section per page". Here is a course with eight topics, with the third one currently shown. The links left and right lead to topics two and four:

[[Image:Single_section_page.png|frame|center|Single section page]]

''Notes:''
#The course home page shows just the section names and any text in the section description along with activity and resource numbers, with the names being clickable.
#If editing is ON, then the Main course page will display all the content in all the sections.
#There is a 'Jump to...' menu at the bottom of each single section page.

===Social format===
[[Image:Socialformat.png|thumb|Social format example]] This format is oriented around one main [[Forum module|forum]], the social forum, which appears listed on the main page. It is useful for situations that are more free form. They may not even be courses. The [http://moodle.org/course/view.php?id=55 Moodle Lounge] is an example of a social format course.

The social forum can be edited by clicking the 'Update this forum' button on the social forum page. The forum introduction is displayed at the top of the course page.

===SCORM format===
The SCORM format only has 1 section, and allows teacher to insert a pre-built SCORM package. Moodle can use SCORM packages as a content type (see [[SCORM module]]), or as a course format.

An example of SCORM format is [http://school.demo.moodle.net/course/view.php?id=112 the New Staff Induction course on the School demo site]

Note: If you have a large SCORM object you want to use as an entire course, then you can select this course format and students will only be able to interact with the SCORM object, not the rest of the Moodle tools.

==Contributed Course Formats==
The Moodle community has developed a number of course formats, available in the [https://moodle.org/plugins/browse.php?list=category&id=19 plugins directory]. If you plan to create a new one, see [https://docs.moodle.org/dev/Course_formats Developers documentation].

See MDL-27646 and MDL-28555 and maybe the discussion http://moodle.org/mod/forum/discuss.php?d=175758#p770737

===Collapsed Topics and its sister format, Collapsed Weeks===
These are formats that are essentially the same as the standard Topic and Weekly formats but with a 'toggle' for each section except '0'. The toggles' purpose is to reduce the amount of initial information presented to the user thus reducing the 'scroll of death' that can plague courses with a lot of content. The 'state' of the toggles is remembered on a per course per user basis. Collapsed Weeks automatically opens the current week. For more information, please visit [[Collapsed_Topics_course_format]] and [[Collapsed_Weeks_course_format]].

==== Demonstration ====

For a demonstration of 'Collapsed Topics' and its latest structure enhancement please see this video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

===Daily format===
The [https://moodle.org/plugins/view.php?plugin=format_days daily format] is a modification of the weekly format that shows sections by day rather than by week.

===Grid format===
The [https://moodle.org/plugins/view.php?plugin=format_grid grid format] is a modular and visual course format. Hides all topics and creates a grid of icons (one for each topic) with short titles. Clicking on an icon brings up the content from the corresponding topic in a "lightbox" style display.

===Menutopic format===
The [https://moodle.org/plugins/view.php?plugin=format_menutopic menutopic format] allows you to display the topics/sections in a menu.

===Noticeboard format===
The [https://moodle.org/plugins/view.php?plugin=format_noticebd Noticeboard format] presents the latest post in the news forum at the top of the course.

===Onetopic format===
The [https://moodle.org/plugins/view.php?plugin=format_onetopic onetopic format] shows each topic in a tab, keeping the current tab between calls to resources, in such a way that when it returns from a module as the blog or the glossary it returns to tab from where you started. This format is based on the Moodle standard format: “Topics”.

===Topic format (colors)===
The [https://moodle.org/plugins/view.php?plugin=format_colours colored topic format] is based on the 'Topics' standard format and allows a teacher to specify the foreground and background colours for each course section.

===Flexible sections format===
The [https://moodle.org/plugins/view.php?plugin=format_flexsections flexible sections format] for Moodle 2.4+ allows to have nested sections and each section may be displayed expanded (with all content on the parent section page) or collapsed (as a link to a separate page)

===Single activity format===
The [https://moodle.org/plugins/view.php?plugin=format_singleactivity single activity format] for Moodle 2.4+ does not have a course main page and immediately redirects to the activity. It is similar to SCORM format except that it can have any activity type.

Other contributed course formats are available from the [http://moodle.org/plugins modules and plugins database].

==See also==

*Using Moodle [http://moodle.org/mod/forum/view.php?id=47 Course formats forum]
*[http://www.moodleman.net/archives/47 Getting the most out of course design] blog post describing various contributed course formats

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=116428 Social format: where to put an introduction]
*[http://moodle.org/mod/forum/discuss.php?d=136453 RSS Feed for forum in a Social Format course]

[[de:Kursformate]]
[[es:FormatoCurso]]
[[fr:Formats de cours]]

File:Single section page.png

2013-04-24T17:24:11Z

Gb2048: Single section page with 'Jump to...' menu.

Single section page with 'Jump to...' menu.

Course completion settings

2013-04-05T11:30:06Z

Gb2048: /* Site administration settings */

{{Course completion}}
In order to use the course completion features, it has to be enabled in the site administration settings before the course completion link will appear in the course administration menu. There are also settings which need to be reviewed in the course administration settings. You should also install the [[Course completion status block]] and the [[Self completion block]] to view reports and use some of the features of course completion.

==Completion tracking settings==
The following settings may be found in ''Settings > Course administration > Completion tracking'':

===Overall criteria type aggregation===
Choose here how you wish to mark the course complete -whether you want ''Any'' or ''All'' of the requirements that follow to count towards completion.

:'''All''' means just that, every condition that has been checked. The most restrictive setting.
: '''Any''' means any one of those conditions that have been specified.

===Completion dependencies===
*This setting allows you to have completion of another course as a condition for completing the course you are currently working in. This does not block the student from your current course; it simply means that the current course will not be marked complete until the first course has been marked complete. Thus, completion of the current course is dependent upon completion of an earlier course. You need to lick on the course or courses in the "Courses available box" that you wish to use in order to select them.

*If completion tracking has not been set for any other courses yet then a message will appear as in (1). If completion tracking has been set elsewhere then the display changes to (2):

{|
|[[File:completionnotset.png|thumb|No other courses have completion tracking set]]
|[[File:completiondependencies.png|thumb|Available course to be completed before the current course is marked complete]]
|}

===Manual self completion===
If you check the box in this link, then students can mark the course as complete themselves. In order to do this, the [[Self completion block]] must also be added to the course.

===Manual completion by===
This setting allows users with selected roles to mark the course as complete. If used, put a check mark next to the role that can mark the course as complete. The roles listed are ones for which the capability [[Capabilities/moodle/course:markcomplete|Mark users as complete in course completion]] is allowed.

Select the Aggregation method "All" when every role that is marked here must put a check mark in the course completion report in order for the student's course to be marked complete.

Select the Aggregation method "Any" when one or more of the roles that are marked here have put a check mark in the course completion report in order for the student's course to be marked complete.

===Activities completed===
This setting will show a list of activities which have [[Activity completion]] setting defined. Put a check next to the ones which should count towards course completion.

The "All" aggregation method means that each of the checked activities must meet their Activity completion settings.

The "Any" aggregation method means that at least one of the checked activities must meet their Activity completion settings.

===Date===
If you check the ''Enable'' box you can then set a date, after which the course will be declared complete..

===Duration after enrolment===
If you check the ''Enable'' box you can then choose a number of days after enrolment upon which the course will be marked complete.

===Grade===
If you check the ''Enable'' box you can set a passing grade for the course.

===Unenrolment===
If you check the box ''Completion on unenrolment'' then the student's course will be complete once they have unenrolled.

==Course administration settings==
''Course administration > Edit settings''

*Student Progress
**Completion tracking must be enabled
**Completion tracking begins after enrollment (best practice is to check this).

==Site administration settings==
''Site administration > Advanced features > Enable completion tracking'' (check enabled).

The above settings can be set as defaults for the site in ''Settings > Site administration > Courses > Course default settings''.
:''Tip:'' The [[Cron]] trigger default for course completion is every 10 minutes. This is not usually what the Teachers and Students expect. The length of time can be impacted by the server cron schedule and by the code found in /lib/completionlib.php under "Cache expiry time".

==Course completion capabilities==

There are two capabilities, both of which are allowed for the default roles of manager, teacher and non-editing teacher:

*[[Capabilities/report/completion:view|View course completion report]]
*[[Capabilities/moodle/course:markcomplete|Mark users as complete in course completion]]

[[Category:Site administration]]

[[eu:Ikastaro-osaketaren_jarraipenaren_ezarpenak]]

Collapsed Topics course format

2013-03-30T11:17:32Z

Gb2048: /* FAQ */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Settings ==

'''Collapsed Topics specific settings'''

The format's settings are accessed through the 'settings' icon that appears in editing mode:

[[Image:ct23_settings.png|center|Settings]]

which gives the form:

[[Image:ct23_settings_form.png|center|Settings 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):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''Columns'''

In the settings form you can choose between one to four columns for the layout:

[[Image:ct23_columns_settings.png|center|Per course column settings]]

which in this example gives:

[[Image:ct23_columns.png|center|Per course columns]]

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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], [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3] & [https://docs.moodle.org/en/Moodle_2.4_release_notes Moodle 2.4] compatible?

: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.

Q. Will there be a Moodle 2.5 version?

:A. Yes. Shortly after the release of Moodle 2.5.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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, 2.3 and 2.4. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Course formats

2012-12-22T17:27:14Z

Gb2048: /* Contributed Course Formats */

{{Courses}}
A course format refers to the layout of a course. The course format can be selected in ''Settings > Course administration > Edit settings''.

An administrator can enable. disable or delete course formats for courses in ''Settings>Site administration>Plugins>Courses>Course formats>Manage course formats.'' They can also change the order in which available course formats are displayed to teachers in the course settings.
{{New features}}

{|
|[[File:managecourseformats.png|thumb|Manage course formats screen for admins]]
|}

==Standard course formats==

===Weekly format===
[[Image:Weeklyoutline.png|thumb|Weekly format example]] The course is organized week by week, with a clear start date and a finish date. Moodle will create a section for each week of your course. You can add content, forums, quizzes, and so on in the section for each week.

:''TIP:'' If you want all your students to work on the same materials at the same time, this would be a good format to choose.

:''NOTE:'' Make sure your course start date is correct. If it is not your weeks will have the wrong date on it. This is especially important if you are restoring a course to use with a new section of students.

===Topics format===
[[Image:Topicoutline.png|thumb|Topic format example]]The course is organised into topic sections that a teacher can give titles to. Each topic section consists of activities, resources and labels.

TIP: This is great to use if your course is objective based and each objective may take different amounts of time to complete. An example of this would be scaffolding where the students are building upon the knowledge from earlier topics.

===="Show only one section"====

With the Weekly format and the Topics format it is possible via ''Settings > Course administration > Edit settings'' to "show one section per page". Here is a course with three topics, with the second one currently shown. The links left and right lead to topics 1 and 3:

[[File:showonlyonesection.png]]

''Notes:''
#The course home page shows just the section names and any text in the section description, with the names being clickable.
#If editing is ON, on the Main course page, then you will see all the content in all the sections.
#There is a link at the bottom "Return to Main course page" on each single section page.

===Social format===
[[Image:Socialformat.png|thumb|Social format example]] This format is oriented around one main [[Forum module|forum]], the social forum, which appears listed on the main page. It is useful for situations that are more free form. They may not even be courses. The [http://moodle.org/course/view.php?id=55 Moodle Lounge] is an example of a social format course.

The social forum can be edited by clicking the 'Update this forum' button on the social forum page. The forum introduction is displayed at the top of the course page.

===SCORM format===
The SCORM format only has 1 section, and allows teacher to insert a pre-built SCORM package. Moodle can use SCORM packages as a content type (see [[SCORM module]]), or as a course format.

An example of SCORM format is [http://school.demo.moodle.net/course/view.php?id=112 the New Staff Induction course on the School demo site]

Note: If you have a large SCORM object you want to use as an entire course, then you can select this course format and students will only be able to interact with the SCORM object, not the rest of the Moodle tools.

==Contributed Course Formats==
The Moodle community has developed a number of course formats, available in the [https://moodle.org/plugins/browse.php?list=category&id=19 plugins directory].

See MDL-27646 and MDL-28555 and maybe the discussion http://moodle.org/mod/forum/discuss.php?d=175758#p770737

===Collapsed Topics and its sister format, Collapsed Weeks===
These are formats that are essentially the same as the standard Topic and Weekly formats but with a 'toggle' for each section except '0'. The toggles' purpose is to reduce the amount of initial information presented to the user thus reducing the 'scroll of death' that can plague courses with a lot of content. The 'state' of the toggles is remembered on a per course per user basis. Collapsed Weeks automatically opens the current week. For more information, please visit [[Collapsed_Topics_course_format]] and [[Collapsed_Weeks_course_format]].

==== Demonstration ====

For a demonstration of 'Collapsed Topics' and its latest structure enhancement please see this video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

===Daily format===
The [https://moodle.org/plugins/view.php?plugin=format_days daily format] is a modification of the weekly format that shows sections by day rather than by week.

===Grid format===
The [https://moodle.org/plugins/view.php?plugin=format_grid grid format] is a modular and visual course format. Hides all topics and creates a grid of icons (one for each topic) with short titles. Clicking on an icon brings up the content from the corresponding topic in a "lightbox" style display.

===Menutopic format===
The [https://moodle.org/plugins/view.php?plugin=format_menutopic menutopic format] allows you to display the topics/sections in a menu.

===Noticeboard format===
The [https://moodle.org/plugins/view.php?plugin=format_noticebd Noticeboard format] presents the latest post in the news forum at the top of the course.

===Onetopic format===
The [https://moodle.org/plugins/view.php?plugin=format_onetopic onetopic format] shows each topic in a tab, keeping the current tab between calls to resources, in such a way that when it returns from a module as the blog or the glossary it returns to tab from where you started. This format is based on the Moodle standard format: “Topics”.

===Topic format (colors)===
The [https://moodle.org/plugins/view.php?plugin=format_colours colored topic format] is based on the 'Topics' standard format and allows a teacher to specify the foreground and background colours for each course section.

Other contributed course formats are available from the modules and plugins database.

==See also==

*Using Moodle [http://moodle.org/mod/forum/view.php?id=47 Course formats forum]
*[http://www.moodleman.net/archives/47 Getting the most out of course design] blog post describing various contributed course formats

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=116428 Social format: where to put an introduction]
*[http://moodle.org/mod/forum/discuss.php?d=136453 RSS Feed for forum in a Social Format course]

[[de:Kursformate]]
[[es:FormatoCurso]]
[[fr:Formats de cours]]

Collapsed Topics course format

2012-12-22T17:21:03Z

Gb2048: /* FAQ */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Settings ==

'''Collapsed Topics specific settings'''

The format's settings are accessed through the 'settings' icon that appears in editing mode:

[[Image:ct23_settings.png|center|Settings]]

which gives the form:

[[Image:ct23_settings_form.png|center|Settings 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):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''Columns'''

In the settings form you can choose between one to four columns for the layout:

[[Image:ct23_columns_settings.png|center|Per course column settings]]

which in this example gives:

[[Image:ct23_columns.png|center|Per course columns]]

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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], [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3] & [https://docs.moodle.org/en/Moodle_2.4_release_notes Moodle 2.4] compatible?

: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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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, 2.3 and 2.4. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Collapsed Topics course format

2012-12-22T17:20:22Z

Gb2048: /* See also */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Settings ==

'''Collapsed Topics specific settings'''

The format's settings are accessed through the 'settings' icon that appears in editing mode:

[[Image:ct23_settings.png|center|Settings]]

which gives the form:

[[Image:ct23_settings_form.png|center|Settings 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):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''Columns'''

In the settings form you can choose between one to four columns for the layout:

[[Image:ct23_columns_settings.png|center|Per course column settings]]

which in this example gives:

[[Image:ct23_columns.png|center|Per course columns]]

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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] & [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3] compatible?

: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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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, 2.3 and 2.4. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

User:Gareth Barnard

2012-12-22T17:06:41Z

Gb2048: Created page with "I'm the creator, developer and maintainer of the 'Collapsed Topics course format' course format. I have also updated the 'Grid' and 'Noticeboard' formats to 2.3 and 2.4. Mo..."

I'm the creator, developer and maintainer of the '[[Collapsed Topics course format]]' course format. I have also updated the 'Grid' and 'Noticeboard' formats to 2.3 and 2.4.

More information on '[http://about.me/gjbarnard]about.me/gjbarnard'.

Collapsed Topics course format

2012-09-04T19:27:16Z

Gb2048: /* Fine tuning the look */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Settings ==

'''Collapsed Topics specific settings'''

The format's settings are accessed through the 'settings' icon that appears in editing mode:

[[Image:ct23_settings.png|center|Settings]]

which gives the form:

[[Image:ct23_settings_form.png|center|Settings 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):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''Columns'''

In the settings form you can choose between one to four columns for the layout:

[[Image:ct23_columns_settings.png|center|Per course column settings]]

which in this example gives:

[[Image:ct23_columns.png|center|Per course columns]]

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

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:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

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:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

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

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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] & [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3] compatible?

: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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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 [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

File:ct23 tarrow.png

2012-09-04T19:25:04Z

Gb2048: Collapsed Topics open / close all sections arrow CSS for Moodle 2.3.1

Collapsed Topics open / close all sections arrow CSS for Moodle 2.3.1

File:ct23 arrow.png

2012-09-04T19:22:07Z

Gb2048: Collapsed Topics CSS toggle arrows for Moodle 2.3.1

Collapsed Topics CSS toggle arrows for Moodle 2.3.1

Collapsed Topics course format

2012-09-03T12:59:10Z

Gb2048: /* See also */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Settings ==

'''Collapsed Topics specific settings'''

The format's settings are accessed through the 'settings' icon that appears in editing mode:

[[Image:ct23_settings.png|center|Settings]]

which gives the form:

[[Image:ct23_settings_form.png|center|Settings 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):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''Columns'''

In the settings form you can choose between one to four columns for the layout:

[[Image:ct23_columns_settings.png|center|Per course column settings]]

which in this example gives:

[[Image:ct23_columns.png|center|Per course columns]]

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''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 Topics?

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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] & [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3] compatible?

: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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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 [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Collapsed Topics course format

2012-09-03T12:58:42Z

Gb2048: /* FAQ */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Settings ==

'''Collapsed Topics specific settings'''

The format's settings are accessed through the 'settings' icon that appears in editing mode:

[[Image:ct23_settings.png|center|Settings]]

which gives the form:

[[Image:ct23_settings_form.png|center|Settings 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):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''Columns'''

In the settings form you can choose between one to four columns for the layout:

[[Image:ct23_columns_settings.png|center|Per course column settings]]

which in this example gives:

[[Image:ct23_columns.png|center|Per course columns]]

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''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 Topics?

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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] & [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3] compatible?

: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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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 and 2.2. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Collapsed Topics course format

2012-09-03T12:57:43Z

Gb2048: /* Settings */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Settings ==

'''Collapsed Topics specific settings'''

The format's settings are accessed through the 'settings' icon that appears in editing mode:

[[Image:ct23_settings.png|center|Settings]]

which gives the form:

[[Image:ct23_settings_form.png|center|Settings 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):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''Columns'''

In the settings form you can choose between one to four columns for the layout:

[[Image:ct23_columns_settings.png|center|Per course column settings]]

which in this example gives:

[[Image:ct23_columns.png|center|Per course columns]]

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''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 Topics?

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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. 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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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 and 2.2. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

Collapsed Topics course format

2012-09-03T12:55:40Z

Gb2048: /* Fine tuning the look */

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Settings ==

'''Collapsed Topics specific settings'''

The format's settings are accessed through the 'settings' icon that appears in editing mode:

[[Image:ct23_settings|center|Settings]]

which gives the form:

[[Image:ct23_settings_form|center|Settings 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):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''Columns'''

In the settings form you can choose between one to four columns for the layout:

[[Image:ct23_columns_settings.png|center|Per course column settings]]

which in this example gives:

[[Image:ct23_columns.png|center|Per course columns]]

== Fine tuning the look ==

'''Formatting'''

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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''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 Topics?

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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. 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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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 and 2.2. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

File:ct23 columns.png

2012-09-03T12:54:37Z

Gb2048: Collapsed Topics columns in Moodle 2.3

Collapsed Topics columns in Moodle 2.3

File:ct23 columns settings.png

2012-09-03T12:53:12Z

Gb2048: Collapsed Topics Moodle 2.3 column settings.

Collapsed Topics Moodle 2.3 column settings.

File:ct23 settings form.png

2012-09-03T12:49:28Z

Gb2048: Collapsed Topics Settings Form

Collapsed Topics Settings Form

File:ct23 settings.png

2012-09-03T12:47:05Z

Gb2048: Collapsed Topics Moodle 2+ settings.

Collapsed Topics Moodle 2+ settings.

Collapsed Topics course format

2012-09-03T12:38:30Z

Gb2048:

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Fine tuning the look ==

'''Formatting'''

Most of the formatting is contained within the file 'topics_collapsed.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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class in the 'styles.css' file:

[[Image:ct_23_font.png|center|Changing the css]]

'''Per Course Colours'''

You can set a different look on a per course basis by changing the format's settings (using the 'settings' icon that appears top right in editing mode):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''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 Topics?

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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. 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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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 and 2.2. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

File:ct 23 main.png

2012-09-03T12:35:28Z

Gb2048: Collapsed Topics on Moodle 2.3

Collapsed Topics on Moodle 2.3

Collapsed Topics course format

2012-09-03T12:34:24Z

Gb2048: /* Fine tuning the look */

{{Courses}}
The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:Collapsed topics image1.png|center|Collapsed Topics format example]]

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 for Moodle 1.9.14+, 2.0.5+, 2.1.2+, 2.2+ and 2.3dev+ 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Fine tuning the look ==

'''Formatting'''

Most of the formatting is contained within the file 'topics_collapsed.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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class in the 'styles.css' file:

[[Image:ct_23_font.png|center|Changing the css]]

'''Per Course Colours'''

You can set a different look on a per course basis by changing the format's settings (using the 'settings' icon that appears top right in editing mode):

[[Image:ct23_colour.png|center|Per course colours]]

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.

'''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 Topics?

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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. 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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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 and 2.2. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

File:ct23 colour.png

2012-09-03T12:28:08Z

Gb2048: Collapsed Topics Moodle 2.3 colour.

Collapsed Topics Moodle 2.3 colour.

Collapsed Topics course format

2012-09-03T12:26:56Z

Gb2048: /* Fine tuning the look */

{{Courses}}
The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |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.

[[Image:Collapsed topics image1.png|center|Collapsed Topics format example]]

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

<mediaplayer>http://www.youtube.com/watch?v=ydFdES-pKYc</mediaplayer>

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''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]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''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 ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 for Moodle 1.9.14+, 2.0.5+, 2.1.2+, 2.2+ and 2.3dev+ 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.

=== Demonstration ===

For a demonstration of this enhancement, please see the 'Collapsed Topics course format new structure' video:

<mediaplayer>http://www.youtube.com/watch?v=gvo-OseVKr8</mediaplayer>

=== Structure descriptions ===

* '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.

== Fine tuning the look ==

'''Formatting'''

Most of the formatting is contained within the file 'topics_collapsed.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...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class in the 'styles.css' file:

[[Image:ct_23_font.png|center|Changing the css]]

'''Per Theme Changes'''

You can set a different look globally or on a per theme basis by changing the following css in 'collapsed_topics.css'. Non-standard colours used to illustrate the point.

[[Image:Collapsed_topics_image5.png|center|Per theme css]]

If you want a per theme look for when you allow your users to choose their own theme, move the css shown and place in your theme's css files and change as desired.

'''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 Topics?

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [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. 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.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll 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 and 2.2. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/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]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]
*[[Collapsed Weeks course format]] is a similar contributed code module.

[[Category:Contributed code]]
[[Category:Course format]]

File:ct 23 font.png

2012-09-03T12:25:23Z

Gb2048: Collapsed Topics fonts on Moodle 2.3.

Collapsed Topics fonts on Moodle 2.3.