My WebLink
|
Help
|
About
|
Sign Out
Home
Browse
Search
CRDSS_Task1_05-12_OnlineDocumentationSystem
CWCB
>
Decision Support Systems
>
DayForward
>
CRDSS_Task1_05-12_OnlineDocumentationSystem
Metadata
Thumbnails
Annotations
Entry Properties
Last modified
9/25/2011 10:18:53 AM
Creation date
5/30/2008 2:34:31 PM
Metadata
Fields
Template:
Decision Support Systems
Title
CRDSS Task 1.05-12 - System Integration Issues Documentation - On-line Documentation System
Description
This memorandum discusses methods of delivering an on-line documentation system for the CRDSS.
Decision Support - Doc Type
Task Memorandum
Date
6/29/1994
DSS Category
DMI Utilities
DSS
Colorado River
Basin
Colorado Mainstem
Contract/PO #
C153658, C153727, C153752
Grant Type
Non-Reimbursable
Bill Number
SB92-87, HB93-1273, SB94-029, HB95-1155, SB96-153, HB97-008
Prepared By
Riverside Technology inc.
There are no annotations on this page.
Document management portal powered by Laserfiche WebLink 9 © 1998-2015
Laserfiche.
All rights reserved.
/
17
PDF
Print
Pages to print
Enter page numbers and/or page ranges separated by commas. For example, 1,3,5-12.
After downloading, print the document using a PDF reader (e.g. Adobe Reader).
Show annotations
View images
View plain text
convert the man pages to PostScript. Limitations are that man pages do not support <br />hypertext or graphics. At the very least, the ASCII text could be printed. A rudimentary <br />hypertext system could be developed by using existing references to other man pages (e.g., <br />in the See Also section) or by putting special comments within man pages. This would <br />involve developing a viewer program. <br />xman <br />The program, or a variant thereof. This program is in the public domain and is <br />? <br />distributed by the X-consortium. It formats man pages nicely but does not have hypertext <br />or graphics capabilities. It does not have a hard-copy option. <br />Mosaic <br />The program. This program is in the public domain and offers a hypertext interface <br />? <br />to documentation that has text and graphics. Positive aspects are that it is widely used and <br />has many useful features (such as being aware of the Internet). It is also available on <br />different platforms, including UNIX, PC Windows, and Macintosh. Negative aspects are <br />that it requires documentation to be formatted in hypertext markup language (text files can <br />be inserted into a hypertext file without formatting). <br />A ?home-grown? documentation system using products from previous RTi and CSU <br />? <br />projects. This would not be difficult but would result in a system that does not conform <br />with anyone else's system. This approach might be effectively used if a standard document <br />format or an extension of a standard format were used, e.g., UNIX man pages. <br />Mosaic <br />The evaluations of the above products concentrated on evaluating the product because it <br />seems to be the best overall solution for the least effort. A proof of concept hypertext document was <br />prepared for the March 29 Technical Advisory Committee meeting at RTi, in which approximately <br />ten pages of information, with graphics, was shown. The demonstration seemed to be successful, <br />Mosaic <br />and a copy of the document and has been installed on the Briefing Room machine. Although <br />Mosaic <br />this document is not complete, it does illustrate the potential of . It has also been verified that <br />Mosaic <br />the documents displayed by can be printed and mailed from the program interface. <br />Many UNIX man pages exist for RTi and CSU software that may potentially be used in the CRDSS. <br />Mosaic <br />A link to UNIX man pages exists on the Internet and is being tested. If this link is verified, <br />Mosaic <br />then can serve nearly all documentation needs. <br />UNIX man pages can be ported between different platforms and are widely used for technical <br />documentation. UNIX man pages will therefore be used heavily within the CRDSS to document <br />software in a technical manner that will be used by CRDSS developers. Such man pages will also be <br />available to users, but the material in such documentation may not be of interest to users. <br />Implementation of Mosaic On-line Documentation <br />Mosaic <br />The program uses the hypertext markup language (HTML) to create hypertext links between <br />documentation elements (see Appendix D of the Phase I report for information on HTML). The <br />basic presumption of the HTML is that documents are written with high-level formatting commands <br />rather than very specific commands. For example, a level 1 heading is indicated by the syntax: <br /><h1> This is a level 1 heading </h1> <br />2 <br />A275 06.29.94 1.05-12 Malers <br />
The URL can be used to link to this page
Your browser does not support the video tag.