Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / mcr-test / WWW / Doc / User / browsezip.html
diff --git a/JMCR-Stable/mcr-test/WWW/Doc/User/browsezip.html b/JMCR-Stable/mcr-test/WWW/Doc/User/browsezip.html
new file mode 100644 (file)
index 0000000..a89a3a2
--- /dev/null
@@ -0,0 +1,160 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" \r
+   "http://www.w3.org/TR/REC-html40/loose.dtd"> \r
+<HTML>\r
+<HEAD>\r
+    <META HTTP-EQUIV="Content-Type" CONTENT="text/html;\r
+      charset=iso-8859-1">\r
+    <link rel="stylesheet" type="text/css" href="../style/doc.css">\r
+    <TITLE>Browsing Zip files</TITLE>\r
+</HEAD>\r
+<BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#0000EE" VLINK="#551A8B"\r
+    ALINK="#FF0000">\r
+    <div class="icons-w3c">\r
+      <a href="../../../">\r
+       <img src="/Icons/w3c_home" \r
+         border="0" \r
+         alt="W3C logo"\r
+         height="48" \r
+         width="72">\r
+      </a>\r
+    </div>\r
+    <div class="icons-jigsaw">\r
+      <a href="../../">\r
+       <img src="/Icons/jigsaw" \r
+         border="0"\r
+         alt="Jigsaw"\r
+         height="49"\r
+         width="212">\r
+      </a>\r
+    </div>\r
+\r
+    <div class="title">\r
+      <H1 class="title">\r
+       Browsing zip files with Jigsaw\r
+      </H1>\r
+      <hr NOSHADE width="70%" align="left">\r
+      <a href="../../Overview.html">Jigsaw Home</a> /\r
+      <a href="../Overview.html">Documentation Overview</a> /\r
+      <a href="Tutorials.html">Tutorials</a>\r
+    </div>\r
+    <div class="body">\r
+<p>\r
+<UL>\r
+<LI>\r
+<A HREF="#intro">Introduction</A></LI>\r
+\r
+<LI>\r
+<A HREF="#indexer">Configuring the zip indexer</A></LI>\r
+\r
+<LI>\r
+<A HREF="#zip-file">Configuring the zip file</A></LI>\r
+</UL>\r
+\r
+<H1>\r
+<A NAME="intro"></A>Introduction</H1>\r
+Yes, <B>Jigsaw</B> allows you to browse the content of any zip file, that\r
+could be done with a set of resources and frames and by configuring a special\r
+indexer. Actually, you need to create a <A HREF="../Reference/org.w3c.jigsaw.zip.ZipDirectoryResource.html">ZipDirectoryResource</A>\r
+associated to a <A HREF="../Reference/org.w3c.jigsaw.zip.ZipFrame.html">ZipFrame</A>.\r
+This <TT>ZipDirectoryResource</TT> must be associated with a special indexer\r
+named <TT>zip-indexer</TT> (org.w3c.jigsaw.zip.ZipIndexer) in this sample\r
+configuration.\r
+<H1>\r
+<A NAME="indexer"></A>Configuring the zip indexer</H1>\r
+First, read the <A HREF="indexers.html">indexer documentation</A> (if your\r
+not aware of that kind of <B>Jigsaw</B> feature).\r
+\r
+<P>In order to be able to browse a zip file, you need to define the way\r
+<B>Jigsaw</B> will index the files (or directories) found in this zip file.\r
+This could be done by creating a specific indexer. The <B>ZipIndexer</B>\r
+(<TT>org.w3c.jigsaw.zip.ZipIndexer</TT>) must be configured like any other\r
+indexer, except that usuals resources classes must be replaced like that:\r
+<UL>\r
+<LI>\r
+<TT>FileResource => ZipFileResource</TT></LI>\r
+\r
+<LI>\r
+<TT>DirectoryResource => ZipDirectoryResource</TT></LI>\r
+\r
+<LI>\r
+<TT>HTTPFrame => ZipFrame</TT></LI>\r
+</UL>\r
+So, create your <TT>zip-indexer</TT> like in the followings screen shots,\r
+save your configuration and go to the following step.\r
+<H2>\r
+How to index a directory?</H2>\r
+A directory found into a zip file should be indexed in a <TT>ZipDirectoryResource</TT>\r
+associated to a <TT>ZipFrame</TT>. And its indexer MUST be the <TT>zip-indexer</TT>.\r
+<p>\r
+      <IMG SRC="images/zip1.gif" ALT="How to index a directory?"\r
+       HSPACE=10 VSPACE=10 HEIGHT=401 WIDTH=666>\r
+      <IMG SRC="images/zip2.gif" ALT="How to index a directory?"\r
+       HSPACE=10 VSPACE=10 HEIGHT=410 WIDTH=387>\r
+<p>\r
+<H2>\r
+How to index an html file?</H2>\r
+An html file must be indexed in a <TT>ZipFileResource</TT> associated to\r
+a <TT>ZipFrame</TT>, with a <TT>Content-Type</TT> set to\r
+    <TT>text/html</TT>.\r
+<p>\r
+      <IMG SRC="images/zip3.gif" ALT="How to index an HTML file ?"\r
+       HSPACE=10 VSPACE=10 HEIGHT=401 WIDTH=666>\r
+      <IMG SRC="images/zip4.gif" ALT="How to index an HTML file ?"\r
+       HSPACE=10 VSPACE=10 HEIGHT=374 WIDTH=358>\r
+<H1>\r
+<A NAME="zip-file"></A>Configuring the zip file</H1>\r
+Your browsable zip file must be indexed (manually or by another indexer)&nbsp;\r
+in a <TT>ZipDirectoryResource</TT> associated to a <TT>ZipFrame</TT>. This\r
+resource needs your new <TT>zip-indexer</TT>, so edit its attributes and\r
+set its indexer to <TT>zip-indexer</TT>. Commit your changes, save the\r
+configuration and browse your zip!\r
+<p>\r
+      <IMG SRC="images/zip5.gif" ALT="zip file"\r
+       HSPACE=10 VSPACE=10 HEIGHT=401 WIDTH=666>\r
+      <IMG SRC="images/zip6.gif" ALT="zip file"\r
+       HSPACE=10 VSPACE=10 HEIGHT=382 WIDTH=426>\r
+\r
+<p>This screen shot show you a sample configuration. The file <B>html.zip\r
+</B>located at <TT>&lt;instdir>/Jigsaw/Jigsaw/WWW/zips/html.zip</TT> is\r
+reachable (and browsable!) at <TT>http://your-server-host/zips/html.zip/</TT>\r
+.\r
+    </div> <!-- body -->\r
+    <div class="footer">\r
+<P>\r
+<HR NOSHADE WIDTH="100%">\r
+    <a href="mailto:jigsaw@w3.org">Jigsaw Team</a><br>\r
+    <span class="mini">\r
+      $Id: browsezip.html,v 1.1 2010/06/15 12:22:55 smhuang Exp $\r
+    </span>\r
+    <p class="policyfooter">\r
+      <font size=-1>\r
+       <a href="/Consortium/Legal/ipr-notice.html#Copyright">Copyright</a>\r
+       &copy; 1999 <a href="http://www.w3.org">W3C</a> \r
+       (<a href="http://www.lcs.mit.edu">MIT</a>, \r
+       <a href="http://www.inria.fr/">INRIA</a>, \r
+       <a href="http://www.keio.ac.jp/">Keio</a> ), \r
+       All Rights Reserved. W3C \r
+       <a href="/Consortium/Legal/ipr-notice.html#Legal Disclaimer">\r
+         liability,\r
+       </a>\r
+       <a href="/Consortium/Legal/ipr-notice.html#W3C Trademarks">\r
+         trademark\r
+       </a>, \r
+       <a href="/Consortium/Legal/copyright-documents.html">\r
+         document use \r
+       </a>\r
+       and\r
+       <a href="/Consortium/Legal/copyright-software.html">\r
+         software licensing\r
+       </a> rules apply. Your interactions with this site are in\r
+       accordance with our \r
+       <a href="/Consortium/Legal/privacy-statement.html#Public">\r
+         public\r
+       </a> and \r
+       <a href="/Consortium/Legal/privacy-statement.html#Members">\r
+         Member\r
+       </a>\r
+       privacy statements.</font>\r
+    </div>\r
+</BODY>\r
+</HTML>\r