home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / wps / utils / contrast / contrast.ipf < prev    next >
Encoding:
Information Presentation Facility markup  |  1991-01-11  |  7.3 KB  |  223 lines
  1. :userdoc.
  2.  
  3. .* ************ CONTRAST C Program Help Text File (.IPF) ***************
  4. :h1 res=401.Contrast
  5.  
  6. :i1.Contrast Program
  7.  
  8. :p.:hp2.Contrast:ehp2. compares two files on disk and notes lines that are
  9. common to both. A :link reftype=hd res=500.bar chart:elink. is drawn, giving an
  10. overall view of which lines match, and the text of either file, or a
  11. :link reftype=hd res=501.composite:elink. file, is displayed. The default view is
  12. the composite file.
  13.  
  14. :h1 res=402.Open Dialog
  15.  
  16. :i1.Open dialog
  17.  
  18. :p.The :hp2.Open:ehp2. dialog supplies lists of files and directories from
  19. which the source files can be selected. The full path of the file is made by
  20. concatenating the file name to the directory, so you can type subdirectories
  21. in the name field if you want. '..' means the parent directory. If the name of
  22. File B is null, the name from File A is used.
  23.  
  24. :h1 res=403.Problem Message Box
  25.  
  26. :i1.Problem Message Box
  27.  
  28. :p.The :hp2.Problem:ehp2. message box informs the user of a problem in the
  29. program. This may or may not be fatal. The user is required to acknowledge the
  30. message; the program will take appropriate action.
  31.  
  32. :h1 res=404.File Menu
  33.  
  34. :i1.File menu
  35.  
  36. :p.The :hp2.File:ehp2. menu contains the following items:
  37. :dl tsize=4 compact break=all.
  38. :dt.Open
  39. :dd.Allows new source files to be :link reftype=hd res=503.opened:elink..
  40. :dt.Exit
  41. :dd.Closes the :hp2.Contrast:ehp2. program.
  42. :edl.
  43.  
  44. :h1 res=405.Help Menu
  45.  
  46. :i1.Help menu
  47.  
  48. :p.The :hp2.Help:ehp2. menu contains the following items:
  49. :dl break=all tsize=4 compact.
  50. :dt.Help for help
  51. :dd.Explains the use of the help functions.
  52. :dt.Extended help
  53. :dd.Displays general help on the :hp2.Contrast:ehp2. program.
  54. :dt.Keys help
  55. :dd.Displays help on the keys that can be used in the :hp2.Contrast:ehp2.
  56. program.
  57. :dt.Help index
  58. :dd.Displays a list of selectable help topics.
  59. :dt.About
  60. :dd.Displays the application logo.
  61. :edl.
  62.  
  63. :h1 res=406.Keys for Contrast
  64.  
  65. :i1.Keys for Contrast
  66.  
  67. :p.The :hp2.Contrast:ehp2. program assigns the following special functions to
  68. keys:
  69. :dl tsize=4 compact break=all.
  70. :dt.Alt+O
  71. :dd.Bring up the Open dialog.
  72. :dt.F3
  73. :dd.Exit the Contrast program.
  74. :dt.Alt+A
  75. :dt.Alt+B
  76. :dd.Display file A or B
  77. :dt.Alt+C
  78. :dd.Display the :link reftype=hd res=501.composite:elink. file
  79. :dt.Alt+L
  80. :dt.Alt+T
  81. :dt.Alt+I
  82. :dd.Ignore leading, trailing, or all blanks for line comparison. Use
  83. the :link reftype=hd res=408.Options:elink. menu to see the current status.
  84. :dt.Alt+U
  85. :dd.Display lines unique to either source file interleaved, as opposed to
  86. alternately.
  87. :dt.Alt+D
  88. :dd.Bring up the Define Colours dialog.
  89. :dt.Alt+F
  90. :dd.Bring up the Fonts dialog.
  91. :dt.Arrow keys
  92. :dd.Scroll the displayed file by one character.
  93. :dt.Page Up
  94. :dt.Page Down
  95. :dd.Scroll the file by the height of the text window.
  96. :edl.
  97.  
  98. :h1 res=407.View Menu
  99.  
  100. :i1.View menu
  101.  
  102. :p.The :hp2.View:ehp2. menu changes the text displayed. This can be either of
  103. the source files, or the :link reftype=hd res=501.composite:elink. file.
  104.  
  105. :h1 res=408.Options Menu
  106.  
  107. :i1.Options menu
  108.  
  109. :p.The :hp2.Options:ehp2. menu contains the following items:
  110. :dl tsize=4 compact break=all.
  111. :dt.Ignore leading blanks
  112. :dd.Re-contrasts the files, with white space (i.e. spaces, tabs or nulls)
  113. at the beginning of lines ignored. Any formatting of programs will thus be
  114. irrelevent.
  115. :dt.Ignore trailing blanks
  116. :dd.Ignores white space at the end of lines. Some editors can be inconsistent
  117. about leaving this in files.
  118. :dt.Ignore all blanks
  119. :dd.Disregards all white space, wherever it is in the files. This is
  120. useful for comparing programs in free-format languages, especially if differing
  121. editors have been used.
  122. :dt.Interleave unique lines
  123. :dd.Orders unmatching blocks in the composite file so that lines from files A
  124. and B alternate. If this option is off, unmatching blocks will displayed as
  125. whole blocks from file A or B.
  126. :dt.Define colours used
  127. :dd.Allows user definition of the :link reftype=hd res=502.colours:elink. used
  128. by :hp2.Contrast:ehp2..
  129. :dt.Set font used
  130. :dd.Changes the :link reftype=hd res=504.font:elink. and style used for the text
  131. display.
  132. :edl.
  133.  
  134. :h1 res=500.Bar Chart
  135.  
  136. :i1.Bar chart
  137.  
  138. :p.The bar chart is a graphical representation of the two source files. Blocks
  139. of common lines are assigned a :link reftype=hd res=502.colour:elink. different from
  140. those around them, and drawn on the bars representing the files; a line links
  141. the matched blocks. The matched colours in the bar chart are used as the text
  142. colour for the file display; the default text colour for unmatched lines is
  143. black (red or yellow on the chart). Black marks by the bar chart show where
  144. the current text display is in the files.
  145.  
  146. :h1 res=501.Composite
  147.  
  148. :i1.Composite
  149.  
  150. :p.The composite file is made from the two source files, using the common lines
  151. where possible.
  152. :p.This is the default colour scheme:
  153. :p.Common lines have a white background.
  154. :p.Lines unique to File A are shown in black on yellow.
  155. :p.Lines unique to File B are shown in black on red.
  156. :p.Where a block of lines in File B has been moved from where it was in File A
  157. the program has to guess whether block 1 was moved up past block 2 or block 2
  158. moved down past block 1. It shows the larger block as common and the other as
  159. moved in each file. The text shown as moved is drawn in a dark colour (not
  160. black) on yellow or red.
  161. The :link reftype=hd res=500.bar chart:elink. shows the connections.
  162.  
  163. :h1 res=502.Colours
  164.  
  165. :i1.Colours
  166.  
  167. :p.Default colours are:
  168. :p.Text Background
  169. :dl tsize=4 break=all compact.
  170. :dt.Yellow
  171. :dd.Lines unique to File A (or moved in File A)
  172. Used in :link reftype=hd res=500.bar chart:elink. and as text background.
  173. :dt.Red
  174. :dd.Lines unique to File B (or moved in File B)
  175. Used in bar chart and as text background.
  176. :dt.White
  177. :dd.Lines common to File A and File B
  178. Text background only.
  179. :edl.
  180. :p.See :link reftype=hd res=501.Composite:elink. for how moved blocks are coloured.
  181.  
  182. :p.Text Foreground
  183. :dl tsize=4 break=all compact.
  184. :dt.Blue
  185. :dt.Dark pink
  186. :dt.Dark green
  187. :dt.Dark cyan
  188. :dd.Text that has been matched in both files. The same colour is used for the
  189. identical text in each file; the choice of colour is such that surrounding
  190. blocks of matched lines use different ones. The same colour is used in the
  191. bar chart to show the lines.
  192.  
  193. :dt.Black
  194. :dd.Unmatched text.
  195. :edl.
  196.  
  197. :p. The :link reftype=inform res=1.actual colours:elink. are defined by the user
  198. in the :link reftype=hd res=503.Define colours:elink. dialog.
  199.  
  200. :h1 res=503.Colours dialog
  201.  
  202. :i1.Colours dialog
  203.  
  204. :p.The :hp2.Colours:ehp2. dialog allows the colours used by :hp2.Contrast:ehp2.
  205. to be set to any of 16 colours provided by Presentation Manager. Five text and
  206. three background colours need to be defined. They do not have to be all
  207. different, but the display may be confusing if they are not.
  208. :p.The :hp2.default:ehp2. button resets all the colours to the program-supplied
  209. settings.
  210.  
  211. :h1 res=504.Font Dialog
  212.  
  213. :i1.Font dialog
  214.  
  215. :p.The :hp2.Font:ehp2. dialog allows any fixed-width font present on the system
  216. to be used to display the file. If there is no suitable font, the program will
  217. use the System Proportional font, but text alignment will suffer as a result.
  218. The numbers given after the font names are point sizes.
  219. :p.The :hp2.italic:ehp2. and :hp2.bold:ehp2. checkboxes allow the font to be
  220. displayed in different styles.
  221.  
  222. :euserdoc.
  223.