---
title: "Element <share>"
source: https://dev.pageseeder.com/api/elements/element_share.html
description: "API Element reference for <share>"
last_updated: 2026-08-07T17:09:54+10:00
tokens: ~866
---

# \<share\>

## Summary

The `<share>` element is used to display sharing information about a URI (document or URL). It contains an element that represents a group that the URI is shared with and its attributes specify what is accessible from said group.

For a more detailed discussion on share documents, *see* [document sharing](../../guide/documents/shared_documents.md).

## Usage context

| Permitted content | `<group>` |
| --- | --- |
| Permitted parent | `<sharing>` |

## Attributes

For a document URI (internal), this element includes the following attributes:

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| owner | `xs:boolean` | no | If the group is the owner of the document |
| editable | `xs:boolean` | no | If the group members can edit the document |
| addcomments | `xs:boolean` | no | If the group members can add comments to the document |

For a URL (external), this element includes only the following attribute:

| groupspecific | `xs:string` | no | Comma-separated list of metadata the group can edit |
| --- | --- | --- | --- |

### `@owner`

Flag whether the group is the owner of the document, this optional attribute’s default value is `false`.

### `@editable`

Flag whether the document is editable in the group, this value is always `true` for the default group or for all groups if there is no default group.

### `@addcomments`

Flag whether the group members can add comments to the document.

### `@shareedits`

Flag whether the document edits are shared with the group. This value is based on the group property `shareDocumentEdits` in the default group.

> **Obsolete:** This attribute was removed in PageSeeder 5.99.

### `@sharexrefs`

Flag whether the document xrefs are shared with the group. This value is based on the group property `shareXrefsWithTarget` in the default group.

> **Obsolete:** This attribute was removed in PageSeeder 5.99.

### `@groupspecific`

Comma-separated list of URL metadata that is overwritten by the group; possible metadata values are `title`, `description` and `labels`.

## Examples

```lang-xml

<share editable="false"
       addcomments="true">
  <group id="82"
         name="dev-group2"
         description="Dev group 2"
         owner="dev"
         access="member"
         common="false"
         relatedurl="http://dev.example.org/home.html"/>
</share>

<share owner="true"
       editable="true"
       addcomments="true">
  <group id="35"
         name="dev-group1"
         description="Dev group 1"
         owner="dev"
         access="member"
         common="false"/>
</share>

<share groupspecific="title,description">
  <group id="35"
         name="dev-group1"
         description="Dev group 1"
         owner="dev"
         access="member"
         common="false"/>
</share>
```

## Schema

### XML Schema

```lang-xml

<xs:element name="share">
  <xs:sequence>
    <xs:element ref="group" />
  </xs:sequence>
  <xs:attribute name="owner" type="xs:boolean" fixed="true" />
  <xs:attribute name="editable" type="xs:boolean" />
  <xs:attribute name="addcomments" type="xs:boolean" />
  <xs:attribute name="groupspecific" type="xs:string" />
</xs:element>
```

### Relax Schema

```lang-relax

element share {
  attribute owner{ xs:boolean }?,
  attribute editable { xs:boolean }?,
  attribute addcomments { xs:boolean }?,
  attribute groupspecific { xs:string }?,
  element group
}
```

## Compatibility

No change since initial API release.