From: Christian Meunier (meunierc (at) acm.org)
Subject: ANNOUNCE: A documentation set for SMART, rev. 1.0 
Newsgroups: comp.ai.nat-lang, comp.text, comp.theory.info-retrieval
Date: 1999/07/14 
 

In may, I have (pre-)released a document set for the SMART
software, a tool for information research and text retrieval.
It is available for reading or download at
http://donalde.dhs.org/Smart/ .

Support for editing this document will be limited (see document),
but i'll be glad to hear if there is any error/omission in the
document set.

See "Acknowledgement" (below) for credits about SMART; see the
document itself for bits of history about the project.

Christian Meunier
----------------------------------------------------------------------
Christian Meunier, B.Sc., M.Ing., Polytechnique de Montreal
e-mail: meunierc (at) acm.org
web:    http://pages.infinit.net/meunierc
----------------------------------------------------------------------


-------------
Introduction to this document 

This document is a term project for a graduate course. The course
presented the SMART system as a tool for Information Research, and given
the current state of the SMART documentation, it seemed a good idea to
use this opportunity to write a bit of documentation for the system. 

The document does has flaws; I absolutely to not pretend this to be the
(not even "an") absolute reference on SMART. My experience with the
system is limited. 

If you know more, and would be kind enough to correct the blatant
mistakes in this document, please submit them to me. I will gladly
redistribute these corrections; and if the editing take too much of my
time and I see an interest for this project going on, I will hand on the
project to those who manifest long-term interest in continuing it. 

This document applies to SMART v11.0, as used on a Linux or Sun system. 

Christian Meunier. 



Christian Meunier 
1999-05-02 
-------------
Table of contents:


A documentation set for SMART, rev. 1.0 

A SMART documentation project produced during the course on Information
Research (ift6255) at the Université de Montréal, for Jian-Yun Nie
(mailto:nie (at) iro.umontreal.ca) 

Christian Meunier (mailto:meunierc (at) acm.org) 
École Polytechnique de Montréal - 
Ghita Bouayad
(mailto:bouayad (at) iro.umontreal.ca) 
Université de Montréal 



  

    History 
    Introduction to this document 
    Contents 
    Acknowledgements 
    Downloading this documentation set 
    Introduction to the SMART system 
        Getting started 
        Getting SMART v11.0 to compile 
        Installing man pages 
    Technical documentation 
        Using SMART 
        Software architecture of the SMART hierarchy 
        The SMART action hierarchy 
        Debugging 
            Error reporting 
            Accounting 
        Modifying SMART 
            Adding actions to smart 
                Adding your own procedures to SMART 
                Liblocal 
                Classroom use 
                User interface 
            An example - Adding a stemming function 
                Create a test collection 
                Add the function to the hierarchy 
                Add the function to SMART 
                Compile SMART 
                Test the function 
        The SMART self-documentation 
            Using the docsmart documentation set 
            Interpreting a SMART man page 
            Some useful SMART actions 
    User documentation 
        man(1) pages 
        Creation of a SMART collection (document written by Ghita
Bouayad) 
    Annexes 
        Glossary 
        References 
    About this document ... 



Christian Meunier 
1999-05-02 

-----------------
Acknowledgements 

Many people have contributed to this document, many without actually
knowing. We wish to thank the following people: 

The original SMART authors and contributors: Gerard Salton, Chris
Buckley and members of the SMART group, whitout
which nothing of this would exist. 

Contributors to the SMART project, people who gave their time to write
tutorials, article, propaganda and such, to whom we have (almost)
shamelessly stolen material for this document. They are, in many sense,
the real authors of this document. When possible, whole sections of
their documents have been reproduced integrally here. This document
merely glues them together and tries to give a single reference from
which a user would start. 

Ghita Bouayad, who wrote completely the (lengthy) section titled
"Creation of a SMART collection". She put many hours on this - we are
grateful. Thanks again! 

Jian-Yun Nie, our teacher for the course on Information Research at the
University of Montreal (ift6255), who was interested in seeing SMART
documented in the first place. 



Christian Meunier 
1999-05-02
-- 
Art Pollard <PollardA@Hawaii.edu>
Moderator for Comp.Theory.Info-Retrieval
List Maintainer for the Hyper-Theory (Hypertext Theory) mailing list.