Customize Document's skin

Note

This section is related to the configuration. You can see a sample here.

First, you need to create a new document definition.

<myportal_path>/src/main/webapp/WEB-INF/conf/myportal/customized/document/ACustomizedDocument.xml

	node type name :exo:customizedDocument
	properties: exo:name(type : String), exo:title(type : String), exo:content(type : String)

You also need to configure it to make sure it is imported to the database.

<myportal_path>/src/main/webapp/WEB-INF/conf/myportal/customized/document/definition-configuration.xml




<external-component-plugins>

  <target-component>org.exoplatform.services.jcr.RepositoryService</target-component>

  <component-plugin>

    <name>ACustomizedDocument</name>

    <set-method>addPlugin</set-method>

    <type>org.exoplatform.services.jcr.impl.AddNodeTypePlugin</type>

    <priority>200</priority>

    <init-params>

      <values-param>

        <name>autoCreatedInNewRepository</name>

        <description>ACustomizedDocument document definition</description>

        <value>war:/conf/myportal/customized/document/ACustomizedDocument.xml</value>

      </values-param>

    </init-params>

  </component-plugin>

</external-component-plugins>

Next, create the templates for this document, including:

Dialog: see the sample here.

<myportal_path>/src/main/webapp/WEB-INF/conf/myportal/customized/document/dialog.gtmpl

<div class="UIForm ACustomizedDocument">
  <% uiform.begin() %>
  <!-- Document dialog content is here -->
  <% uiform.end() %>

View: see the sample here.

<myportal_path>/src/main/webapp/WEB-INF/conf/myportal/customized/document/view.gtmpl

<style>
  <% _ctx.include(uicomponent.getTemplateSkin("exo:customizedDocument", "Stylesheet")); %>
</style>
<!-- Document view template content is here -->

Stylesheet: see the sample here.

Note

This document should contain ONLY the stylesheet for THIS template.

<myportal_path>/src/main/webapp/WEB-INF/conf/myportal/customized/document/stylesheet.css

/* ... */

.ACustomizedDocument {
  /* ... */
}

/* ... */

You also need to import them to the database.

<myportal_path>/src/main/webapp/WEB-INF/conf/myportal/customized/document/template-configuration.xml




<external-component-plugins>

  <target-component>org.exoplatform.services.cms.templates.TemplateService</target-component>

  <component-plugin>

    <name>addTemplates</name>

    <set-method>addTemplates</set-method>

    <type>org.exoplatform.services.cms.templates.impl.TemplatePlugin</type>

    <init-params>

      <value-param>

        <name>autoCreateInNewRepository</name>

        <value>true</value>

      </value-param>

      <value-param>

        <name>storedLocation</name>

        <value>war:/conf/myportal/customized/document</value>

      </value-param>

      <value-param>

        <name>repository</name>

        <value>repository</value>

      </value-param>

      <object-param>

        <name>template.configuration</name>

        <description>configuration for the localtion of nodetypes templates to inject in jcr</description>

        <object type="org.exoplatform.services.cms.templates.impl.TemplateConfig">

          <field name="nodeTypes">

            <collection type="java.util.ArrayList">

              <value>

                <object type="org.exoplatform.services.cms.templates.impl.TemplateConfig$NodeType">

                  <field name="nodetypeName">

                    <string>exo:customizedDocument</string>

                  </field>

                  <field name="documentTemplate">

                    <boolean>true</boolean>

                  </field>

                  <field name="label">

                    <string>Customized Document</string>

                  </field>

                  <field name="referencedView">

                    <collection type="java.util.ArrayList">

                      <value>

                        <object type="org.exoplatform.services.cms.templates.impl.TemplateConfig$Template">

                          <field name="templateFile">

                            <string>view.gtmpl</string>

                          </field>

                          <field name="roles">

                            <string>*</string>

                          </field>

                        </object>

                      </value>

                    </collection>

                  </field>

                  <field name="referencedDialog">

                    <collection type="java.util.ArrayList">

                      <value>

                        <object type="org.exoplatform.services.cms.templates.impl.TemplateConfig$Template">

                          <field name="templateFile">

                            <string>dialog.gtmpl</string>

                          </field>

                          <field name="roles">

                            <string>webdesigner:/platform/web-contributors</string>

                          </field>

                        </object>

                      </value>

                    </collection>

                  </field>

                  <field name="referencedSkin">

                    <collection type="java.util.ArrayList">

                      <value>

                        <object type="org.exoplatform.services.cms.templates.impl.TemplateConfig$Template">

                          <field name="templateFile">

                            <string>stylesheet.css</string>

                          </field>

                          <field name="roles">

                            <string>*</string>

                          </field>

                        </object>

                      </value>

                    </collection>

                  </field>

                </object>

              </value>

            </collection>

          </field>

        </object>

      </object-param>

    </init-params>

  </component-plugin>

</external-component-plugins>

Finally, you should create some initial contents and export them to XML files.

To import this XML into database, you can set up the deployment like this:




<external-component-plugins>

  <target-component>org.exoplatform.services.wcm.deployment.WCMContentInitializerService</target-component>

  <component-plugin>

    <name>Content Initializer Service</name>

    <set-method>addPlugin</set-method>

    <type>org.exoplatform.services.wcm.deployment.plugins.XMLDeploymentPlugin</type>

    <description>XML Deployment Plugin</description>

    <init-params>

      <object-param>

        <name>ACME Logo data</name>

        <description>Deployment Descriptor</description>

        <object type="org.exoplatform.services.deployment.DeploymentDescriptor">

          <field name="target">

            <object type="org.exoplatform.services.deployment.DeploymentDescriptor$Target">

              <field name="repository">

                <string>repository</string>

              </field>

              <field name="workspace">

                <string>collaboration</string>

              </field>

              <field name="nodePath">

                <string>/sites content/live/acme/web contents/site artifacts</string>

              </field>

            </object>

          </field>

          <field name="sourcePath">

            <string>war:/conf/wcm/artifacts/site-resources/acme/Logo.xml</string>

          </field>

        </object>

      </object-param>

    </init-params>

  </component-plugin>

</external-component-plugins>