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