Tutorials

Task-driven tutorials and recipes for PageSeeder

How to create a properties fragment

Skills required:XML, JSON
Time required (minutes):30
Intended audience:Developer
Difficulty:Low to Medium
Category:Document

Objective

PSML supports a special class of fragments known as properties fragments. These name/value pairs can be used to store information such as metadata. This tutorial will explain how they can be implemented.

Tutorial

Introduction

By default, sections in PageSeeder documents use the PSML format and the CK editor. PageSeeder defines other formats which are associated with other built-in editors.

Note

To insert a new section into an existing document, export the document and insert the new section inside the PSML.

Create a new document type

This step can be skipped if the documents to be changed already belong to a custom document type.

Otherwise, follow the tutorial How to create a new document type.

Create a new section with label values format

Edit the document-template.xml file for the specific document type. For example:

/WEB-INF/template/movie_database/psml/movie_info/document-template.xml

Insert a new section using format='pslabelvalues'

...
<root>
  <properties> ... </properties>
  <section> ... </section>

  <!-- Insert the new section -->
  <section id="metadata" format="pslabelvalues">
    <para>Director: <inlineLabel name="director"> </inlineLabel></para>
    <para>Rating : <inlineLabel name="rating"> </inlineLabel></para>
  </section>

  <section> ... </section>
</root>

By default, a section with the 'pslabelvalues' format is bound to the label value editor, therefore the user is not served the richtext editor for these sections.

Configure the editor

Where label values are a big component of the data, customizing the editor can improve productivity or data quality. To learn more about this topic, see the How to configure a custom properties editor tutorial or the PSML properties editor reference documentation.

Created on , last edited on