If you are not used to customizing Nuxeo, you should give a try to [Nuxeo Studio|Studio:Nuxeo Studio Documentation Center], a visual environment to configure your Nuxeo DM, DAM or CMF instance.
You will find on this page two entry points to Nuxeo customization samples plus useful links. We advise you to give first a glance at all the Nuxeo EP wiki domain, so that you get a global idea of the architecture of the product.
Then you can start playing with the sample project or the tutorial, that gives you a lot of explanations too.
h3. The sample project
In addition to the Nuxeo Tutorial, there is a sample project outlined in chapter 3 ('Getting started') of the Nuxeo DM Reference Book:
* [HTML (Chapter 3 only)|http://doc.nuxeo.org/current/books/nuxeo-book/html/getting-started.html]
The sample chapter builds on the tutorial, and illustrates a number of additional examples.
The source code for the sample project can be found in the Nuxeo Mercurial repository at the following link:
* [Sample Project Source Code|http://hg.nuxeo.org/addons/nuxeo-sample-project].
To check the sample code out from this remote repository onto your local machine, you will need to have [mercurial|http://mercurial.selenic.com/wiki] installed. Once you have mercurial you can run:
{{$ hg clone http://hg.nuxeo.org/addons/nuxeo-sample-project}}
This will create a directory on your local machine called nuxeo-sample-project which contains all the source code for nuxeo the sample project.
The mercurial repository contains branches such as '5.2' and '5.3'. You can see these branches by entering:
{{$ hg branches}}
Check which branch you are in by entering in:
{{$ hg branch}}
You can change branches by running for example (if you are currently in the 5.3 branch, and want to switch to the 5.2 branch):
{{$ hg update 5.2\\
$ hg branch}}
h3. The tutorial
[The Tutorial (draft) - HTML:|http://www.nuxeo.org/static/dev-tutorial] (also known as the 'Learning Nuxeo DM' Guide).
This tutorial shows you how to extend and customize Nuxeo's 'out of the box' functionality in a step-by-step fashion.
5. Tutorial Source Code
The source code for the tutorial is held in the Nuxeo subversion repository. Although the tutorial links to the source code in each chapter, it's listed again here for convenience:
* [Source Code for Chapter 5: Your First Bundle|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-bundle]
* [Source Code for Chapter 6: Improving The Upcoming UI|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-basic-ui]
* [Source Code for Chapter 7: Internationalization And Localization|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-l10n]
* [Source Code for Chapter 8: Events And Event Listeners|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-events]
* [Source Code for Chapter 9: XMap And Logging|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-xmap]
* [Source Code for Chapter 10: Users and Groups|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-users]
* [Source Code for Chapter 11: Access Control And Security|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-security]
* [Source Code for Chapter 12: Relations And A Bit Of Content|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-relations]
To check out the source code from the Nuxeo subversion repository you'll need the [subversion|http://subversion.tigris.org] client installed. Once installed you can check out each chapter's source code by entering at the command line (for example):
{{$ svn export http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-bundle/}}
The svn export command checks out all the source for the lesson-bundle chapter into a directory called lesson-bundle, without any of the accompanying .svn files.
You will find on this page two entry points to Nuxeo customization samples plus useful links. We advise you to give first a glance at all the Nuxeo EP wiki domain, so that you get a global idea of the architecture of the product.
Then you can start playing with the sample project or the tutorial, that gives you a lot of explanations too.
h3. The sample project
In addition to the Nuxeo Tutorial, there is a sample project outlined in chapter 3 ('Getting started') of the Nuxeo DM Reference Book:
* [HTML (Chapter 3 only)|http://doc.nuxeo.org/current/books/nuxeo-book/html/getting-started.html]
The sample chapter builds on the tutorial, and illustrates a number of additional examples.
The source code for the sample project can be found in the Nuxeo Mercurial repository at the following link:
* [Sample Project Source Code|http://hg.nuxeo.org/addons/nuxeo-sample-project].
To check the sample code out from this remote repository onto your local machine, you will need to have [mercurial|http://mercurial.selenic.com/wiki] installed. Once you have mercurial you can run:
{{$ hg clone http://hg.nuxeo.org/addons/nuxeo-sample-project}}
This will create a directory on your local machine called nuxeo-sample-project which contains all the source code for nuxeo the sample project.
The mercurial repository contains branches such as '5.2' and '5.3'. You can see these branches by entering:
{{$ hg branches}}
Check which branch you are in by entering in:
{{$ hg branch}}
You can change branches by running for example (if you are currently in the 5.3 branch, and want to switch to the 5.2 branch):
{{$ hg update 5.2\\
$ hg branch}}
h3. The tutorial
[The Tutorial (draft) - HTML:|http://www.nuxeo.org/static/dev-tutorial] (also known as the 'Learning Nuxeo DM' Guide).
This tutorial shows you how to extend and customize Nuxeo's 'out of the box' functionality in a step-by-step fashion.
5. Tutorial Source Code
The source code for the tutorial is held in the Nuxeo subversion repository. Although the tutorial links to the source code in each chapter, it's listed again here for convenience:
* [Source Code for Chapter 5: Your First Bundle|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-bundle]
* [Source Code for Chapter 6: Improving The Upcoming UI|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-basic-ui]
* [Source Code for Chapter 7: Internationalization And Localization|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-l10n]
* [Source Code for Chapter 8: Events And Event Listeners|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-events]
* [Source Code for Chapter 9: XMap And Logging|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-xmap]
* [Source Code for Chapter 10: Users and Groups|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-users]
* [Source Code for Chapter 11: Access Control And Security|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-security]
* [Source Code for Chapter 12: Relations And A Bit Of Content|http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-relations]
To check out the source code from the Nuxeo subversion repository you'll need the [subversion|http://subversion.tigris.org] client installed. Once installed you can check out each chapter's source code by entering at the command line (for example):
{{$ svn export http://svn.nuxeo.org/nuxeo/sandbox/iansmith/book/lesson-bundle/}}
The svn export command checks out all the source for the lesson-bundle chapter into a directory called lesson-bundle, without any of the accompanying .svn files.