home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / internet / fidomail_1 / !FidoMail / Dox / ExpandInfo < prev    next >
Text File  |  1994-02-17  |  5KB  |  133 lines
  1. About the expanded strings: Footer, Quote, TearLine & Origin.
  2.  
  3. These are defined in the !Config file, in one of 4 ways:
  4.  
  5. Type 1: "" or not defined at all
  6. Type 2: "<string>"
  7. Type 3: "%File:<filename>"
  8. Type 4: "%List:<filename>"
  9.  
  10. Type 1:
  11. This will not insert anything in your messages, not even empty lines. To get
  12. empty lines, use " " (a space). The Origin text must not be empty, so a text
  13. is mandatory. The TearLine text can be empty (giving only '--- '), but if it
  14. is undefined, it will revert to 'FidoMail v.<version> (<date>)'.
  15.  
  16. Type 2:
  17. This will insert the given string into your messages, after expanding it
  18. according to the rules below.
  19.  
  20. Type 3:
  21. This command causes redirection to the named file. A random line is read from
  22. the file, and then processed as a new command, which may be of types 1-4.
  23.  
  24. Type 4:
  25. Another type of redirection. This is like type 3, but it is not a random line.
  26. Instead, the line read will depend on the area you are writing the message to.
  27. Each line should start with '<area>:', e.g.
  28. 'ARCHIMEDES:%File:<FidoMail$Dir>.Domains.Fidonet.Misc.ArcFooters'
  29. This will take a random line from that file when writing messages in the
  30. Archimedes area. Special areas are '<NET>', '<JUNK>', and '<ALL>'.
  31. If '<ALL>' is met before the area could be found, that line will be used.
  32.  
  33. Then, finally, when a normal string is remaining, it will be expanded.
  34. This process is controlled by putting %-variables in the string. A %-variable
  35. consists of a % and one or more letters, which will then be replaced by some
  36. part of the message.
  37. Currently recognised fields are:
  38.  
  39. Field:    Replaced by:
  40. %t    To (The receiver of the message)
  41. %t1    To (first name)
  42. %t2    To (surname)
  43. %s    The subject of the message
  44. %d    The date of the message (the original, if writing a reply)
  45. %c    The time of the message (otherwise as %d)
  46. %q    The person you are quoting (usually the same as %t)
  47. %q1    The person you are quoting (first name)
  48. %q2    The person you are quoting (surname)
  49. %a    Quote header: The area in which the quoted message belongs.
  50.     Footer: The area in which your new message is.
  51. %i    Same as %a except this is the actual fido-identifier for the area.
  52. %%    %
  53.  
  54.  
  55.                                   Examples:
  56.                                   ---------
  57.  
  58. --> Generating a random footer from a file of footers.
  59. ------------------------------------------------------
  60.  
  61. Make sure the footer-file contain single-line footers (not too long)
  62. separated by LF (!). Put the file in the 'Misc' directory inside !FidoMail
  63. for convenience. Let's say it is called 'Footers'.
  64. In the !Config file, you would write:
  65.  
  66. Footer   "%File:<FidoMail$Dir>.Domains.FidoNet.Misc.Footers"
  67.  
  68.  
  69. --> Generating a different Origin line for each area.
  70. -----------------------------------------------------
  71.  
  72. If, for example, you have 7 areas speaking different languages, you could make
  73. a file like this:
  74.  
  75. <NET>:
  76. ARCHIMEDES:Point Blank
  77. ARCCOMMS:A Pointless Point
  78. ARCPROG:Point of No Return
  79. ZAKE:Beze mel yrk Point krutzfer heno
  80. TEUSCH:Point "Boom Thscak"
  81. UMBA:Hrunga okosa Urapun
  82.  
  83. Put it in the Misc directory as before, named 'Origins'
  84. Then, in the !Config file, write:
  85.  
  86. Origin "%List:<FidoMail$Dir>.Domains.Fidonet.Misc.Origins"
  87.  
  88. The first area, which is netmail, would have no string, as there's no * Origin
  89. line on netmails. Each of the other 6 areas will have their own origin line.
  90.  
  91.  
  92. --> Generating random footers in several languages.
  93. ---------------------------------------------------
  94.  
  95. This is done as a combination of the above.
  96. If, for example, you have 2 footer-files, imaginatively called 'FootersUK' and
  97. 'FootersDK', containing footer-lines in English and Danish.
  98. First, the !Config file should read:
  99.  
  100. Footer "%List:<FidoMail$Dir>.Misc.FooterPtr"
  101.  
  102. The 'FooterPtr' file should consist of 1 line per area:
  103.  
  104. <NET>:=== My Point - Mit Point ===
  105. ARCHIMEDES:%File:<FidoMail$Dir>.Domains.FidoNet.Misc.FootersUK
  106. ARCCOMMS:%File:<FidoMail$Dir>.Domains.FidoNet.Misc.FootersUK
  107. ARCPROG:%File:<FidoMail$Dir>.Domains.FidoNet.Misc.FootersUK
  108. LOKALA:%File:<FidoMail$Dir>.Domains.FidoNet.Misc.FootersDK
  109. LOKALQ:%File:<FidoMail$Dir>.Domains.FidoNet.Misc.FootersDK
  110.  
  111. The first line is in both languages for netmails, but could simply be empty
  112. to get no footers on netmails. The next 3 areas have English footers, and the
  113. last 2 have Danish ones. Any other areas will have no footer, since there is no
  114. '<ALL>:' line.
  115.  
  116.  
  117. --> Interresting quoting.
  118. -------------------------
  119.  
  120. You could have a selection of Quote-headers in a file and select one at random.
  121. The file could contain:
  122.  
  123. Quoting %q:
  124. Well, %q, %d you said:
  125. I suddenly saw %q writing:
  126. %q said this about '%s':
  127. Allow me to quote %q:
  128. ... and so on.
  129.  
  130. So, as you see, the % fields will be replaced by the relevant data as described
  131. above. You can combine this with the previous example to get both quote-headers
  132. and footers in different languages (or to suit different moderators :-).
  133.