Document and Document UI

Document

Document is Nuxeo is not just a file (even a folder in Nuxeo is a Document), but a set of fields includes

• Simple fields
• Simple lists (multiple valued properties)
• Complex types
  • file
  • custom complex types

Document structure is defined using (several) XSD schemas

And facets, which can be associated with zero or more schemas, and other behaviours.

Structural Document Type

Document type is defined by

• a name
• "extends" (Studio - Extends) - a super type, usually Document / Folder
• a set of schemas
• a set of facets
  • at pure storage level, Facets are simple declarative markers used by repository and other EP services to define how the document must be handled
  • a facet can has zero or more schemas
  • Default facets include
    • Versionnable
    • HiddenInNavigation
    • Commentable
    • Folderish
    • ...
  • facets can be used on
    • document type, adding to <doctype> element
    • document instance, by application code

Document type can inherit from each other

UI document types

To register structural document type so that it becomes visible in platform.

• contribute to "types" extension point of "org.nuxeo.ecm.platform.types.TypeService" component
• label / description / icon / bigIcon / category (see development document, and can be extended)
• facelet views (defaults are applied if not specified, so no need to add to type if
  • default-view - view to display the document, corresponds to a file in the webapp, by default "view_documents.html", a standard view defined in base Nuxeo EP bundle, and changing is not advised
  • create-view / edit-view
• layout
  • is the arrangement of a series of widgets, making association with the field of a schema with a JSF component, and used by modification and summary views
  • defined inside with <layouts> section (note final s) for the document type for a given mode
    • "create" / "edit" / "view"
    • "any" will be merged with all others
    • "header" - things always there, above tabs
  • Registration: as extension contribution
    • Component "org.nuxeo.ecm.platform.forms.layout.WebLayoutManager"
    • Extension point "layouts"
    • XML structure defined in org.nuxeo.ecm.platform.forms.layout.descriptors.LayoutDescriptor
  • Definition (what's in that XML)
    • name (as simple as 'heading', for example)
    • templates: list of templates (XHTML) to use for global rendering, see more below
    • rows:
      • what widgets to be display on what row.
      • each row can hold several widgets
      • empty widget type can be used to control alignment
      • widget has to match a widget name given in this layout definition
    • widget
      • if not referenced in rows, will be ignored
      • before ignored, the widget is searched in the global widget registry - to share widget definitions between layouts
  • Listing layout (used to render table rows)
    • mode (or widget mode) can not depend on iteration variable, because when layout is built iteration variable is not available
  • see more in http://doc.nuxeo.com/display/NXDOC56/Manage+layouts
• subtypes (Container / Accepted Child doc in Studio)
  • defines a list of type elements that can be created inside (as children objects) of other document types. i.e. what can be placed in what
  • pre-existing type can be used to allow new subtypes
• Tabs - various tabs to show (is it here? incomplete....)

Layouts

Structure templates

- a section of tree of doc nodes to create altogether (is it here? incomplete)

Implementation Samples and Details

Schema

• defined in .xsd
• registered by a contribution to the schema extension point
• registration includes
  • a schema name
  • schema location
  • schema prefix (recommended)
• possible overriding an existing schema - register with same name, and with attribute "override="true"" in "schema" tag

[ a very simple, sample schema]

<?xml version="1.0"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"

    targetNamespace="http://project.nuxeo.org/sample/schemas/sample/">

<xs:element name="sample1" type="xs:string"/>

<xs:element name="sample2" type="xs:string"/>

</xs:schema>

[ register through "schema" extension point]

<?xml version="1.0"?>

<component name="org.nuxeo.project.sample.types">

<extension target="org.nuxeo.ecm.core.schema.TypeService"

point="schema">

<schema name="sample" src="schemas/sample.xsd" prefix="smp" />

</extension>

</component>

Facet

[sample, adding to a document type]

<?xml version="1.0"?>

<component name="org.nuxeo.project.sample.types">

...

<extension target="org.nuxeo.ecm.core.schema.TypeService"

point="doctype">

<facet name="Rated">

<schema name="rating"/>Schema

</facet>

...

</extension>

</component>

Structural Document Type

• contribution to doctype extension, specifies:
• which standard document type it extends (usually "Document" or "Folder")
• which schemas being used
• and facets applied

<?xml version="1.0"?>

<component name="org.nuxeo.project.sample.types">

...

    <extension target="org.nuxeo.ecm.core.schema.TypeService"

point="doctype">

...

        <doctype name="Sample" extends="Document">

            <schema name="common"/>

            <schema name="dublincore"/>

            <schema name="sample"/>

            <facet name="Rated"/>

        </doctype>

    </extension>

</component>

UI document types

[ skeleton]

<?xml version="1.0"?>

<component name="org.nuxeo.project.sample.ecm.types">

    <extension target="org.nuxeo.ecm.platform.types.TypeService"

point="types">

        <type id="Sample">

            <label>Sample document</label>

            <description>Sample document to do such and such</description>

            <icon>/icons/file.gif</icon>

            <bigIcon>/icons/file_100.png</bigIcon>

            <category>SimpleDocument</category>

            ......

            <layouts>...</layouts>

            ...

        </type>

    </extension>

</component>

[Facelet views - only needed if other than defaults are used]

<type id="Sample">

...

    <default-view>view_documents</default-view>

    <create-view>create_document</default-view>

    <edit-view>edit_document</default-view>

...

</type>

[Layout example]

This refers to layouts definition in another extension point. Layout may be laid inside but that is deprecated.

<type id="Sample">

...

    <layouts mode="any">

        <layout>heading</layout>

        <layout>note</layout>

    </layouts>

...

</type>

[subtypes]

what can be placed in what...

Note it's not inside the Sample type but stand alone <type> sections.

Note "hidden" can hide type (not be allowed) as children in some cases (create, paste)

<type id="Folder">

    <subtypes>

        <type>Sample</type>

    </subtypes>

</type>

<type id="Workspace">

    <subtypes>

        <type>Sample</type>

        <type hidden="create, paste">Folder</type>

    </subtypes>

</type>