Medium

GetDoc adapter callbacks that have been determined by SDL Contenta Engineering to be medium in usefulness.

pcm_header_insert
This method is used to insert data into the header between the square brackets. Override this method if you want to insert your own declarations of file, character, text, or parameter entities, etc.

This method is passed a reference to an API generated compound object with data in it describing the top level object of the tree, which is the currently selected object. Use the call $CompoundO->GetValueByLabel(0,"NAME"), for example, to get the name of the top object.

This method is also passed the file handle to the header file. The file pointed to by the file handle, is complete to the open square bracket, [ (refer to the example below). After this method returns, the remainder of the header is written, including the close square bracket, ].

Example: Sample of an XML header file exported from Contenta Explorer . The square brackets referred to above are highlighted in bold type.

xml version="1.0"
<!DOCTYPE SCENE PUBLIC "-//ARBORTEXT//DTD SHAKESPEARE//EN" "" []>
&xyent-rw001;

To determine where this callback is invoked, search PcmEpic.pm and PcmFrame.pm in the adapters/custom directory.

pcm_make_header

This method can be overridden if you need to modify the way the header is created.

This is an empty method in CustomGetDocDefault (except for comments) but it is defined in all of the delivered Custom Modules.

See also pcm_header_insert.

pcm_set_editor_name
This method sets the data member {ToolName} to an editor name.

In CustomGetDocDefault {ToolName} is set to Globaled. The value assigned to this data member is used for such things as creating one component of the checkout directory.

In CustomGetDocEpic, the value assigned is EpicEdit so the directory is named Contenta/Checkout/EpicEdit.