X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Fquickstart.xml;h=b7daa8c2cc1972074cb02e661e76c5a6b0bb9486;hp=8cac9bce2f64fb64b60bb19edd8a7ac0ed72903e;hb=dcda88860b03641b6900d43135ca769f005105e8;hpb=4fe772289b1ab968655c27b144d08fc69c113fd9 diff --git a/doc/quickstart.xml b/doc/quickstart.xml index 8cac9bc..b7daa8c 100644 --- a/doc/quickstart.xml +++ b/doc/quickstart.xml @@ -1,124 +1,104 @@ - - - Quick Start - - - FIXME - Start with the new improved example scripts that run - without any configuration file changes! - + + Quick Start - - In this section, we will test the system by indexing a small set of sample - GILS records that are included with the software distribution. Go to the - test/gils subdirectory of the distribution archive. - There you will find a configuration - file named zebra.cfg with the following contents: - - - # Where are the YAZ tables located. - profilePath: ../../../yaz/tab ../../tab - - # Files that describe the attribute sets supported. - attset: bib1.att - attset: gils.att - - - - - Now, edit the file and set profilePath to the path of the - YAZ profile tables (sub directory tab of the YAZ - distribution archive). - - - - The 48 test records are located in the sub directory - records. To index these, type: - - - $ ../../index/zebraidx -t grs.sgml update records - - - - - In the command above the option -t specified the record - type — in this case grs.sgml. - The word update followed - by a directory root updates all files below that directory node. - - - - If your indexing command was successful, you are now ready to - fire up a server. To start a server on port 2100, type: - - - $ ../../index/zebrasrv tcp:@:2100 - - - + + + In this section, we will test the system by indexing a small set of + sample GILS records that are included with the &zebra; distribution, + running a &zebra; server against the newly created database, and + searching the indexes with a client that connects to that server. + + + Go to the examples/gils subdirectory of the + distribution archive. The 48 test records are located in the sub + directory records. To index these, type: + + zebraidx update records + + + + + In this command, the word update is followed + by the name of a directory: zebraidx updates all + files in the hierarchy rooted at that directory. + + + + If your indexing command was successful, you are now ready to + fire up a server. To start a server on port 2100, type: + + + zebrasrv @:2100 + - - The Zebra index that you have just created has a single database - named Default. - The database contains records structured according to - the GILS profile, and the server will - return records in either either USMARC, GRS-1, or SUTRS depending - on what your client asks for. - - - - To test the server, you can use any Z39.50 client (1992 or later). - For instance, you can use the demo client that comes with YAZ: Just - cd to the client subdirectory of the YAZ distribution - and type: - - - - $ ./yaz-client tcp:localhost:2100 - - - - - When the client has connected, you can type: - - - - - - Z> find surficial - Z> show 1 - - - - - The default retrieval syntax for the client is USMARC. To try other - formats for the same record, try: - - - - Z>format sutrs - Z>show 1 - Z>format grs-1 - Z>show 1 - Z>format xml - Z>show 1 - Z>elements B - Z>show 1 - - - - - You may notice that more fields are returned when your - client requests SUTRS or GRS-1 records. When retrieving GILS records, - this is normal - not all of the GILS data elements have mappings in - the USMARC record format. - - - If you've made it this far, there's a good chance that - you've got through the compilation OK. - - - + + + The &zebra; index that you have just created has a single database + named Default. + The database contains records structured according to + the GILS profile, and the server will + return records in &acro.usmarc;, &acro.grs1;, or &acro.sutrs; format depending + on what the client asks for. + + + + To test the server, you can use any &acro.z3950; client. + For instance, you can use the demo command-line client that comes + with &yaz;: + + + + yaz-client localhost:2100 + + + + + When the client has connected, you can type: + + + + + Z> find surficial + Z> show 1 + + + + + The default retrieval syntax for the client is &acro.usmarc;, and the + default element set is F (``full record''). To + try other formats and element sets for the same record, try: + + + + Z>format sutrs + Z>show 1 + Z>format grs-1 + Z>show 1 + Z>format xml + Z>show 1 + Z>elements B + Z>show 1 + + + + + You may notice that more fields are returned when your + client requests &acro.sutrs;, &acro.grs1; or &acro.xml; records. + This is normal - not all of the GILS data elements have mappings in + the &acro.usmarc; record format. + + + + If you've made it this far, you know that your installation is + working, but there's a certain amount of voodoo going on - for + example, the mysterious incantations in the + zebra.cfg file. In order to help us understand + these fully, the next chapter will work through a series of + increasingly complex example configurations. + + +