Changeset 30302
- Timestamp:
- 02/19/08 18:34:29 (9 months ago)
- Files:
-
- doc/nuxeo-book/trunk/src/docbook/actions-views/index.xml (modified) (1 diff)
- doc/nuxeo-book/trunk/src/docbook/admin/virtualhosting.xml (modified) (5 diffs)
- doc/nuxeo-book/trunk/src/docbook/administration/admin-database-configuration.xml (modified) (1 diff)
- doc/nuxeo-book/trunk/src/docbook/administration/admin-specific_IP_binding-configuration.xml (modified) (1 diff)
- doc/nuxeo-book/trunk/src/docbook/administration/index.xml (modified) (1 diff)
- doc/nuxeo-book/trunk/src/docbook/architecture-overview/index.xml (modified) (11 diffs)
- doc/nuxeo-book/trunk/src/docbook/core-io/index.xml (modified) (9 diffs)
- doc/nuxeo-book/trunk/src/docbook/coredevguide-book.xml (modified) (2 diffs)
- doc/nuxeo-book/trunk/src/docbook/workflow-service/deploy-process-definitions.xml (modified) (5 diffs)
- doc/nuxeo-book/trunk/src/docbook/workflow-service/jbpm-plugins.xml (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
doc/nuxeo-book/trunk/src/docbook/actions-views/index.xml
r26476 r30302 383 383 <title>Nuxeo JSF tags</title> 384 384 385 <para>Please refer to the tag li vbrary documentation available at <link385 <para>Please refer to the tag library documentation available at <link 386 386 xlink:href="http://maven.nuxeo.org/nuxeo-platform-parent/nuxeo-platform-ui-web/tlddoc/index.html">http://maven.nuxeo.org/nuxeo-platform-parent/nuxeo-platform-ui-web/tlddoc/index.html</link>.</para> 387 387 </section> doc/nuxeo-book/trunk/src/docbook/admin/virtualhosting.xml
r27437 r30302 40 40 41 41 <para>Nuxeo 5 generate standard http cache headers for all static 42 resources (images, javascripts...).</para>42 resources (images, JavaScript...).</para> 43 43 44 44 <para>These resources are by default cached on the client side (in 45 the browser cache), for performances reason, it can be useful lto45 the browser cache), for performances reason, it can be useful to 46 46 host these resources in the reverse proxy cache.</para> 47 47 </listitem> … … 49 49 </section> 50 50 <section> 51 <title id="" xreflabel="Apache2 configuration">Configuration Virtual hosting with Apache 2</title>51 <title id="" xreflabel="Apache2 configuration">Configuration Virtual hosting with Apache 2</title> 52 52 53 53 <section> … … 65 65 </para> 66 66 <para> 67 Unfortu tly this header does not include the protocol, so if your apache is https, you will need to send, Nuxeo5 a dedicated header to indicate the base URL that the webappust use when generating links.67 Unfortunately this header does not include the protocol, so if your apache is https, you will need to send, Nuxeo 5 a dedicated header to indicate the base URL that the webapp must use when generating links. 68 68 </para> 69 69 <programlisting> … … 110 110 <section> 111 111 <title>Configuring http cache </title> 112 <para></para>112 <para></para> 113 113 <programListing> 114 114 </programListing> … … 117 117 </section> 118 118 119 120 119 </section> 121 120 </chapter> doc/nuxeo-book/trunk/src/docbook/administration/admin-database-configuration.xml
r25585 r30302 17 17 <itemizedlist> 18 18 <listitem> 19 <para>install the JDBC driver ,</para>19 <para>install the JDBC driver for your DBMS,</para> 20 20 </listitem> 21 21 22 22 <listitem> 23 <para>configure Nuxeo Core storage, modifying the default repository23 <para>configure the Nuxeo Core storage, modifying the default repository 24 24 configuration,</para> 25 25 </listitem> doc/nuxeo-book/trunk/src/docbook/administration/admin-specific_IP_binding-configuration.xml
r27919 r30302 19 19 <filename>$JBOSS_HOME/server/default/deploy/nuxeo.ear/config/nuxeo.properties</filename> 20 20 change the value of <varname>org.nuxeo.ecm.instance.host</varname>, 21 remplace "localhost" by the IP adress of the J boss server</para>21 remplace "localhost" by the IP adress of the JBoss server</para> 22 22 </listitem> 23 23 doc/nuxeo-book/trunk/src/docbook/administration/index.xml
r29590 r30302 139 139 140 140 <para>Note that the platform used for both the JVM and OOo have to be 141 consistent to allow UNO protocol to work : with a 32 bits JVM, you'll have142 to use the 32 bits OOo vers on while the 64 bits one will be mandatory for141 consistent to allow UNO protocol to work: with a 32 bits JVM, you'll have 142 to use the 32 bits OOo version while the 64 bits one will be mandatory for 143 143 a 64 bits JVM.</para> 144 144 </section> doc/nuxeo-book/trunk/src/docbook/architecture-overview/index.xml
r27437 r30302 47 47 <listitem> 48 48 <para>In order to be easily hostable, the platform need to be 49 compat bible with several application servers</para>49 compatible with several application servers</para> 50 50 </listitem> 51 51 </itemizedlist> … … 358 358 <para>This mainly means synchronous or asynchronous events 359 359 listener that are a great place to handle communication and 360 synchroni sation between applications.</para>360 synchronization between applications.</para> 361 361 </listitem> 362 362 </itemizedlist> … … 477 477 some platform that don't handle this (like Java EE).</para> 478 478 479 <para>This is one of the motivation for the N XRuntime that will be479 <para>This is one of the motivation for the Nuxeo Runtime that will be 480 480 quickly introduce later in this document.</para> 481 481 </section> … … 637 637 638 638 <section> 639 <title>N XRuntime:Nuxeo EP component model</title>639 <title>Nuxeo Runtime: the Nuxeo EP component model</title> 640 640 641 641 <section> … … 730 730 731 731 <para>Because Nuxeo EP is extensible and has a plugin model, 732 we need that feature. A contribution is depend ant on the732 we need that feature. A contribution is dependent on the 733 733 component it contribute to:</para> 734 734 … … 1351 1351 role="bold">deployment strategy</emphasis></para> 1352 1352 1353 <para>Thanks to the N XRuntime remoting features it is very easy to split1353 <para>Thanks to the Nuxeo Runtime remoting features it is very easy to split 1354 1354 the components on several JVM. But splitting some services can have a 1355 1355 very bad effect on the global system performance.</para> … … 1476 1476 several Maven 2 artifact.</para> 1477 1477 1478 <para>Nuxeo packaging and deployment system (N XRuntime, Plateform API,1478 <para>Nuxeo packaging and deployment system (Nuxeo Runtime, Platform API, 1479 1479 Maven ...) leverage this separation to help you distributing the 1480 1480 needed deployment unit according to your target physical … … 1540 1540 <title>Nuxeo Repository Service</title> 1541 1541 <para> The repository service let you define new document repositories. Defining separated repositories for your documents is pretty much like defining separated Databases for your records.</para> 1542 <para> Because Nuxeo Core defines a SPI on repository, you can configure how you want the repository to be implemented. For now, default implementation uses JSR-170 (Java Content Repository) reference implementation : Apache Jack Rabbit. In the future, we may provide other implementation of the Repos tory SPI (like native SQL DB or Object Oriented DB).</para>1543 <para> Even if for now there is only one Repository implementation available, using JCR implementation, you can configure how your data will be persisted : filesystem, xml or SQL Database. Please see "How to o"s about repository configuration.</para>1544 <para> When definin ing a new repository, you can configure :1542 <para> Because Nuxeo Core defines a SPI on repository, you can configure how you want the repository to be implemented. For now, default implementation uses JSR-170 (Java Content Repository) reference implementation : Apache Jack Rabbit. In the future, we may provide other implementation of the Repository SPI (like native SQL DB or Object Oriented DB).</para> 1543 <para> Even if for now there is only one Repository implementation available, using JCR implementation, you can configure how your data will be persisted : filesystem, xml or SQL Database. Please see "How to"s about repository configuration.</para> 1544 <para> When defining a new repository, you can configure : 1545 1545 <itemizedlist> 1546 1546 <listitem> … … 1580 1580 1581 1581 <listitem> 1582 <para>An option nal super document type (inheritence)</para>1582 <para>An optional super document type (inheritance)</para> 1583 1583 </listitem> 1584 1584 … … 1590 1590 <listitem> 1591 1591 <para>A list of facets</para> 1592 <para>Simple markers used to define document behavio ur.</para>1592 <para>Simple markers used to define document behavior.</para> 1593 1593 </listitem> 1594 1594 </itemizedlist> … … 1609 1609 </programlisting> 1610 1610 1611 For further expla ination on Schemas and Document types, please see the dedicated section in this document.1611 For further explanation on Schemas and Document types, please see the dedicated section in this document. 1612 1612 </para> 1613 1613 </section> doc/nuxeo-book/trunk/src/docbook/core-io/index.xml
r25371 r30302 83 83 the XML file in their own file.</para> 84 84 85 <para>So instead of enco nding the blob in the XML file a reference to an85 <para>So instead of encoding the blob in the XML file a reference to an 86 86 external file is preserved: cd1f161f.blob</para> 87 87 … … 129 129 130 130 <listitem> 131 <para>transforming the data if neces arly</para>131 <para>transforming the data if necessary</para> 132 132 </listitem> 133 133 … … 146 146 147 147 <listitem> 148 <para>transforming the data if neces arly</para>148 <para>transforming the data if necessary</para> 149 149 </listitem> 150 150 … … 234 234 <listitem> 235 235 <para>DocumentListReader - this one is taking as input a list of 236 document models and export them as domj Documents. This is useful l236 document models and export them as domj Documents. This is useful 237 237 when wanting to export a search result for example.</para> 238 238 </listitem> … … 249 249 <para>XMLDirectoryReader - read a directory tree in the format 250 250 supported by Nuxeo (as described in <xref 251 linkend="exportFormat" /> section). YThis can be used to import252 def alted nuxeo archives or hand created document251 linkend="exportFormat" /> section). This can be used to import 252 deflated nuxeo archives or hand created document 253 253 directories.</para> 254 254 </listitem> … … 261 261 262 262 <listitem> 263 <para>ZipReader - read a zip archive and output DOM objects. This263 <para>ZipReader - read a zip archive and output DOM objects. This 264 264 reader can read both Nuxeo zip archives and regular zip archives 265 265 (hand made). Reading a Nuxeo archive is more optimized - because … … 267 267 predefined order that makes possible reading the entire archive 268 268 tree on the fly without unziping the content of the archive on the 269 file systemnfirst. If the zip archive is not recognized as a270 Nuxeo archive the zip will be def alted in a temporary folder on269 filesystem first. If the zip archive is not recognized as a 270 Nuxeo archive the zip will be deflated in a temporary folder on 271 271 the file system and the XMLDirectoryReader will be used to read 272 272 the content.</para> … … 283 283 <title>Document Writer</title> 284 284 285 <para>A document writer is re psonsible to write the documents that exit285 <para>A document writer is responsible to write the documents that exit 286 286 the pipe in a document store. This storage can be a File System, A Nuxeo 287 287 Repository or any database or data storage as long as you have a writer … … 354 354 <title>Document Transformer</title> 355 355 356 <para>Document transformers are useful to transform documents that yenter356 <para>Document transformers are useful to transform documents that enter 357 357 the pipe and before being sent to the writer. This way you can remove, add 358 358 or modify some properties from the documents, or other information doc/nuxeo-book/trunk/src/docbook/coredevguide-book.xml
r24889 r30302 48 48 <para>The first time, you need to add some Nuxeo libraries into the 49 49 JBoss directory, so you first run, from the top of your nuxeo-ep 50 checkout: <programlisting>$ cd nuxeo-ep 50 checkout: 51 <programlisting>$ cd nuxeo-ep 51 52 $ ant patch</programlisting> 52 53 then: … … 68 69 <para>From the top of your <filename>nuxeo-ep</filename> checkout, 69 70 after having done a <command>svn up</command>, to build the updated 70 platform you need to execute only: <programlisting>$ cd nuxeo-ep 71 $ ant </programlisting></para> 71 platform you need to execute only: 72 <programlisting>$ cd nuxeo-ep 73 $ ant </programlisting> 74 </para> 72 75 </section> 73 76 doc/nuxeo-book/trunk/src/docbook/workflow-service/deploy-process-definitions.xml
r29472 r30302 14 14 specify a new process definition language. Thus it has no Nuxeo 15 15 specificities speaking of format or process definition language. For 16 instance, if you use jBPM as a backend with Nuxeo 5 then the workflow16 instance, if you use jBPM as a backend with Nuxeo 5 then the workflow 17 17 definition should be a standard jpdl file that you may have designed using 18 18 your favorite editor or still if you are using Shark as a backend then the … … 28 28 29 29 <para>The Nuxeo workflow service provides a dedicated extension point for 30 workflow definition deployment. The extension point is called <emphasis30 workflow definition deployment. The extension point is called <emphasis 31 31 role="bold">definition.</emphasis></para> 32 32 … … 34 34 application server deployment time (For now, this is the case when the 35 35 application server is starting up since hot deployment is not yet possible 36 using Nuxeo Runtime .at the time of writing this document).It means this36 using Nuxeo Runtime at the time of writing this document).It means this 37 37 way of deploying workflow definition is not suitable for all cases. See 38 38 the next subsections for other ways of deploying workflow 39 39 definitions.</para> 40 40 41 <para>Below is an example of a j pdlworkflow definition contribution for41 <para>Below is an example of a jPDL workflow definition contribution for 42 42 the jBPM backend. This XML fragment would be defined in a contribution 43 43 registered as a component in a bundle:</para> … … 60 60 <itemizedlist> 61 61 <listitem> 62 <para><emphasis role="bold">engineName : </emphasis>name specified for62 <para><emphasis role="bold">engineName:</emphasis> name specified for 63 63 the target backend at workflow service registration time (see workflow 64 64 service backend extension point)</para> … … 66 66 67 67 <listitem> 68 <para><emphasis role="bold">mimetype :</emphasis> mimetype of the68 <para><emphasis role="bold">mimetype:</emphasis> mimetype of the 69 69 workflow definition. This is especially interesting in case of the 70 format is binary. (serialization issue at deploy ement time)</para>70 format is binary. (serialization issue at deployment time)</para> 71 71 </listitem> 72 72 73 73 <listitem> 74 <para><emphasis role="bold">definitionPath :</emphasis> bundle75 relative path of fthe worklow definition to deploy.</para>74 <para><emphasis role="bold">definitionPath:</emphasis> bundle 75 relative path of the workklow definition to deploy.</para> 76 76 </listitem> 77 77 </itemizedlist> 78 78 79 <para>In this situation here is how would look the tree :</para>79 <para>In this situation here is how would look the tree:</para> 80 80 81 81 <para><programlisting>com.company.workflow / doc/nuxeo-book/trunk/src/docbook/workflow-service/jbpm-plugins.xml
r29472 r30302 15 15 <title>Process definition deployment</title> 16 16 17 <para>jBPM comes with a simple servlet allowing one to deploy j pdlprocess18 definitions and m initor running process instances. (NB: this is not yet19 activated on stock Nuxeo 5 instance).</para>17 <para>jBPM comes with a simple servlet allowing one to deploy jPDL process 18 definitions and monitor running process instances. (NB: this is not yet 19 activated on stock Nuxeo 5 instance).</para> 20 20 </section> 21 21
