This document provides background information on the process of creating a new KB document. It also includes a training exercise that demonstrates the document editor's basic functionality. For detailed information about specific aspects of the document editor, please continue with this training series or return to the KB Author Training - Overview.
If you are not already logged in, log into the KB Admin Tools.
Note: If your institution is not using Shibboleth, go to the Active Directory Login.
In the KB Admin Tools, click on the Documents tab.
Click on the New Doc link in the left navigation bar.
You will be presented with the document editor, all fields will be blank. (Please note it says "Creating a New Document" at the top of the screen).
As you are working, click the button located under the Body field to periodically to save your changes. Since this is a brand new document, once you click on the Save Change button, the Creating a New Document header will become Editing Document XXXXX. The status of this document changes from New to In Progress.
In the image below, the left side shows a brand new document with content in all four required fields. The right side of this image is what you see after clicking the Save change button: the new document, or "draft", is saved and assigned its own, distinct number, 75607.
*Note: Observe how the Template field (which appears on the left, in the image below) disappears (as seen on the right side of the image below) once the document is saved / assigned a distinct number. Please refer to this document for more information about Templates.
Clicking the Save change or Submit button saves your work in the new document and assigns it a distinct number. However, if you do not save changes, specifically if you:
...you will lose all content since the last time you saved. While the KB does keep a copy of all your revisions, it is necessary to tell the KB to save by clicking on that Save change button.
While you are modifying the content of your document, you can preview the document without saving to make sure it looks as you expect it to.
To preview a document, simply click the button under the Body field. Click on the X in the upper left corner to exit the Preview without Saving window.
The image below shows our sample document in the Preview without Saving pop up screen.
When you have finished editing document, you need to set the:
in order to either notify your KB Admin that the doc is ready to be published or to publish it yourself (depending on your have Publish rights).
If you are not already logged in, log into the KB Admin Tools.
Note: If your institution is not using Shibboleth, go to the Active Directory Login.
Open the document editor to create a new document.
Enter a Title in the following format: [your name]'s First KB Document
Enter the following Keywords (separated by commas): apple, banana, orange, pear, zucchini.
Enter the following Summary text: "Summary: this document contains all of the necessary information including Title, Keywords, Summary and Body."
At this point, try clicking Save change button. You should receive an error message indicating that Body is a required field. Click 'OK' to exit the error message.
Enter the following text into the Body section: "This is where the body of the document appears."
Click the Save change button. The text at the top of the document editor should now read "Editing Document [Document Number]". Record the document number for use in subsequent training exercises.