Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

How do I create an index

Alex
2004-11-14
2013-04-24
  • Alex
    Alex
    2004-11-14

    I normally use a bunch of shell scripts to do this. But I'll keep it
    really simple. This file assumes you are not going to modify
    the code. If you wanna get into that can of worms, check out
    the README.txt.

    So, you wanna make your own index?

    All you really need is Vicaya.jar and appletAll.html (you can
    rename this anything you like). Although, because we're
    open source/free software friendly, you can keep
    everything else as well. Let us name the directory which
    contains Vicaya.jar and appletAll.html the ROOTDIR.

    I have already created an index based on the sutta
    directory. Let us start fresh. Remove or rename the
    'index' and 'sutta' directories.

    Place a directory in the ROOTDIR that you would like to index.
    (It is not technically necessary to do this, but
    it'll make this intro much easier). Suppose you add a
    directory called MyWebSite. From the command line (on
    one line):

        java -cp Vicaya.jar org.accesstoinsight.vicaya.Index -create MyWebSite

    When you run that command, make sure your current working
    directory is ROOTDIR. You should see something like this:

       adding MyWebSite/mn002.html
       adding MyWebSite/mn004.html
       adding MyWebSite/mn007.html
       adding MyWebSite/mn008.html
       adding MyWebSite/mn009.html
       Optimizing index...
       4795 total milliseconds

    Now you'll have a brand-new index directory filled with a dozen
    binary files that'll make searching much faster. We can test
    that everything worked three ways. Since we're at the command
    line. Let us type:

       java -jar Vicaya.jar

    This will launch Vicaya in stand-alone mode. This should
    be intuitive from here. If you don't get what you expect
    doesn't mean the index failed. If Vicaya doesn't work as
    a stand-alone, please tell me.

    Second option. Double-click the Vicaya.jar from the
    Desktop (Explorer/Finder/Midnight Commander/whatever).

    Finally, you can open the appletAll.html in a browser
    (you can probably double click on that too).

    References are (mostly) relative. As long as you followed
    these directions, you should be able to move ROOTDIR around
    anywhere you like (like a CDROM).

    Best of luck to you,
    Alex

    com . yahoo @ alexgenaud

     
  • Alex
    Alex
    2007-07-18

    Details can be found here:

    http://vicaya.sourceforge.net/creator/index.html
    or
    http://vicaya.sourceforge.net/dev/index.html#quicksearchindex

    In summary, starting with the basic Vicaya distribution, you can use the 'documentation' as your content.

    (1) Start Vicaya

    (2) run 'sh start_crawl.sh' from the 'vicaya' directory from bash (Unix or cygwin command line)

    (3) replace 'MY_CD/documentation/WEB-INF/segments' with 'MY_CD/segments'.

    If you want to work with your own content, copy 'documentation' keeping WEB-INF intact. Add your own content along with a file named 'seeds.html' pointing to all or many of your pages. Tweak the 'vicaya/context.properties' file. Follow the three steps above.