Content Types
Note: This is the print view with all the Reference Manual pages on one page. The paginated version is available here, if you prefer that.
1. Rules for Adding Content
Each content type may be added only in specific locations. The following table specifies which types may be added where.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| How-to Section | How-to |
| FAQ Section | FAQ |
| Glossary Section | Definition |
| Video Section | Video |
2. KMS Area
Each KMS Area represents one instance of the OpenEngagement KMS. KMS Area objects may appear only in the root of the CMS. Within KMS Areas, Folders and other container types are used to organize the KMS Area.
3. Folder
The Folder type is used for site organization (similar to folders on the Windows file system), and for assigning users local roles. As with most content types in the OpenEngagement CMS, Folders allow for descriptions, keywords, threaded discussion, and so on.
4. Software Section
The Software Section is used to store software executables, patches, templates and so on. It may be used, for example, for releases of Working Papers, Time and various CaseView templates. The Software Section has a Software object for each software application, and these are then divided into releases, and may also store documentation about the applications.
Where there are software licensing limitations, firms will likely wish to tightly control who may and may not download from each software page.
5. Software
6. Software Release
Software Releases appear in Software objects and represent one version of a given software application. It is from here that users may download the actual software. Documentation relating to the software may be kept within a Software Release as well. This assumes that each release of an application has its own documentation. The documentation may be kept in Reference Manuals, Tutorials, How-tos, FAQs, Glossary Definitions, Videos, Files, Pages, Images, or Links.
7. Reference Manual Section
Reference Manual Sections are used to store a collection of Reference Manuals. As with some of the other container types in the KMS, Reference Manual Sections can have Sections. Sections are not containers, like Folders; instead they're labels, similar to keywords. Each Reference Manual may be in any number of the defined Sections. The Sections are then used to help users navigate from the Reference Manual Section to the desired Reference Manual. Sections are useful where there are large numbers of items, as grouping related items in one or more ways can help users locate quickly the items they need.
8. Reference Manual
Reference Manuals contain a collection of Pages, Files and Images, which contain documentation explaining one regulation, process, policy or other such subjects. Reference Manuals may also be divided into Chapters, going any number of levels deep. That is, Chapters may contain sub-chapters, which may contain further sub-chapters and so on.
Reference Manuals are structurally the same as Tutorials, with the one exception that Tutorials may not be divided into Chapters. The difference between the two is in the nature of the content firms would upload to each. Reference Manuals explain a certain topic in detail, while Tutorials explain how to perform a certain task. Where firms do not wish to make a distinction between Reference Manuals and Tutorials, they can can just use one or the other type, likely the Reference Manual.
9. Chapter
Chapters appear in Reference Manuals and other Chapters within Reference Manuals, and are used, as with Folders and other container types, to organize content and to assign local roles.
10. Tutorial Section
Tutorial Sections are collections of Tutorials. As with Reference Manuals, they can use Sections to label the Tutorials within the Tutorial Section.
Tutorials are similar to both Reference Manuals and How-tos, and many firms will not need to use all three types. Tutorials explain how to perform a certain action, so have similar content to How-tos. This difference is, Tutorials are multiple pages, while How-tos are single-page descriptions. So Tutorials would be used to provide long, detailed explanations of how to perform more complicated tasks.
Tutorials are different that Reference Manuals in the nature of the content that would be stored. Reference Manuals would be used to store material that explains a given subject but does not describe to the reader how to perform any given task.
11. Tutorial
Tutorials are a collection of Files, Pages and Images which contain an explanation of how to perform a given task.
12. FAQ Section
FAQ Sections are a collection of FAQs. Likely, all related FAQs would be contained in multiple FAQ Sections, and a firm would use an FAQ Sections for each subject, though this is not necessary. As with Reference Manual Sections and Tutorial Sections, a series of Sections may be defined for the FAQ Section.
13. FAQ
14. Glossary Section
A Glossary Section contains a collection of Definitions, which provide a definition for a single word or phrase. Glossary Sections use Sections to organize the Definitions within them.
15. Definition
Definitions appear within Glossaries and are used to provide the definition of a single word or phrase.
16. Video Section
17. Video
18. File
Files behave essentially the same in the KMS and DMS. They are used to store an uploaded file, such as a Word, Excel, PDF, or other such file.