Glossary

A-Z glossary of PageSeeder concepts

Document ID (DocID)

The PageSeeder server allows any document – XML or binary – to be assigned a server-wide, unique, permanent identifier. This value is commonly referred to as the DocID and it has the same use case for both developers and end-users. That is, the DocID is an alternative method to folder path and filename for locating a document, like a primary key.

The following is an example of markup for the DocID :

<?xml version="1.0" encoding="UTF-8"?>
<?stylesheet format="standard" title="My Doc's Title"
  docid="MDT-15"?>

Following are rules to be aware of when processing using DocIDs:

  • Because DocIDs are unique to a server, they may be in use but not visible to a particular project or group. To protect the integrity of a particular range of IDs, use a prefix to (ie. XYZ-????).
  • Developers using the API don't need to consider this point, but this is important for anyone manually accessing the XML created by PageSeeder. If the DocID is required, it is best to use the Export function available via the action icon.
  • When using the Save As XML option in Document Options Block, only a DocID that was created with the file will be exported. If the DocID was added through the user interface, it will not. 

Created on , last edited on