The TABLE tag displays a table with customizable formatting, header text, columns and order of records. These customizations are made within the tag itself and are not editable by the web user within the web interface to re-order requests or remove items from the table.
An example of how this tag would display in the HTML:
<#TABLE class="instructor-table" name="Item" id="ItemTable" type="CourseItems" headerText="Reserve Items" LinkType="ItemInfo" AllowRowClick="Yes" LinkColumn="BothTitlesIcon" AllowJavascriptHover="Yes" column="ItemID:ID" column="BothTitlesIcon:Title" column="Author:Author" column="inactiveDate:Inactive" column="CurrentStatus:Status" column="Tags:Tags" NoDataAction="ShowMessage" NoDataMessage="There are no items in this course." allowsort="true">
Attributes Applicable to any TABLE Tag
Name | The type of table that will be generated. Possible options are AuthorizedUsers, CloneInstructors, CloneItems, Course, CourseCrossList, CourseImport, CourseUsage, CourseValidation, Item, ItemHistory, ItemNonUsage, ItemNotes, ItemRestriction, ItemTracking, ItemUsage, MessageBoard, MessageBoradThread, NotificationInformation, Proxy, SharedList, SharedListItem, StudentList, ViewNotifications |
---|---|
ID | The ID value for the table. |
HeaderText | Header text to be displayed at the top of the table spanning all columns. |
FooterText | Footer text to be displayed at the bottom of the table spanning all columns. |
NoDataAction | Indicates how the table should be generated in the event there is no data. There are 3 possible options, ShowMessageRow, ShowEmptyTable, and ShowNone. |
NoDataMessage | The text that is displayed when a table has no data to display and NoDataAction is set to ShowMessageRow. |
AllowJSHover | Enables a JavaScript hover effect for the data row. |
HideColumnHeaders | The header row for columns that shows the column label will not be be generated if this is set to true. There are 2 possible options, true and false. |
Class | The CSS class to apply to the table. |
LegacyStyle | Tables have a border set to 1 and cellpadding set to 2. This is considered obsolete and CSS should be used to mimic the same behavior. There are 2 possible options, true and false. If not specified, this value defaults to false. |
ShowMessageRow | Displays text that spans all columns. The text that is displayed is set using the NoDataMessage parameter. |
ShowEmptyTable | The base table and all columns will display but there will be no rows created and no message will be displayed. |
ShowNone | If the value provided for NoDataAction is not a valid option it is treated as if it was ShowNone. The table will not be generated. |
Column | Individual columns from the table results can be included that overrides the default display. If the table tag has any columns explicitly set, all columns must be explicitly set that wish to be displayed. If no columns are specified the default columns listed for each table will be used. The column attribute can be added for as many columns that need to be displayed. Default columns will only be display if no column attributes are defined. The values for the column can contain the field or a field and label. If only a field is specified, it will be used as the column header if HideColumnHeaders is set to false. Labels can be specified by appending a colon (:) and adding any label that should be used in the column header. |
IconColumn |
Specifies the column in which to display item icons. May be used instead of the BothTitlesIcon and BothTitlesViewedIcon special columns. See Creating Item Tables with Icons for more information. |
IconAlign |
Valid values are “Left” (default) and “Right”. When IconColumn is specified, controls the alignment of the icon within the table cell. See Creating Item Tables with Icons for more information. |
IconStyle |
Valid values are “Icon” (default) and “IconViewed”. When IconColumn is specified and when viewed in a student context, will control whether or not to display the “New” icon next to the regular item icon if the student has not yet viewed an item. See Creating Item Tables with Icons for more information. |
Ares Web Tables
AuthorizedUsers
This table will display all students in a course.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE Name="AuthorizedUsers" headerText="Authorized Users" class="instructor-table-nohover" NoDataMessage="There are currently no students in this course." NoDataAction="ShowMessage" orderBy="LastName">
CloneInstructors
Displays instructors that may be cloned along with a course.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="CloneInstructors" id="CloneInstructors" class="instructor-table-nohover" headerText="Proxy Instructors to Clone" />
CloneItems
Displays item available to be cloned.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="CloneItems" id="CloneItems" class="instructor-table-nohover" headerText="Reserve Materials to Clone" IncludeSharedListRelationship="Conditionally" IncludeJavascriptCalendar="Yes" calendarText="<img src='images/cal.gif' alt='Open Calendar'/>"/>
Course
Displays a table containing courses.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
The Course table includes CSS classes for the following action link(s):
- view-course
- import-items-course
- import-items-sharedlist
- add-course
CourseCrossList
Displays courses that are cross listed.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="CourseCrossList" class="xlist-table" HideColumnHeaders="True" column="CourseNumber" headerText="This course is also cross-listed as the following:" NoDataAction="ShowNothing"/>
The CourseCrossList table includes CSS classes for the following action link(s):
- remove-crosslist
CourseImport
Displays a listing of all courses eligible for import.
Course Import is a legacy tag. Please see suggested alternative coding below in the 'Recommended Changes'.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="Course" class="instructor-table filterTable" Type="Import" headerText="Current and Previous Courses" LimitRecentMonths="2" Session="PreviousOrCurrent" Role="Instructor" column="Semester:Semester" column="CourseNumber:Course" column="CourseCode:Course Code" column="Name:Name" column="ReserveItems:Reserve Items" NoDataAction="ShowMessage" NoDataMessage="No courses found." orderby="C.StopDate DESC,C.CourseNumber ASC">
<#TABLE name="Course" class="instructor-table" Type="Import" AllowRowClick="Yes" headerText="Current and Previous Courses" LimitRecentMonths="2" AllowJavascriptHover="True" Session="PreviousOrCurrent" Role="Instructor" column="Semester:Semester" column="CourseNumber:Course" column="CourseCode:Section Number" column="Name:Name" column="ReserveItems:Reserve Items" NoDataAction="ShowMessage" NoDataMessage="No courses found." orderby="C.StopDate DESC,C.CourseNumber ASC">
CourseUsage
Displays the number of viewings of an item within a course.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE Name="CourseUsage" class="instructor-table-nohover" AllowJavascriptHover="False" AllowSort="True" NoDataMessage="No items have been viewed yet." NoDataAction="ShowMessage" ShowDetailLink="True" DetailLinkText="Show Detailed Usage">
The CourseUsage table includes CSS classes for the following action link(s):
- view-usage
CourseValidation
Displays the contents of the CourseValidation table.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
The CourseValidation table includes CSS classes for the following action link(s):
- create-course
Item
Displays a table of items
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="Item" id="ItemTable" class="instructor-table" type="CourseItems" headerText="Reserve Items" LinkType="ItemInfo" AllowRowClick="Yes" LinkColumn="BothTitlesIcon" AllowJavascriptHover="Yes" column="ItemID:ID" column="BothTitlesIcon:Title" column="Author:Author" column="inactiveDate:Inactive" column="CurrentStatus:Status" column="Tags:Tags" NoDataAction="ShowMessage" NoDataMessage="There are no items in this course." allowsort="true">
The Item table includes CSS classes for the following action link(s):
- view-item-detail
- view-item-content
- edit-item
ItemHistory
Displays the item history.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="ItemHistory" class="instructor-table-nohover" headerText="History" noDataAction="ShowMessage" noDataMessage="No History Information" column="DateTime:Date" column="Entry:Entry">
ItemNonUsage
Displays a listing of students who have not viewed an item.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE Name="ItemNonUsage" class="instructor-table-nohover" headerText="Students who did not view this item" AllowJavascriptHover="False" AllowSort="Yes" NoDataMessage="All Students viewed this item." NoDataAction="ShowMessage" AllowSort="True" orderBy="LastName,FirstName,UsageCount DESC">
ItemNotes
Displays a listing of ItemNotes.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="ItemNotes" class="instructor-table-nohover" headerText="Notes" noDataAction="ShowMessage" noDataMessage="No Notes" column="Note" column="AddedBy" column="NoteDate" column="NoteType" ExcludeNoteTypes="Staff,Copyright">
ItemRestrictions
Displays a listing of ItemRestrictions.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="ItemRestrictions" class="instructor-table" courseChoice="one" headerText="Reserve Restrictions" IncludeJavascriptCalendar="Yes" calendarText="<img src='images/cal.gif' alt='Open Calendar'/>"/>
ItemTracking
Displays a listing of ItemTracking entries.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="ItemTracking" class="instructor-table-nohover" headerText="Tracking" noDataAction="ShowMessage" noDataMessage="No Tacking information" column="TrackingDateTime:Date" column="Status:Status">
ItemUsage
Displays ItemUsage information. Anonymous usage is controlled by the customization key AnonymousUsageStatistics.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE Name="ItemUsage" class="instructor-table-nohover" headerText="Detailed Reserve Usage" AllowJavascriptHover="False" AllowSort="Yes" NoDataMessage="This item has not been viewed." NoDataAction="ShowMessage" AllowSort="True" orderBy="LastName,FirstName,UsageCount DESC">
MessageBoard
Lists the various threads of a message board.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="MessageBoard" class="student-table" headerText="Message Board" AllowRowClick="Yes" LinkColumn="Title" AllowJavascriptHover="Yes" NoDataAction="ShowMessage" NoDataMessage="There are no messages yet.">
The MessageBoard table includes CSS classes for the following action link(s):
- view-thread
MessageBoardThread
Displays all posts within a message board thread.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="MessageBoardThread" class="student-table" headerText="Previous messages in thread" NoDataAction="ShowNothing">
NotificationInformation
Displays information about email messages
Default Columns | Special Columns | Additional Parameters |
---|---|---|
If no fields are specified, Subject, EmailDate, and Body will be used. |
|
|
<#TABLE name="NotificationInformation" headerText="Notification Information" hideColumnHeaders="true" field="Item:Reserve Item" field="EmailFrom:From" field="EmailDate:Date" field="Subject:Subject" field="Body:Body">
Proxy
Displays proxy instructors associated with a course.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE Name="Proxy" headerText="Proxy Users" class="instructor-table" DeleteText="Remove" Type="Course" HideColumnHeaders="True" column="DeleteUsernameFirstnameLastname:Name" NoDataMessage="You currently have no course proxy users assigned." NoDataAction="ShowMessage">
SharedList
Displays a list of available Shared Lists.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="SharedList" class="instructor-table" AllowRowClick="Yes" headerText="Instructor Shared Lists" LinkColumn="ListID" AllowJavascriptHover="True" ListType="Instructor" column="ListID:List ID" column="ListName:List Name" column="ListReference:Instructor Name" NoDataAction="ShowMessage" NoDataMessage="No Shared Lists found.">
The SharedList table includes CSS classes for the following action link(s):
- view-list-details
- import-items-sharedlist
SharedListItem
Displays a table of shared list items
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="SharedListItem" class="instructor-table" id="SharedListItemTable" headerText="List Items" LinkType="ItemInfo" AllowRowClick="Yes" LinkColumn="BothTitlesIcon" allowJavascriptHover="Yes" column="ListItemID:ID" column="BothTitlesIcon:Title" column="Author:Author" NoDataAction="ShowMessage" NoDataMessage="There are no items in this shared list." allowsort="true">
The SharedListItem table includes CSS classes for the following action link(s):
- view-shared-item-detail
- view-shared-item-content
- edit-shared-item
SharedListItemRestrictions
This will display a listing of Shared Lists that an Item can be added to. This tag will work on Item request forms where the Type=16 (the ISLRF request forms). This table tag is very similar to the ItemRestrictions tag. It can be used to select multiple Shared Lists to add an Item to (such as on the OpenURL request forms). It can also be used on the regular request forms as a reminder of which Shared List they are about to add the Items too if they change the SharedListChoice parameter to "One". This is similar to how the regular IRF request forms work where a single course is shown. When a new Item is added to a single Shared List, the DLL will redisplay the Shared List home page. If the Item is being added to multiple Shared Lists, the DLL will redirect back to the Ares main page.
This only applies to Instructors or their Full Proxies. Course proxies will not be able to see the Shared Lists since they normally don't have permissions to add Items to Shared Lists.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE class="instructor-table" name="SharedListItemRestrictions" headerText="Shared Lists" />
StudentList
Displays a list of students enrolled in a course.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE Name="StudentList" Id="StudentList" headerText="Students" class="instructor-table-nohover" NoDataMessage="You currently have no students enrolled." NoDataAction="ShowMessage" allowsort="true">
ViewNotifications
Displays a table of email notifications.
Default Columns | Special Columns | Additional Parameters |
---|---|---|
|
|
|
<#TABLE name="ViewNotifications" class="instructor-table-nohover" EmailType="Item" headerText="Notifications" noDataAction="ShowMessage" noDataMessage="No Notifications">