Changeset 28383

Show
Ignore:
Timestamp:
12/27/07 11:05:36 (1 year ago)
Author:
sfermigier
Message:

Minor edits.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • doc/nuxeo-book/trunk/src/docbook/webdav/index.xml

    r27262 r28383  
    1010  <title>Nuxeo WebDav interface</title> 
    1111 
    12   <para>nuxeo-platform-webdav-server provides a WebDAV interface on top of 
    13   Nuxeo services.</para> 
     12  <para>The <filename>nuxeo-platform-webdav-server</filename> module provides a WebDAV interface on top of Nuxeo services.</para> 
    1413 
    1514  <section> 
    16     <title id="webDavClients" xreflabel="WebDav Client">WebDAV clients</title> 
     15    <title id="webDavClients" xreflabel="WebDAV Client">WebDAV clients</title> 
    1716 
    1817    <para>There are several WebDAV clients available. Each of them has its 
    …… 
    2221      <title>Path vs displayName</title> 
    2322 
    24       <para>In WebDav specification each accessible resource must have a name 
     23      <para>In WebDAV specification each accessible resource must have a name 
    2524      (part of the URL) and can have a displayName (defines how the resource 
    2625      should be displayed to the user). Unfortunately, most WebDAV client don't 
    …… 
    5554      <title>Filesystem resource vs Nuxeo DocumentModel artifact</title> 
    5655 
    57       <para>Inside WebDav, each container is a collection. Most webdav client 
     56      <para>Inside WebDAV, each container is a collection. Most WebDAV client 
    5857      consider that a collection is not a document, but a simple folder. This 
    59       limitation is important because Nuxeo supports Folderish documents, and 
     58      limitation is important because Nuxeo supports folderish documents, and 
    6059      document types that can contain several files. Because of that, 
    6160      depending on the document types we may want to map, a Nuxeo document 
    62       could be seen as a collection or as a resource. Unfortunately all clients 
    63       consider Collections as simple folder this is not very useful.</para> 
    64     </section> 
    65  
    66     <section> 
    67       <title>MS WebFolder client</title> 
    68  
    69       <para>One of the most popular WebDAV client are WebFolders that are 
    70       included inside Windows OS. Unfortunalty depending on the version of 
     61      could be seen as a collection or as a resource. Unfortunately, since all clients 
     62      consider collections as simple folders, this is not very useful.</para> 
     63    </section> 
     64 
     65    <section> 
     66      <title>MS Web Folder client</title> 
     67 
     68      <para>One of the most popular WebDAV client are Web Folders that are 
     69      included inside Windows OS. Unfortunately depending on the version of 
    7170      Windows (including service pack) and also on the version of MSOffice the 
    7271      webdav client will be implemented in a different way with different bugs 
    73       and behavior. WebFolders are not the worse WebDav client, but they are 
     72      and behavior. Web Folders are not the worse WebDAV client, but they are 
    7473      definitely the less predictable...</para> 
    7574 
    76       <para>For a complete bug listing of WebFolders depending on version 
     75      <para>For a complete bug listing of Web Folders depending on version 
    7776      please see http://www.greenbytes.de/tech/webdav/webdavfaq.html, 
    7877      http://www.greenbytes.de/tech/webdav/webfolder-client-list.html, 
    …… 
    8281 
    8382  <section> 
    84     <title id="DavHacks" xreflabel="Nuxeo WebDav Hacks">Fooling WebDav 
     83    <title id="DavHacks" xreflabel="Nuxeo WebDAV Hacks">Fooling WebDAV 
    8584    clients</title> 
    8685 
    …… 
    132131          to have the collection correctly displayed as "My Workspace 1". 
    133132          Although this hack does not work with most clients, it works with 
    134           most WebFolders version.</para> 
     133          most Web Folders version.</para> 
    135134        </listitem> 
    136135      </itemizedlist> 
    …… 
    152151          <listitem> 
    153152            <para>If your client needs MS specific DAV Headers (required for 
    154             some versions of WebFolders)</para> 
     153            some versions of Web Folders)</para> 
    155154          </listitem> 
    156155        </itemizedlist> 
    …… 
    162161  &lt;extension target="org.nuxeo.ecm.platform.webdav.config.WebDavConfigurationService" point="DavClientConfiguration"&gt; 
    163162   &lt;documentation&gt; 
    164     Configuration for MS WebFolders (both versions) and WebDrive. 
     163    Configuration for MS Web Folders (both versions) and WebDrive. 
    165164   &lt;/documentation&gt; 
    166165   &lt;davClientConfiguration 
    …… 
    180179</programlisting> 
    181180      As you can see, each configuration set is attached to one or 
    182       more User-Agent substring. Unfortunately, WebFolders clients do not send 
     181      more User-Agent substring. Unfortunately, Web Folders clients do not send 
    183182      information about their version, even if it would be very 
    184183      helpful.</para> 
    …… 
    187186 
    188187  <section> 
    189     <title id="nuxeoDav" xreflabel="Nuxeo WebDav">Nuxeo WebDav 
     188    <title id="nuxeoDav" xreflabel="Nuxeo WebDav">Nuxeo WebDAV 
    190189    implementation</title> 
    191190 
    …… 
    215214 
    216215      <section> 
    217         <title>WebDav resource adapters</title> 
     216        <title>WebDAV resource adapters</title> 
    218217 
    219218        <para>Displaying your Nuxeo documents as simple files (that's what 
    220         will do most WebDav client) can be very restrictive.</para> 
    221  
    222         <para>Nuxeo WebDav connector uses DocumentModel Adapters to define how 
    223         a Nuxeo 5 Document must be mapped to a WebDav resources. This adapter 
     219        will do most WebDAV client) can be very restrictive.</para> 
     220 
     221        <para>The Nuxeo WebDAV connector uses DocumentModel adapters to define how 
     222        a Nuxeo 5 Document must be mapped to a WebDAV resources. This adapter 
    224223        defines: 
    225224          <itemizedlist> 
    …… 
    240239              request.</para> 
    241240 
    242               <para>The default built-in behavior will be to return : 
     241              <para>The default built-in behavior will be to return: 
    243242              <itemizedlist> 
    244243                  <listitem> 
    …… 
    260259          </itemizedlist></para> 
    261260 
    262         <para>New DavAdapters can be contributed to define specific WebDav 
    263         mapping for your document types. For that, Nuxeo WebDav connector 
     261        <para>New DavAdapters can be contributed to define specific WebDAV 
     262        mapping for your document types. For that, the Nuxeo WebDAV connector 
    264263        provides an extension point to let you register a new class 
    265264        implementing<classname>org.nuxeo.ecm.platform.webdav.adapters.DavResourceAdapter</classname> 
    …… 
    284283      as in Nuxeo Core.</para> 
    285284 
    286       <para>Propset is for now not implemented as none of the used webdav 
     285      <para>Propset is for now not implemented as none of the used WebDAV 
    287286      client seems to use this method.</para> 
    288287 
    289       <para>WebDav versioning extension are not implemented.</para> 
     288      <para>WebDAV versioning extension are not implemented.</para> 
    290289    </section> 
    291290  </section> 
    292291  
    293292  <section> 
    294     <title>Using Nuxeo WebDav connector</title> 
     293    <title>Using the Nuxeo WebDAV connector</title> 
    295294          
    296295          <section> 
    297             <title>Installing WebDav connector</title> 
     296            <title>Installing the WebDAV connector</title> 
    298297         
    299             <para> Nuxeo WebDav Connector is an optional additional component for Nuxeo 5 EP.</para> 
     298            <para>The Nuxeo WebDAV Connector is an optional additional component for Nuxeo EP 5.</para> 
    300299         
    301             <para> In order to install the webdav features, you need to download WebDav Connector jar (or build it from source), copy the jar in $nuxeo.ear/platform and restart your server.</para> 
     300            <para>In order to install the WebDAV features, you need to download the WebDAV Connector jar (or build it from source), copy the jar in <filename>nuxeo.ear/platform</filename> and restart your server.</para> 
    302301         
    303             <para>The WebDav connector works for both 5.1 and 5.2 versions of Nuxeo EP, you just need to download the associated version or build it using the right pom file.</para> 
     302            <para>The WebDAV connector works for both 5.1 and 5.2 versions of Nuxeo EP, you just need to download the associated version or build it using the right POM file.</para> 
    304303          </section> 
    305304 
    306305          <section> 
    307             <title>Connecting a client to Nuxeo WebDav connector</title> 
     306            <title>Connecting a client to Nuxeo WebDAV connector</title> 
    308307         
    309             <para>The webdav URL for the default domain is http://$NuxeoServer/nuxeo/dav/default/default-domain. </para> 
    310             <para>In order to use MSWebFolder you just need to go to "My Network Places" and choose "Add a new Network place". You can then enter Nuxeo webdav URL and login/password.</para> 
     308            <para>The WebDAV URL for the default domain is http://$NuxeoServer/nuxeo/dav/default/default-domain. </para> 
     309            <para>In order to use MS Web Folders, you just need to go to "My Network Places" and choose "Add a new Network place". You can then enter the Nuxeo WebDAV URL and login/password.</para> 
    311310          </section> 
    312311  </section>