Interfaces
Type | Interface | Description |
---|---|---|
![]() | IPublishRequest |
Represents a queued request to publish a document using a specified PublishTemplate object. All
publish requests are processed asynchronously, including copy operations, which do not transform the
document. Once a PublishRequest object is saved, it is always enqueued.
In IBM Content Foundation, the IBM FileNet Rendition Engine is not supported.
Therefore, this class cannot be used for transform publishing. It can only be used for copy publishing or DITA publishing.
A publish request can be for a publish or republish operation, as determined by the PublishTemplate and PublicationDocument properties. If the PublishTemplate property is set and the PublicationDocument property is null, the request is for a publish operation. Otherwise, if the PublicationDocument property is set, the publish request is for a republish operation. A PublishRequest object can be created by calling the Publish or Republish methods on a Document object. Alternatively, a PublishRequest can be created by calling Factory.IPublishRequest.CreateInstance and filling in the desired properties prior to saving. In either case, when the object is saved, it goes into the publish request queue, where it will be processed asynchronously by a publishing event handler. Once a PublishRequest object has been successfully processed, it is deleted from the server. |
![]() | IPublishStyleTemplate |
Represents the style template that defines how a source document will be transformed. A style template serves
as a template for a particular kind of transformation and is tied to a specific publishing event handler on a
specific object store. (Note that a publishing event handler can have more than one style template associated
with it.)
In IBM Content Foundation, the IBM FileNet Rendition Engine is not supported.
Therefore, this class cannot be used for transform publishing. It can only be used for copy publishing or DITA publishing.
Information in the style template can be whatever is meaningful to the publishing event handler. For example, the style template might include an XML-based description of the transformation to be done for this style template, an ID of another document that contains a more detailed template, or a URL for publishing to an external location. A style template also specifies a list of input formats (MIME types) supported for the style template, the output format (MIME type) generated when the style template is applied, and, optionally, passwords used by PDF renditions. A publish style template associated with the HTML publishing event handler does not specify any additional transformation options beyond the basic ones (title, description, input formats, output format, and provider ID). In addition to the basic transformation options (as mentioned above for the HTML publishing event handler), a publish style template associated with the PDF publishing event handler optionally specifies the user and master PDF passwords, as well as other PDF security and watermark settings (stored as XML in the TransformationOptions property). |
![]() | IPublishTemplate |
Represents a template for publishing a document. A publish template is an XML document that contains
information used to automate the selection of options for a publishing request. For example, it
contains the properties and security to apply to the destination document, and instructions for
republishing a document, such as whether to version the existing destination document or replace it.
Also, a publish template's StyleTemplate property might reference a PublishStyleTemplate
object, which describes how the document is to be transformed.
In IBM Content Foundation, the IBM FileNet Rendition Engine is not supported.
Therefore, this class cannot be used for transform publishing. It can only be used for copy publishing or DITA publishing.
Because IPublishTemplate extends the IDocument interface, you can work with a publish template in the same way you work with a document. For example, you can version a publish template, file it into a folder, and delete it. Publish templates are usually authored in the Publishing Designer application. However, you can override certain publish options when you call the Publish or Republish method. See Publish Options XML for more information. |