home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-385-Vol-1of3.iso / x / xhyper10.zip / XHyper_v1.0 / sampledoc / section1.mml < prev    next >
Text File  |  1992-11-05  |  3KB  |  86 lines
  1. <MML 1.00 -- Sample.mml   A sample mml file>
  2.  
  3. <Comment *** Define paragraphs and fonts tags>
  4. <Include "Formats.mml">
  5.  
  6. <Comment *** Start of Document Text ***>
  7. <Title>
  8. \n
  9. Advanced On-Line Help System
  10.  
  11. <Section>
  12. 1.0 Introduction
  13.  
  14. <Body>
  15. No highly interactive system is complete unless it is fully documented, 
  16. complete with "On-line Help", available while the system is operating, 
  17. in addition to "Off-line Help" (i.e. User's Manual's). Proper 
  18. documentation can greatly ease the learning curves associated with 
  19. systems, reducing cost to the end-users in the form of labor and 
  20. productivity. This in turn may reduce cost to the developers in
  21. the form of reduced customer support.  With the acceptance of 
  22. the <hyper  XWindows> X Window System <endhyp> and in turn OSF/Motif 
  23. there has been a great deal of research and development in the 
  24. areas of Graphical User Interfaces (GUIs). However, very little has 
  25. been done with respect to the integration 
  26. of "Help" and documentation of these system.  In this project, I 
  27. performed the initial development of an X based on-line help
  28. system , <bold>XHelp<plain>, which features:
  29.  
  30. <Body>
  31. 1. Multiple fonts and highlighted text.
  32. <Body>
  33. 2. Paragraph formating and justification.
  34. <Body>
  35. 3. Integration of figures.
  36. <Body>
  37. 4. Hypertext.
  38. <Body>
  39. 5. On line helpl stored in Maker Markup Language format.
  40.  
  41. <Body>
  42. <bold>XHelp<plain> is written in C++ and utilizes the 
  43. <hyper InterViews> InterViews <endhyp> package developed by 
  44. Stanford University.
  45.  
  46. <Section mml>
  47. 1.1 Maker Markup Language
  48.  
  49. <Body>
  50. On of the most popular and powerful desktop publishing systems available 
  51. today is FrameMaker. FrameMaker is particularly powerful since it operates 
  52. on Unix work stations under the <hyper XWindows>X Window System<endhyp>. 
  53. FrameMaker files are stored in a very complex internal format. However, 
  54. to allow users to update documents from other word processors or text 
  55. editors, FrameMaker supports a Maker Markup Language (MML). 
  56.  
  57. <Figure "test.ips">
  58.  
  59. <Body>
  60. The MML files are text files which 
  61. describe the format of the document in addition to the contents of 
  62. the document. Since the MML is very broad, this phase of development 
  63. of <bold>XHelp<plain> only supports a small subset of the MML 
  64. with extensions for figures and <hyper Hypertext>hypertext<endhyp>.
  65.  
  66.  
  67. <Section InterViews>
  68. 1.2 InterViews
  69.  
  70. <Body>
  71. InterViews is a software system for X window-based applications. 
  72. InterViews comes from the idea of a user interface object presenting 
  73. an interactive view of some data (Linton, et al). For 
  74. example, <bold>XHelp <plain>implements an interactive view of 
  75. <hyper MML> MML <endhyp> based help files. The InterViews 
  76. package contains a set of libraries containing a large variety of C++ 
  77. classes built on top of The <hyper XWindows>X Window Library (xlib)<endhyp>. 
  78. The most recent release of InterViews, version 3.0, contains a new base 
  79. class, Glyph. Appendix I contains a detailed description of Glyphs 
  80. and provides examples 
  81. from which XHelp evolved. Figure 2 illustrates the relation of InterViews 
  82. with res pect to the Xlib and applications. Note that the applications 
  83. DO NOT access the Xlib directly as to Xt based applications.
  84.  
  85.  
  86.