home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 2 / crawlyvol2.bin / apps / bbs / today201 / todayrpt.fmt < prev    next >
Text File  |  1994-10-29  |  15KB  |  351 lines
  1.  
  2.                   TODAYSRPT.FMT for version 2.01
  3.  
  4.  
  5.          Position           Meaning
  6.           ------  -----------------------------------------------
  7. +-----------      Beginning Marker (ALWAYS a % sign)
  8. |+---------- 1    Function code (as opposed to a heading code (%H))
  9. || +------ 2,3,4  Function name: (see below)
  10. || | +------ 5    Display type: As defined in TODAYS.LNG, 
  11. || | |                          Cardinal, External, Number, Ordinal,
  12. || | |                          Plural, Roman, or Upper Case
  13. || | |+----- 6    Modifier: Word, Number, Suffex, Integer, or Each
  14. || | ||+---- 7    Justification: Left, Right, Center, 0s, or None
  15. || | |||+--- 8+   Justification Value (1-32767) (See Note Below)
  16. || | ||||+--      Ending Marker (ALWAYS a % sign)
  17. ||/|\|||||
  18. %FDOWAWL#%
  19.  
  20.  Notes:
  21.  
  22.      The justification value is any number between 1 and 32767, 
  23.      and will be used to 'align' the text.  The default value is 
  24.      the length of the result of the function (no justification).
  25.  
  26.      Justification values are ignored if No justification is 
  27.      selected in the 7th position.  (You can have them there, but 
  28.      they'll have no effect.)
  29.  
  30.      If the Justification Value is less then the length of the 
  31.      value or word, the value or word will be 'trimmed' to the 
  32.      Justification Value.  (i.e. %FDOWAWL3% would deliver the 3 
  33.      left most characters in the Day Of the Week word defined in 
  34.      TODAYS.LNG, %FDOWAWR3% would deliver the three right most 
  35.      characters.)
  36.  
  37.      The 5th position code A (As defined) means that the word that 
  38.      is in the TODAYS.LNG file will be copied into the function, 
  39.      or that it should come out in a specific format.  See the 
  40.      Function names list below for where it can be used.
  41.  
  42.      Upper, in the display Type (position 5) converts the As 
  43.      defined characters in your TODAYS.LNG file to Upper case.  As 
  44.      with the As defined display type, it is ONLY valid for those 
  45.      functions listed below that have a A to the right of the 
  46.      code.
  47.  
  48.      Cardinal numbers are the numbers used when counting (One, 
  49.      Two, Three, Four, etc.)
  50.      Ordinal numbers are numbers as when used in showing order or 
  51.      succession. (First, Second, Third, Forth, etc.)
  52.      To get Ordinal numbers, use a capitol letter o, not the 
  53.      number 0!
  54.  
  55.      Roman, in the 5th position, gives the value in Roman Numberals.  
  56.      Because the Roman Numberal for 5,000 (a V with a line over it) 
  57.      cannot be displayed, this function is limited to those numbers 
  58.      under 4,000 (1 - 3,999).  There is no Roman Numberal for 0.
  59.  
  60.      External, in the 5th position, provides the user with a method 
  61.      of getting the n-th line out of a external file.  For instance, 
  62.      if the day of the week code (DOW) is used in positions 2 - 4, 
  63.      the program will read the day of the week-th line from the 
  64.      external file.  To provide support for functions resulting in 0, 
  65.      the value is automatically increased by 1.  If the day of the 
  66.      week was Friday, the program would read the 7th line of the 
  67.      file. (Friday is the 6th day of the week + 1 to allow for 0 = 
  68.      7th line.  A typical External support line might look like:
  69.      %FDOWEc:\today\weekday.txt%
  70.  
  71.      Plural, also in the 5th position, tells TODAYS that you want the 
  72.      program to determine the proper word to use (i.e. day or days) 
  73.      to use with the result of the Function code.  TODAYS will append 
  74.      the word onto the end of the number.
  75.  
  76.      Plural, when used with Modifier W in position 6, results with 
  77.      *only* the word (i.e day or days), but *not* the number.
  78.  
  79.      The Suffix option in position 6 is valid ONLY if the Number 
  80.      option is selected in position 5.
  81.  
  82.      The Integer option in position 6 means that the result should 
  83.      always be a number, and that TODAYS should not use the 
  84.      'ZeroSwap' command in TODAYS.CFG for this function.
  85.  
  86.      The 0's option in position 7 is a special Right justification 
  87.      method. It is only valid if the Number option is selected in 
  88.      position 5.  Zeros, instead of spaces, will appear to the 
  89.      left of the Number.
  90.  
  91.   Function names:
  92.  
  93. AH$ A    PostHeader from TODAYS.CFG
  94. APM A    AM or PM
  95. ARD A    Age _to_ Range Date
  96. BDM A    Business Day of Month
  97. BDQ A    Business Day of Quarter
  98. BDW A    Business Day of Week
  99. BDY A    Business Day of Year
  100. BLM A    Business days Left in Month
  101. BLQ A    Business days Left in Quarter
  102. BLW A    Business days Left in Week
  103. BLY A    Business days Left in Year
  104. CD0 A    Current Date (in format dd.mm.yyyy)
  105. CD1 A    Current Date (in format mm/dd/yyyy)
  106. CD2 A    Current Date (in format dd.mm.yy)
  107. CD3 A    Current Date (in format mm/dd/yy)
  108. CDW A    Current Day of Week
  109. COT A    Computer On Time (ddd:hh:mm:ss)
  110. CR$ A    CarridgeReturn from TODAYS.CFG
  111. CRI A    CarridgeReturn with Indent from TODAYS.CFG
  112. CSY A    Current Season of the Year
  113. DA$ A    DefineAfter from TODAYS.CFG
  114. DA0 A    DAte (in format dd.mm.yyyy)
  115. DA1 A    DAte (in format mm/dd/yyyy)
  116. DA2 A    DAte (in format dd.mm.yy - 2 digit year)
  117. DA3 A    DAte (in format mm/dd/yy - 2 digit year)
  118. DCO A    Days Computer has been On
  119. DCS A    Day of Current Season
  120. DLM      Days Left in Month
  121. DLQ      Days Left in current Quarter
  122. DLS      Days Left in Season
  123. DLW      Days Left in Week
  124. DLY      Days Left in Year
  125. DOM      Day Of Month
  126. DOQ      Day Of current Quarter
  127. DOT      Days of computer On Time
  128.  
  129.     Note: The difference between the ?OT and ?CO functions is that 
  130.           the ?OT functions seperate out the COT function into it's 
  131.           component parts, for example if the COT function returned 
  132.           7:12:43:08 then DOT would return 7, HOT would return 12, 
  133.           MOT would return 43, and SOT would return 8.
  134.  
  135.           DCO would also return 7, but HCO would return 180 (7 
  136.           days*24=168+12 hours), MCO would return 10843 (180 
  137.           hours*60=10800+43 minutes), SCO would return 110588 (10843 
  138.           minutes*60=10580+8 seconds).
  139.  
  140.           'Ticks' are computer clock cycles, which for the ST/TT is 
  141.           200, so TCO would return 22117600.
  142.  
  143. DOW A    Day Of Week
  144. DOY      Day Of Year
  145. DS1 A    Days Since Spring
  146. DS2 A    Days Since Summer
  147. DS3 A    Days Since Fall
  148. DS4 A    Days Since Winter
  149. DU1 A    Days Until Spring
  150. DU2 A    Days Until Summer
  151. DU3 A    Days Until Fall
  152. DU4 A    Days Until Winter
  153.  
  154.     Note:   DU# and DS# always use the *next* or the *last* season as
  155.             appropriate.
  156.  
  157. EXT   W  import EXTernal file.  All other modifiers invalid!
  158.  
  159.     Note:   Following the %FEXT should come the name of the file you 
  160.             want TODAYS to load in.  Remember to terminate the command
  161.             with a %.  Example: %FEXTD:\TEXT\IMPORT.TXT%  When run,
  162.             TODAYS will 'import' the D:\TEXT\IMPORT.TXT file directly
  163.             where you have the funtion code.
  164.  
  165. FLM      Full weeks Left in Month
  166. FLQ      Full weeks Left in Quarter
  167. FLS      Full weeks Left in Season
  168. FLY      Full weeks Left in Year
  169. FOL      Full week of year on Line
  170. FOM      Full week Of Month
  171. FOQ      Full week Of Quarter
  172. FOS      Full week Of Season
  173. FOY      Full week Of Year
  174. GMT A    Current Greenwich Time
  175. H12 A    Hour of day (12 hour format)
  176. H24      Hour of day (24 hour format)
  177. HCO  C   Hours Computer has been On
  178. HLD      Hours Left in Day
  179. HOT      Hours of computer On Time
  180. JUD  C   Julian Date (number of days since 1/1/4713 BC)
  181. JYR  C   Julian YeaR
  182. LUN      LUNar year (aka "The Golden Number") (a 19 year cycle)
  183. MCO  C   Minutes Computer has been On
  184. MIN      MINutes of hour
  185. MLD  C   Minutes Left in Day
  186. MLH      Minutes Left in Hour
  187. MLY      Months Left in Year
  188. MOD  C   Minute Of Day
  189. MOH      Minutes Of Hour
  190. MON A    MONth of year
  191. MOT      Minutes of computer On Time
  192. NSY A    Next Season of the Year
  193. PH$ A    AfterHeader from TODAYS.CFG
  194. POD A    Period of Day (Morning, Afternoon, Evening, or Night.)
  195. PT$ A    PreText from TODAYS.CFG
  196. PY$ A    PreYear from TODAYS.CFG
  197. QLY      Quarters Left in Year
  198. QTR      QuarTeR of year (1,2,3, or 4.  Numbers only, no names.
  199. RAN   W  import RANdom line from a external file.
  200.             All other modifiers invalid!
  201.  
  202.     Note:    Following %FRAN must come the name of the file you want
  203.              TODAYS to use.  Remember to terminate the command with a 
  204.              %.  Example: %FRAND:\TEXT\IMPORT.TXT%  When run, TODAYS 
  205.              will count the number of lines in the D:\TEXT\IMPORT.TXT
  206.              file, generate a RANdom number based on that, and 
  207.              'import' the randomly selected line from the file 
  208.              directly where you have the function code.  It's slow, 
  209.              since the file has to be read in once just to figure out 
  210.              how many lines there are in the file, and then read 
  211.              through the file to find the line, but it works.  TODAYS 
  212.              will *not* check to see if the line has been used before.
  213.  
  214. RIY      Roman Indiction or "Tax" Year (a 15 year cycle)
  215. SCO  C   Seconds Computer has been On
  216. SCY      Solar Year Cycle (a 28 year cycle)
  217. SEC      SEConds of minute
  218. SEP A    Seperator from TODAYS.CFG
  219. SLD  C   Seconds Left in Day
  220. SLM      Seconds Left in Minute
  221. SOD  C   Seconds Of Day
  222. SOM      Seconds Of Minute
  223. SOT      Seconds of computer On Time
  224. STD  C   STar Date (Last 4 digits of JULian date)
  225. STP      STar date Point
  226. TCO AC   Time Computer has been On (ddd:hh:mm:ss)
  227. TIM A    Time (hh:mm:ss)
  228. TLD A    Time Left in Day (hh:mm:ss)
  229. TUL      Total number of days Until/since date on Line
  230. WLM      Weeks Left in Month
  231. WLQ      Weeks Left in Quarter
  232. WLS      Weeks Left in Season
  233. WLY      Weeks Left in Year
  234. WOL      Week of year On Line
  235. WOM      Week Of Month
  236. WOQ      Week Of Quarter
  237. WOS      Week Of Season
  238. WOY      Week Of Year
  239. WUL      Number of Weeks Until/since date on Line
  240. YR2      Year (last 2 digits)
  241. YR4  C   Year (4 digits)
  242. ZON A    Current Time ZONe name as defined in TODAYS.LNG
  243.     ^^^
  244.     |||
  245.     ||+-- The W in this column means that the last character of the 
  246.     ||    function name can be changed to a W to force the program to 
  247.     ||    do a word wrap on the line before it is inserted into your 
  248.     ||    report. (functions EXT and RAN *only*!)
  249.     ||
  250.     |+--- The C in this column means that the last character of 
  251.     |     the function name can be changed to a C to produce a 
  252.     |     value that has commas in it.  i.e. JUD would become JUC 
  253.     |     to produce the JUlian date with Commas.
  254.     |
  255.     +---- The A in this column means that either the As defined or 
  256.           Upper display type codes may be used.
  257.  
  258.  ---------------------------------------------------------------------
  259.  
  260.      Below are codes that may be used in addition to the above codes
  261. on the lines within your TODAY.mmm monthly files, any AdditionalFiles
  262. you use, or the AlternateFile in your TODAYS.CFG file.  These codes
  263. *CANNOT* be used in the TODAYS.RPT file!
  264.  
  265. DO0 A  L Date On line (in format dd.mm.yyyy)
  266. DO1 A  L Date On line (in format mm/dd/yyyy)
  267. DO2 A  L Date On line (in format dd.mm.yy - 2 digit year)
  268. DO3 A  L Date On line (in format mm/dd/yy - 2 digit year)
  269. DOL    L Day of the month On the Line from the TODAY.mmm file
  270. DUL    L Days Until/since date on Line, exclusive of months and/or years
  271. DWL A  L Day of Week on the Line from the TODAY.mmm file
  272. DXL    L Number of Days until/since date on line, eXclusive of weeks
  273. DYL    L Day of Year on the Line from the TODAY.mmm file
  274. JOL  C L Julian date of the date On the Line from the TODAY.xxx file
  275. JYL  C L Julian Year of the date on the Line from the TODAY.xxx file
  276. MOL    L Month that is On the Line from the TODAY.mmm file
  277. MUL    L Months Until/since date on Line exclusive of days and/or years
  278. NUL  C L Number of days Until/since the date in columns 2-9 on the
  279.             Line from your TODAY.xxx file(s)
  280. STL    L Stardate of the the date On the Line from the TODAY.xxx file
  281.             (NOTE: No Commas option!)
  282. YOL  C L Year that is On the Line from the TODAY.xxx file
  283. YUL  C L number of Years Until/since the date in colums 5-9 on the 
  284.             Line from your TODAY.xxx file
  285.  
  286.  ---------------------------------------------------------------------
  287.  
  288.     Below are codes that can *only* be used on Range Date lines in 
  289.     the data files.
  290.  
  291. DLR    R Days Left in Range
  292. DOR    R Day of Range
  293. ER0 A  R End of Range date (in format dd.mm.yyyy)
  294. ER1 A  R End of Range date (in format mm/dd/yyyy)
  295. ER2 A  R End of Range date (in format dd.mm.yy - 2 digit year)
  296. ER3 A  R End of Range date (in format mm/dd/yy - 2 digit year)
  297. RNG    R Number of days to display the line for (the Range Of Line)
  298. SR0 A  R Start of Range date (in format dd.mm.yyyy)
  299. SR1 A  R Start of Range date (in format mm/dd/yyyy)
  300. SR2 A  R Start of Range date (in format dd.mm.yy - 2 digit year)
  301. SR3 A  R Start of Range date (in format mm/dd/yy - 2 digit year)
  302.     ^^ ^
  303.     || |
  304.     || +- The L in this column means that the function can *only* be 
  305.     || |  used on a line from your data files.
  306.     || |
  307.     || +- The R in this column means that the function can *only* be 
  308.     ||    used on a Range Date Line from your data files.
  309.     ||
  310.     |+--- The C in this column means that the last character of 
  311.     |     the function name can be changed to a C to produce a 
  312.     |     value that has commas in it.  i.e. JOL would become JOC 
  313.     |     to produce the Julian date with commas.
  314.     |
  315.     +---- The A in this column means that the As defined or Upper           
  316.           display type codes may be used.
  317.  
  318.     NOTE:   When %F codes are used on the lines from the TODAY.mmm 
  319.             file(s) the resultant lines are *NOT* lined up, nor is 
  320.             the year displayed to the left of the text.  Users may
  321.             select to duplicate the method for presenting the years on
  322.             'normal' lines though the use of the %FYOLNNR9% Function
  323.             code.
  324.  
  325. -----------------------------------------------------------------------
  326.                             Math!
  327.  
  328.     As of 03/12/1994, you can do _limited_ math funtions within 
  329. TODAYS.  Currently the only math allowed is addition, subtraction, 
  330. multipication, division, and modula (MOD).
  331.  
  332.     To use TODAYS math within Function codes, the equation you want 
  333. TODAYS to perform *MUST* be enclosed in the brackets: [].  For 
  334. example, to have TODAYS find the day of the year and add 6 to it, you 
  335. would use the code: %FDOY[+6]NNN%.  (The NNN can be any valid Display 
  336. Type, Modifier, and Justification.  I just picked those for 
  337. simplicity.)
  338.  
  339.     You may choose to do more then one operation within the brackets 
  340. if you so choose.  Mathimatics will be performed in a simple left to 
  341. right operation, for example %FJOD[&3+1*10]NNN% will find the Julian 
  342. Date, mod 3 it, add 1, and multiply the result by 10.
  343.  
  344.     The math functions have not been completely tested at this point, 
  345. and I hope in the future to allow Function Codes to be used in 
  346. addition to the above, (i.e. %FDOW[+DOY]NNN% would result in the Day 
  347. of the week plus the day of the year), but for now, that's not 
  348. available.
  349.  
  350.         ** USE MATH FUCTIONS AT YOUR OWN RISK!! **
  351.