Widgets

 

Overview

Widgets extend the function of the Campus Suite platform. These components range from inserting email addresses into pages in a way that is protected from spam bots to inserting online media such as videos or image rotators. We add and refine widgets based on real customer requests. We take every request into consideration, but we can't implement all of them for various reasons ranging from security to technology that works on all platforms and browsers.

Listed below are an overview of the widgets available in Campus Suite 2.5. To request features, click here to add them to our requests database.

 

What a Widget Looks Like

When you add a widget to a page, its appearance may be confusing. Take for instance a simple email display widget:

Although this may not be very readable to humans, the widgets are made in this way since they are easily read and understood by the server.

When a page of your site is requested, the server will search the page for this widget markup, interpret it, and then compile the final result which is put into the page in place of the widget markup.

To break down the markup:

  • The  tells the server it came to a widget tag, and the  tells the server to stop processing a tag.
  • The display-email portion is the name of the widget being used.
  • The () enclose the different parameters the widget needs to render properly.
  • The data within the () is the properties used to fill in the widget details. This is a list of values separated by commas. Each widget uses a different numbers of parameters, so this data may consist of many different comma separated values, or it could just be one value.

After a widget is made, you can edit this tag directly to make changes. For instance, if one were to change the email address in the widget above, all that is needed is to replace the [email protected] with the other address. Some fields may not be very obvious as to what they are, like the yes in the middle of the parameter list in the example. If a widget is quite complex, you might find yourself having to re-insert the widget using its wizard with the updated parameters, and then simply delete the markup for the old one. 

It is very important to keep the markup for widgets well-formed. If the server cannot parse the widget, it will end up showing as text on your site. If you see that your widget markup has been incorrectly edited and you cannot seem to fix it, you will need to re-insert the widget onto the page.

Some parameters for widgets may take certain values over others. If this is the case, specifying an incorrect value for a parameter may result in the widget not being displayed properly, if at all, on the page.

Campus Suite will attempt to parse any instance of the  characters to begin processing a widget, even if they are not intended to be used as the start of a widget. Using double left brackets in your pages will cause server errors when you access the page, so it is best to avoid using them. (The instances of the double brackets on this page use a workaround, which is why no error occurs when the server attempts to process the page.)

 

Blog List

The Blog List widget displays a list of blog posts from the entire site or specific site group. See the example below.

blog list

Configuring the Blog List

When placing the Blog List widget on a page, the following options can be configured.

  • Select group to pull blogs from - Select a specific group or select all groups within the site to create the blog list from.
  • Number of blogs to show - Select the number of blogs posts to show in the list (ie. 1-10, 15, or 20).
  • Enhanced date display - If enabled a date box icon will be displayed to the left of each blog post listed.
  • Date location - Choose whether you would like the date displayed for each blog post listed above the title, below the title or turned off.
  • Label to show above entries - Enter a label/heading to be dsiplayed above your blog list (eg. My Blog List). Enter 'off' for no label/heading.
  • Image thumbnail - If enabled a thumbnail represented the blog will be displayed to the left of each blog post listed.
    Note: If a blog post is linked to a gallery, gallery is linked to a post (and not a image) and the post is being rendered to a page via the widget, it will show an "Image not available" placeholder.
  • Show preview - Should preview text show in the listing view?
  • Preview length - If "yes" to preview text, how many characters should show?
  • Select the tags to filter news releases by (optional) - You can use the blog widget to call only blogs that are tagged with a certain keyword.

 

Contact Directory

The contact directory widget needs no configuration. Simply drop it on to any page, and a mechanism will show that will allow people to search your directory by all or part of first and last name. Your public-facing departments will also be populated in a pull-down menu. If a department is selected, all the people in that department will show with their contact info. Click a person for detailed bio and contact info.

 

Digital Backpack

Some schools call it Virtual Backpack. The function allows schools to upload PDF's and other documents that may have been sent home with kids for their parents reviews. Since these documents sometimes don't make it home, parents can come view your digital backpack and download the original document (if you have made it available via the Digital Backpack on your website. Our support team can help you set this up and train you on how to use it, if needed.

digital backpack

Configuring Digital Backpack

When placing the Digital Backpack widget on a page, the following options can be configured.

  • Select the digital backpack lightbox. Any lightbox precedded with "DBP -" in front of it will be designated as a digital backpack. There is no limit to the number of categories.
  • Window size - Enter the number of days, weeks, months or years (Window type) of information to be displayed.
  • Window type - Select whether the information displayed is listed by days, weeks, months or years.
  • Show date - Select whether the dates is displayed on each item listed.

Customizing Digital Backpack

Coming soon.

Sticky

 

Event List

The Event List widget displays a list of event posts from the entire site or specific site group. See the example below.

Configuring the Event List

When placing the Event List widget on a page, the following options can be configured.

  • Select the group that the events will be pulled from.
  • Select if all or if a tagged events will be pulled. Select the tags to filter Event lists by if 'Featured' is selected.
  • Number of Events - Select All or any number up to 20.
  • If a heading should be shown above the entries. Default is 'off'.
  • Enhanced Date Display - Off or On. The default is 'Off'. If set to on, it will display the date of the event to the left of the event in a rectangle. Displaying the month and date of the event.
  • Select if a date should be shown and where. The default is 'off'. Options available are off, top and bottom.

Faculty List

The Faculty List widget displays a list of the faculty from the entire site or specific site group. See the example below.

Configuring the Faculty List

When placing the Faculty List widget on a page, the following options can be configured.

  • Select the group that the faculty will be pulled from.
  • Enter the heading to show above entries. The default is 'none' for no label.
  • If a heading should be shown above the entries. Default is 'off'.
  • Select the tags to filter faculty by (optional) - You can tell the blog widget to call only faculty that are tagged with a certain keyword.
  • Select if you want to include teachers. Default is set to 'true'.
  • Select if you want to organize the results by departments or not. The default is 'false' so only one list is shown.

Ordering the Faculty List

To organize the Faculty under a specific department, there are two methods.

Publishers: Publishers can only manage the faculty in a department that have access to manage. They will do this while on the faculty module in the public view. While logged in, the publisher can see sequence arrows pointing up and down. They can click these arrows to move specific records up or down.

Administrators: Administrators can manage faculty the same way as publishers, but they have additional access from the main dashboard. Administrators will see a Depts/Users tab at the top of their dashboard. Under this tab, all the departments in Campus Suite are listed. Next to each department, there are several buttons to manage various actions to that specific department. The Organize button will allow an admin drag and drop functionality to move faculty up or down to order them. In addition, there is a Alphabetize button that will automatically sort all records into alphabetical order by their last name. After ordering, you must click Save.

 

Feature Slider

More information coming soon. See the example below.

feature slider

Configuring the Feature Slider

When placing the Feature Slider widget on a page, the following options can be configured.

Also please watch the video "Add additional banners to home page rotation"  that reviews how to add additional banners to the rotation.

  • Select group that hold banner files - Select the site group (pages) from which to pull the banners/slides for the slider.
  • Common prefix of banner files - Set the prefix for the set of banners/slides (eg. 'Home-Feature-' will pull all banners with this prefix from the selected group).
  • Display Order (1-2-3) - Set the order of the banners selected.

Customizing the Feature Slider

Coming soon.

 

Flex Slider

More information coming soon. See the example below.

flex slider

Configuring the Flex Slider

When placing the Flex Slider widget on a page, the following options can be configured.

Also please watch the video "Add additional banners to home page rotation"  that reviews how to add additional banners to the rotation.

  • Select group that hold banner files - Select the site group (pages) from which to pull the banners/slides for the slider.
  • Common prefix of banner files - Set the prefix for the set of banners/slides (eg. 'Home-Flex-' will pull all banners with this prefix from the selected group).
  • Display Order (1-2-3) - Set the order of the banners selected.

Customizing the Flex Slider

 

Gallery Embed

The Gallery Embed widget embeds a gallery, which is selected, onto the page. See the example below.

Configuring the Gallery Embed

When placing the Gallery Embed widget on a page, the following options can be configured.

  • Select the gallery you want to embed.
  • Choose the number of photos you want to display. Default is set to 6.
  • Select if you want to display the gallery title.
  • Decide if you want to display the gallery description or not.
  • Choose if you want to display the image titles.
  • Select if you want to display the image description.

 

Gallery List

The Gallery List widget displays a list of galleries from the entire site or specific site group. See the example below. Note: This widget is being updated for use in Campus Suite 2.5. Please do not use at this time.

Configuring the Gallery List

When placing the Gallery List widget on a page, the following options can be configured.

  • Select the group that the Gallery List will be pulled from. The default is All galleries.
  • Select the tags to filter gallery by (optional) - You can tell the Gallery List widget to call only galleries that are tagged with a certain keyword.
  • Gallery type -  Default is 'any'. The options are Any, Only Image galleries and Only Video Galleries.
  • Enter the headline/title for the widget (optional) - Entered text will be displayed above the calendar.
  • Select if you want a title shown. This displays the title of the gallery if selected
  • Decide if you want a description to be shown. This displays a description of the gallery if selected.
  • Select if you want to show a link. If selected a link  will be shown that goes to the gallery.
  • Choose an image limit. Default is none. The options are none and 1 through 4.

 

Google Translate

More information coming soon.

google translate

Configuring Google Translate

Nothing to configure.

Customizing Google Translate

Nothing to customize.

 

Graphical Calendar

More information coming soon. See the example below.

graphical calendar

Configuring the Graphical Calendar

When placing the Graphical Calendar widget on a page, the following options can be configured.

  • Select the group that the events will be pulled from.
  • Select the tags to filter the evens by - (optional).
  • Select if you want to show details - (optional). By default it is set to Yes..
  • Choose the limit number of events to show - optional. Select All or any number up to 7.
  • Enter the CSS classes to append to container - (optional).
  • Enter a Headline/title for the widget - optional. Entered text will be displayed above the calendar.

 

News List

Pulls events as configured. See the example below.

news list

Configuring the News List

When placing the News List widget on a page, the following options can be configured.

  • Select the group that the News List will be pulled from. The default is to show ALL News.
  • Select the news by type; All, featured or by specific tags. If you enter tags it can be tagged 'New' or select from the ones that are displayed.
  • Choose the the number of new releases that you would like to show. Default is all, but you can choose between one and twenty.
  • Enter the heading that you would like to show above the entries. The default is "off" for no label.
  • Enhanced Date Display - Off or On. The default is 'Off'. If set to on, it will display the date of the event to the left of the event in a rectangle. Displaying the month and date of the event.
  • Date location - The default is off for no date, but top and bottom are also available.
  • Select if you want teaser text or not. - this is the text shown below the name of the event and date in the above example. The default is off.
  • Select if you want an image thumbnail by default it is set to off.

Customizing the News List

Coming soon.

 

Past Events List

Works just like the events list widget, however, only shows events that have already passed. See the example below.

Configuring the Past Events List

When placing the Past Events List widget on a page, the following options can be configured.

  • Select the group that the Events will be pulled from. The default is to show ALL News.
  • Select the news by type; All, featured or by specific tags. If you enter tags it can be tagged 'New' or select from the ones that are displayed.
  • Choose the the number of events that you would like to show. Default is all, but you can choose between one and twenty.
  • Enter the heading that you would like to show above the entries. The default is "off" for no label.
  • Enhanced Date Display - Off or On. The default is 'Off'. If set to on, it will display the date of the event to the left of the event in a rectangle. Displaying the month and date of the event.
  • Select the Date location. The default is off for no date, but top and bottom are also available.
  • Choose how you want to the list to be sorted, Descending (default) or Ascending.

Customizing the Past Events List

Coming soon.

 

Teacher List

Displays a list of teachers with teacher sites from a given school (or the whole site). See the example below.

teacher list

Configuring the Teacher List

When placing the Teacher List widget on a page, the following options can be configured.

  • Select the school to pull the teachers from. The default is All Departments
  • Enter the heading that you would like to show above the entries. The default is "none" for no heading.
  • Select the tag to filter faculty by (optional).
  • Choose if you want to organize the result by departments or not. The default is "false" to show all in one list.

 

Video Embed

Allows a user to embed a video code snippet from places like Vimeo, YouTube, etc. onto a page. See the example below.

video embed

Configuring the Video Embed

When placing the Video Embed widget on a page, you must have the snippet of the video from the video service that is hosting the video.

Customizing the Video Embed

Coming soon.