Access Keys:
Skip to content (Access Key - 0)

Filters Manual

The most recent documentation for Moodle/Joule 2 has moved.

Please go to http://kb.moodlerooms.com to view the New Knowledge Base.

Table of Contents

1. Coursename Filter

1.1. Overview

The Coursename filter allows you to create a custom course program overview, allowing the Moodler insight into future classes & instant access once they are enrolled or if guest access is enabled. The filter works by translating the course shortname into a clickable link or button, with the option of adding that course's summary or section overview.

1.2. User Documentation

The Coursename filter replaces strings starting with SN_ and ending with _CN in any HTML area with the information from the course and a link based on the course shortname provided.

The Coursename filter can display 10 pieces of information about a course:

  1. Fullname link
  2. Shortname link
  3. Link to course with custom text
  4. Button link to course with custom text
  5. Sections link
  6. Summary
  7. Cost
  8. Completion Bar (Unlocked Pages/Total Pages) (flex page only)
  9. Completion Percentage (Unlocked Pages/Total Pages) (flex page only)
  10. Completion Enrollment Days Left

1.2.1. Fullname Link

Displays the course's full name as a clickable link

1.2.1.1. Filter Structure

CN_fullname_<course shortname>_CN

1.2.1.2. Example

CN_fullname_CF101_CN

1.2.2. Shortname Link

Displays the course's short name as a clickable link.

1.2.2.1. Filter Structure

CN_shortname_<course shortname>_CN

1.2.2.2. Example

CN_shortname_CF101_CN

1.2.3. Link to course with custom text

Displays whatever text you determine as a direct link to the course.

1.2.3.1. Filter Structure

CN_link_<course shortname>_<Your Text Here>_CN

1.2.3.2. Example

CN_link_CF101_Your Text Here_CN

1.2.4. Button link to course with custom text

Displays whatever text you determine as a button link to that course.

1.2.4.1. Filter Structure

CN_button_<course shortname>_<Your Text Here>_CN

1.2.4.2. Example

CN_button_CF101_Your Text Here_CN

1.2.5. Sections Link

Displays the sections/topics of the course as clickable links.

1.2.5.1. Filter Structure

CN_sections_<course shortname>_CN

1.2.5.2. Example

CN_sections_CF101_CN

1.2.6. Summary

Displays the course summary.

1.2.6.1. Filter Structure

CN_summary_<course shortname>_CN

1.2.6.2. Example

CN_summary_CF101_CN

1.2.7. Cost

Displays the cost of the course.

1.2.7.1. Filter Structure

CN_cost_<course shortname>_CN

1.2.7.2. Example

CN_cost_CF101_CN

1.2.8. Completion Bar (Unlocked Pages/Total Pages)

Displays a horizontal progress bar that can be styled via CSS to look how you want. The bar's width is determined by the number of flex pages in a course that are unlocked for the user.

1.2.8.1. Filter Structure

CN_comppagebar_<course shortname>_CN

1.2.8.2. Example

CN_comppagebar_CF101_CN

1.2.9. Completion Percentage (Unlocked Pages/Total Pages)

Displays a percentage value that is determined by the number of flex pages in a course that are unlocked for the user.

1.2.9.1. Filter Structure

CN_comppageperc_<course shortname>_CN

1.2.9.2. Example

CN_comppageperc_CF101_CN

1.2.10. Completion Enrollment Days Left

Displays the number of days that the user has left for their enrollment in the course based on the users enrollment end date. It displays Unlimited if the user doesn't have an enrollment end date.

1.2.10.1. Filter Structure

CN_daysleft_<course shortname>_CN

1.2.10.2. Example

CN_daysleft_CF101_CN

1.3. Administrator Documentation

1.3.1. Enabling Coursename Filter

  1. Click the eye icon next to the Coursename filter in Site Administration > Activities > Filters > Manage Filters
  2. Click the settings link to the right of the eye icon for the Coursename filter and fill in the settings

1.4. Global Settings

  • Show section zero: Display the Topic 0 when listing the sections using the CN_sections filter. Default: Yes
  • Show Blank Sections: Show sections with no content in the summary when using the CN_sections filter. Default: No

2. Screen Steps Filter

2.1. Overview

The ScreenSteps filter was developed to integrate with hosted Web sites provided to ScreenSteps clients. The filter will display spaces, manuals, buckets and lessons from the site inline wherever the filtered string is found. This is useful for rapidly developing step-by-step how-to instructions to include within a user's course.

2.2. User Documentation

The ScreenSteps filter replaces strings starting with SS_ and ending with _SS in any HTML area with the information from the ScreenSteps Web site (if found).

The ScreenSteps filter has 6 types of filter strings:

  1. Manual spaces
  2. Bucket spaces
  3. Manuals
  4. Buckets
  5. Manual lesson steps
  6. Bucket lesson steps
Warning on Naming
The ScreenSteps filter does not work with buckets, manuals or lessons that have underscores (_) in their name. The underscore is used by the filter to separate different variables that it needs in order to determine what to return and display.

2.2.1. Spaces

This use of the filter displays a listing of all manuals and buckets that exist in the space and links to the ScreenSteps-hosted page for each manual or bucket.

2.2.1.1. Filter Structure

SS_space_<space name>_SS

2.2.1.2. Example

*filter:*SS_space_steps_SS
URL: http://clickables.moodlerooms.com/spaces/steps

2.2.2. Manual

This use of the filter displays all chapters and all of their lessons with links to the ScreenSteps-hosted page for each lesson in the manual.

2.2.2.1. Filter Structure

SS_manual_<space name>_<manual name>_SS

2.2.2.2. Example

filter: SS_manual_steps_joule_SS
URL: http://clickables.moodlerooms.com/spaces/steps/manuals/joule/

2.2.3. Bucket

This use of the filter displays links to the ScreenSteps-hosted page for all of the lessons within the bucket manual.

2.2.3.1. Filter Structure

SS_bucket_<space name>_<bucket name>_SS

2.2.3.2. Example

filter: SS_bucket_employees_employeestuff_SS
URL: http://bmls.screenstepslive.com/spaces/employees/buckets/employeestuff

2.2.4. Lesson Steps

These filters are used to display the actual ScreenSteps lesson, which will display the actual how-to instructions.

2.2.4.1. Manual Lesson Steps

User this filter if you are looking to display the steps in a lesson from a manual.

2.2.4.1.1. Filter Structure

SS_mlesson_<space name><manual name><lesson name>_SS

2.2.4.1.2. Example

filter: SS_mlesson_steps_joule_12302-Can-I-view-a-sample-of-a-course-organized-by-type-_SS
URL: http://clickables.moodlerooms.com/spaces/steps/manuals/joule/lessons/12302-Can-I-view-a-sample-of-a-course-organized-by-type-

2.2.4.2. Bucket Lesson Steps
2.2.4.2.1. Filter Structure

SS_blesson_<space name><bucket name><lesson name>_SS

2.2.4.2.2. Example

filter: SS_blesson_employees_employeestuff_5543-Adding-Messages-to-Highrise-via-Email_SS
URL: http://bmls.screenstepslive.com/spaces/employees/buckets/employeestuff/lessons/5543-Adding-Messages-to-Highrise-via-Email

2.3. Administrator Documentation

2.3.1. Enabling ScreenSteps Filter

  1. Click the eye icon next to the ScreenSteps filter in Site Administration > Activities > Filters > Manage Filters
  2. Click the settings link to the right of the eye icon for the ScreenSteps filter and fill in the settings

2.4. Global Settings

  • URL: The URL to your ScreenSteps instance without the http:// or the trailing / ex: clickables.moodlerooms.com
  • User Name: A ScreenSteps account with access to view all the ScreenSteps you want to link to, usually an administrative account
  • Password: Password for the account on the ScreenSteps site

3. Product Manual Terms of Use

Permission for the use of Product Manual is granted subject to the following terms and conditions:

By accessing this page and using this manual, you agree to and are bound by the terms of this Terms of Use. If you do not agree to all of the terms and conditions contained in the Terms of Use, you are not authorized to use this page or these documents.

In using Product Manual, you agree that you will use them only for their intended purpose and not use them for any purpose that is unlawful or prohibited by these terms. You may not misuse or alter any document in any way, including any derivative work, or reproduce or display these documents outside your enterprise without the express written consent of Moodlerooms.

Except as expressly granted in the Terms of Use, no other permissions, licenses or rights are granted, either express or implied, to the Product Manual, or to any information, data, software or other intellectual property contained therein.

Moodlerooms reserves the right to withdraw the permissions granted herein whenever, in its sole discretion, the use of the Product Manual is detrimental to its interest or, as determined by Moodlerooms, the instructions contained herein are not being properly followed.

Moodlerooms makes no guarantee about the content of the Product Manual. Use of the Product Manual is at your own risk. They are provided “as is” and without warranty of any kind, either express or implied, including, but not limited to implied warranties of merchantability, non-infringement and fitness for a particular purpose.

The Content, Software, Services and all other aspects of this web site are subject to these Terms of Use. Moodlerooms reserves the right to update these Terms of Use at any time without notice to you. The applicable and most current version of the Terms of Use can be reviewed by clicking on the “Terms of Use” hypertext link located at the bottom of our web pages.

Your Rating: Results: PatheticBadOKGoodOutstanding! 3 rates
Adaptavist Theme Builder Powered by Atlassian Confluence