Changeset 28356

Timestamp:

12/26/07 12:49:21 (1 year ago)

Author:

ddupraz

Message:

virtual navigation documentation updated

Files:

• doc/nuxeo-book/trunk/src/docbook/virtual-navigation/virtual-navigation.xml (modified) (8 diffs)

doc/nuxeo-book/trunk/src/docbook/virtual-navigation/virtual-navigation.xml

@@ -95 +95 @@
-      <para>You have to create a vocabulary that will be used for the new
-      Virtual Navigation, keep in mind that you can set up a multi-level
-s
+
-      Ther is no limitation on this side.</para>
-
@@ -145 +145 @@
-
-
-indicate the children
+with a "parent" parameter added
-
-<emphasis role="bold">id, label, parent, obsolete</emphasis>
@@ -183 +183 @@
-
-    <section>
+      <title>Set up a new Document Type for search purpose</title>
+
+      <para>The query based search service of Nuxeo 5 requires that you create
+      a document type that will be a base for a document model to register
+      data handeld by the query. To understand it more here is an example
+      :</para>
+
+      <para>You are browsing your documents by coverage. You are selecting the
+      path Europe/France in the tree. The data Europe/France is the base of
+      the query and need to be registered in a document model created from a
+      document type. In this case the document type can be very simple, cause
+      the query must register only one data at a time. Creating a document
+      type with only one schema that contains one field will be enough.</para>
+
+      <para>This document type will be referenced as <emphasis
+      role="bold">query document type</emphasis> in this walkthrough. Create
+      it and register it as a normal document type. See Nuxeo Book part 6 to
+      get more informations about document type creation.</para>
+    </section>
+
+    <section>
-      <title>Set up new navigation tree</title>
-
@@ -192 +213 @@
-      <emphasis role="bold">virtualNavigation</emphasis> package.</para>
-
-, the 
-schema</emphasis> and the <emphasis role="bold">element of
-he schema (field)</emphasis> that you will use to navigate through
-documents,<emphasis role="bold"> a queryModel</emphasis> to indicate the
-query you will use to get your documents
+s,
+ a queryModel</emphasis> to indicate the query you will use
+o get your documents, a <emphasis role="bold">schema</emphasis> and a
+<emphasis role="bold">field</emphasis> coming from the query document
+type you just set up in part 3
-      role="bold">outcome</emphasis> that indicates the page where documents
-      will be displayed after the request and a list of vocabularies you can
@@ -223 +244 @@
-
-      <para>Now you need to contribute to 2 extension points that will set up
-request
+query
-      will need to contribute. For a full example see the file <emphasis
-      role="bold">querymodel-contrib.xml</emphasis> and <emphasis
@@ -230 +251 @@
-
-      <para>The query model contribution needs many information. In the
+      <emphasis role="bold">docType</emphasis> parameter you have to put the
+      name of the documentType you created in part 3. In the
-      &lt;predicate&gt;&lt;/predicate&gt; tag you must set up the name of the
-
-
+
+
+
+
+
+
+
+
+
+
-      role="bold"> schema:field</emphasis>, if there is a prefix set it up
-      like this <emphasis role="bold">prefix:field</emphasis>. In the operator
-      param put the value STARTSWITH. In the &lt;field/&gt; tag put the schema
-
-
-
-
-
-
+
+
-
-      <para><example>
@@ -269 +296 @@
-
-      <para>Now you need to register a new indexing configuration in the
-you are using since the
-begining of this configuration. Here is the extension point you have to
-contribute. For a full example see the <emphasis
-role="bold">nxsearch-contrib.xml</emphasis> file in the <emphasis
-
+that register the data you want
+to apply the search on, it is the same data as saw at the end of part 5
+. Here is the extension point you have to contribute. For a full example
+see the <emphasis role="bold">nxsearch-contrib.xml</emphasis> file in
+the <emphasis 
-
-      <para>You will have to create a new &lt;resource&gt;&lt;/resource&gt;
-      tag if it doesn't exist for your schema. For the <emphasis
-
+eter
-      schema, <emphasis role="bold">type</emphasis> param must be "schema" and
-      <emphasis role="bold">indexAllFields</emphasis> param must be "true". In
-      a &lt;field/&gt; tag you have to indicate the indexing strategy, the
-Path", if the field
-that register your vocabulary is a complexType (many String for example)
-you can add the parameter <emphasis role="bold">multiple</emphasis> and
-
+<emphasis
+role="bold">Path</emphasis>", if the field that register your vocabulary
+is a complexType (list of String for example) you can add the parameter
+<emphasis role="bold">multiple</emphasis> and 
-
-      <para><example>
@@ -310 +337 @@
-      role="bold">coverage_virtual_navigation.xml</emphasis> .</para>
-
-widget displaying already exist in
-
- if
-you want to modify some parts
+tree navigation widget already exist
+in 
+
+for information purpose
-
-      <para>Indeed you have to add vitualNavigation to Nuxeo 5 plugin if you
-
-
+
-    </section>
-  </section>