Difference between revisions of "How to Author Teaching Files"

From MircWiki
Jump to: navigation, search
Line 46: Line 46:
  
 
Browse the sections of the document, adding, deleting, and modifying content where you wish.  
 
Browse the sections of the document, adding, deleting, and modifying content where you wish.  
* While you are editing a paragraph, if you enter a lot of text into a box and want a larger box, click the "Save" button. The author service will resize the text boxes.
+
* While you are editing a paragraph, if you enter a lot of text into a box and want a larger box, click the <b>Save</b> button. The author service will resize the text boxes.
 
* When entering text in a text box, if you separate text lines by a blank line, the author service will generate separate paragraphs for you. If you start a new line with a '-' character, the author service will generate a bullet list for you. If you start a new line with a '#' character, the author service will generate a numbered list for you.  
 
* When entering text in a text box, if you separate text lines by a blank line, the author service will generate separate paragraphs for you. If you start a new line with a '-' character, the author service will generate a bullet list for you. If you start a new line with a '#' character, the author service will generate a numbered list for you.  
  
Note that some sections are fixed in place and cannot be deleted - Document, Title, Authors, Abstract, Keywords, References, Indexed Content, PHI, and Permissions. If you don't have anything to add to such a section, you can leave it alone; empty sections are not displayed to users. If you create or move sections, they are constrained to positions between Keywords and References.  
+
Note that some sections are fixed in place and cannot be deleted - <b>Document</b>, <b>Title</b>, <b>Authors</b>, <b>Abstract</b>, <b>Keywords</b>, <b>References</b>, <b>Indexed Content</b>, <b>PHI</b>, and <b>Permissions</b>. If you don't have anything to add to such a section, you can leave it alone; empty sections are not displayed to users. If you create or move sections, they are constrained to positions between Keywords and References.  
  
As you work, you should periodically click the "Save" button to save the changes you have made. When you click the "Save" button, the author service will redisplay the editor page to allow you to continue editing. If the author service indicates that the document had an error, see note 2 below.
+
As you work, you should periodically click the <b>Save</b> button to save the changes you have made. When you click the <b>Save</b> button, the author service will redisplay the editor page to allow you to continue editing. If the author service indicates that the document had an error, see note 2 below.
  
 
If you wish your document to be private, or if you wish to otherwise restrict access to it, see the section on "Creating Private and Public Documents".
 
If you wish your document to be private, or if you wish to otherwise restrict access to it, see the section on "Creating Private and Public Documents".
Line 58: Line 58:
 
To edit an existing document, first view the document by finding it with a query on the query page and then clicking on the title of the document in the query results.
 
To edit an existing document, first view the document by finding it with a query on the query page and then clicking on the title of the document in the query results.
  
If the document is displayed in page mode, scroll to the bottom of the page. If the document is displayed with tabs, click the "Document" tab and scroll to the bottom. You will see a small table of buttons as shown below.
+
If the document is displayed in page mode, scroll to the bottom of the page. If the document is displayed with tabs, click the <b>Document</b> tab and scroll to the bottom. You will see a small table of buttons as shown below.
  
 
<center>
 
<center>
Line 64: Line 64:
 
</center>
 
</center>
  
Click the "Edit" button. The author service will open a new window and display the document in the editor, allowing you to add, delete, or modify the contents. Be sure to click the "Save" or "Preview" buttons to ensure that your changes are saved.
+
Click the <b>Edit</b> button. The author service will open a new window and display the document in the editor, allowing you to add, delete, or modify the contents. Be sure to click the <b>Save</b> or <b>Preview</b> buttons to ensure that your changes are saved.
  
 
<b>Note:</b>  
 
<b>Note:</b>  
If the "Edit" button is not enabled, there are two possibilities: you may not have permission to edit the document, or you may not have logged in. To log in, go back to the query page and click the "Login" button on the right side of the page.  
+
If the <b>Edit</b> button is not enabled, there are two possibilities: you may not have permission to edit the document, or you may not have logged in. To log in, go back to the query page and click the "Login" button on the right side of the page.  
  
 
==Advanced Functions==
 
==Advanced Functions==
 
The left-most button in the toolbar switches the editor between the normal mode and the advanced mode. In the advanced mode, several tabs are shown that are not presented in the normal mode:
 
The left-most button in the toolbar switches the editor between the normal mode and the advanced mode. In the advanced mode, several tabs are shown that are not presented in the normal mode:
* The Document tab allows you to change the display format, the background color, and several attributes describing the document. These are typically defined in the template and do not need to be changed.
+
* The <b>Document</b> tab allows you to change the display format, the background color, and several attributes describing the document. These are typically defined in the template and do not need to be changed.
* The Indexed Content tab allows you to enter keywords in numerous categories. This information is not displayed to viewers of the document, but it is used in queries, making the document more easily discoverable in some situations.
+
* The <b>Indexed Content</b> tab allows you to enter keywords in numerous categories. This information is not displayed to viewers of the document, but it is used in queries, making the document more easily discoverable in some situations.
* The PHI tab allows you to indicate that the document contains Protected Health Information. If you include such information in your document, you must include a PHI section in order to tell the MIRC site that distributes the document to keep an audit trail of users who have viewed the information, as required by HIPAA.
+
* The <b>PHI</b> tab allows you to indicate that the document contains Protected Health Information. If you include such information in your document, you must include a PHI section in order to tell the MIRC site that distributes the document to keep an audit trail of users who have viewed the information, as required by HIPAA.
* The Permissions tab allows you to specify who can read, update, export, and delete the document on the server. More details are supplied in the section on Creating Private and Public Documents, below.
+
* The <b>Permissions</b> tab allows you to specify who can read, update, export, and delete the document on the server. More details are supplied in the section on Creating Private and Public Documents, below.
  
 
The advanced mode also provides some additional parameters within document sections.  
 
The advanced mode also provides some additional parameters within document sections.  
* The Heading field allows you to change the heading that is displayed above the section in the document.
+
* The <b>Heading</b> field allows you to change the heading that is displayed above the section in the document.
* The Visible field allows you to specify whether the section should be displayed when the document is viewed. The choices are "yes", "no", and "Owners only". If you have text that would be useful in a query but not necessarily in viewing the document (for instance, a transcript of an audio file that is referenced in the document), you can put it in a visible="no" section. If you have notes which you want to keep with the document but which you don't want others to see, you can put it in a visible="Owners only" section.
+
* The <b>Visible</b> field allows you to specify whether the section should be displayed when the document is viewed. The choices are <b>yes</b>, <b>no</b>, and <b>owner</b>. If you have text that would be useful in a query but not necessarily in viewing the document (for instance, a transcript of an audio file that is referenced in the document), you can put it in a visible="no" section. If you have notes which you want to keep with the document but which you don't want others to see, you can put it in a visible="owner" section.
* The Image width field, which is only displayed in normal document sections, allows you to specify the maximum width of images that are to be displayed in the section. The default is 256, which works well for most types of documents, but which can be increased if you want to show more detail.
+
* The <b>Image width</b> field, which is only displayed in normal document sections, allows you to specify the maximum width of images that are to be displayed in the section. The default is 256, which works well for most types of documents, but which can be increased if you want to show more detail.
* The Pane width field, which is only displayed in a special type of section called an "image-section" and which appears only in the "tab" or "mstf" format, allows you to specify the width of the main image display pane on the right side of the section. The default is 700, which works well for most types of documents.
+
* The <b>Pane width</b> field, which is only displayed in a special type of section called an "image-section" and which appears only in the <b>tab</b> or <b>mstf</b> format, allows you to specify the width of the main image display pane on the right side of the section. The default is 700, which works well for most types of documents.
*The Suppress icons checkbox, which is only displayed in image-sections, allows you to suppress the display of token images in the lower left corner of the window when the image-section is displayed. This provides more room on the left side for text sections to be displayed.
+
*The <b>Suppress icons</b> checkbox, which is only displayed in image-sections, allows you to suppress the display of token images in the lower left corner of the window when the image-section is displayed. This provides more room on the left side for text sections to be displayed.

Revision as of 13:15, 23 April 2007

This article is a shorthand guide for creating and editing MIRC documents using the MIRC Author Service.

1 Prerequisites

To use the MIRC Author Service, you must have an account on the storage service where you will create documents. See your MIRC site administrator, who will create an account with user and author roles. Your account will consist of a username and password which you will use to access the author service.

2 Creating a New Document

To create a new document, launch your browser and go the MIRC site's query page. Select the storage service on which you wish to create a document and click the "Author Service" button on the right side of the page. The browser will display a dialog box for you to enter your name and password.

The author service will then display a page welcoming you. Enter your name, affiliation, and contact information as you wish to see it appear in the document. This information is remembered by the author service and filled in for you each time you create a new document.

Error creating thumbnail: Unable to save thumbnail to destination
.

Select the template you wish to use to create the new document by clicking the down arrow on the selection box and choosing one of the items in the menu. Several templates covering all the standard display modes are provided. Your MIRC site administrator may have created additional templates. A template is simply a starting point for editing a document. Templates can simplify the task of creating documents, but no matter what template you select, you can make changes to create the document in any format you wish.

After selecting the template, click the "Submit Request" button.

The author service will display a page like the one below.

Error creating thumbnail: Unable to save thumbnail to destination
.

The page contains four sections. On the right is a column of icons representing all the files you have in your private file cabinet. You can learn about how to insert, delete and manage files by reading <a href="http://mirc.rsna.org/mircstorage/documents/fileservice/FileServiceQuickStart.xml">How to Use the MIRC File Service</a>.

At the top is a toolbar providing various functions. As you roll the mouse over the buttons, a short description of the function is displayed.

Error creating thumbnail: Unable to save thumbnail to destination
.

The left-most button switches the author service between the simplified normal mode and the advanced mode which is described in the Advanced Functions section below. The next two buttons save the changes you make to the document and display the document in a separate browser window so you can see how the document will look to users who view it.

The next group of buttons allows you to create, delete, and move document sections. The template you chose to begin creating the document contained one or more sections. With these buttons, you can modify the document to fit your current purpose. If you create a new section, you will want to change its heading as described in the Advanced Functions section below.

The last group of buttons allows you to insert, delete, and move various kinds of items that may be placed in sections. For instance, some of the buttons insert paragraphs, captions, images, patient tables, and quizzes; another removes selected items, and the last two move selected items up or down on the page.

Under the toolbar is a row of section titles.

Error creating thumbnail: Unable to save thumbnail to destination
.

If you click on a section heading, the contents of that section are displayed in the main body of the page, with each paragraph, caption, image, patient, and quiz shown in a separate box. Clicking on a box selects it, allowing you to edit it, remove it or move it up or down on the page.

Browse the sections of the document, adding, deleting, and modifying content where you wish.

  • While you are editing a paragraph, if you enter a lot of text into a box and want a larger box, click the Save button. The author service will resize the text boxes.
  • When entering text in a text box, if you separate text lines by a blank line, the author service will generate separate paragraphs for you. If you start a new line with a '-' character, the author service will generate a bullet list for you. If you start a new line with a '#' character, the author service will generate a numbered list for you.

Note that some sections are fixed in place and cannot be deleted - Document, Title, Authors, Abstract, Keywords, References, Indexed Content, PHI, and Permissions. If you don't have anything to add to such a section, you can leave it alone; empty sections are not displayed to users. If you create or move sections, they are constrained to positions between Keywords and References.

As you work, you should periodically click the Save button to save the changes you have made. When you click the Save button, the author service will redisplay the editor page to allow you to continue editing. If the author service indicates that the document had an error, see note 2 below.

If you wish your document to be private, or if you wish to otherwise restrict access to it, see the section on "Creating Private and Public Documents".

3 Editing an Existing Document

To edit an existing document, first view the document by finding it with a query on the query page and then clicking on the title of the document in the query results.

If the document is displayed in page mode, scroll to the bottom of the page. If the document is displayed with tabs, click the Document tab and scroll to the bottom. You will see a small table of buttons as shown below.

Error creating thumbnail: Unable to save thumbnail to destination
.

Click the Edit button. The author service will open a new window and display the document in the editor, allowing you to add, delete, or modify the contents. Be sure to click the Save or Preview buttons to ensure that your changes are saved.

Note: If the Edit button is not enabled, there are two possibilities: you may not have permission to edit the document, or you may not have logged in. To log in, go back to the query page and click the "Login" button on the right side of the page.

4 Advanced Functions

The left-most button in the toolbar switches the editor between the normal mode and the advanced mode. In the advanced mode, several tabs are shown that are not presented in the normal mode:

  • The Document tab allows you to change the display format, the background color, and several attributes describing the document. These are typically defined in the template and do not need to be changed.
  • The Indexed Content tab allows you to enter keywords in numerous categories. This information is not displayed to viewers of the document, but it is used in queries, making the document more easily discoverable in some situations.
  • The PHI tab allows you to indicate that the document contains Protected Health Information. If you include such information in your document, you must include a PHI section in order to tell the MIRC site that distributes the document to keep an audit trail of users who have viewed the information, as required by HIPAA.
  • The Permissions tab allows you to specify who can read, update, export, and delete the document on the server. More details are supplied in the section on Creating Private and Public Documents, below.

The advanced mode also provides some additional parameters within document sections.

  • The Heading field allows you to change the heading that is displayed above the section in the document.
  • The Visible field allows you to specify whether the section should be displayed when the document is viewed. The choices are yes, no, and owner. If you have text that would be useful in a query but not necessarily in viewing the document (for instance, a transcript of an audio file that is referenced in the document), you can put it in a visible="no" section. If you have notes which you want to keep with the document but which you don't want others to see, you can put it in a visible="owner" section.
  • The Image width field, which is only displayed in normal document sections, allows you to specify the maximum width of images that are to be displayed in the section. The default is 256, which works well for most types of documents, but which can be increased if you want to show more detail.
  • The Pane width field, which is only displayed in a special type of section called an "image-section" and which appears only in the tab or mstf format, allows you to specify the width of the main image display pane on the right side of the section. The default is 700, which works well for most types of documents.
  • The Suppress icons checkbox, which is only displayed in image-sections, allows you to suppress the display of token images in the lower left corner of the window when the image-section is displayed. This provides more room on the left side for text sections to be displayed.