---
title: "<labeling>"
source: https://dev.pageseeder.com/guide/configuration/psml/psml_document_config/document_labeling.html
description: "How to use the <labeling> element in the PSML document-config.xml file to control what labels are available in PSML documents"
last_updated: 2026-08-11T16:03:10+10:00
tokens: ~637
---

# PSML document labeling

This article describes how to use the `<labeling>` element in the PSML `document-config.xml` file to control what labels are available in PSML documents.

It has the following structure:

```xml

<labeling [override="true"]>
  <labels type="..." ... />*
</labeling>
```

## Behavior

By default, the labels configuration extends the default configuration so that labels defined here are added to the project labels. To override the labels configuration, use the `@override` boolean attribute.

If the `<labeling>` element is not defined or the `document-config.xml` doesn’t exist, the labels are automatically inherited from the project labels.

## Details

Each `<labels>` element defines the following:

| Attribute | Description |
| --- | --- |
| `type` | The type of label to define (`content-block`, `content-inline`, `image`, `link`, `xref`, `edit-note`, `fragment, document`) |

Each `<labels>` element can have one or more `<label>` elements which define:

| Attribute | Description |
| --- | --- |
| `name` | The name of the label |
| `description` | A description for this label (optional) |
| `fragmenttypes` | A comma-separated list of fragment types to restrict the label to, `default` means only fragments with no type  – does not apply to `type="document"`  (optional) |
| `color` | The color of the label in the document view (optional - only applies to type `content-block` or `content-inline` ) – can be `black, navy, blue, green, yellow, orange, pink` or `purple.` |

### Example

```xml
<labeling>
  <labels type="content-block">
    <label name="deprecated"
           description="Feature no longer supported"/>
    <label name="note"
           description="Displayed in a special box"/>
    <label name="warning"
           description="Big and red"
           fragmenttypes="outcome,question"
           color="pink" />
  </labels>
  <labels type="content-inline">
    <label name="parameter"
           description="A function parameter"/>
  </labels>
  <labels type="xref">
    <label name="glossary" 
           description="Link to a glossary item"
           fragmenttypes="question"/>
  </labels>
  <labels type="edit-note">
    <label name="spelling"
           description="Spelling correction"/>
  </labels>
  <labels type="fragment">
    <label name="thumbnail"
           description="A thumbnail image"
           fragmenttypes="figure"/>
  </labels>
  <labels  type="document">
    <label name="important"
           description="An important document"/>
  </labels>
</labeling>
```