Using the Documentation

 

Overview

Aside from a few special cases, the articles contained within the user guide will follow certain conventions.  This is done to ensure that your experience with using the documentation is quick, easy, and consistent.

This article briefly explains what some of these conventions are, so as you begin to peruse the documentation, you are more acquainted with everything it has to offer.

 

Browser Requirements

There are many dynamic elements that are used within the documentation, such as the auto-populating table of contents, screenshot popups, and feedback/comment forms.

These items all use Javascript in order to run properly.  If you have Javascript disabled, then you may not be able to take advantage of these features.  (Most likely your Javascript is turned on, as many features of Campusuite itself requires it.)

If a Javascript error message is displayed directly below, than your Javascript support is disabled.  If this is the case, it is recommended that you enable it.

 

Article Organization

For the most part, articles will be broken down into the following format:

 

  • Title
  • Table of Contents
  • Overview/Introduction (this may be ommited if no sections/subsections are present)
  • Section/Topic #1
    • Subsection/Subtopic #1.1
    • ...
  • Section/Topic #2
  • ...

 

A page can have zero, one, or multiple sections/topics, and each of these can have zero, one, or more subsections/subtopics. The use of this kind of organization depends upon the size and amount of information on a page; very short articles will most likely not use these.

The Table of Contents will automatically populate in regards to the sections and subsections on the page. If no such items exist on the page, then the Table of Contents will be ommited.

The Overview is designed to give you a quick glimpse into a general topic or concept, whereas the sections/subsections are used to convey more specific information or how-to guides.

 

Types of Content

In general, you will find three types of content within this documentation: topics, how-to guides, and interface references.

 

Topics

Topics are usually longer pieces of content that explain or describe some concept within the system. For example, like the topic of the draft workflow. This content will most likely be written in more of a paragraph format, and may contain inline screenshots.

 

How-To Guides

The how-to guides are basically lists of steps that help walk you through some kind of task. They will make use of popup screenshots in order to save on length, as some how-to guides contain multiple screenshots per step.

 

Interface Descriptions

There are many user interfaces within Campusuite, some of which can be rather lengthy and daunting for new users. Each interface, such as the page editor dialogs or the forms used to create new entries for things like modules, has been well-documented. These references will include a labeled screenshot of the interface (as long as it is not too large), as well as detailed descriptions of the fields contained within the interface.

These references will be linked to as needed in the topics and the how-to guides.

 

Table of Contents

Most pages will display a Table of Contents at the top of the page, right underneath the article title.  The items in the Table of Contents are hyperlinks that point to anchors on the page.  Clicking one of this will quickly position you in the page at the respective section or subsection.

Items in the Table of Contents that appear more indented than the others are subsections of content.

 

Screenshots

In addition to describing topics and how to do tasks in writing, many articles contain a plethora of screenshots to help you.  Some of these screenshots are inline with text, and others will be opened in a popup after clicking one of these icons:


If Javascript is disabled, you will not see an icon; only those with Javascript enabled will be able to open and view these screenshots.

 

Comments and Feedback

Near the bottom of each page will be a link for sending us questions, comments, or feedback about an article.

If you feel an article could be improved, or are left more confused after reading a piece of documentation, feel free to use this link to send us your comments or concerns. Feedback from our customers and users is critical to provide quality documentation and support not only for one customer, but the entire Campusuite community.

We ask that you use this feature only to inform us of possible issues with the documentation. If you are in need of actual support, please use the contact support form to submit an actual support ticket.

This feature also makes use of Javascript, so if you have Javascript disabled, you can always just send us an email with your comments. Just be sure to specify somehow in the header that you are contacting us with comments concerning the documentation, and are not actually in need a support technician.