home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 12 / CD_ASCQ_12_0294.iso / vrac / tagd083.zip / TAGDUDE.DOC < prev    next >
Text File  |  1994-01-06  |  22KB  |  536 lines

  1.  
  2.                                    TagDude
  3.                                  Version 0.83
  4.  
  5.                         Copyright  1993 Sword Software
  6.  
  7.                 Programmed by Travis Griggs (FidoNet 1:3807/304)
  8.  
  9.  
  10.  
  11.         WHAT IS IT?
  12.         ───────────
  13.         TagDude is a utility dedicated solely to the management of echomail
  14.         taglines.  TagDude will allow you to insert taglines into virtually
  15.         any message editor that allows you to "read" or upload ASCII text
  16.         files into the current message or document.  But it doesn't stop
  17.         there!  You can also "steal" taglines as you're reading mail and
  18.         insert them into a single tagline storage file.  TagDude can also
  19.         sort the data file and search for duplicate taglines!
  20.  
  21.         If you're already collecting taglines have no fear, TagDude can
  22.         import your collection and add it to the data file or you can start
  23.         a new collection. However, TagDude comes complete with a collection
  24.         of 200 great one liners that should keep you ROTFLOL for quite some
  25.         time...!!
  26.  
  27.  
  28.  
  29.         SHAREWARE NOTICE
  30.         ────────────────
  31.         TagDude is shareware, not freeware. If you find this program useful
  32.         and want to continue using it longer than 30 days you must register
  33.         it.  Registration is only $10.00 (US Funds) and is "one time only".
  34.         Your support will help to insure updates to this program.  Please
  35.         read REGISTER.FRM for more information.  Thanks for trying TagDude!
  36.  
  37.  
  38.         DISCLAIMER
  39.         ──────────
  40.         TagDude is guaranteed to do nothing but take up space on your hard
  41.         drive.  In no event and under no circumstances will the author of
  42.         this program be held liable for any damages including but not
  43.         limited to hardware, software, lost profits and/or savings, or any
  44.         other consequential damages arising out of your use or inability to
  45.         use this program, or for any other claims by another party.
  46.  
  47.  
  48.         PACKING LIST
  49.         ────────────
  50.         70TO80.EXE --- Converts TAGDUDE.CFG to the new config format
  51.         CONTENTS.DOC - The packing list.
  52.         REGISTER.FRM - Registration form and information.
  53.         TAGDUDE.DOC -- What you are reading right now!
  54.         TAGDUDE.EXE -- Main executable program file.
  55.         TAGDUDE.HIS -- History of TagDudes evolution.
  56.         TAGDUDE.TLN -- Binary data file containing 200 taglines.
  57.         UPGRADE.DOC -- Upgrading to TagDude 0.80 and future TagDude features
  58.  
  59.                                 INSTALLATION
  60.                                 ────────────
  61.  
  62.  
  63.         TagDude was originally written for use with Front Door so it is
  64.         referenced throughout this installation section although TagDude can
  65.         be used with almost any editor or term program.  Other setup
  66.         examples are included later in this document.
  67.  
  68.  
  69.         I.  Initial Installation and Configuration
  70.         ──────────────────────────────────────────
  71.         Copy the above files into the directory of your choice.  You are now
  72.         ready to crank up TagDude...!  Run TAGDUDE.EXE.  When you run the
  73.         program for the first time it will automatically go into the
  74.         configuration menu.  Anytime TagDude does not find TAGDUDE.CFG in
  75.         the current directory, it will go into the config menu.  Here's an
  76.         explanation of the options with their default values:
  77.  
  78.         Taglines Filename           : TAGLINES.TLN
  79.         Import Tagline Filename     : Q.
  80.         Export Tagline Filename     : T.
  81.         Highlight Effect Speed      : 20
  82.         Ripple Effect Speed         : 20
  83.         Direct Video Writes         : Yes
  84.         Check for Snow              : No
  85.         Advertisement Under Tagline : Yes
  86.         Show Number of Taglines     : Yes
  87.         Duplicate Detection         : Yes
  88.         Monochrome Display          : No
  89.  
  90.  
  91.         (1) Taglines Filename:
  92.         ──────────────────────
  93.         This is the name of the file where the TagDude taglines are stored.
  94.         The *.TLN file can store an unlimited number of taglines.  The *.TLN
  95.         file is stored as a binary file so you cannot edit it outside of the
  96.         program.  NOTE: Pre existing ascii text files can be uploaded into
  97.         the *.TLN file from the maintenance menu which is covered later in
  98.         this document.
  99.  
  100.  
  101.         (2) Import Tagline Filename:
  102.         ────────────────────────────
  103.         This is the name of the file TagDude will automatically look for
  104.         whenever the program is run, to upload "stolen" taglines that you
  105.         have accumulated since last running TagDude.  This topic is covered
  106.         in more detail later in this document.  If this filename is
  107.         changed from the default of "T." you'll need to change any
  108.         reference of this filename to the new filename.
  109.  
  110.  
  111.         (3) Export Tagline Filename:
  112.         ────────────────────────────
  113.         This is the name of the file TagDude will export the selected
  114.         tagline to.  You can then import this file into your message.
  115.  
  116.  
  117.         (4) Spotlight Effect Speed:
  118.         ───────────────────────────
  119.         This variable controls the speed at which the "spotlight" effect
  120.         moves.  The higher the number the SLOWER the cursor spins and visa
  121.         versa.  You can disable the spinning cursor by setting the speed
  122.         below 1.
  123.  
  124.  
  125.         (5) Ripple Effect Speed:
  126.         ────────────────────────
  127.         This is the speed at which the "ripple" effect moves from side to
  128.         side.  As on the spinning cursor, the higher the number the slower
  129.         the effect will be.  Setting this variable to below 1 will disable
  130.         it.
  131.  
  132.  
  133.         (6) Direct Video Writes:
  134.         ────────────────────────
  135.         The program defaults to DIRECT screen writes.  Unless you are
  136.         running a multi-tasker such as DesqView, you should leave this as
  137.         is.
  138.  
  139.  
  140.         (7) Check for Snow:
  141.         ───────────────────
  142.         If you are seeing "snow" on your screen, turn this option on.  The
  143.         default setting is OFF and should work with most newer monitors. You
  144.         should only need this option if you're using an older CGA monitor.
  145.  
  146.  
  147.         (8) Advertisement Under Tagline:
  148.         ────────────────────────────────
  149.         This option will turn OFF/ON the advertisement for TagDude that
  150.         appears under the imported tagline.  The default is ON and cannot be
  151.         changed unless you REGISTER THIS PROGRAM.
  152.  
  153.  
  154.         (9) Show Number of Taglines:
  155.         ────────────────────────────
  156.         This option will turn OFF/ON the bragging about the number of
  157.         taglines you have.  For example:
  158.  
  159.         Show Number of Taglines ON:
  160.  
  161.         ... What's a tagline?
  162.         ___ TagDude 0.83+ with 9356 taglines
  163.  
  164.         Show Number of Taglines OFF:
  165.  
  166.         ... What's a tagline?
  167.         ___ TagDude 0.83+
  168.  
  169.  
  170.         (A) Duplicate Detection:
  171.         ────────────────────────
  172.         This option will turn ON/OFF the dupe detection feature used when
  173.         "stealing" tagline.  When importing "stolen" taglines, this option
  174.         will scan your existing database file to make sure you're not
  175.         importing a tagline you already have.
  176.  
  177.  
  178.         (B) Monochrome Display:
  179.         ───────────────────────
  180.         Turns ON/OFF support for monochrome monitors.  The default is OFF.
  181.  
  182.  
  183.         II.  Command Line Parameters
  184.         ────────────────────────────
  185.         TagDude has many command line parameters.  You may use them any
  186.         order you like.
  187.  
  188.         TAGDUDE -ADD1 TIMED.MSG
  189.  
  190.         This will cause TagDude to add a tagline to a text file.  This is
  191.         used when TagDude is used with a message reader that uses an
  192.         external editor.  The file to add the tagline to must follow right
  193.         after the -ADD1 parameter like shown above.  This parameter is fully
  194.         explained later in the documentation.  -ADD1 is the first step to
  195.         the adding of a tagline to a text file.  -ADD2 is the second step
  196.         of adding a tagline to a text file.
  197.  
  198.         TAGDUDE -CONFIG
  199.  
  200.         Pulls up the configuration menu for TagDude.
  201.  
  202.         TAGDUDE -C:TAGDUDE1.CFG
  203.         TAGDUDE -C:C:\OTHER.CFG
  204.  
  205.         TagDude will use the filename specified after -C: for the config
  206.         instead of default filename TAGDUDE.CFG.
  207.  
  208.         TAGDUDE -DUPE
  209.  
  210.         TagDude will remove duplicate taglines from the database then
  211.         terminate.  This can be used to have TagDude remove duplicate
  212.         taglines from inside an event from a mailer.
  213.  
  214.         TAGDUDE -MONO
  215.  
  216.         TagDude will use monochrome colors.  This overrides what is set in
  217.         the config.
  218.  
  219.         TAGDUDE -NOASK
  220.  
  221.         This causes TagDude to not ask you if you want to pick your own
  222.         taglines.  TagDude picks a random tagline instead.
  223.  
  224.         TAGDUDE -NOSIG
  225.  
  226.         TagDude will not import the signature file, TAGDUDE.SIG, even if it
  227.         exists.
  228.  
  229.         TAGDUDE -SORT
  230.  
  231.         TagDude will sort the tagline database then terminate.  This is
  232.         mainly used for setting this up in an event on a mailer.
  233.  
  234.         TAGDUDE -T:C:\TAGDUDE\TAGLINES.TLN
  235.         TAGDUDE -T:TAGLINES.TLN
  236.  
  237.         TagDude will use the the file specified after -T for the tagline
  238.         database instead of the database specified in the config file.
  239.  
  240.         Here's a few examples:
  241.  
  242.         TAGDUDE -ADD2 TIMED.MSG -T:TAGDUDE2.TLN -NOASK
  243.         TAGDUDE -DUPE -SORT -T:TAGDUDE2.TLN
  244.         TAGDUDE -NOASK -T:TAGDUDE2.TLN -NOSIG
  245.         TAGDUDE -T:TAGDUDE2.TLN -NOASK -C:TAGDUDE2.CFG
  246.  
  247.  
  248.         III. Setting Up TagDude To Work With Your Editor
  249.         ────────────────────────────────────────────────
  250.         TagDude will work with almost any editor on the market.  Quite a few
  251.         of the offline message readers use external editors to write
  252.         messages.  If you have setup TagDude on a program that I don't have
  253.         listed below please send this setup information to me.  The end of
  254.         this document shows how to get into contact with me.  Below are a
  255.         few examples...
  256.  
  257.  
  258.         For External Editors (TimEd, etc.)
  259.         ──────────────────────────────────
  260.         For this example we are using QEDIT for the external editor, which
  261.         is called from the offline mail reader.
  262.  
  263.         Configure your mailer/offline mail reader to call QE.BAT as the
  264.         editor.  Below is the QE.BAT file:
  265.  
  266.         @ECHO OFF
  267.         TAGDUDE -ADD1 %1
  268.         Q %1
  269.         TAGDUDE -ADD2 %1
  270.  
  271.         Thats all there is to it.  When you finish writing your message it
  272.         will automatically add a tagline to the end of it.  If there is a
  273.         tear line and/or origin line TagDude will add the tagline above
  274.         either of the two.  TagDude will also scan the message to make sure
  275.         there is not a tagline already there.  If it finds one, it will
  276.         abort and you'll be on your way.  If TagDude sees the message hasn't
  277.         changed then a tagline will not be added to the message.
  278.  
  279.         The above configuration SHOULD work with almost ANY offline message
  280.         reader that uses an external editor.
  281.  
  282.  
  283.         For FrontDoor's Editor
  284.         ──────────────────────
  285.         As stated earlier, this program was originally written for use in
  286.         FrontDoor's message editor.  Go into the FDSETUP program and pick
  287.         the Editor option.  From there choose the Keyboard Macros option.
  288.         Setup a macro as follows:
  289.  
  290.         File   Global   Mailer   Editor   Terminal   Modem     Manager
  291.         ═════════════════════════╒═════════════════╕════════════════════
  292.         ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ Miscellaneous   │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  293.         ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ Keyboard macros │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  294.         ▒╒═══════════════════════════════════════════════════════════╕▒▒
  295.         ▒│                                                           │▒▒
  296.         ▒│                                                           │▒▒
  297.         ▒│ F1  ~ETagDude;~It;~#                                      │▒▒
  298.         ▒│ F2                                                        │▒▒
  299.         ▒│ F3                                                        │▒▒
  300.         ▒╘═══════════════════════════════════════════════════════════╛▒▒
  301.         ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  302.  
  303.  
  304.         NOTE: For this setup to work configured exactly as shown above, you
  305.         must have TagDude in your FrontDoor directory.  If you don't, then
  306.         you will need to add the path to the macro.
  307.  
  308.         Now all you have to do is call the macro when you're ready to save
  309.         the message in FrontDoor's Editor.  Also, if you have option (9) in
  310.         the configuration set to YES then TagDude will automatically save
  311.         the message after importing the tagline into it.
  312.  
  313.  
  314.         For TerMail (Terminate's Point System)
  315.         ──────────────────────────────────────
  316.         Use the same setup as the external editor section but change the
  317.         "%1" to TMAIL.MSG.
  318.  
  319.  
  320.         For Renegade BBS Software
  321.         ─────────────────────────
  322.         TagDude can also be used with the Renegade BBS Software.  It can
  323.         only be used on the SysOp's side.  Create a batch file named
  324.         GLOBAT1.BAT in your main RG directory.  Below is the GLOBAT1.BAT
  325.         contents:
  326.  
  327.         @ECHO OFF
  328.         CLS
  329.         TAGDUDE
  330.  
  331.         Go in the System Config of Renegade under D. System variables.
  332.         Create a macro that contains the following:
  333.  
  334.         /ut.<ENTER>
  335.  
  336.         Don't type the <ENTER> just press ENTER.  The macro should turn into
  337.         "/ut.^M".  It's that simple.  When you are done writing a message
  338.         press ALT-1 which will call GLOBAT1.BAT to select the tagline. After
  339.         it gets back to Renegade press ALT-F1 (this will be different if you
  340.         used a another macro) which will import the tagline into the
  341.         message.
  342.  
  343.  
  344.         IV.  NORMAL OPERATION
  345.         ─────────────────────
  346.         You basically only have 2 options when running TagDude under normal
  347.         operation.  They are:
  348.  
  349.         Type of Tagline Selection: User Selected │ Randomly Selected
  350.  
  351.         If you choose "Randomly Selected", TagDude will randomly select
  352.         a tagline from the database file and write it to the export file
  353.         (explained earlier in this document) which in turn will be
  354.         uploaded into your message.
  355.  
  356.         If you choose "User Selected", which is the default option, the
  357.         Tagline Selection Menu will come up.  From this menu you can
  358.         scroll through the taglines in your database file and select the
  359.         one you want.
  360.  
  361.         The options for the Tagline Selection Menu are as follows:
  362.  
  363.         (E)dit tagline - This option will allow you to edit the current
  364.         highlighted tagline.
  365.  
  366.         (D)elete tagline - This option marks the current highlighted tagline
  367.         for later deletion.
  368.  
  369.         (U)ndelete tagline - This option unmarks the current highlighted
  370.         tagline.
  371.  
  372.         (S)earch for tagline - Prompts you for the text to search for in
  373.         your tagline database file.
  374.  
  375.         (R)andom tagline - Jumps to a randomly selected tagline in the
  376.         database file.
  377.  
  378.         (A)dd tagline - Allows you to manually insert a tagline into the
  379.         database file.
  380.  
  381.         (G)o to tagline # - Prompts you for the number of the tagline to
  382.         jump to.
  383.  
  384.         (M)aintenance menu - Takes you to the Maintenance Menu (explained
  385.         next).
  386.  
  387.         (C)onfiguration menu - Takes you to the Configuration Menu
  388.         (explained earlier in this document).
  389.  
  390.  
  391.         Maintenance Menu
  392.         ────────────────
  393.         The Maintenance Menu will let you make changes and update your
  394.         tagline database file.  Below are the options and their functions.
  395.  
  396.         (1) Sort tagline database - Uses a fast sort to sort the
  397.         taglines in the current tagline file.
  398.  
  399.         (2) Search for and remove duplicate taglines - TagDude will
  400.         sort the taglines first.  TagDude will then make *ONE* sweep to
  401.         flag the duplicates for deletion.  TagDude will then remove the
  402.         flagged taglines.  During the duplication removal TagDude uses a
  403.         fuzzy logic duplication removal routine.  For example all of the
  404.         below taglines TagDude will consider them duplicates:
  405.  
  406.         Hey!  I have 5000 taglines!
  407.         Hey, I have 2445 taglines.
  408.         HEY!!!  I have 2485239 taglines......
  409.         Hey. I have 2 taglines.
  410.  
  411.         And so on....
  412.  
  413.         (3) Remove deleted taglines from tagline database - This option will
  414.         delete any tagline you "marked" (see option "D" in the Tagline
  415.         Selection Menu section) earlier.
  416.  
  417.         (4) Import text file into tagline database - This option allows you
  418.         to import any ASCII text file into your tagline database file.
  419.  
  420.         (5) Export tagline database to text file - This option will output
  421.         an ASCII text file format of your current tagline database file.
  422.  
  423.  
  424.         V.  OTHER USEFUL OPTIONS
  425.         ────────────────────────
  426.  
  427.         How To Steal Taglines
  428.         ─────────────────────
  429.         TagDude does not actually steal taglines.  You must first copy the
  430.         message with the tagline in it you want to steal, to the file you
  431.         defined earlier for IMPORT FILENAME.  There is no limit to the
  432.         amount of actual messages you can put in this file before running
  433.         the program.
  434.  
  435.         When you run TagDude, it will look for the file defined under the
  436.         IMPORT FILENAME options in the configuration menu.  If it finds such
  437.         a file, it will then search the entire contents of that file for
  438.         taglines.
  439.  
  440.         After TagDude searches the "import file", it then prompts you with a
  441.         listing of all the taglines it found and you have the option to keep
  442.         those you want and throw away those you don't.
  443.  
  444.         TagDude will automatically delete the "import file" when it is
  445.         through with it.
  446.  
  447.  
  448.         Auto Signature
  449.         ──────────────
  450.         TagDude can even sign your name to the message as it uploads the
  451.         tagline.  When TagDude is ready to create the "export file" it will
  452.         look in the current directory for an ASCII text file named
  453.         TAGDUDE.SIG.  If found, TagDude will insert it's contents above the
  454.         tagline and then create the "export file".  This is useful for
  455.         defining a signature you want to appear on every message you write
  456.         (and use TagDude on...).
  457.  
  458.  
  459.         Suggestions and/or Comments
  460.         ───────────────────────────
  461.         For any questions or comments send netmail to 1:3807/304 or write a
  462.         letter to the address below.  If desired, you may use
  463.         routed-netmail. I'm a mail only system so please send direct netmail
  464.         between 3am-6am Central Time.
  465.  
  466.         Travis Griggs
  467.         3528 Linda Lane
  468.         Lake Charles, La.  70605
  469.  
  470.  
  471.         Where to get the latest version of TagDude
  472.         ──────────────────────────────────────────
  473.         The latest version of TagDude can be retrieved by logging on to one
  474.         of the below bbs's:
  475.  
  476.         Center of the Universe  1-(603)-435-7771    14.4k V.32bis/V.42bis
  477.         Ice Castle              1-(509)-736-0976    14.4k V.32bis/V.42bis
  478.         Lyons' Den (Node 1)     1-(318)-582-6411    14.4k V.32bis/V.42bis
  479.         Lyons' Den (Node 2)     1-(318)-582-3509    14.4k V.32bis/V.42bis
  480.         Sox! Bbs                1-(305)-821-3317    DS/HST 16.8k V.32bis
  481.         Stargate Oregon         1-(503)-756-3887    9600 V.32/V.42b
  482.          └──> 9 PM to 9 AM Daily PST
  483.  
  484.         If you have a FidoNet mailer then File Request with the magic name
  485.         of "TAGDUDE" (without quotes) from one of the below nodes:
  486.  
  487.         1:132/233  -  SysOp: Jeff Casey, 14.4k V.32b/V.42b
  488.         1:3807/100 -  SysOp: Todd Lyons, 14.4k V.32b/V.42b
  489.         1:3807/101 -  SysOp: Tony Lyons, 14.4k V.32b/V.42b
  490.         1:135/71   -  SysOp: Ronnie Toth, USR DS/HST 16.8k V.32b/V.42b
  491.         1:3407/10  -  SysOp: Randy Weaver, 14.4k V.32b/V.42b
  492.         1:356/3    -  SysOp: Les Lemke, 9600 V.32/V.42b (9PM-9AM PST)
  493.  
  494.         Special thanks to the following individuals
  495.         ───────────────────────────────────────────
  496.         (in alphabetical order)
  497.  
  498.         Bob Huth - The first person that ever asked for TagDude - He helped
  499.         me realize that people actually wanted TagDude.  If it wasn't for
  500.         Bob, I would have selfishly kept TagDude for myself. (everybody give
  501.         a big applause for Bob!)  Bob assisted in testing TagDude in it's
  502.         early stages. Thanks Bob for your creative suggestions.
  503.  
  504.         Les Lemke - Suggested I write TagDude to insert taglines into text
  505.         files for use with other mail readers.  Les helped test this added
  506.         feature and also gave some excellent suggestions.
  507.  
  508.         Todd Lyons - Provides a place for TagDude to be file requested 24
  509.         hours a day (which helped out a lot!).  Thanks for the help in
  510.         alpha/beta testing TagDude.
  511.  
  512.         James Richardson - Helps me alpha/beta test TagDude and nags me to
  513.         convert to C++(in his dreams<grin>!).  He let me borrow his
  514.         monochrome XT to implement monochrome support in TagDude.
  515.  
  516.         James Surles - Helped me include a very fast sorting routine in
  517.         TagDude.
  518.  
  519.         David Wynn - Provides a place for TagDude to be file requested 24
  520.         hours a day.  And also, for writing these excellent docs so you
  521.         wouldn't have to figure it all out for yourself!
  522.  
  523.  
  524.         Alpha testers
  525.         ─────────────
  526.         William Barzee   -  1:260/366
  527.         Jeff Casey       -  1:132/233
  528.         Bob Huth         -  1:356/5
  529.         Les Lemke        -  1:356/3
  530.         Todd Lyons       -  1:3807/100
  531.         James Richardson -  1:3807/304.304
  532.         James Surles     -  1:3807/307
  533.         Randy Weaver     -  1:3407/10
  534.         David Wynn       -  1:3807/300
  535.  
  536.