ECN Knowledge Base

What is the ECN Knowledge Base?

The ECN Knowledge Base is a Zope application for creating, maintaining, searching, and viewing documentation on the ECN web site. The Knowledge Base replaced the Frequently Asked Question (FAQ) System available on the previous ECN web site.

Features of the ECN Knowledge Base

• Documents can exist in multiple categories
• Document review schedule
• Custom Search Engine
• Easy to use document management interface
  

Location of the ECN Knowledge Base

http://eng.purdue.edu/ECN/KnowledgeBase/

Using the Knowledge Base

Browsing the Knowledge Base

Knowledge Base documents can be browsed by category from the main Knowledge Base page. Categories in bold text are main categories, smaller text choices are sub-categories.

Figure 1 - The Main Knowledge Base Page

Once you have selected a category you are taken to a screen listing any sub categories as well as all documents which fall into that category. Click on a documents title to view that document. Some documents are listed in multiple categories.

Searching the Knowledge Base

The Knowledge Base can be searched by keywords from the main Knowledge Base page (Figure 1). Type your search terms into the text field and click the search button. A listing of categories of interest as well as individual documents that contain the search terms is presented.

Figure 2 - Knowledge Base Search Results

Managing Knowledge Base Documents

Gaining access to manage the Knowledge Base

All ECN Staff has complete access to the Knowledge Base. Send access issues to webmaster@ecn.purdue.edu.

Steps for Developing a new Document

1. Create
2. Edit
3. Associate Categories
4. Restrict Access
5. Publish
6. Check in
   

Creating a Document

Once you have found an appropriate category, click the link in the bottom of the page titled, "Add a Document Here" (Figure 3).

Figure 3 - Add a Document Link

Figure 4 - Add a Document Form

Editing a Document

This will take you directly to the Edit screen for your new document (Figure 5). This provides a WYSIWYG (What you see is what you get) editor for developing your document. You may type your document directly or copy and paste from another source.

Figure 5 - Edit a Document

Adding Images to a Document

To add an Image to your document click the "Insert Image" button to bring up the "Select Image" popup (Figure 6). From here you can view all of the images currently associated with this document. You may also browse to upload new Images from your computer.

Figure 6 - Select an Image

Click on an image to insert it into your document. Once it is inserted it can be moved/scaled using the mouse. Once your document is completed click the "Save Changes" button at the bottom of the screen.

Adding a Document to Multiple Categories

If your document belongs in multiple categories click the "Categories" icon at the top of the page. This will bring you to the "Edit Categories" screen (Figure 7). Here you can add/remove categories associated with this document. To add a category click the "Add" link to right of the category name under "Add to a Category". To remove a category click  the "Remove" link to the right of the category name under "Remove from a Category".

 

Figure 7 - Edit Categories

Restricting Access to ECN Staff

If your document contains information that should not be made public you may want to restrict access to it. To do this click the "Security" icon at the top of the page. This will take you to the "Security Settings" page (Figure 8).

Figure 8 - Security Settings

Check the boxes to the left of the groups that should be able to view your document. Once any changes are made click the "Update Security" button.

Publishing a Document

Before anyone can see your document you must publish it. To publish a document click the "Publish" icon at the top of the page. This will take you to the "Document Status" screen (Figure 8). Click the "Publish Document" button.

Figure 8 - Document Status

Checking in a Document

Once your document is completed you should check it in. Any ECN staff member can check out documents and make changes. To check in your document click the "Check in/Out" icon at the top of the page to view the "Sharing Control" screen (Figure 9). From here click the "Check in Document" button. If you return to the "Edit" screen you will notice that you can no longer edit the document.

Figure 9 - Sharing Control

Congratulations, your document is complete and available for anyone to view.

Editing an Existing Document

1. Search/Browse to find the document you wish to edit
2. Click the "Edit this Document" link at the bottom of the page (Figure 10)
3. Check out the Document (Check in/Out)
4. Make any changes (Edit)
5. Check in the Document (Check in/Out)

Figure 10 - Edit Document Link

Adding a Category

To add a category browse to the category where the new category fits. Click the "Add a Sub Category" link at the bottom of the page (Figure 11).

Figure 11 - Add a Sub Category Link

This will load the Add Sub Category Form where you can create a new category. Once the category is created it is ready for documents to be added to it.