Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / mcr-test / WWW / Doc / User / jigedit.html
diff --git a/JMCR-Stable/mcr-test/WWW/Doc/User/jigedit.html b/JMCR-Stable/mcr-test/WWW/Doc/User/jigedit.html
new file mode 100644 (file)
index 0000000..fc08665
--- /dev/null
@@ -0,0 +1,154 @@
+<!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
+ <link rel="stylesheet" type="text/css" href="../style/doc.css">\r
+ <title>Collaborative editing</title>\r
+</head>\r
+<body>\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>Collaborative editing</h1>\r
+    </div>\r
+    <div class="body">\r
+\r
+<p>For W3C internal needs, a collaborative editing solution using CVS ahs benn\r
+developped. It is part of the standard distribution, but to use it, you need\r
+to add <em>jigedit.jar</em> to your CLASSPATH.</p>\r
+\r
+<h2>Generic principle</h2>\r
+\r
+<p>Jigedit works with three spaces:</p>\r
+<ul>\r
+  <li>The CVS repository</li>\r
+  <li>The exported space (publishing space)</li>\r
+  <li>Some optional working spaces (local editing spaces)</li>\r
+</ul>\r
+\r
+<p>Due to some limitations in CVS, direct access to the repository is needed,\r
+CVS server or rsh/ssh-ed CVS will not work or only with severe\r
+limitations.</p>\r
+\r
+<p>The classic scheme is a user who has a local editing space. The client gets\r
+a page from his editing space (with or without automatic synchronization with\r
+the CVS repository - latest version), edit, and sace the edits using a\r
+PUT-aware client, like Amaya.<br>\r
+The document is then saved on the client editing space, and this document can\r
+be commited automatically in the CVS repository, so that other editors can\r
+share the latest edits.<br>\r
+Then, when all the documents the client edited are ready for publication, the\r
+client goes to his PutList, and propagate the changes to the publishing space\r
+(it can, of course, be automated, using the "auto-publish" option).<br>\r
+</p>\r
+\r
+<p>Also, direct editing on the publishing space can be done, the publishing\r
+phase is then no longer needed, and the auto-commit option should be enabled,\r
+so that users editing their own space are as much as possible synchronized\r
+with the exported version.</p>\r
+\r
+<p>To be able to track who is doing what, or simply to reuse the\r
+<strong>$I</strong>d<strong>$</strong> tags of CVS, a per-user authorization\r
+scheme has to be done, but it is always good to prevent everyone to edit your\r
+website!<br>\r
+NOTE: To be able to change its name, cvs 1.10 has to be patched, otherwise,\r
+the name used will always be the username who started the server. <!-- @@ drawing representing the 3 setup styles-->\r
+</p>\r
+\r
+<h2>Resource tree setup</h2>\r
+If you have a per-user editing space, the best way it to have a specific entry\r
+point, using its name, like this:\r
+<pre>   user - PutList\r
+       |-  editing space</pre>\r
+Note the PutList, which is in charge of propagating the changes to the\r
+publishing space.<br>\r
+If you have a shared editing space, like direct editing of the publishing\r
+space, you may have per-user entry points or just a clone of your exported web\r
+server.\r
+\r
+<h2>Frames settings</h2>\r
+\r
+<p>Basically, a leaf or container resource under Cvs control are usually like\r
+this</p>\r
+<ul>\r
+  <li>FileResource-> org.w3c.jigsaw.resources.FileResource with\r
+    org.w3c.jigedit.frames.CvsFileFrame</li>\r
+  <li>DirectoryResource -> org.w3c.jigedit.resources.AutoLookupDirectory with\r
+    org.w3c.jigsaw.frames.HTTPFrame</li>\r
+</ul>\r
+\r
+<p>Also, you may have different setup if you don't want automatic cvs update\r
+(done by AutoLookupDirectory). You may also want to have a Cvs form to help\r
+you with cvs commands. This is a fake resource, so its type is\r
+org.w3c.tools.resources.FramedResource and the frame in charge of all the CVS\r
+commands is org.w3c.jigedit.cvs.CvsFrame</p>\r
+\r
+<h2>Specific indexers</h2>\r
+\r
+<p>Of course you can setup some indexers to create the skeleton of user's\r
+accounts. As there is not (yet) support for automatic renaming with the\r
+indexers, some work has to be done manually after the automatic indexing, like\r
+the PutList file references and other things.</p>\r
+\r
+<p>The <a href="jigedit-sample.html">following description</a> has been done\r
+based on W3C's editing space, with a fixed Icons repository and also a fixed\r
+StyleSheets repository.</p>\r
+\r
+<p></p>\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: jigedit.html,v 1.1 2010/06/15 12:23:03 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