MoodleDocs - User contributions [en]

admin/setting/blocksettingmrbs

2012-09-29T18:55:38Z

Francoisevans: /* MRBS Block Settings */

== MRBS Block Settings ==

(MRBS stands for Meeting Room Booking System.)

'''Window'''

When set to 'New window', the MRBS block will open in a new window. When set to 'Same window', the MRBS block will open inside Moodle, with the Moodle headers.

----

'''MRBS Installation Path'''

Place on your Moodle's server where the MRBS block is installed. This is usually at:

http://www.yourwebsitename.suffix/moodle/blocks/mrbs/web

----

'''MRBS Admin'''

Name of the MRBS administrator

----

'''MRBS admin email'''
Email address of the MRBS administrator. In order to receive MRBS email notifications, the email address must be associated with a Moodle user account.

----

'''Use Periods'''

If set to 'No', MRBS will present a standard time resolution for room bookings. If set to 'Yes', then MRBS will refer to the 'Custom periods' you define below...

Setting 'Use periods' to 'Yes', will make an empty 'Custom Periods' text box appear, for you to fill in (see below).

Warning: If you set MRBS to Use custom periods and then define and save these, and later decide that you do not wish to use Custom periods after all and set 'Use periods' top 'No', then this may cause errors in the proper functioning of MRBS. If this happens, re-set 'Use periods' to 'Yes' and ensure the desired period resolution is typed into the 'Custom Periods' box (see below).

----

'''Custom Periods'''

Typing times into this box in an appropriate format, will present the user with those times to be able to book rooms to. For example, if you want users to be able to book a room at 3.15pm or 3.45pm, then you will need to define presented (Custom) periods to resolve to a ''quarter'' hour. If you wanted users to be able to book rooms only every ''half'' hour, then you would need to define custom periods in that way.

The required format for lists of times in the Custom periods box can be in am/pm format or 24-hour format. For am/pm, the following will work:

9.00am

9.30am

10.00am

10.30am

...etc.

Notice that there has to be a carriage return between each individual given time, with no spaces in between.

To save ''you'' time, you may wish to copy and paste from the lists below, extending or curtailing these earlier or later as required before pasting them in to your 'Custom Periods' box:

Half-hourly custom periods to paste into Custom periods box:

8.00am

8.30am

9.00am

9.30am

10.00am

10.30am

11.00am

11.30am

12.00pm

12.30pm

1.00pm

1.30pm

2.00pm

2.30pm

3.00pm

3.30pm

4.00pm

4.30pm

5.00pm

5.30pm

6.00pm

6.30pm

7.00pm

7.30pm

8.00pm

8.30pm

9.00pm

Quarter-hourly custom periods to paste into Custom periods box:

8.00am

8.15am

8.30am

8.45am

9.00am

9.15am

9.30am

9.45am

10.00am

10.15am

10.30am

10.45am

11.00am

11.15am

11.30am

11.45am

12.00pm

12.15pm

12.30pm

12.45pm

1.00pm

1.15pm

1.30pm

1.45pm

2.00pm

2.15pm

2.30pm

2.45pm

3.00pm

3.15pm

3.30pm

3.45pm

4.00pm

4.15pm

4.30pm

4.45pm

5.00pm

5.15pm

5.30pm

5.45pm

6.00pm

6.15pm

6.30pm

6.45pm

7.00pm

7.15pm

7.30pm

7.45pm

8.00pm

8.15pm

8.30pm

8.45pm

9.00pm

Alternatively, you might want to have rooms bookable to a resolution of 5-minute intervals etc.

----

'''Start of Week'''

Day you want your week to start, e.g. 'Monday'.

----

'''Length of week'''

The week can be curtailed, for example to exclude weekends. Do do this, set 'Start of week' (see above) to 'Monday' and 'Length of week' to '5'.

----

'''Date format'''

Choose how you want your dates to be displayed from the drop-down menu.

----

'''Time format'''

Choose how you want your times to be displayed from the drop-down menu.

----

'''Max. Rep Entries'''

It's possible for someone booking a room to repeat that booking (e.g. every day or every week). In this box you can set a limit on the number of repeats that someone booking a room could type in. The default is 365, which restricts a person to booking a room daily for the next year, or weekly for the next seven years (!) etc.

----

'''Maximum advance booking'''

If you want to stop users from booking rooms too many ''days'' in advance, then you can set a limit here. For example, typing in '7' would stop users from booking a room more than seven days in advance - the booking date would only become available seven days before.

To turn this feature off and allow users to book as far ahead of time as they like, type '-1' in the box.

----

'''Report span (days)'''

Default report span in days - This is the length of time in days that a report generated by MRBS covers. The default is '60' (approx. two months).

----

'''Search results per page'''

If you're searching for a booking, this limits the number of results displayed per page.

----

'''Show area list'''

In MRBS, an 'Area' is a category of room (NB not a Moodle category).

For example, if you ran a Science department comprising rooms used exclusively for Physics, Chemistry or Biology, then you could predefine three 'Areas': Physics, Chemistry and Biology. The Physics rooms (1, 2 and 3) would be named under the Physics Area, The Biology rooms (4, 5 & 6) under the Biology Area etc.

To book a room in MRBS's user interface, a user first selects an Area. In the MRBS user interface, the list of rooms ''for'' that area then becomes visible.

'Show area list' sets how you want the area list to display for users: 'List' shows a list. 'Select' will present users with a drop-down menu.

----

'''View monthly details'''

Entries in monthly view can be shown as start/end slot, brief description or both. Set to 'description' for brief description, 'slot' for time slot and 'both' for both. Default is 'both', but 6 entries per day are shown instead of 12.

----

'''View week number'''

To view weeks in the bottom as week numbers (42) instead of 'first day of the week' (13 Oct), set this to TRUE.

Display of weeks in the bottom of the MRBS user interface are handled by the '''trailer.php''' file.

----

'''Time right side'''

To display times on right side in day and week view, set to 'Yes'.

----

'''Javascript cursor'''

Change to 'false' if clients have old browsers incompatible with JavaScript.

----

'''Show plus link'''

Change to 'true' always to show the (+) link. The plus link is a small icon displaying a plus sign inside each bookable time cell.

----

'''Highlight method'''

Choose one of the highlight methods: bgcolor, class, or hybrid.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Default view'''

Define default starting view (month, week or day) - MRBS can show any of these three and they can be switched between.

----

'''Default room'''

Define default room to start with (used by index.php). Room numbers can be determined by looking at the 'Edit' or 'Delete' page URL for a room from the admin page.

----

'''Entry type A - J'''

Entry types is a way of defining purposes for room use. In this way, a user can book a room for a named class (e.g. 'Drama') and then indicate what ''kind'' of booked session that is going to be. For example:

• Lecture

• Lesson

• Seminar

• Tutorial

• Practice

• Private meeting

• Maintenance

etc.

While this function may seem useful, it may make MRBS seem unnecessarily complicated for users. Each entry type will appear on the MRBS timetable in a different colour (one per Entry type). Colours will define Entry type (Tutorial /Private meeting etc.) and not the subject of the class (e.g. English /Maths etc.)

The Entry type colours can be defined inside MRBS php files on the server.

----

'''Mail admin bookings'''

Send email to admin. notifying of a new booking. - Every time a booking is made, an email will be sent to the MRBS admin's email address as defined in the MRBS Admin email box (towards the top of the page).

----

'''Mail area admin'''

Send email to area admin notifying of a new booking. - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with particular Areas. - This would be useful for larger institutions.

See 'Mail admin email' above.

----

'''Mail room admin'''

Send email to room admin notifying of a new booking - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with individual Rooms.

See 'Mail admin email' above.

----

'''Mail admin deletes'''

Sends an email to the admin notifying of room bookings having been deleted.

See 'Mail admin email' above.

----

'''Mail admin all'''

Sends an email to the MYBS administrator whenever any change is made by users to the MRBS system.

See 'Mail admin email' above.

----

'''Mail details'''

Mail details.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail scheduler'''

Send an email to the scheduler of a new booking.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail from'''

Set the email address of the From field. Default is site admin.

This is the email address from which MRBS notification emails will be sent. It has to be associated with a Moodle user account.

----

'''Mail recipients'''

Set the recipient email. You can define more than one recipient like this 'john@doe.com,scott@tiger.com'. Recipient email(s) must be associated with a Moodle user account.

----

'''Mail cc'''

Set email address of the Carbon Copy field. Default is blank. Similar to mail recipients, you can define more than one recipient. All recipient emails must be associated with a Moodle user account.

----

'''Location of session import file'''

If you wish to use the automatic session import feature, enter the location of the file here. The file must be able to be moved by the webserver user. By entering a location, you will enable special booking types for imported bookings.

A session import file is a comma-separated value (CSV) file which can be uploaded by Moodle's automated scripts (cron) to import a timetable into MRBS. Details for how to do this are here:

https://docs.moodle.org/24/en/MRBS_block/import

Prepared CSV files made to populate the MRBS with (perhaps) an initial set of bookings, can be left in the folder located at the URL pasted into the 'Location of session import file' box. When the appropriate Moodle cron file runs, it will look in this location for a CSV file to implement.

admin/setting/blocksettingmrbs

2012-09-29T18:54:16Z

Francoisevans: /* MRBS Block Settings */

== MRBS Block Settings ==

(MRBS stands for Meeting Room Booking System.)

'''Window'''

When set to 'New window', the MRBS block will open in a new window. When set to 'Same window', the MRBS block will open inside Moodle, with the Moodle headers.

----

'''MRBS Installation Path'''

Place on your Moodle's server where the MRBS block is installed. This is usually at:

http://www.yourwebsitename.suffix/moodle/blocks/mrbs/web

----

'''MRBS Admin'''

Name of the MRBS administrator

----

'''MRBS admin email'''
Email address of the MRBS administrator. In order to receive MRBS email notifications, the email address must be associated with a Moodle user account.

----

'''Use Periods'''

If set to 'No', MRBS will present a standard time resolution for room bookings. If set to 'Yes', then MRBS will refer to the 'Custom periods' you define below...

Setting 'Use periods' to 'Yes', will make an empty 'Custom Periods' text box appear, for you to fill in (see below).

Warning: If you set MRBS to Use custom periods and then define and save these, and later decide that you do not wish to use Custom periods after all and set 'Use periods' top 'No', then this may cause errors in the proper functioning of MRBS. If this happens, re-set 'Use periods' to 'Yes' and ensure the desired period resolution is typed into the 'Custom Periods' box (see below).

----

'''Custom Periods'''

Typing times into this box in an appropriate format, will present the user with those times to be able to book rooms to. For example, if you want users to be able to book a room at 3.15pm or 3.45pm, then you will need to define presented (Custom) periods to resolve to a ''quarter'' hour. If you wanted users to be able to book rooms only every ''half'' hour, then you would need to define custom periods in that way.

The required format for lists of times in the Custom periods box can be in am/pm format or 24-hour format. For am/pm, the following will work:

9.00am

9.30am

10.00am

10.30am

...etc.

Notice that there has to be a carriage return between each individual given time, with no spaces in between.

To save ''you'' time, you may wish to copy and paste from the lists below, extending or curtailing these earlier or later as required before pasting them in to your 'Custom Periods' box:

Half-hourly custom periods to paste into Custom periods box:

8.00am

8.30am

9.00am

9.30am

10.00am

10.30am

11.00am

11.30am

12.00pm

12.30pm

1.00pm

1.30pm

2.00pm

2.30pm

3.00pm

3.30pm

4.00pm

4.30pm

5.00pm

5.30pm

6.00pm

6.30pm

7.00pm

7.30pm

8.00pm

8.30pm

9.00pm

Quarter-hourly custom periods to paste into Custom periods box:

8.00am

8.15am

8.30am

8.45am

9.00am

9.15am

9.30am

9.45am

10.00am

10.15am

10.30am

10.45am

11.00am

11.15am

11.30am

11.45am

12.00pm

12.15pm

12.30pm

12.45pm

1.00pm

1.15pm

1.30pm

1.45pm

2.00pm

2.15pm

2.30pm

2.45pm

3.00pm

3.15pm

3.30pm

3.45pm

4.00pm

4.15pm

4.30pm

4.45pm

5.00pm

5.15pm

5.30pm

5.45pm

6.00pm

6.15pm

6.30pm

6.45pm

7.00pm

7.15pm

7.30pm

7.45pm

8.00pm

8.15pm

8.30pm

8.45pm

9.00pm

Alternatively, you might want to have rooms bookable to a resolution of 5-minute intervals etc.

----

'''Start of Week'''

Day you want your week to start, e.g. 'Monday'.

----

'''Length of week'''

The week can be curtailed, for example to exclude weekends. Do do this, set 'Start of week' (see above) to 'Monday' and 'Length of week' to '5'.

----

'''Date format'''

Choose how you want your dates to be displayed from the drop-down menu.

----

'''Time format'''

Choose how you want your times to be displayed from the drop-down menu.

----

'''Max. Rep Entries'''

It's possible for someone booking a room to repeat that booking (e.g. every day or every week). In this box you can set a limit on the number of repeats that someone booking a room could type in. The default is 365, which restricts a person to booking a room daily for the next year, or weekly for the next seven years (!) etc.

----

'''Maximum advance booking'''

If you want to stop users from booking rooms too many ''days'' in advance, then you can set a limit here. For example, typing in '7' would stop users from booking a room more than seven days in advance - the booking date would only become available seven days before.

To turn this feature off and allow users to book as far ahead of time as they like, type '-1' in the box.

----

'''Report span (days)'''

Default report span in days - This is the length of time in days that a report generated by MRBS covers. The default is '60' (approx. two months).

----

'''Search results per page'''

If you're searching for a booking, this limits the number of results displayed per page.

----

'''Show area list'''

In MRBS, an 'Area' is a category of room (NB not a Moodle category).

For example, if you ran a Science department comprising rooms used exclusively for Physics, Chemistry or Biology, then you could predefine three 'Areas': Physics, Chemistry and Biology. The Physics rooms (1, 2 and 3) would be named under the Physics Area, The Biology rooms (4, 5 & 6) under the Biology Area etc.

To book a room in MRBS's user interface, a user first selects an Area. In the MRBS user interface, the list of rooms ''for'' that area then becomes visible.

'Show area list' sets how you want the area list to display for users: 'List' shows a list. 'Select' will present users with a drop-down menu.

----

'''View monthly details'''

Entries in monthly view can be shown as start/end slot, brief description or both. Set to 'description' for brief description, 'slot' for time slot and 'both' for both. Default is 'both', but 6 entries per day are shown instead of 12.

----

'''View week number'''

To view weeks in the bottom as week numbers (42) instead of 'first day of the week' (13 Oct), set this to TRUE.

Display of weeks in the bottom of the MRBS user interface are handled by the '''trailer.php''' file.

----

'''Time right side'''

To display times on right side in day and week view, set to 'Yes'.

----

'''Javascript cursor'''

Change to 'false' if clients have old browsers incompatible with JavaScript.

----

'''Show plus link'''

Change to 'true' always to show the (+) link. The plus link is a small icon displaying a plus sign inside each bookable time cell.

----

'''Highlight method'''

Choose one of the highlight methods: bgcolor, class, or hybrid.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Default view'''

Define default starting view (month, week or day) - MRBS can show any of these three and they can be switched between.

----

'''Default room'''

Define default room to start with (used by index.php). Room numbers can be determined by looking at the 'Edit' or 'Delete' page URL for a room from the admin page.

----

'''Entry type A - J'''

Entry types is a way of defining purposes for room use. In this way, a user can book a room for a named class (e.g. 'Drama') and then indicate what ''kind'' of booked session that is going to be. For example:

• Lecture
• Lesson
• Seminar
• Tutorial
• Practice
• Private meeting
• Maintenance

etc.

While this function may seem useful, it may make MRBS seem unnecessarily complicated for users. Each entry type will appear on the MRBS timetable in a different colour (one per Entry type). Colours will define Entry type (Tutorial /Private meeting etc.) and not the subject of the class (e.g. English /Maths etc.)

The Entry type colours can be defined inside MRBS php files on the server.

----

'''Mail admin bookings'''

Send email to admin. notifying of a new booking. - Every time a booking is made, an email will be sent to the MRBS admin's email address as defined in the MRBS Admin email box (towards the top of the page).

----

'''Mail area admin'''

Send email to area admin notifying of a new booking. - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with particular Areas. - This would be useful for larger institutions.

See 'Mail admin email' above.

----

'''Mail room admin'''

Send email to room admin notifying of a new booking - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with individual Rooms.

See 'Mail admin email' above.

----

'''Mail admin deletes'''

Sends an email to the admin notifying of room bookings having been deleted.

See 'Mail admin email' above.

----

'''Mail admin all'''

Sends an email to the MYBS administrator whenever any change is made by users to the MRBS system.

See 'Mail admin email' above.

----

'''Mail details'''

Mail details.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail scheduler'''

Send an email to the scheduler of a new booking.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail from'''

Set the email address of the From field. Default is site admin.

This is the email address from which MRBS notification emails will be sent. It has to be associated with a Moodle user account.

----

'''Mail recipients'''

Set the recipient email. You can define more than one recipient like this 'john@doe.com,scott@tiger.com'. Recipient email(s) must be associated with a Moodle user account.

----

'''Mail cc'''

Set email address of the Carbon Copy field. Default is blank. Similar to mail recipients, you can define more than one recipient. All recipient emails must be associated with a Moodle user account.

----

'''Location of session import file'''

If you wish to use the automatic session import feature, enter the location of the file here. The file must be able to be moved by the webserver user. By entering a location, you will enable special booking types for imported bookings.

A session import file is a comma-separated value (CSV) file which can be uploaded by Moodle's automated scripts (cron) to import a timetable into MRBS. Details for how to do this are here:

https://docs.moodle.org/24/en/MRBS_block/import

Prepared CSV files made to populate the MRBS with (perhaps) an initial set of bookings, can be left in the folder located at the URL pasted into the 'Location of session import file' box. When the appropriate Moodle cron file runs, it will look in this location for a CSV file to implement.

admin/setting/blocksettingmrbs

2012-09-29T18:53:44Z

Francoisevans: /* MRBS Block Settings */

== MRBS Block Settings ==

(MRBS stands for Meeting Room Booking System.)

'''Window'''

When set to 'New window', the MRBS block will open in a new window. When set to 'Same window', the MRBS block will open inside Moodle, with the Moodle headers.

----

'''MRBS Installation Path'''

Place on your Moodle's server where the MRBS block is installed. This is usually at:

http://www.yourwebsitename.suffix/moodle/blocks/mrbs/web

----

'''MRBS Admin'''

Name of the MRBS administrator

----

'''MRBS admin email'''
Email address of the MRBS administrator. In order to receive MRBS email notifications, the email address must be associated with a Moodle user account.

----

'''Use Periods'''

If set to 'No', MRBS will present a standard time resolution for room bookings. If set to 'Yes', then MRBS will refer to the 'Custom periods' you define below...

Setting 'Use periods' to 'Yes', will make an empty 'Custom Periods' text box appear, for you to fill in (see below).

Warning: If you set MRBS to Use custom periods and then define and save these, and later decide that you do not wish to use Custom periods after all and set 'Use periods' top 'No', then this may cause errors in the proper functioning of MRBS. If this happens, re-set 'Use periods' to 'Yes' and ensure the desired period resolution is typed into the 'Custom Periods' box (see below).

----

'''Custom Periods'''

Typing times into this box in an appropriate format, will present the user with those times to be able to book rooms to. For example, if you want users to be able to book a room at 3.15pm or 3.45pm, then you will need to define presented (Custom) periods to resolve to a ''quarter'' hour. If you wanted users to be able to book rooms only every ''half'' hour, then you would need to define custom periods in that way.

The required format for lists of times in the Custom periods box can be in am/pm format or 24-hour format. For am/pm, the following will work:

9.00am

9.30am

10.00am

10.30am

...etc.

Notice that there has to be a carriage return between each individual given time, with no spaces in between.

To save ''you'' time, you may wish to copy and paste from the lists below, extending or curtailing these earlier or later as required before pasting them in to your 'Custom Periods' box:

Half-hourly custom periods to paste into Custom periods box:

8.00am

8.30am

9.00am

9.30am

10.00am

10.30am

11.00am

11.30am

12.00pm

12.30pm

1.00pm

1.30pm

2.00pm

2.30pm

3.00pm

3.30pm

4.00pm

4.30pm

5.00pm

5.30pm

6.00pm

6.30pm

7.00pm

7.30pm

8.00pm

8.30pm

9.00pm

Quarter-hourly custom periods to paste into Custom periods box:

8.00am

8.15am

8.30am

8.45am

9.00am

9.15am

9.30am

9.45am

10.00am

10.15am

10.30am

10.45am

11.00am

11.15am

11.30am

11.45am

12.00pm

12.15pm

12.30pm

12.45pm

1.00pm

1.15pm

1.30pm

1.45pm

2.00pm

2.15pm

2.30pm

2.45pm

3.00pm

3.15pm

3.30pm

3.45pm

4.00pm

4.15pm

4.30pm

4.45pm

5.00pm

5.15pm

5.30pm

5.45pm

6.00pm

6.15pm

6.30pm

6.45pm

7.00pm

7.15pm

7.30pm

7.45pm

8.00pm

8.15pm

8.30pm

8.45pm

9.00pm

Alternatively, you might want to have rooms bookable to a resolution of 5-minute intervals etc.

----

'''Start of Week'''

Day you want your week to start, e.g. 'Monday'.

----

'''Length of week'''

The week can be curtailed, for example to exclude weekends. Do do this, set 'Start of week' (see above) to 'Monday' and 'Length of week' to '5'.

----

'''Date format'''

Choose how you want your dates to be displayed from the drop-down menu.

----

'''Time format'''

Choose how you want your times to be displayed from the drop-down menu.

----

'''Max. Rep Entries'''

It's possible for someone booking a room to repeat that booking (e.g. every day or every week). In this box you can set a limit on the number of repeats that someone booking a room could type in. The default is 365, which restricts a person to booking a room daily for the next year, or weekly for the next seven years (!) etc.

----

'''Maximum advance booking'''

If you want to stop users from booking rooms too many ''days'' in advance, then you can set a limit here. For example, typing in '7' would stop users from booking a room more than seven days in advance - the booking date would only become available seven days before.

To turn this feature off and allow users to book as far ahead of time as they like, type '-1' in the box.

----

'''Report span (days)'''

Default report span in days - This is the length of time in days that a report generated by MRBS covers. The default is '60' (approx. two months).

----

'''Search results per page'''

If you're searching for a booking, this limits the number of results displayed per page.

----

'''Show area list'''

In MRBS, an 'Area' is a category of room (NB not a Moodle category).

For example, if you ran a Science department comprising rooms used exclusively for Physics, Chemistry or Biology, then you could predefine three 'Areas': Physics, Chemistry and Biology. The Physics rooms (1, 2 and 3) would be named under the Physics Area, The Biology rooms (4, 5 & 6) under the Biology Area etc.

To book a room in MRBS's user interface, a user first selects an Area. In the MRBS user interface, the list of rooms ''for'' that area then becomes visible.

'Show area list' sets how you want the area list to display for users: 'List' shows a list. 'Select' will present users with a drop-down menu.

----

'''View monthly details'''

Entries in monthly view can be shown as start/end slot, brief description or both. Set to 'description' for brief description, 'slot' for time slot and 'both' for both. Default is 'both', but 6 entries per day are shown instead of 12.

----

'''View week number'''

To view weeks in the bottom as week numbers (42) instead of 'first day of the week' (13 Oct), set this to TRUE.

Display of weeks in the bottom of the MRBS user interface are handled by the '''trailer.php''' file.

----

'''Time right side'''

To display times on right side in day and week view, set to 'Yes'.

----

'''Javascript cursor'''

Change to 'false' if clients have old browsers incompatible with JavaScript.

----

'''Show plus link'''

Change to 'true' always to show the (+) link. The plus link is a small icon displaying a plus sign inside each bookable time cell.

----

'''Highlight method'''

Choose one of the highlight methods: bgcolor, class, or hybrid.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Default view'''

Define default starting view (month, week or day) - MRBS can show any of these three and they can be switched between.

----

'''Default room'''

Define default room to start with (used by index.php). Room numbers can be determined by looking at the 'Edit' or 'Delete' page URL for a room from the admin page.

----

'''Entry type A - J'''

Entry types is a way of defining purposes for room use. In this way, a user can book a room for a named class (e.g. 'Drama') and then indicate what ''kind'' of booked session that is going to be. For example:

• Lecture
• Lesson
• Seminar
• Tutorial
• Practice
• Private meeting
• Maintenance

etc.

While this function may seem useful, it may make MRBS seem unnecessarily complicated for users. Each entry type will appear on the MRBS timetable in a different colour (one per Entry type). Colours will define Entry type (Tutorial /Private meeting etc.) and not the subject of the class (e.g. English /Maths etc.)

The Entry type colours can be defined inside MRBS php files on the server.

----

'''Mail admin bookings'''

Send email to admin. notifying of a new booking. - Every time a booking is made, an email will be sent to the MRBS admin's email address as defined in the MRBS Admin email box (towards the top of the page).

----

'''Mail area admin'''

Send email to area admin notifying of a new booking. - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with particular Areas. - This would be useful for larger institutions.

See 'Mail admin email' above.

----

'''Mail room admin'''

Send email to room admin notifying of a new booking - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with individual Rooms.

See 'Mail admin email' above.

----

'''Mail admin deletes'''

Sends an email to the admin notifying of room bookings having been deleted.

See 'Mail admin email' above.

----

'''Mail admin all'''

Sends an email to the MYBS administrator whenever any change is made by users to the MRBS system.

See 'Mail admin email' above.

----

'''Mail details'''

Mail details.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail scheduler'''

Send an email to the scheduler of a new booking.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail from'''

Set the email address of the From field. Default is site admin.

This is the email address from which MRBS notification emails will be sent. It has to be associated with a Moodle user account.

----

'''Mail recipients'''

Set the recipient email. You can define more than one recipient like this 'john@doe.com,scott@tiger.com'. Recipient email(s) must be associated with a Moodle user account.

----

'''Mail cc'''

Set email address of the Carbon Copy field. Default is blank. Similar to mail recipients, you can define more than one recipient. All recipient emails must be associated with a Moodle user account.

----

'''Location of session import file'''

If you wish to use the automatic session import feature, enter the location of the file here. The file must be able to be moved by the webserver user. By entering a location, you will enable special booking types for imported bookings.

A session import file is a comma-separated value (CSV) file which can be uploaded by Moodle's automated scripts (cron) to import a timetable into MRBS. Details for how to do this are here:

https://docs.moodle.org/24/en/MRBS_block/import

Prepared CSV files made to populate the MRBS with (perhaps) an initial set of bookings, can be left in the folder located at the URL pasted into the 'Location of session import file' box. When the appropriate Moodle cron file runs, it will look in this location for a CSV file to implement.

admin/setting/blocksettingmrbs

2012-09-29T18:53:22Z

Francoisevans: /* MRBS Block Settings */

== MRBS Block Settings ==

(MRBS stands for Meeting Room Booking System.)

'''Window'''

When set to 'New window', the MRBS block will open in a new window. When set to 'Same window', the MRBS block will open inside Moodle, with the Moodle headers.

----

'''MRBS Installation Path'''

Place on your Moodle's server where the MRBS block is installed. This is usually at:

http://www.yourwebsitename.suffix/moodle/blocks/mrbs/web

----

'''MRBS Admin'''

Name of the MRBS administrator

----

'''MRBS admin email'''
Email address of the MRBS administrator. In order to receive MRBS email notifications, the email address must be associated with a Moodle user account.

----

'''Use Periods'''

If set to 'No', MRBS will present a standard time resolution for room bookings. If set to 'Yes', then MRBS will refer to the 'Custom periods' you define below...

Setting 'Use periods' to 'Yes', will make an empty 'Custom Periods' text box appear, for you to fill in (see below).

Warning: If you set MRBS to Use custom periods and then define and save these, and later decide that you do not wish to use Custom periods after all and set 'Use periods' top 'No', then this may cause errors in the proper functioning of MRBS. If this happens, re-set 'Use periods' to 'Yes' and ensure the desired period resolution is typed into the 'Custom Periods' box (see below).

----

'''Custom Periods'''

Typing times into this box in an appropriate format, will present the user with those times to be able to book rooms to. For example, if you want users to be able to book a room at 3.15pm or 3.45pm, then you will need to define presented (Custom) periods to resolve to a ''quarter'' hour. If you wanted users to be able to book rooms only every ''half'' hour, then you would need to define custom periods in that way.

The required format for lists of times in the Custom periods box can be in am/pm format or 24-hour format. For am/pm, the following will work:

9.00am

9.30am

10.00am

10.30am

...etc.

Notice that there has to be a carriage return between each individual given time, with no spaces in between.

To save ''you'' time, you may wish to copy and paste from the lists below, extending or curtailing these earlier or later as required before pasting them in to your 'Custom Periods' box:

Half-hourly custom periods to paste into Custom periods box:

8.00am

8.30am

9.00am

9.30am

10.00am

10.30am

11.00am

11.30am

12.00pm

12.30pm

1.00pm

1.30pm

2.00pm

2.30pm

3.00pm

3.30pm

4.00pm

4.30pm

5.00pm

5.30pm

6.00pm

6.30pm

7.00pm

7.30pm

8.00pm

8.30pm

9.00pm

Quarter-hourly custom periods to paste into Custom periods box:

8.00am

8.15am

8.30am

8.45am

9.00am

9.15am

9.30am

9.45am

10.00am

10.15am

10.30am

10.45am

11.00am

11.15am

11.30am

11.45am

12.00pm

12.15pm

12.30pm

12.45pm

1.00pm

1.15pm

1.30pm

1.45pm

2.00pm

2.15pm

2.30pm

2.45pm

3.00pm

3.15pm

3.30pm

3.45pm

4.00pm

4.15pm

4.30pm

4.45pm

5.00pm

5.15pm

5.30pm

5.45pm

6.00pm

6.15pm

6.30pm

6.45pm

7.00pm

7.15pm

7.30pm

7.45pm

8.00pm

8.15pm

8.30pm

8.45pm

9.00pm

Alternatively, you might want to have rooms bookable to a resolution of 5-minute intervals etc.

----

'''Start of Week'''

Day you want your week to start, e.g. 'Monday'.

----

'''Length of week'''

The week can be curtailed, for example to exclude weekends. Do do this, set 'Start of week' (see above) to 'Monday' and 'Length of week' to '5'.

----

'''Date format'''

Choose how you want your dates to be displayed from the drop-down menu.

----

'''Time format'''

Choose how you want your times to be displayed from the drop-down menu.

----

'''Max. Rep Entries'''

It's possible for someone booking a room to repeat that booking (e.g. every day or every week). In this box you can set a limit on the number of repeats that someone booking a room could type in. The default is 365, which restricts a person to booking a room daily for the next year, or weekly for the next seven years (!) etc.

----

'''Maximum advance booking'''

If you want to stop users from booking rooms too many ''days'' in advance, then you can set a limit here. For example, typing in '7' would stop users from booking a room more than seven days in advance - the booking date would only become available seven days before.

To turn this feature off and allow users to book as far ahead of time as they like, type '-1' in the box.

----

'''Report span (days)'''

Default report span in days - This is the length of time in days that a report generated by MRBS covers. The default is '60' (approx. two months).

----

'''Search results per page'''

If you're searching for a booking, this limits the number of results displayed per page.

----

'''Show area list'''

In MRBS, an 'Area' is a category of room (NB not a Moodle category).

For example, if you ran a Science department comprising rooms used exclusively for Physics, Chemistry or Biology, then you could predefine three 'Areas': Physics, Chemistry and Biology. The Physics rooms (1, 2 and 3) would be named under the Physics Area, The Biology rooms (4, 5 & 6) under the Biology Area etc.

To book a room in MRBS's user interface, a user first selects an Area. In the MRBS user interface, the list of rooms ''for'' that area then becomes visible.

'Show area list' sets how you want the area list to display for users: 'List' shows a list. 'Select' will present users with a drop-down menu.

----

'''View monthly details'''

Entries in monthly view can be shown as start/end slot, brief description or both. Set to 'description' for brief description, 'slot' for time slot and 'both' for both. Default is 'both', but 6 entries per day are shown instead of 12.

----

'''View week number'''

To view weeks in the bottom as week numbers (42) instead of 'first day of the week' (13 Oct), set this to TRUE.

Display of weeks in the bottom of the MRBS user interface are handled by the '''trailer.php''' file.

----

'''Time right side'''

To display times on right side in day and week view, set to 'Yes'.

----

'''Javascript cursor'''

Change to 'false' if clients have old browsers incompatible with JavaScript.

----

'''Show plus link'''

Change to 'true' always to show the (+) link. The plus link is a small icon displaying a plus sign inside each bookable time cell.

----

'''Highlight method'''

Choose one of the highlight methods: bgcolor, class, or hybrid.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Default view'''

Define default starting view (month, week or day) - MRBS can show any of these three and they can be switched between.

----

'''Default room'''

Define default room to start with (used by index.php). Room numbers can be determined by looking at the 'Edit' or 'Delete' page URL for a room from the admin page.

----

'''Entry type A - J'''

Entry types is a way of defining purposes for room use. In this way, a user can book a room for a named class (e.g. 'Drama') and then indicate what ''kind'' of booked session that is going to be. For example:

• Lecture
• Lesson
• Seminar
• Tutorial
• Practice
• Private meeting
• Maintenance

etc.

While this function may seem useful, it may make MRBS seem unnecessarily complicated for users. Each entry type will appear on the MRBS timetable in a different colour (one per Entry type). Colours will define Entry type (Tutorial /Private meeting etc.) and not the subject of the class (e.g. English /Maths etc.)

The Entry type colours can be defined inside MRBS php files on the server.

----

'''Mail admin bookings'''

Send email to admin. notifying of a new booking. - Every time a booking is made, an email will be sent to the MRBS admin's email address as defined in the MRBS Admin email box (towards the top of the page).

----

'''Mail area admin'''

Send email to area admin notifying of a new booking. - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with particular Areas. - This would be useful for larger institutions.

See 'Mail admin email' above.

----

'''Mail room admin'''

Send email to room admin notifying of a new booking - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with individual Rooms.

See 'Mail admin email' above.

----

'''Mail admin deletes'''

Sends an email to the admin notifying of room bookings having been deleted.

See 'Mail admin email' above.

----

'''Mail admin all'''

Sends an email to the MYBS administrator whenever any change is made by users to the MRBS system.

See 'Mail admin email' above.

----

'''Mail details'''

Mail details.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail scheduler'''

Send an email to the scheduler of a new booking.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail from'''

Set the email address of the From field. Default is site admin.

This is the email address from which MRBS notification emails will be sent. It has to be associated with a Moodle user account.

----

'''Mail recipients'''

Set the recipient email. You can define more than one recipient like this 'john@doe.com,scott@tiger.com'. Recipient email(s) must be associated with a Moodle user account.

----

'''Mail cc'''

Set email address of the Carbon Copy field. Default is blank. Similar to mail recipients, you can define more than one recipient. All recipient emails must be associated with a Moodle user account.

----

'''Location of session import file'''

If you wish to use the automatic session import feature, enter the location of the file here. The file must be able to be moved by the webserver user. By entering a location, you will enable special booking types for imported bookings.

A session import file is a comma-separated value (CSV) file which can be uploaded by Moodle's automated scripts (cron) to import a timetable into MRBS. Details for how to do this are here:

https://docs.moodle.org/24/en/MRBS_block/import

Prepared CSV files made to populate the MRBS with (perhaps) an initial set of bookings, can be left in the folder located at the URL pasted into the 'Location of session import file' box. When the appropriate Moodle cron file runs, it will look in this location for a CSV file to implement.

admin/setting/blocksettingmrbs

2012-09-29T18:52:26Z

Francoisevans: /* MRBS Block Settings */

== MRBS Block Settings ==

(MRBS stands for Meeting Room Booking System.)

'''Window'''

When set to New window, the MRBS block will open in a new window. When set to Same window, the MRBS block will open inside of Moodle with the Moodle headers.

----

'''MRBS Installation Path'''

Place on your Moodle's server where the MRBS block is installed. This is usually at:
Default: http://www.yourwebsitename.suffix/moodle/blocks/mrbs/web

----

'''MRBS Admin'''

Name of the MRBS administrator

----

'''MRBS admin email'''
Email address of the MRBS administrator. In order to receive MRBS email notifications, the email address must be associated with a Moodle user account.

----

'''Use Periods'''

If set to 'No', MRBS will present a standard time resolution for room bookings. If set to 'Yes', then MRBS will refer to the 'Custom periods' you define below...

Setting 'Use periods' to 'Yes', will make an empty 'Custom Periods' text box appear, for you to fill in (see below).

Warning: If you set MRBS to Use custom periods and then define and save these, and later decide that you do not wish to use Custom periods after all and set 'Use periods' top 'No', then this may cause errors in the proper functioning of MRBS. If this happens, re-set 'Use periods' to 'Yes' and ensure the desired period resolution is typed into the 'Custom Periods' box (see below).

----

'''Custom Periods'''

Typing times into this box in an appropriate format, will present the user with those times to be able to book rooms to. For example, if you want users to be able to book a room at 3.15pm or 3.45pm, then you will need to define presented (Custom) periods to resolve to a ''quarter'' hour. If you wanted users to be able to book rooms only every ''half'' hour, then you would need to define custom periods in that way.

The required format for lists of times in the Custom periods box can be in am/pm format or 24-hour format. For am/pm, the following will work:

9.00am

9.30am

10.00am

10.30am

...etc.

Notice that there has to be a carriage return between each individual given time, with no spaces in between.

To save ''you'' time, you may wish to copy and paste from the lists below, extending or curtailing these earlier or later as required before pasting them in to your 'Custom Periods' box:

Half-hourly custom periods to paste into Custom periods box:

8.00am

8.30am

9.00am

9.30am

10.00am

10.30am

11.00am

11.30am

12.00pm

12.30pm

1.00pm

1.30pm

2.00pm

2.30pm

3.00pm

3.30pm

4.00pm

4.30pm

5.00pm

5.30pm

6.00pm

6.30pm

7.00pm

7.30pm

8.00pm

8.30pm

9.00pm

Quarter-hourly custom periods to paste into Custom periods box:

8.00am

8.15am

8.30am

8.45am

9.00am

9.15am

9.30am

9.45am

10.00am

10.15am

10.30am

10.45am

11.00am

11.15am

11.30am

11.45am

12.00pm

12.15pm

12.30pm

12.45pm

1.00pm

1.15pm

1.30pm

1.45pm

2.00pm

2.15pm

2.30pm

2.45pm

3.00pm

3.15pm

3.30pm

3.45pm

4.00pm

4.15pm

4.30pm

4.45pm

5.00pm

5.15pm

5.30pm

5.45pm

6.00pm

6.15pm

6.30pm

6.45pm

7.00pm

7.15pm

7.30pm

7.45pm

8.00pm

8.15pm

8.30pm

8.45pm

9.00pm

Alternatively, you might want to have rooms bookable to a resolution of 5-minute intervals etc.

----

'''Start of Week'''

Day you want your week to start, e.g. 'Monday'.

----

'''Length of week'''

The week can be curtailed, for example to exclude weekends. Do do this, set 'Start of week' (see above) to 'Monday' and 'Length of week' to '5'.

----

'''Date format'''

Choose how you want your dates to be displayed from the drop-down menu.

----

'''Time format'''

Choose how you want your times to be displayed from the drop-down menu.

----

'''Max. Rep Entries'''

It's possible for someone booking a room to repeat that booking (e.g. every day or every week). In this box you can set a limit on the number of repeats that someone booking a room could type in. The default is 365, which restricts a person to booking a room daily for the next year, or weekly for the next seven years (!) etc.

----

'''Maximum advance booking'''

If you want to stop users from booking rooms too many ''days'' in advance, then you can set a limit here. For example, typing in '7' would stop users from booking a room more than seven days in advance - the booking date would only become available seven days before.

To turn this feature off and allow users to book as far ahead of time as they like, type '-1' in the box.

----

'''Report span (days)'''

Default report span in days - This is the length of time in days that a report generated by MRBS covers. The default is '60' (approx. two months).

----

'''Search results per page'''

If you're searching for a booking, this limits the number of results displayed per page.

----

'''Show area list'''

In MRBS, an 'Area' is a category of room (NB not a Moodle category).

For example, if you ran a Science department comprising rooms used exclusively for Physics, Chemistry or Biology, then you could predefine three 'Areas': Physics, Chemistry and Biology. The Physics rooms (1, 2 and 3) would be named under the Physics Area, The Biology rooms (4, 5 & 6) under the Biology Area etc.

To book a room in MRBS's user interface, a user first selects an Area. In the MRBS user interface, the list of rooms ''for'' that area then becomes visible.

'Show area list' sets how you want the area list to display for users: 'List' shows a list. 'Select' will present users with a drop-down menu.

----

'''View monthly details'''

Entries in monthly view can be shown as start/end slot, brief description or both. Set to 'description' for brief description, 'slot' for time slot and 'both' for both. Default is 'both', but 6 entries per day are shown instead of 12.

----

'''View week number'''

To view weeks in the bottom as week numbers (42) instead of 'first day of the week' (13 Oct), set this to TRUE.

Display of weeks in the bottom of the MRBS user interface are handled by the '''trailer.php''' file.

----

'''Time right side'''

To display times on right side in day and week view, set to 'Yes'.

----

'''Javascript cursor'''

Change to 'false' if clients have old browsers incompatible with JavaScript.

----

'''Show plus link'''

Change to 'true' always to show the (+) link. The plus link is a small icon displaying a plus sign inside each bookable time cell.

----

'''Highlight method'''

Choose one of the highlight methods: bgcolor, class, or hybrid.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Default view'''

Define default starting view (month, week or day) - MRBS can show any of these three and they can be switched between.

----

'''Default room'''

Define default room to start with (used by index.php). Room numbers can be determined by looking at the 'Edit' or 'Delete' page URL for a room from the admin page.

----

'''Entry type A - J'''

Entry types is a way of defining purposes for room use. In this way, a user can book a room for a named class (e.g. 'Drama') and then indicate what ''kind'' of booked session that is going to be. For example:

• Lecture
• Lesson
• Seminar
• Tutorial
• Practice
• Private meeting
• Maintenance

etc.

While this function may seem useful, it may make MRBS seem unnecessarily complicated for users. Each entry type will appear on the MRBS timetable in a different colour (one per Entry type). Colours will define Entry type (Tutorial /Private meeting etc.) and not the subject of the class (e.g. English /Maths etc.)

The Entry type colours can be defined inside MRBS php files on the server.

----

'''Mail admin bookings'''

Send email to admin. notifying of a new booking. - Every time a booking is made, an email will be sent to the MRBS admin's email address as defined in the MRBS Admin email box (towards the top of the page).

----

'''Mail area admin'''

Send email to area admin notifying of a new booking. - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with particular Areas. - This would be useful for larger institutions.

See 'Mail admin email' above.

----

'''Mail room admin'''

Send email to room admin notifying of a new booking - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with individual Rooms.

See 'Mail admin email' above.

----

'''Mail admin deletes'''

Sends an email to the admin notifying of room bookings having been deleted.

See 'Mail admin email' above.

----

'''Mail admin all'''

Sends an email to the MYBS administrator whenever any change is made by users to the MRBS system.

See 'Mail admin email' above.

----

'''Mail details'''

Mail details.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail scheduler'''

Send an email to the scheduler of a new booking.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail from'''

Set the email address of the From field. Default is site admin.

This is the email address from which MRBS notification emails will be sent. It has to be associated with a Moodle user account.

----

'''Mail recipients'''

Set the recipient email. You can define more than one recipient like this 'john@doe.com,scott@tiger.com'. Recipient email(s) must be associated with a Moodle user account.

----

'''Mail cc'''

Set email address of the Carbon Copy field. Default is blank. Similar to mail recipients, you can define more than one recipient. All recipient emails must be associated with a Moodle user account.

----

'''Location of session import file'''

If you wish to use the automatic session import feature, enter the location of the file here. The file must be able to be moved by the webserver user. By entering a location, you will enable special booking types for imported bookings.

A session import file is a comma-separated value (CSV) file which can be uploaded by Moodle's automated scripts (cron) to import a timetable into MRBS. Details for how to do this are here:

https://docs.moodle.org/24/en/MRBS_block/import

Prepared CSV files made to populate the MRBS with (perhaps) an initial set of bookings, can be left in the folder located at the URL pasted into the 'Location of session import file' box. When the appropriate Moodle cron file runs, it will look in this location for a CSV file to implement.

admin/setting/blocksettingmrbs

2012-09-29T18:51:22Z

Francoisevans: /* MRBS Block Settings */

== MRBS Block Settings ==

(MRBS stands for Meeting Room Booking System.)

'''Window'''

When set to New window, the MRBS block will open in a new window. When set to Same window, the MRBS block will open inside of Moodle with the Moodle headers.

----

'''MRBS Installation Path'''

Place on your Moodle's server where the MRBS block is installed. This is usually at:
Default: http://www.yourwebsitename.suffix/moodle/blocks/mrbs/web

----

'''MRBS Admin'''

Name of the MRBS administrator

----

'''MRBS admin email'''
Email address of the MRBS administrator. In order to receive MRBS email notifications, the email address must be associated with a Moodle user account.

----

'''Use Periods'''

If set to 'No', MRBS will present a standard time resolution for room bookings. If set to 'Yes', then MRBS will refer to the 'Custom periods' you define below...

Setting 'Use periods' to 'Yes', will make an empty 'Custom Periods' text box appear, for you to fill in (see below).

Warning: If you set MRBS to Use custom periods and then define and save these, and later decide that you do not wish to use Custom periods after all and set 'Use periods' top 'No', then this may cause errors in the proper functioning of MRBS. If this happens, re-set 'Use periods' to 'Yes' and ensure the desired period resolution is typed into the 'Custom Periods' box (see below).

----

'''Custom Periods'''

Typing times into this box in an appropriate format, will present the user with those times to be able to book rooms to. For example, if you want users to be able to book a room at 3.15pm or 3.45pm, then you will need to define presented (Custom) periods to resolve to a ''quarter'' hour. If you wanted users to be able to book rooms only every ''half'' hour, then you would need to define custom periods in that way.

The required format for lists of times in the Custom periods box can be in am/pm format or 24-hour format. For am/pm, the following will work:

9.00am

9.30am

10.00am

10.30am

...etc.

Notice that there has to be a carriage return between each individual given time.

To save ''you'' time, you may wish to copy and paste from the lists below, extending or curtailing these earlier or later as required before pasting them in to your 'Custom Periods' box:

Half-hourly custom periods to paste into Custom periods box:

8.00am

8.30am

9.00am

9.30am

10.00am

10.30am

11.00am

11.30am

12.00pm

12.30pm

1.00pm

1.30pm

2.00pm

2.30pm

3.00pm

3.30pm

4.00pm

4.30pm

5.00pm

5.30pm

6.00pm

6.30pm

7.00pm

7.30pm

8.00pm

8.30pm

9.00pm

Quarter-hourly custom periods to paste into Custom periods box:

8.00am

8.15am

8.30am

8.45am

9.00am

9.15am

9.30am

9.45am

10.00am

10.15am

10.30am

10.45am

11.00am

11.15am

11.30am

11.45am

12.00pm

12.15pm

12.30pm

12.45pm

1.00pm

1.15pm

1.30pm

1.45pm

2.00pm

2.15pm

2.30pm

2.45pm

3.00pm

3.15pm

3.30pm

3.45pm

4.00pm

4.15pm

4.30pm

4.45pm

5.00pm

5.15pm

5.30pm

5.45pm

6.00pm

6.15pm

6.30pm

6.45pm

7.00pm

7.15pm

7.30pm

7.45pm

8.00pm

8.15pm

8.30pm

8.45pm

9.00pm

Alternatively, you might want to have rooms bookable to a resolution of 5-minute intervals etc.

----

'''Start of Week'''

Day you want your week to start, e.g. 'Monday'.

----

'''Length of week'''

The week can be curtailed, for example to exclude weekends. Do do this, set 'Start of week' (see above) to 'Monday' and 'Length of week' to '5'.

----

'''Date format'''

Choose how you want your dates to be displayed from the drop-down menu.

----

'''Time format'''

Choose how you want your times to be displayed from the drop-down menu.

----

'''Max. Rep Entries'''

It's possible for someone booking a room to repeat that booking (e.g. every day or every week). In this box you can set a limit on the number of repeats that someone booking a room could type in. The default is 365, which restricts a person to booking a room daily for the next year, or weekly for the next seven years (!) etc.

----

'''Maximum advance booking'''

If you want to stop users from booking rooms too many ''days'' in advance, then you can set a limit here. For example, typing in '7' would stop users from booking a room more than seven days in advance - the booking date would only become available seven days before.

To turn this feature off and allow users to book as far ahead of time as they like, type '-1' in the box.

----

'''Report span (days)'''

Default report span in days - This is the length of time in days that a report generated by MRBS covers. The default is '60' (approx. two months).

----

'''Search results per page'''

If you're searching for a booking, this limits the number of results displayed per page.

----

'''Show area list'''

In MRBS, an 'Area' is a category of room (NB not a Moodle category).

For example, if you ran a Science department comprising rooms used exclusively for Physics, Chemistry or Biology, then you could predefine three 'Areas': Physics, Chemistry and Biology. The Physics rooms (1, 2 and 3) would be named under the Physics Area, The Biology rooms (4, 5 & 6) under the Biology Area etc.

To book a room in MRBS's user interface, a user first selects an Area. In the MRBS user interface, the list of rooms ''for'' that area then becomes visible.

'Show area list' sets how you want the area list to display for users: 'List' shows a list. 'Select' will present users with a drop-down menu.

----

'''View monthly details'''

Entries in monthly view can be shown as start/end slot, brief description or both. Set to 'description' for brief description, 'slot' for time slot and 'both' for both. Default is 'both', but 6 entries per day are shown instead of 12.

----

'''View week number'''

To view weeks in the bottom as week numbers (42) instead of 'first day of the week' (13 Oct), set this to TRUE.

Display of weeks in the bottom of the MRBS user interface are handled by the '''trailer.php''' file.

----

'''Time right side'''

To display times on right side in day and week view, set to 'Yes'.

----

'''Javascript cursor'''

Change to 'false' if clients have old browsers incompatible with JavaScript.

----

'''Show plus link'''

Change to 'true' always to show the (+) link. The plus link is a small icon displaying a plus sign inside each bookable time cell.

----

'''Highlight method'''

Choose one of the highlight methods: bgcolor, class, or hybrid.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Default view'''

Define default starting view (month, week or day) - MRBS can show any of these three and they can be switched between.

----

'''Default room'''

Define default room to start with (used by index.php). Room numbers can be determined by looking at the 'Edit' or 'Delete' page URL for a room from the admin page.

----

'''Entry type A - J'''

Entry types is a way of defining purposes for room use. In this way, a user can book a room for a named class (e.g. 'Drama') and then indicate what ''kind'' of booked session that is going to be. For example:

• Lecture
• Lesson
• Seminar
• Tutorial
• Practice
• Private meeting
• Maintenance

etc.

While this function may seem useful, it may make MRBS seem unnecessarily complicated for users. Each entry type will appear on the MRBS timetable in a different colour (one per Entry type). Colours will define Entry type (Tutorial /Private meeting etc.) and not the subject of the class (e.g. English /Maths etc.)

The Entry type colours can be defined inside MRBS php files on the server.

----

'''Mail admin bookings'''

Send email to admin. notifying of a new booking. - Every time a booking is made, an email will be sent to the MRBS admin's email address as defined in the MRBS Admin email box (towards the top of the page).

----

'''Mail area admin'''

Send email to area admin notifying of a new booking. - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with particular Areas. - This would be useful for larger institutions.

See 'Mail admin email' above.

----

'''Mail room admin'''

Send email to room admin notifying of a new booking - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with individual Rooms.

See 'Mail admin email' above.

----

'''Mail admin deletes'''

Sends an email to the admin notifying of room bookings having been deleted.

See 'Mail admin email' above.

----

'''Mail admin all'''

Sends an email to the MYBS administrator whenever any change is made by users to the MRBS system.

See 'Mail admin email' above.

----

'''Mail details'''

Mail details.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail scheduler'''

Send an email to the scheduler of a new booking.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail from'''

Set the email address of the From field. Default is site admin.

This is the email address from which MRBS notification emails will be sent. It has to be associated with a Moodle user account.

----

'''Mail recipients'''

Set the recipient email. You can define more than one recipient like this 'john@doe.com,scott@tiger.com'. Recipient email(s) must be associated with a Moodle user account.

----

'''Mail cc'''

Set email address of the Carbon Copy field. Default is blank. Similar to mail recipients, you can define more than one recipient. All recipient emails must be associated with a Moodle user account.

----

'''Location of session import file'''

If you wish to use the automatic session import feature, enter the location of the file here. The file must be able to be moved by the webserver user. By entering a location, you will enable special booking types for imported bookings.

A session import file is a comma-separated value (CSV) file which can be uploaded by Moodle's automated scripts (cron) to import a timetable into MRBS. Details for how to do this are here:

https://docs.moodle.org/24/en/MRBS_block/import

Prepared CSV files made to populate the MRBS with (perhaps) an initial set of bookings, can be left in the folder located at the URL pasted into the 'Location of session import file' box. When the appropriate Moodle cron file runs, it will look in this location for a CSV file to implement.

admin/setting/blocksettingmrbs

2012-09-29T18:49:33Z

Francoisevans: /* MRBS Block Settings */

== MRBS Block Settings ==

(MRBS stands for Meeting Room Booking System.)

'''Window'''

When set to New window, the MRBS block will open in a new window. When set to Same window, the MRBS block will open inside of Moodle with the Moodle headers.

----

'''MRBS Installation Path'''

Place on your Moodle's server where the MRBS block is installed. This is usually at:
Default: http://www.yourwebsitename.suffix/moodle/blocks/mrbs/web

----

'''MRBS Admin'''

Name of the MRBS administrator

----

'''MRBS admin email'''
Email address of the MRBS administrator. In order to receive MRBS email notifications, the email address must be associated with a Moodle user account.

----

'''Use Periods'''

If set to 'No', MRBS will present a standard time resolution for room bookings. If set to 'Yes', then MRBS will refer to the 'Custom periods' you define below...

Setting 'Use periods' to 'Yes', will make an empty 'Custom Periods' text box appear, for you to fill in (see below).

Warning: If you set MRBS to Use custom periods and then define and save these, and later decide that you do not wish to use Custom periods after all and set 'Use periods' top 'No', then this may cause errors in the proper functioning of MRBS. If this happens, re-set 'Use periods' to 'Yes' and ensure the desired period resolution is typed into the 'Custom Periods' box (see below).

----

'''Custom Periods'''

Typing times into this box in an appropriate format, will present the user with those times to be able to book rooms to. For example, if you want users to be able to book a room at 3.15pm or 3.45pm, then you will need to define presented (Custom) periods to resolve to a ''quarter'' hour. If you wanted users to be able to book rooms only every ''half'' hour, then you would need to define custom periods in that way.

The required format for lists of times in the Custom periods box can be in am/pm format or 24-hour format. For am/pm, the following will work:

9.00am
9.30am
10.00am
10.30am

...etc.

Notice that there has to be a carriage return between each individual given time.

To save ''you'' time, you may wish to copy and paste from the lists below, extending or curtailing these earlier or later as required before pasting them in to your 'Custom Periods' box:

Half-hourly custom periods to paste into Custom periods box:

8.00am
8.30am
9.00am
9.30am
10.00am
10.30am
11.00am
11.30am
12.00pm
12.30pm
1.00pm
1.30pm
2.00pm
2.30pm
3.00pm
3.30pm
4.00pm
4.30pm
5.00pm
5.30pm
6.00pm
6.30pm
7.00pm
7.30pm
8.00pm
8.30pm
9.00pm

Quarter-hourly custom periods to paste into Custom periods box:

8.00am
8.15am
8.30am
8.45am
9.00am
9.15am
9.30am
9.45am
10.00am
10.15am
10.30am
10.45am
11.00am
11.15am
11.30am
11.45am
12.00pm
12.15pm
12.30pm
12.45pm
1.00pm
1.15pm
1.30pm
1.45pm
2.00pm
2.15pm
2.30pm
2.45pm
3.00pm
3.15pm
3.30pm
3.45pm
4.00pm
4.15pm
4.30pm
4.45pm
5.00pm
5.15pm
5.30pm
5.45pm
6.00pm
6.15pm
6.30pm
6.45pm
7.00pm
7.15pm
7.30pm
7.45pm
8.00pm
8.15pm
8.30pm
8.45pm
9.00pm

Alternatively, you might want to have rooms bookable to a resolution of 5-minute intervals etc.

----

'''Start of Week'''

Day you want your week to start, e.g. 'Monday'.

----

'''Length of week'''

The week can be curtailed, for example to exclude weekends. Do do this, set 'Start of week' (see above) to 'Monday' and 'Length of week' to '5'.

----

'''Date format'''

Choose how you want your dates to be displayed from the drop-down menu.

----

'''Time format'''

Choose how you want your times to be displayed from the drop-down menu.

----

'''Max. Rep Entries'''

It's possible for someone booking a room to repeat that booking (e.g. every day or every week). In this box you can set a limit on the number of repeats that someone booking a room could type in. The default is 365, which restricts a person to booking a room daily for the next year, or weekly for the next seven years (!) etc.

----

'''Maximum advance booking'''

If you want to stop users from booking rooms too many ''days'' in advance, then you can set a limit here. For example, typing in '7' would stop users from booking a room more than seven days in advance - the booking date would only become available seven days before.

To turn this feature off and allow users to book as far ahead of time as they like, type '-1' in the box.

----

'''Report span (days)'''

Default report span in days - This is the length of time in days that a report generated by MRBS covers. The default is '60' (approx. two months).

----

'''Search results per page'''

If you're searching for a booking, this limits the number of results displayed per page.

----

'''Show area list'''

In MRBS, an 'Area' is a category of room (NB not a Moodle category).

For example, if you ran a Science department comprising rooms used exclusively for Physics, Chemistry or Biology, then you could predefine three 'Areas': Physics, Chemistry and Biology. The Physics rooms (1, 2 and 3) would be named under the Physics Area, The Biology rooms (4, 5 & 6) under the Biology Area etc.

To book a room in MRBS's user interface, a user first selects an Area. In the MRBS user interface, the list of rooms ''for'' that area then becomes visible.

'Show area list' sets how you want the area list to display for users: 'List' shows a list. 'Select' will present users with a drop-down menu.

----

'''View monthly details'''

Entries in monthly view can be shown as start/end slot, brief description or both. Set to 'description' for brief description, 'slot' for time slot and 'both' for both. Default is 'both', but 6 entries per day are shown instead of 12.

----

'''View week number'''

To view weeks in the bottom as week numbers (42) instead of 'first day of the week' (13 Oct), set this to TRUE.

Display of weeks in the bottom of the MRBS user interface are handled by the '''trailer.php''' file.

----

'''Time right side'''

To display times on right side in day and week view, set to 'Yes'.

----

'''Javascript cursor'''

Change to 'false' if clients have old browsers incompatible with JavaScript.

----

'''Show plus link'''

Change to 'true' always to show the (+) link. The plus link is a small icon displaying a plus sign inside each bookable time cell.

----

'''Highlight method'''

Choose one of the highlight methods: bgcolor, class, or hybrid.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Default view'''

Define default starting view (month, week or day) - MRBS can show any of these three and they can be switched between.

----

'''Default room'''

Define default room to start with (used by index.php). Room numbers can be determined by looking at the 'Edit' or 'Delete' page URL for a room from the admin page.

----

'''Entry type A - J'''

Entry types is a way of defining purposes for room use. In this way, a user can book a room for a named class (e.g. 'Drama') and then indicate what ''kind'' of booked session that is going to be. For example:

• Lecture
• Lesson
• Seminar
• Tutorial
• Practice
• Private meeting
• Maintenance

etc.

While this function may seem useful, it may make MRBS seem unnecessarily complicated for users. Each entry type will appear on the MRBS timetable in a different colour (one per Entry type). Colours will define Entry type (Tutorial /Private meeting etc.) and not the subject of the class (e.g. English /Maths etc.)

The Entry type colours can be defined inside MRBS php files on the server.

----

'''Mail admin bookings'''

Send email to admin. notifying of a new booking. - Every time a booking is made, an email will be sent to the MRBS admin's email address as defined in the MRBS Admin email box (towards the top of the page).

----

'''Mail area admin'''

Send email to area admin notifying of a new booking. - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with particular Areas. - This would be useful for larger institutions.

See 'Mail admin email' above.

----

'''Mail room admin'''

Send email to room admin notifying of a new booking - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with individual Rooms.

See 'Mail admin email' above.

----

'''Mail admin deletes'''

Sends an email to the admin notifying of room bookings having been deleted.

See 'Mail admin email' above.

----

'''Mail admin all'''

Sends an email to the MYBS administrator whenever any change is made by users to the MRBS system.

See 'Mail admin email' above.

----

'''Mail details'''

Mail details.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail scheduler'''

Send an email to the scheduler of a new booking.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail from'''

Set the email address of the From field. Default is site admin.

This is the email address from which MRBS notification emails will be sent. It has to be associated with a Moodle user account.

----

'''Mail recipients'''

Set the recipient email. You can define more than one recipient like this 'john@doe.com,scott@tiger.com'. Recipient email(s) must be associated with a Moodle user account.

----

'''Mail cc'''

Set email address of the Carbon Copy field. Default is blank. Similar to mail recipients, you can define more than one recipient. All recipient emails must be associated with a Moodle user account.

----

'''Location of session import file'''

If you wish to use the automatic session import feature, enter the location of the file here. The file must be able to be moved by the webserver user. By entering a location, you will enable special booking types for imported bookings.

A session import file is a comma-separated value (CSV) file which can be uploaded by Moodle's automated scripts (cron) to import a timetable into MRBS. Details for how to do this are here:

https://docs.moodle.org/24/en/MRBS_block/import

Prepared CSV files made to populate the MRBS with (perhaps) an initial set of bookings, can be left in the folder located at the URL pasted into the 'Location of session import file' box. When the appropriate Moodle cron file runs, it will look in this location for a CSV file to implement.

admin/setting/blocksettingmrbs

2012-09-29T18:47:34Z

Francoisevans: Created page with "== MRBS Block Settings == (MRBS stands for Meeting Room Booking System.) '''Window''' When set to New window, the MRBS block will open in a new window. When set to Same window..."

== MRBS Block Settings ==

(MRBS stands for Meeting Room Booking System.)

'''Window'''

When set to New window, the MRBS block will open in a new window. When set to Same window, the MRBS block will open inside of Moodle with the Moodle headers.

----

'''MRBS Installation Path'''

Place on your Moodle's server where the MRBS block is installed. This is usually at:
Default: http://www.yourwebsitename.suffix/moodle/blocks/mrbs/web

----

'''MRBS Admin'''

Name of the MRBS administrator

'''MRBS admin email'''
Email address of the MRBS administrator. In order to receive MRBS email notifications, the email address must be associated with a Moodle user account.

----

'''Use Periods'''

If set to 'No', MRBS will present a standard time resolution for room bookings. If set to 'Yes', then MRBS will refer to the 'Custom periods' you define below...

Setting 'Use periods' to 'Yes', will make an empty 'Custom Periods' text box appear, for you to fill in (see below).

Warning: If you set MRBS to Use custom periods and then define and save these, and later decide that you do not wish to use Custom periods after all and set 'Use periods' top 'No', then this may cause errors in the proper functioning of MRBS. If this happens, re-set 'Use periods' to 'Yes' and ensure the desired period resolution is typed into the 'Custom Periods' box (see below).

----

'''Custom Periods'''

Typing times into this box in an appropriate format, will present the user with those times to be able to book rooms to. For example, if you want users to be able to book a room at 3.15pm or 3.45pm, then you will need to define presented (Custom) periods to resolve to a ''quarter'' hour. If you wanted users to be able to book rooms only every ''half'' hour, then you would need to define custom periods in that way.

The required format for lists of times in the Custom periods box can be in am/pm format or 24-hour format. For am/pm, the following will work:

9.00am
9.30am
10.00am
10.30am

...etc.

Notice that there has to be a carriage return between each individual given time.

To save ''you'' time, you may wish to copy and paste from the lists below, extending or curtailing these earlier or later as required before pasting them in to your 'Custom Periods' box:

Half-hourly custom periods to paste into Custom periods box:

8.00am
8.30am
9.00am
9.30am
10.00am
10.30am
11.00am
11.30am
12.00pm
12.30pm
1.00pm
1.30pm
2.00pm
2.30pm
3.00pm
3.30pm
4.00pm
4.30pm
5.00pm
5.30pm
6.00pm
6.30pm
7.00pm
7.30pm
8.00pm
8.30pm
9.00pm

Quarter-hourly custom periods to paste into Custom periods box:

8.00am
8.15am
8.30am
8.45am
9.00am
9.15am
9.30am
9.45am
10.00am
10.15am
10.30am
10.45am
11.00am
11.15am
11.30am
11.45am
12.00pm
12.15pm
12.30pm
12.45pm
1.00pm
1.15pm
1.30pm
1.45pm
2.00pm
2.15pm
2.30pm
2.45pm
3.00pm
3.15pm
3.30pm
3.45pm
4.00pm
4.15pm
4.30pm
4.45pm
5.00pm
5.15pm
5.30pm
5.45pm
6.00pm
6.15pm
6.30pm
6.45pm
7.00pm
7.15pm
7.30pm
7.45pm
8.00pm
8.15pm
8.30pm
8.45pm
9.00pm

Alternatively, you might want to have rooms bookable to a resolution of 5-minute intervals etc.

----

'''Start of Week'''

Day you want your week to start, e.g. 'Monday'.

----

'''Length of week'''

The week can be curtailed, for example to exclude weekends. Do do this, set 'Start of week' (see above) to 'Monday' and 'Length of week' to '5'.

----

'''Date format'''

Choose how you want your dates to be displayed from the drop-down menu.

----

'''Time format'''

Choose how you want your times to be displayed from the drop-down menu.

----

'''Max. Rep Entries'''

It's possible for someone booking a room to repeat that booking (e.g. every day or every week). In this box you can set a limit on the number of repeats that someone booking a room could type in. The default is 365, which restricts a person to booking a room daily for the next year, or weekly for the next seven years (!) etc.

----

'''Maximum advance booking'''

If you want to stop users from booking rooms too many ''days'' in advance, then you can set a limit here. For example, typing in '7' would stop users from booking a room more than seven days in advance - the booking date would only become available seven days before.

To turn this feature off and allow users to book as far ahead of time as they like, type '-1' in the box.

----

'''Report span (days)'''

Default report span in days - This is the length of time in days that a report generated by MRBS covers. The default is '60' (approx. two months).

----

'''Search results per page'''

If you're searching for a booking, this limits the number of results displayed per page.

----

'''Show area list'''

In MRBS, an 'Area' is a category of room (NB not a Moodle category).

For example, if you ran a Science department comprising rooms used exclusively for Physics, Chemistry or Biology, then you could predefine three 'Areas': Physics, Chemistry and Biology. The Physics rooms (1, 2 and 3) would be named under the Physics Area, The Biology rooms (4, 5 & 6) under the Biology Area etc.

To book a room in MRBS's user interface, a user first selects an Area. In the MRBS user interface, the list of rooms ''for'' that area then becomes visible.

'Show area list' sets how you want the area list to display for users: 'List' shows a list. 'Select' will present users with a drop-down menu.

----

'''View monthly details'''

Entries in monthly view can be shown as start/end slot, brief description or both. Set to 'description' for brief description, 'slot' for time slot and 'both' for both. Default is 'both', but 6 entries per day are shown instead of 12.

----

'''View week number'''

To view weeks in the bottom as week numbers (42) instead of 'first day of the week' (13 Oct), set this to TRUE.

Display of weeks in the bottom of the MRBS user interface are handled by the '''trailer.php''' file.

----

'''Time right side'''

To display times on right side in day and week view, set to 'Yes'.

----

'''Javascript cursor'''

Change to 'false' if clients have old browsers incompatible with JavaScript.

----

'''Show plus link'''

Change to 'true' always to show the (+) link. The plus link is a small icon displaying a plus sign inside each bookable time cell.

----

'''Highlight method'''

Choose one of the highlight methods: bgcolor, class, or hybrid.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Default view'''

Define default starting view (month, week or day) - MRBS can show any of these three and they can be switched between.

----

'''Default room'''

Define default room to start with (used by index.php). Room numbers can be determined by looking at the 'Edit' or 'Delete' page URL for a room from the admin page.

----

'''Entry type A - J'''

Entry types is a way of defining purposes for room use. In this way, a user can book a room for a named class (e.g. 'Drama') and then indicate what ''kind'' of booked session that is going to be. For example:

• Lecture
• Lesson
• Seminar
• Tutorial
• Practice
• Private meeting
• Maintenance

etc.

While this function may seem useful, it may make MRBS seem unnecessarily complicated for users. Each entry type will appear on the MRBS timetable in a different colour (one per Entry type). Colours will define Entry type (Tutorial /Private meeting etc.) and not the subject of the class (e.g. English /Maths etc.)

The Entry type colours can be defined inside MRBS php files on the server.

----

'''Mail admin bookings'''

Send email to admin. notifying of a new booking. - Every time a booking is made, an email will be sent to the MRBS admin's email address as defined in the MRBS Admin email box (towards the top of the page).

----

'''Mail area admin'''

Send email to area admin notifying of a new booking. - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with particular Areas. - This would be useful for larger institutions.

See 'Mail admin email' above.

----

'''Mail room admin'''

Send email to room admin notifying of a new booking - This seems to be an as-yet undeveloped part of MRBS, as no boxes are provided to define separate email addresses for administrators associated with individual Rooms.

See 'Mail admin email' above.

----

'''Mail admin deletes'''

Sends an email to the admin notifying of room bookings having been deleted.

See 'Mail admin email' above.

----

'''Mail admin all'''

Sends an email to the MYBS administrator whenever any change is made by users to the MRBS system.

See 'Mail admin email' above.

----

'''Mail details'''

Mail details.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail scheduler'''

Send an email to the scheduler of a new booking.

THIS SECTION REQUIRES MORE DETAIL.

----

'''Mail from'''

Set the email address of the From field. Default is site admin.

This is the email address from which MRBS notification emails will be sent. It has to be associated with a Moodle user account.

----

'''Mail recipients'''

Set the recipient email. You can define more than one recipient like this 'john@doe.com,scott@tiger.com'. Recipient email(s) must be associated with a Moodle user account.

----

'''Mail cc'''

Set email address of the Carbon Copy field. Default is blank. Similar to mail recipients, you can define more than one recipient. All recipient emails must be associated with a Moodle user account.

----

'''Location of session import file'''

If you wish to use the automatic session import feature, enter the location of the file here. The file must be able to be moved by the webserver user. By entering a location, you will enable special booking types for imported bookings.

A session import file is a comma-separated value (CSV) file which can be uploaded by Moodle's automated scripts (cron) to import a timetable into MRBS. Details for how to do this are here:

https://docs.moodle.org/24/en/MRBS_block/import

Prepared CSV files made to populate the MRBS with (perhaps) an initial set of bookings, can be left in the folder located at the URL pasted into the 'Location of session import file' box. When the appropriate Moodle cron file runs, it will look in this location for a CSV file to implement.

Roles FAQ

2012-09-27T10:48:38Z

Francoisevans: /* Why do I not have my Course creator role when I also have a student role in my course? */

{{Roles}}
==What is the definition of a...==

;Capability
:A configurable aspect of program behavior. Moodle has 100s of capabilities. Each capability has a computer friendly name like [[Capabilities/mod/forum:rate|mod/forum:rate]] and a human-friendly name like "Rate posts."
;Permission
:Permissions are paired with each capability. There are four possible permission values: ''Allow'', ''Prevent'', ''Prohibit'' and ''Not set''/''Inherit''. (It is called not-set when defining roles and inherit when overriding permissions.)
;Role
:A named set of permissions that are associated with each capability. For example. the "Teacher" and "Student" roles come with the standard Moodle install.
;Context
:A functional area of Moodle. Contexts have a hierarchy. Examples of contexts include a course, activity module, or resource.

==Why isn't my role change taking effect?==

Certain capabilities e.g. [[Capabilities/moodle/user:changeownpassword|moodle/user:changeownpassword]] may only be applied in the system context, so giving such permissions by assigning a role in the course context will have no effect.

==My custom role will allow them to enroll others in a course, but only a "non" role==
Go to Site administration> User > Permissions > Define roles. Look at each of the "Allow" tabs and check the appropriate boxes.

==Why do I not have my Course creator role, when I also have a student role in my course?==
When you are assigned a role in a context,like a course, that role's permissions for every capability will take over in that context. You were probably given the course creator role in the system or category context, but then in the lower context of a course, you were enrolled as a student.

If you need to be a student a best practice is to create a phantom or test user, then enrol that user in the course as a student. Teachers and others who know the user name and password, can see the course from the student perspective.

On a deeper level, consider the "Master Teacher" who is made a teacher on the system level. If they are given a student role in a specific course, they "lose" many of their abilities to do things as a teacher in that course. However, it can get complicated when a student capability has a "Not set" permission and the teacher role has an "Allow" permission. Here the "student" maybe able to do things other students can not do. Thus the reason for the best practice mentioned above.

==Why do some users I know are in my course not appear in ''Participants''?==

Users assigned roles in a higher context, for example users assigned the role of teacher in the course category are technically not enrolled in the course and so will not appear in the Participants link in the [[Navigation block]] but can be found via ''Settings>Course administration>Users>Other users''

==When defining roles, what is the difference between Prevent and Not set?==

Short answer: "Not set" means whatever permission was in effect when the user entered the context is still in effect. "Prevent" do not allow this capability in this context.

Best practice: when defining roles, you almost always want to use Allow or Not set.

==Can you give me some examples about permissions?==
When you logged into the site you were given the system role of Authenticated User. You are also enrolled in a course and given the student role. Let's look at a single capability called X (the capability could be to create a blog) to see how permissions work.

In the example below we are just talking about the permissions for a single capability in the course role of a Student and the system role of Authenticated user for 1 user.

* If Student permission is '''Not set''', and Authenticated user permission is '''Not set''', then you are not allowed to do X.
* If Student is '''Not set''', and Authenticated user is '''Allow''', then you are allowed to do X.
* If Student is '''Prevent''' , and Authenticated user is '''Allow''', then you are not allowed to do X.
* If Student is '''Allow''', and Authenticated user is '''Prevent''', then you are allowed to do X.
* If Student is '''Prohibit''', and Authenticated user i '''Allow''', then you are not allowed to do X.
* If Student is '''Allow''', and Authenticated user is '''Prohibit''', then you are not allowed to do X.

==How can I prevent a user from changing their own password?==

To prevent a user from changing their own password, you must make sure they do not have [[Capabilities/moodle/user:changeownpassword|moodle/user:changeownpassword]] = Allow in the System context. The Authenticated user role (which is assigned to users in the System context) has moodle/user:changeownpassword = Allow by default, so you have two choices:
# Edit Authenticated user, setting moodle/user:changeownpassword = Not set
# Create a new role CannotChangeOwnPassword with moodle/user:changeownpassword = Prevent and all other permissions Not set. Choose "system" for the context type and assign the role to selected users in the System context via ''Settings>Site administration -> Users -> Permissions -> Assign system roles).'' Choice (1) will prevent ''all'' users from changing their passwords (except for the administrator, who can do anything). To selectively allow selected users (say teachers) to change their passwords, you could create a new role CanChangeOwnPassword with moodle/user:changeownpassword = Allow and all other permissions not set and assign the role to selected users in the System context (Site administration -> Users -> Permissions -> Assign system roles).

Choice (2) allows you to be selective, but if you have a lot of users that you want to prevent (say, all students), you will have to make a lot of role assignments in the System context. There is currently no convenient way to do this, so you might consider choice (1).

Note that you MUST deal with this permission in the System context.

==How can I prevent a user from editing their own profile?==

See [[Roles_FAQ#How can I prevent a user from changing their own password? | How can I prevent a user from changing their own password?]] The answer to this question is the same if you substitute ''edit their own profile'' for ''change their own password'' and ''[[Capabilities/moodle/user:editownprofile|moodle/user:editownprofile]]'' for ''moodle/user:changeownpassword.''

==Do roles have an inheritance relationship?==

No. Roles are completely independent.

* When you create a new role by copying an existing role, it is just like copying a file: the original and the copy are identical at the outset, but the copy has no ongoing relationship with the original. Changes to the original do not affect the copy and ''vice versa''.
* When you create a new role and select a value such as Role archetype:Student from the role archetype dropdown, you are not "inheriting" from the Student role. You are simply indicating that you want your role to have the same defaults as Student.
* Course creator does not "inherit" from Teacher (a common misconception). As with all roles, the two roles are completely independent. Course creator is actually a very simple role that can basically only create courses and not much else. However a user who creates a course can be automatically assigned the role of Teacher in the newly-created course (the default in site settings). This is how a course creator gets her teaching abilities within a course.
* Since roles are independent of each other, ordering roles at Site Administration > Users > Permissions > Define roles does not have any impact on capabilities or permissions. The only effect of ordering roles is how they are displayed in each context.
* When a Moodle site is upgraded with new capabilities, the "ARCHeTYPE" role determines the initial permissions for those new capabilities.

==How do I change the name for "teacher" in the course description?==

Either
* Edit the role of Teacher via ''Administration > Users > Permissions > Define roles'' and rename it. The new name will apply site-wide.
Or
* Create a duplicate teacher role with an alternative name and assign users the duplicate teacher role as appropriate in the course context. In ''Administration > Appearance > Course contact'' select the alternative name for teacher that you wish to be displayed in the course description when courses are listed. For example, copy the standard teacher role and call it Instructor and only show that role as the course contact.
Or
* Create a new "dummy" role (no capabilities) with those names and assign them to teachers along with the real roles. select the alternative name for teacher that you wish to be displayed in the course description when courses are listed. For example, copy the guest role, call it Lead Teacher and make this the course contact. You may have 5 teachers in the course but only one name will appear as Lead Teacher. If nobody is assigned the role Lead Teacher, no course contact will show.
Or
*Names for different roles in a course may be changed in the [[Course settings|Course administration > edit settings]] "Role renaming" fields. For example, some courses the teacher wants the title "Professor", or "Chief" or "Mentor".
Or
*[[Language customization|Edit the language files]] and change any word you want.

==How do I enable teachers to set role overrides?==

#Access ''Site administration > Users > Permissions > Define roles''.
#Edit the teacher role and change the capability [[Capabilities/moodle/role:safeoverride|moodle/role:safeoverride]] to allow.
#Click the button "Save changes".
#Click the tab "Allow role overrides" (in ''Site administration > Users > Permissions > Define roles'').
#Check the appropriate box(s) in the teacher row to set which role(s) teachers can override. Most likely it will just be the student role (you don't want teachers to be able to override admins!), so check the box where the teacher row intersects with the student column.
#Click the button "Save changes".

==How do I enable teachers to assign other teachers in a course?==

This is disabled by default but it can be switched on by modifying the teacher's role. In ''Siite administration > Users > Permissions > Define roles'' select the "Allow role assignments" tab and tick the checkbox where Teacher and Teacher intersect.

==Why doesn't "Switch role to.." within a course seem to work properly?==

This feature is intended for teachers so that they can see how their course appears for students. It isn't a reliable view however, as some features do not display correctly when viewed by a teacher who has switched their role to a student. For that reason it is always preferable where possible to have a "test" student log in to use.

==Are there any example roles?==

Yes, as follows:

*[[Parent role|Parent]] - for providing parents/mentors/tutors with permission to view certain information about their children/mentees/tutees
*[[Demo teacher role|Demo teacher]] - for providing a demonstration teacher account with a password which can't be changed
*[[Forum moderator role|Forum moderator]] - for providing a user with permission in a particular forum to edit or delete forum posts, split discussions and move discussions to other forums
*[[Calendar editor role|Calendar editor]] - for providing a user with permission to add site events to the calendar
*[[Blogger role|Blogger]] - for limiting blogging to specific users only
*[[Question creator role|Question creator]] - for enabling students to create questions for use in quizzes
*[[Course requester role]] - for restricting users who can make course requests

==Logged-in users can't read the site news. What can I do?==

See [[News forum]] for details.

==How do I enable logged-in users to participate in front page activities?==

Either:
#Access ''Site administration > Front Page > Users > Permissions> Assigned roles''
#Select the role you wish to add individual users to
#Select all or some of the users in the potential users list
#Use the left-facing arrow button to add them to the existing users list

Or:
#Access ''Site Administration > Front Page > Front Page settings''
#Set the default front page role to student.

:Note: Setting the default front page role to student is not sufficient to enable logged-in users to participate in a Front Page "Choice activity". A permissions override should be used instead.

==How do I copy a custom role from one Moodle site to another?==

In Moodle 1.9 it was possible using backup and restore, however this method does not work in Moodle 2.0 onwards. See MDL-30127 for further details.

==What is the difference between the capabilities moodle/role:override and moodle/role:safeoverride?==

The capability [[Capabilities/moodle/role:safeoverride|moodle/role:safeoverride]] was added to Moodle as a way of enabling teachers to [[Override permissions|override permissions]] safely. The capability moodle/role:override allows a user to override all permissions, whereas moodle/role:safeoverride only allows a user to override capabilities that do not have major risks attached to them.

==How can I prevent students from editing their profile?==

If you only want students to be prevented from editing their profile, and not all users, you can create a new role, such as Restricted user as described in the [[Demo teacher role]], with moodle/user:editownprofile set to prevent, and assign it to all students in the system context.

Alternatively, you could change moodle/user:editownprofile to not set for the [[Authenticated user role]], then create a new role for teachers with moodle/user:editownprofile set to allow.

==Why can't I add teachers or students site wide in Moodle?==

You can, but it is not best practice.

*Teachers and students typically work in one or more individual courses. It is unusual for a student to be studying every single course on your Moodle and unusual for a teacher to be teaching every single course. Therefore, the default Moodle does use these as system wide roles. The Manager role might be one that makes sense to assign on a system or category context.
#To assign a teacher or student sitewide, go to ''Settings>Site administration>Users>Permissions>Define roles'' and edit the role to include the ''system'' context.
#Then search for and allow the capability [[Capabilities/moodle/course:view|moodle/course:view]]
#Then assign users to this role via ''Settings>Site administration>Users>Permissions>Assign system roles''
*It might be preferable to create a new role based on the teacher or student and assign this in the System context. Then assign individuals to that role.

==How can I make a role available as a front page role?==

# Go to ''Settings > Site administration > Users > Permissions > Define roles'' and edit the role
# For 'Context types where this role may be assigned' tick the Course checkbox
# Scroll to the bottom of the page and click the 'Save changes' button

==What is a role archetype?==

See [[Creating custom roles]].

== See also ==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=6826 Roles and Capabilities forum]

[[Category:FAQ]]

[[de:Rollen FAQ]]
[[es:FAQ_roles]]
[[fr:FAQ des rôles]]
[[ja:ロールFAQ]]
[[ru:FAQ по ролям]]

Tags block

2012-09-03T22:04:15Z

Francoisevans:

{{Blocks}}A very effective way of viewing all [[Tags|tags]] is in a tags block, or "tag cloud".

A unique feature of tag clouds are that the size of each tag is related to the number of items associated with it. The larger the tag, the more items associated with it.

[[Image:Tag_Cloud2.png]]

==Adding a tags block to a course page==

#Click the "Turn editing on" button.
#Select tags from the Add blocks menu.
#If appropriate, move the tags block up and/or left, using the arrow icons under the block title.

The tags block may be configured via the edit icon in the block header.

==Site administration settings==

The tags block has one setting which may be changed by an administrator in ''Settings > Site administration > Plugins > Blocks > Tags''.

* Show course tags - This enables students to tag courses

==See also==

* [[Tags]]

[[Category:Tags]]
[[Category:Site administration]]

[[de:Schlagworte-Block]]
[[eu:Etiketak_blokea]]
[[fr:Bloc Tags]]