home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / ELIST410.ZIP / echobase.que < prev    next >
Text File  |  2004-06-28  |  6KB  |  182 lines
  1.  
  2.  
  3.  
  4.              A Guide to Interrogating ...
  5.  
  6.                    ECHOBASE
  7.              The Echolist program
  8.            Copyright (c) 1998 by Dana Bell
  9.  
  10.  
  11.  
  12.      ECHOBASE is a database program that maintains a database of
  13.      echomail conference information.  This particular program was
  14.      written to meet the need to maintain and distribute echomail
  15.      conference lists within FamilyNet.  In addition to published
  16.      lists, you can also get information about the echoes listed in
  17.      the database by sending an ECHOBASE query.
  18.  
  19.      Querying ECHOBASE is done by using either the FTSC netmail system 
  20.      or Internet Email to request information using tags and area names.  
  21.      The program will read the message, search the echolist database and 
  22.      then reply to the person requesting information.
  23.  
  24.      Address netmail messages
  25.  
  26.      To:   ECHOLIST, <address>
  27.      Subj: ECHO QUERY
  28.  
  29.      Address email messages
  30.      To: echolist@fidonet.us
  31.      Subj: ECHO QUERY
  32.  
  33.      and use the following keywords to tag the kind of search and
  34.      response you want.
  35.  
  36.      Search Keywords
  37.      /TAG  or  /T = areatag to search for
  38.      /MOD  or  /M = moderator names to search for (Use '_' for spaces)
  39.      /GROUP or /G = group
  40.      /DESC or /PD = search the description fields for the word(s)
  41.      /PT          = search for tags matching the global tagspec
  42.      /PM          = search for moderators matching the global spec
  43.  
  44.      Response Format Keywords
  45.      /LIST  or /SHORT = one-line response showing Tag and title
  46.      /DETAIL or /LONG = respond with a detailed information about the echo
  47.      /MODUPD          = respond with a message in Moderator Update format
  48.      /FORMAT
  49.      ... %--- = respond with a message using the designated format.
  50.      /HELP            = responds with a help message.
  51.  
  52.      When searching for areatags, ECHOBASE will try to make ONE exact
  53.      match.  When searching for moderator names, ECHOBASE will respond
  54.      will all entries moderated by that person.  When search for a
  55.      moderator or tag with the /PT and /PM options, ECHOBASE does a
  56.      global replacement search (* and ?) for multiple areas.  When
  57.      searching for a word in the description field, ECHOBASE will do
  58.      an imbedded search for the expression specified.  In order to use
  59.      multiple words in a single search, replace spaces with '_'.
  60.      Keywords may be capitalized or lowercase.
  61.  
  62.      All options are sticky.  When you selected /DETAIL information,
  63.      every response will be detailed until you change it to /LIST.
  64.      When you select /MOD information, every search will be for
  65.      moderators until you select one of the other kinds of search.
  66.      It's a good idea to specify the search and response for each line
  67.      of queries.  Words not preceded by / are considered the words or
  68.      names to search for.
  69.  
  70.  
  71.      /T /DETAIL FAMILY HOMELIFE
  72.      /PD /LIST FAMILY HOME CHILD
  73.      /M Dana_Bell
  74.  
  75.  
  76.              Specifying a response format
  77.  
  78.  
  79.      A response format can be defined by using the keyword /FORMAT.
  80.      The actual format must begin on the next and end with the
  81.      terminal sequence %---.  All characters and new lines within the
  82.      format will match the format in each response.  Information for
  83.      each area searched for is designated by using keywords preceded
  84.      by a '%' character.
  85.  
  86.      A keyword followed by a period and a number indicates the number of
  87.      characters to use in the output. That's what's needed to format a
  88.      tabular list.  An actual period following a keyword would be
  89.      formatted with two periods. The Description line is indented 7
  90.      spaces from where the keyword is found, with subsequent lines
  91.      indented 7 spaces from the left margin.
  92.  
  93.      The terminal three dashs (%---) is used to indicate where the
  94.      formatting ends.  The following are two sample formats you might
  95.      use.
  96.  
  97.  
  98.      /FORMAT
  99.      %TAG.20 %MOD.20 %ADDR
  100.      %---
  101.  
  102.      /FORMAT
  103.      %TAG.35
  104.       (%GROUP) %TITL
  105.       Moderator: %MOD %ADDR
  106.       Last changed: %UPDA
  107.      %---
  108.  
  109.      The formatting keywords are
  110.       %TAG      <areatag>
  111.       %TITL     <brief area description>
  112.       %DESC     <description of the echo>
  113.       %MOD      <moderator name>
  114.       %MOD2     <moderator #2>
  115.       %MOD3     <moderator #3>
  116.       %MODS     <all three moderators AND addresses>
  117.       %TOT      <number of nodes carrying this conference>
  118.       %VOL      <number of messages>/Month
  119.       %REST     <Flag restrictions>
  120.       %NOTE     <freeform restrictions>
  121.       %ORIG     <origination of the distribution>
  122.       %DIST     <distribution>
  123.       %GATE     <gateways>
  124.       %GROUP    <group echo belongs with>
  125.       %RULE     <rule file>
  126.       %CREA     <creation date>
  127.       %UPDA     <update date>
  128.       %ADDR     <Moderator's Address>
  129.       %ADDR2    <Moderator #2's Address>
  130.       %ADDR3    <Moderator #3's Address>
  131.       %MSGR     <Messenger>
  132.       %MSGA     <Messenger's Address>
  133.       %LANG     <language>
  134.       %%        literal %
  135.  
  136.  
  137.  
  138.              --- Terminating the message
  139.  
  140.      So that Echobase will know when to stop reading the message for
  141.      keywords, you need to include a line beginning with three-dashes
  142.      to indicate the end of a message. Here's a final, full example.
  143.      This message requests detailed information on tags FAMILY and
  144.      HOMELIFE, and formatted information on all listing in group
  145.      CFN. Note the difference between %--- and ---.
  146.  
  147.      To:   ECHOLIST, 8:70/2
  148.      Subj: ECHO QUERY
  149.  
  150.      /T /DETAIL FAMILY HOMELIFE
  151.      /FORMAT
  152.      %TAG.35
  153.       (%GROUP) %TITL
  154.       Moderator: %MOD %ADDR
  155.       Messenger: %MSGR %MSGA
  156.       Last changed: %UPDA
  157.      %---
  158.      /G CFN
  159.      ---
  160.  
  161.  
  162.                Cookbook Queries
  163.  
  164.  
  165.      In order to query the Echobase Cookbook, the ListKeeper must have
  166.      a Meal master recipe database and have it configured in
  167.      Echobase.  Queries to the Cookbook are limited and simple.
  168.  
  169.  
  170.      Address cookbook query messages
  171.  
  172.      To:   COOKBOOK, <address>
  173.      Subj: <search key>
  174.  
  175.      Echobase will respond with the recipes it has found that have
  176.      <search> in the recipe title. It will probably be best to be as
  177.      precise as possible. A search for Chocolate will give you more
  178.      than you need. Chocolate Cake or Chocolate Chip would give you
  179.      a better chance of finding what you need.
  180.  
  181.  
  182.