\nThe type service provides extension points for pluggable document types.\n
\nDocument types here can be seen as entities defining the behavior of a\ndocument within the ECM: they hold information about the way they will be\nmanaged and rendered.\n
\n@version 1.0\n
", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.types.TypeService", "descriptors": [ "org.nuxeo.ecm.platform.types.Type" ], "documentation": "\n A document type has the following properties:\n\n - id: its string identifier\n\n - remove: if true, remove this ecm document type. Can be used, for\n instance, if there is a document type contributed by nuxeo-dm that you\n don't want in your application. (Be careful to add a dependency to the\n contribution that creates this document type.)\n\n - icon: icon path used to represent the document type.\n\n - icon-expanded: icon used for instance in tree view\n\n - bigIcon: icon path aimed at rich application\n\n - bigIcon-expanded: same as icon-expanded for rich application\n\n - category: Category of the document type.\n\n - description: Description of the document type.\n\n - label: string title.\n\n - subtypes: list of the allowed sub document types for a given container.\n This can be used to filter some document types creation and copy to\n specific kinds of container documents.\n\n - deniedSubtypes: list of forbidden sub document types for a given\n container. Useful when you inherit from another container type and want to\n restrict its subtypes.\n\n - default-view: this view will be returned when accessing the document.\n\n - create-view: this view will be returned when creating the document.\n\n - edit-view: this view can be used to display the document default edit\n page.\n\n - views: other views can be defined, so that they can be customized easily\n and trigger specific behaviour. For instance, defining a view named\n 'after-edit' on the document will allow to parameter which view should be\n displayed after the document edition.\n\n WARNING: the views definitions and associated behaviours may change in the\n future. You should avoid customizing more than default-view and\n create-view for now.\n\n - layouts: the list of layouts to use in a given mode. Usual modes are\n \"view\", \"create\" and \"edit\". When no layouts are defined for a specific\n mode, layouts for the mode \"any\" are taken for document rendering. An\n additional mode is \"listing\": layouts defined in this mode are used in\n templates listing children documents.\n\n - content views: the list of content views to use in a given category.\n Categories depend on the page displaying the content views. Available\n since 5.4.0. By default, all content views are shown in the export view of\n the document (available since 5.4.2) except when adding\n showInExportView=\"false\" on the content view definition.\n\n Example:\n\n\n \n \n /icons/folder.gif \n view_documents \n \n WorkspaceRoot \n SectionRoot \n \n \n File \n \n \n heading \n \n \n document_listing \n document_listing_compact_2_columns \n document_listing_icon_2_columns \n \n \n document_content \n \n \n \n document_trash_content\n \n \n \n\n\n\n Types extension point provides merging features: you can change an\n existing type definition in your custom extension point provided you use\n the same identifier.\n\n \n",
"documentationHtml": "\nA document type has the following properties:\n
\n- id: its string identifier\n
\n- remove: if true, remove this ecm document type. Can be used, for\ninstance, if there is a document type contributed by nuxeo-dm that you\ndon't want in your application. (Be careful to add a dependency to the\ncontribution that creates this document type.)\n
\n- icon: icon path used to represent the document type.\n
\n- icon-expanded: icon used for instance in tree view\n
\n- bigIcon: icon path aimed at rich application\n
\n- bigIcon-expanded: same as icon-expanded for rich application\n
\n- category: Category of the document type.\n
\n- description: Description of the document type.\n
\n- label: string title.\n
\n- subtypes: list of the allowed sub document types for a given container.\nThis can be used to filter some document types creation and copy to\nspecific kinds of container documents.\n
\n- deniedSubtypes: list of forbidden sub document types for a given\ncontainer. Useful when you inherit from another container type and want to\nrestrict its subtypes.\n
\n- default-view: this view will be returned when accessing the document.\n
\n- create-view: this view will be returned when creating the document.\n
\n- edit-view: this view can be used to display the document default edit\npage.\n
\n- views: other views can be defined, so that they can be customized easily\nand trigger specific behaviour. For instance, defining a view named\n'after-edit' on the document will allow to parameter which view should be\ndisplayed after the document edition.\n
\nWARNING: the views definitions and associated behaviours may change in the\nfuture. You should avoid customizing more than default-view and\ncreate-view for now.\n
\n- layouts: the list of layouts to use in a given mode. Usual modes are\n"view", "create" and "edit". When no layouts are defined for a specific\nmode, layouts for the mode "any" are taken for document rendering. An\nadditional mode is "listing": layouts defined in this mode are used in\ntemplates listing children documents.\n
\n- content views: the list of content views to use in a given category.\nCategories depend on the page displaying the content views. Available\nsince 5.4.0. By default, all content views are shown in the export view of\nthe document (available since 5.4.2) except when adding\nshowInExportView="false" on the content view definition.\n
\nExample:\n
\n
<type id="Domain">\n <label>Domain</label>\n <icon>/icons/folder.gif</icon>\n <default-view>view_documents</default-view>\n <subtypes>\n <type>WorkspaceRoot</type>\n <type>SectionRoot</type>\n </subtypes>\n <deniedSubtypes>\n <type>File</type>\n </deniedSubtypes>\n <layouts mode="any">\n <layout>heading</layout>\n </layouts>\n <layouts mode="listing">\n <layout>document_listing</layout>\n <layout>document_listing_compact_2_columns</layout>\n <layout>document_listing_icon_2_columns</layout>\n </layouts>\n <contentViews category="content">\n <contentView>document_content</contentView>\n </contentViews>\n <contentViews category="trash_content">\n <contentView showInExportView="false">\n document_trash_content\n </contentView>\n </contentViews>\n </type>\n\nTypes extension point provides merging features: you can change an\nexisting type definition in your custom extension point provided you use\nthe same identifier.\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.types/org.nuxeo.ecm.platform.types.core/org.nuxeo.ecm.platform.types.TypeService/ExtensionPoints/org.nuxeo.ecm.platform.types.TypeService--types", "id": "org.nuxeo.ecm.platform.types.TypeService--types", "label": "types (org.nuxeo.ecm.platform.types.TypeService)", "name": "types", "version": "7.10" } ], "extensions": [], "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.types/org.nuxeo.ecm.platform.types.core/org.nuxeo.ecm.platform.types.TypeService", "name": "org.nuxeo.ecm.platform.types.TypeService", "requirements": [], "services": [ { "@type": "NXService", "componentId": "org.nuxeo.ecm.platform.types.TypeService", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.types/org.nuxeo.ecm.platform.types.core/org.nuxeo.ecm.platform.types.TypeService/Services/org.nuxeo.ecm.platform.types.TypeManager", "id": "org.nuxeo.ecm.platform.types.TypeManager", "overriden": false, "version": "7.10" } ], "version": "7.10", "xmlFileContent": "\n\n\n \n \n /icons/folder.gif \n view_documents \n \n WorkspaceRoot \n SectionRoot \n \n \n File \n \n \n heading \n \n \n document_listing \n document_listing_compact_2_columns \n document_listing_icon_2_columns \n \n \n document_content \n \n \n \n document_trash_content\n \n \n \n \n\n Types extension point provides merging features: you can change an\n existing type definition in your custom extension point provided you use\n the same identifier.\n\n