Difference between revisions of "MIRC User's Manual"

From MircWiki
Jump to navigation Jump to search
m (Protected "MIRC User's Manual" [edit=sysop:move=sysop])
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This article is the User's Manual for the RSNA MIRC implementation.  It is written with the general users of the teaching file system in mind (authors, and people viewing teaching files).
The User's manual has been broken up into three parts, as follows:
* [[Viewing Teaching Files]] talks about viewing and searching for teaching files.
==Viewing Teaching Files==
* [[Your Account]] talks about your login and what you can do with it.
* [[The Author Service]] is intended for the authors of teaching files.
==Basic Query==
[[Image:Basic query page.jpg|thumb]]
Enter your search terms separated by spaces in the text box.  The system will search for any documents that contain (anywhere in the document) ALL of the search terms you have entered.  If you want to find documents that contain either of the two search terms you entered, separate them with the "|" character.  You can also group items in parentheses this (that | other) will find any documents that contain "this" and either "that" or "other" (or both).  Items in quotes are treated as a single search term, so "holiday party" will only find entries that have the the word "holiday party" in it (and not "this holiday I am going to a party" for example).
==Advanced Query==
[[Image:Advanced query page.jpg|thumb]]
The advanced query lets you specify options about how the results are displayed, and allows you to query specific fields within a MIRC document.  It also allows you to query different servers.
===Select Storage Servers to Query===
If your site is setup with more then one storage service, you will see a list of the various storage services available under the advanced query section.  Select one or all of these servers to perform your search against them.
===Select Query Type===
There are a number of different fields within a MIRC document that you can query against.  This section of the advanced options allows you to query specifically words that appear in certain parts of a MIRC Document.
===Display As Unknowns===
===Case Navigator===
Selecting this option will give you your results one MIRC Document at a time, and allow you to scroll between them with a next and previous button.
===Results Per Site===
This option allows you to specify how many results each storage service you query should return.
==Your Account==
[[Your Account]]
==Authoring Teaching Files==
===Basic Authoring Tool===
===Advanced Authoring Tool===
====Normal Sections====
====Image Sections====
====Powerpoint Tool====
===File Cabinet===
===Zip Service===
The Zip Service allows users to submit collections of files to a MIRC site, automatically producing one or more MIRCdocuments on the site. The Zip Service is a server-side implementation of a concept first proposed by Adam Flanders at the RSNA 2005 conference. The original motivation for the Zip Service was to provide an easy way to pre-load a new MIRC site with an existing collection of images organized into individual cases. While the Zip Service is useful in this context, it is also a very convenient way to produce a single MIRCdocument.
See [[The_Zip_Service_User%27s_Manual|the Zip Service User's Manual]] for details.
===Submit Service===
===Manage Account===
To gain access to more than the basic MIRC features, a user must have an account on the MIRC site. An account consists of a username and a password plus a list of permissions, which are called <b>roles</b>. Certain features require that the user possess a specific role related to the feature. For example:
*To be authenticated on a MIRC Storage Service, the user must possess the Storage Service's <b>user</b> role.
*To be allowed to submit a document to a MIRC Storage Service's Submit Service or Zip Service, the user must possess the Storage Service's <b>author</b> role.
*To be allowed to create a document on a MIRC Storage Service's Author Service, the user must possess the Storage Service's <b>author</b> role.
*To be allowed to make a document public on a MIRC Storage Service, the user must possess the Storage Service's <b>publisher</b> role.
*To be allowed to access a MIRC site's File Service, the user must possess the File Service's <b>user</b> role. (This is a separate role from the one for a Storage Service.)
Roles are granted to users by the MIRC site administrator.
====The Login Button====
The <b>Login</b> button on the query page authenticates a user, making the system aware of the user's roles.
====The My Account Button====
Once a user is authenticated, the <b>My Account</b> button on the query page provides access to the user's account, allowing the user to change the account's password.
Additionally, if enabled by the administrator, this function also allows the user to create or join a <b>group</b>. A <b>group</b> is a <b>role</b> that can be created and given a password by a user. Other users wishing to join the group must do so by entering the group name and password on their <b>My Account</b> pages. MIRCdocuments that contain <b>read</b> permissions that include the group name are visible to all members of the group. This provides a way for a group of users to conveniently share a collection of documents without making the documents public.

Latest revision as of 19:26, 31 July 2009

The User's manual has been broken up into three parts, as follows: