20.07.2014 Views

DOC1 Programmer's Guide

DOC1 Programmer's Guide

DOC1 Programmer's Guide

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

Programming PCE<br />

add document id<br />

Function Adds (or changes) the <strong>DOC1</strong> unique identifier that is assigned to the first page of documents<br />

intended for the Document Repository component.<br />

Syntax add document id of idString to firstPage ;<br />

Parameters idString text; the identifier to be stored in the page<br />

firstPage variable or array element containing the first page of a document.<br />

Effects<br />

The identifier stored in idString will be inserted into the datastream page stored in firstPage.<br />

Any existing identifier will be overwritten<br />

Comments firstPage must be the first page of a document.<br />

idString must contain a valid <strong>DOC1</strong> identifier otherwise an error will be raised. The only<br />

method of getting a valid identifier string is to read one from an existing page using the<br />

document id command.<br />

Example ...<br />

//read first page from datastream containing the required id<br />

read 1 page from file 1 into ;<br />

//get the document id<br />

let = document id in ;<br />

//Read in page to be manipulated<br />

read 1 page from file 2 into ;<br />

//copy the id into the page<br />

add document id of into ;<br />

//write out amended page<br />

write 1 page into file 3 from ;<br />

add document name<br />

Function<br />

Syntax<br />

Places pages within a group structure and adds (or changes) the name information for such a<br />

group.<br />

add document name of name to docGroup [at {start|middle|end}];<br />

Parameters name text<br />

docGroup variable containing/to contain a PCE document group.<br />

Effects<br />

name is used as the identifier for all group related datastream fields created by this command.<br />

If the middle keyword is specified the pages in docGroup will be enclosed in the appropriate<br />

fields to form a complete document group.<br />

28

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!