Child pages
  • End User Guide Creation and Maintenance

This space has moved to IU's Confluence.
It is located at https://uisapp2.iu.edu/confluence-prd/display/iulV3/

Skip to end of metadata
Go to start of metadata

End User Guide

How to create and maintain web based end user guide provided with variations

About

The End User Guide provided with the server install includes all of the elements needed to create and maintain a web based user guide. The guide includes a number of web pages already created a populated with content about using variations. The guide also contains a number of page that are either blank or require updates to include more institution specific material (e.g., the home page). To see what a fully implemented user guide looks like, you can view the Indiana University Variations User Guide.

While test sites are encouraged to add content and update these pages, the site was developed so that the variations development team could send updated content and new pages to test site. Therefore some pages should not be updated or changed to maintain consistency (exact pages will be noted later).

Each Test site may change the style (color, fonts, logos) through the modification of the server side includes and the CSS files.

Elements

Server Side Includes

Each page has utilizes three server side includes to control the header, navigation, and footer. The use of these includes allows for greater flexibility for each test site to customize the logos, and header styles of each page while maintaining a consistent page structure.

File Name

Description

header.shtml

Header File

nav.shtml

Left Navigation File

footer.shtml

Footer File

CSS

Aside from producing the styles of the page the css files help control the images shown on each page. Through the use of a JavaScript style switcher users are able to change the images so that instructional pictures can be changed to display either Mac or PC images. The user can also switch to a printing view which optimized the layout and positioning for ease of printing.

File Name

Description

mac.css

Style Sheet for Mac Users

pc.css

Style Sheet for PC Users

print_mac.css

Printing Style Sheet for Mac Users

print_pc.css

Printing Style Sheet for PC users

JavaScript

The style switcher is used to switch between the different stylesheets. While the default style for a page is the PC version the script utilizes cookies to allow keep users style selections similar each time they visit a site.

File Name

Description

Styleswitch.js

JavaScript used for Switching between Style Sheets

Important Tags

The use of the 4 tags listed below allows for web site administrators to control how images and content are viewed. As an example when a website administrator adds a new picture to a page they must decide if an image should be viewable by mac user by adding the tag mac, pc users by adding the tag pc or both by not tagging the image at all. Each of these are defined classes references from the style sheet.

Tag Name

Description

mac

visible when the Mac Style is selected

pc

visible when the PC Style is selected

mac_print

visible when Mac Printing Style is selected

pc_print

visible when PC Printing Style is selected

Content Creation and Editing

The searching page was commented out of the navigation in Variations 6.0 to coincide with the replacement of the search window with the welcome window in the default configuration. You may want to uncomment the search page and put in instructions on searching for Variations content at your own institution, e.g., by OPAC or reserves list.

This is a list of the page names and file names and their editing status. Pages that "Require Editing" need to be updated or have content added to them. Pages that "May Require Editing" do not need to be edited but can be modified. Pages that have a "Do Not Edit" should not be changed in order to be consistent with updates.

Page Name

File Name

Editing Status

Home

index.html

Requires Editing

Where to find it

where.html

Requires Editing

download it

download.html

Requires Editing

samples

samples.html

Requires Editing

Ask for help

support.html

Requires Editing

Known Problems

problems.html

May Require Editing

Legal Notices

legal.html

Requires Editing

Access Rules

access.html

Requires Editing

Logging In

login.html

May Require Editing

Audio Player

listen.html

Do Not Edit

Score Viewer

scores.html

Do Not Edit

Bookmarking

bookmarks.html

Do Not Edit

Annotation Tools

annotate.html

Do Not Edit

Timeline Tool

timelines.html

Do Not Edit

Score with Audio

opus.html

Do Not Edit

Playlist

playlist.html

Do Not Edit

Listening Drill

drill.html

Do Not Edit

Details Feature

detailshelp.html

Do Not Edit

Footer

footer.shtml

Requires Editing

Header

header.shtml

May Require Editing

Navigation

nav.shtml

May Require Editing

Other Important Notes

.htaccess

Because of the use of server side includes the pages need to be parsed by the server. The .htaccess file use the line

AddHandler server-parsed .html

Make sure your server does not override these setting or check that your server is set up correctly to handle includes on the .html files in this directory. The .html extension was used as opposed to .shtml so variations could more easily reference help pages.

Example

A working example of the End User Guide can be seen at
Example

  • No labels