home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / c / calendar / !Calendar / !Help < prev    next >
Text File  |  1992-02-14  |  7KB  |  161 lines
  1. Intoduction
  2.  
  3. This application is public domain, it may be copied freely provided that all 
  4. files are kept together. It may not be sold for profit except for a nominal 
  5. handling charge. Portions of the code may be used in your own programs 
  6. providing recognition to the author is given. The author accepts no 
  7. responsibility for any loss or damage resulting from the use of this 
  8. application.
  9.  
  10. This application is intended to create calendars by sending data to 
  11. Computer Concepts document processor (Impression), or any other application
  12. which requests it, using their ImpulseII protocol.
  13.  
  14. Several example calendars are supplied, these may be accessed by clicking 
  15. on the icon bar icon to open the main control window and then double 
  16. clicking on the 'Calendars' directory icon. Each calendar document 
  17. contains Impression Merge commands to request specific information such 
  18. as the year, month, week or day. This information is sent to the document 
  19. by the !Calendar application.
  20.  
  21. Buttons and Options
  22.  
  23. To create a calendar drag one of the calendar documents, called a template,
  24. onto the main window or onto the calendar icon on the icon bar. The full
  25. pathname of the file will appear in the icon in the centre of the main
  26. window. The Create button will start the merge operation with Impression but
  27. there are several options, controlled by the option icons, which determine
  28. how the calendar is generated. These are explained below.
  29.  
  30. Print :-
  31.         When on this option will cause a Print command to be sent to 
  32.         Impression after the calendar data has been sent to the 
  33.         document. If a printer driver is loaded then the contents of the 
  34.         template, with the merged data, will be printed.
  35.  
  36. Keep Result :-
  37.         This option causes the result of the merge operation to be kept 
  38.         so that you may edit it. This means that the merge commands 
  39.         no longer exist in the document so if you save it you cannot 
  40.         load it in afterwards and generate a different calendar. You 
  41.         should ensure that a copy of your original document, with its 
  42.         merge commands, is kept safe.
  43.  
  44. Use Start/End Month :-
  45.         This option is used when you have a template document 
  46.         which contains Merge commands for only one or two months, 
  47.         and you want to use that document as a template for a range of 
  48.         months. The range used is those months between the values 
  49.         shown in the Start Month and End Month icons at the top of 
  50.         the window.
  51.  
  52. Pause after Merge :-
  53.         This option is handy for examining the results of the merge 
  54.         operation before they are printed or lost. The document is 
  55.         placed in a non-editable state which is shown by the pointer 
  56.         turning into a cross when moved over it.
  57.  
  58. The default options at startup are just Print, with this combination data 
  59. would be sent to the template document and then the results would be 
  60. printed. With Use Start/End Month set as well, a template containing just 
  61. one month would be repeatedly merged and printed.
  62.  
  63. The three sets of "bump" icons at the top of the window control the year 
  64. and the start and end months, the latter two coming into effect with the 
  65. Start/End Month option described above. The year comes up with the 
  66. current year from the real time clock in the computer. Clicking with Adjust 
  67. on any bump icon will perform the opposite action to that of Select.
  68.  
  69. The only icon not mentioned yet is the Cancel button. This will abort the 
  70. current operation and return to the state before Create was pressed. 
  71. Unfortunately, because the message passing which takes place when 
  72. merging is the highest priority event to which the Wimp responds, no 
  73. buttons or option icons will respond whilst merging.
  74.  
  75. Impulse Commands
  76.  
  77. Impulse is a Public Domain high level message passing system written by 
  78. Computer Concepts Ltd. Messages may be passed between applications 
  79. such as Impression II and Minerva's MultiStore database as a means of 
  80. controlling their actions. Contact Computer Concepts for more details.
  81.  
  82. What follows is a list of the methods to which Calendar responds. The first
  83. set of commands do not return a result and so are not meant to be inserted
  84. into an Impression merge command. They are intended for another application
  85. to control Calendar. All except the SetPrefix command are self-explanatory
  86. as they do the same job as their icon namesakes described above. SetPrefix
  87. is provided so that an application other than Impression may be sent the
  88. merge data. The name of the application must be given after the SetPrefix
  89. command then all it needs to do is respond to the Merge, Edit and Print
  90. commands in the same way as Impression.
  91.  
  92. <on/off> may be either 'ON' or 'OFF' the case does not matter. Quit will
  93. shutdown the application in the same way as choosing quit from the icon bar
  94. menu.
  95.  
  96. { methods :
  97.     SetOption
  98.         ( -Print <on/off> | -UseMonth <on/off>
  99.         | -Pause <on/off> | -Keep <on/off> )
  100.  
  101.     Cancel
  102.     Quit
  103.     Create
  104.     SetPrefix <string>
  105. }
  106.  
  107. This second set of commands are intended to be used in the merge commands in
  108. the Impression document. <month> may be either the number 1 to 12 or the
  109. name of the month itself e.g. January. Similarly <day> is 1 to 7 or the name
  110. of the day.
  111.  
  112. GetDate is used to get either day numbers (1..31) or the names of days
  113. (Sunday..Monday). If the day is not specified (no -Day), then a week is
  114. given starting from Sunday. If -Format <number> is used, then the names of
  115. the days are returned to the number of characters rquested.
  116.  
  117. A tab is inserted for days which are blank, i.e. those before the first of
  118. the month and after the end of the month. If the word 'Current' is used then
  119. the month currently selected is used as the one to return the data for. The
  120. word 'Next' can also be used here to select the next month, which is then
  121. returned as the merge data.
  122.  
  123. NextMonth returns null data to Impression, it is used to instruct Calendar
  124. to move onto the next month. This would typically be used at the end of a
  125. template which contained only one month, so that the next merge operation
  126. would start with the next month.
  127.  
  128. Set is another command which returns null data, it is used to force a
  129. particular year, month or range of months to be generated.
  130.  
  131. { methods :
  132.     GetDate
  133.         -Month ( <month> | Current )
  134.         -Week <1..6>
  135.         [ -Day <day> ]
  136.         [ -Format <length of returned string> ]
  137.  
  138.     GetMonth
  139.     GetYear
  140.     NextMonth
  141.  
  142.     Set
  143.         [ -Month <month> ]
  144.         [ -Year <number> ]
  145.         [ -StartMonth <month> ]
  146.         [ -EndMonth <month> ]
  147. }
  148.  
  149.  
  150. ImpulseII is a trademark of Computer Concepts Ltd           
  151.  
  152. Revision History:
  153.  
  154. 15/2/92:
  155.     First release                        
  156.  
  157.  
  158. © Dale Cass 1992
  159. © SFC 1992
  160.  
  161.