Interactive Manual Administrator Manual

The primary role of an administrator is to manage the documents of this interactive manual. As an administrator, you can log into the system, change your login password, upload the updated section of the interactive manual and log out from the system. This manual will guide you through each of these functions, one by one.

Login

For security reasons, the administrators are required to log into the system before using any of the administrator functions. To login, you need to have the username and the password handy and enter them in the name and password field respectively. See Figure 1.

Figure 1: Login Page

Change Password

For safety reasons, administrators are suggested to change the password frequently, no longer than a one month period. To change the password, you need to login first (See Section 1). After a successful login, choose “Change Password” button from the menu on the left side of the administrator home page (See Figure 2).

Figure 2: Administrator Home Page

In the following page (Figure 3), enter the old password and the new password correspondingly, and click submit button. A successful password modification will lead to a page containing the greeting: “The password is updated successfully”.

Figure 3: Change Password

Logout

It is very important for administrator to logout from the system after finishing all the tasks. To logout, click the “Logout” button on the left side of the administrator home page (Figure 2).

Upload the updated section

In order to upload a section of the Interactive Manual successfully you need to provide the htm version of that section, instead of the word version.  Please note, the section is defined here as the deepest node of the index tree specified in the table of contents of the original ESCM and Water Quality and Quantity Management manuals. For instance, “B. Definitions” in subchapter “2C-1 General Information for Stormwater Hydrology” in the Iowa Stormwater Management Manual is called a section. Another example of section is “A. Introduction” in subchapter “2E-1 General Information for Infiltration Practices” of the same manual. Another thing that needs to be noticed is that the “-“ symbol in the section select list. See Figure 4. The “-“ section stands for the section before section A, e.g. the text before “A. Description” in the chapter 2F-1.
In the following part, we will use section “B. Definitions” in subchapter “2C-1 General Information for Stormwater Hydrology” as an example to illustrate the process.

Figure 4. Section “-“

Figure 5: New Word Document

Figure 6: Modified Section

 

Creating HTML Pages:

To create a HTML files you can use any software like Microsoft Frontpage, Microsoft Sharepoint Designer, Dreamweaver, etc. But, please make sure it works perfectly on all browsers. Since, there are encoding issues with different browsers.

 

Important points to make a Section work well on the Server:

• Make sure that the data size is no more than 2 MB

• Please make sure that all the Images are attached.

• *Check whether the encoding is western European i.e. windows-1252. This can be done in source code, look for “charset” and make sure that the “charset” for the meta tag is set to “windows-1252”. If not, then the pages will not be viewed clearly on the Server even if it works perfectly on your PC.

• Or, other way to check the encoding is to

1. Open the file in IE browser and
2. Right click on the page
3.  Look for Encoding
4.  Check if “Western European (Windows)” is selected. (Or ‘page info’ in Firefox).
5.   If not, then look up the web page source code and set the “charset” to “windows-1252” as given in previous point.

* IMPORTANT.

A sample example of meta tag with charset is shown below:

<meta http-equiv="content-type" content="text/html; charset=windows-1252">

One way to make a HTML page is given below using Microsoft Word in the Preparation Section.

 

Preparation

1. Create a new word document and copy the content of the section into the new word document (Figure 4). Modify the section as required (Figure 5).
   Important Notice: In this stage, please make sure that the word document is well-formatted since ill-formatted word document will cause unsatisfactory result. Every other section looks fine but extra attention should be paid for section “-“.  Let’s consider Section “-“ of the chapter “2F-1 Sand Filter” as an example. After we created a new word document and copied the content of the section into the new document, we need to pay attention to the unification of the formatting of the document. For instance, the style of highlighted text is Heading 2 in Figure 7 while the style of highlighted text is Normal in Figure 8. We need to correct and unify the formatting of the document. It is also suggested that the text box in all section “-“ be removed because the text box here will also cause formatting problem. After we have done the modifications, the result should look like in Figure 9.

Figure 7 Formatting problem

Figure 8 Formatting problem

Figure 9 Corrected Formatting

1. Save the word document as htm file with a name of your choice. Here, we name the new htm file as “Illustration.htm”. In the folder where “Illustration.htm” is saved, a new folder called “Illustration.files” will be created automatically to store the image files in the section. We will use these files in the following steps.

Additional considerations: extra attention is also needed for section “-“s. After you have saved the htm file and before you upload the file onto the server, you may test the satisfactory of the formatting of the htm file by opening the htm file using Internet Explorer or Firefox. Adjust the format of the htm file in Microsoft word until the satisfying result is reached.

Upload

1. After we finish the preparation of the htm file, we start to upload the updated section. In the administrator home page, choose the section that we have just updated (Figure 6) and click the “Next” button.

Figure 10: Select the Updated Section

1. In the following page (Figure 7), select the htm file we have just created, i.e. Illustration.htm and select all the image files in the “Illustration.files” folder. After finish with these, click the “Next” button. The updated section is then uploaded successfully (Figure 8).

Figure 11: Select the Updated Files

Figure 12: Updated Section