About publication documents
The source and publication documents form a relationship through object valued properties on the Document class. A publication Document points to a source document as either a non-dependent document or a dependent document, depending on the option specified in the original publish request. If a dependent publication document, a metadata relationship exists that causes the publication document to be deleted if the source Document is deleted.
When republishing a document, the publication document is related to a previous publication document in different ways depending on the original publish request and the capabilities of the previous document. The following are examples of the publication document behavior upon republishing:
- Specifying a ‘version’ option when republishing a document that supports versioning results in two versions of the same document version series, or versioning and replacing the current publication version.
Note that typically you republish a document because a new version of the source exists.
- Specifying a ‘replace’ option when republishing a document that supports versioning results in a new version in that version series. The previous version is deleted.
If a publication document does not support versioning, then the ‘version’ option to republish a document is not valid. Specifying the ‘replace’ option causes a new document to be created and the previous document deleted.
NOTE Publishing a document consisting of multiple content elements will result in only the primary (1st) content element being published. In this respect, publishing does not 'support' multiple content element documents.
For versionable documents, the Publishing Designer has four options regarding the actions to take upon republishing:
- Version the current publication document (Version & Keep)
- Version and replace the current publication document (Version & Replace)
- Add a new publication document (Add & Keep)
- Add a new publication document and replace the current document (Add & Replace)
Each of these four republish options is valid for the three publishing types; native publishing, publishing to PDF, and publishing to HTML. The following section describes how moving a publication document or filing it in multiple folders will affect each of the three publishing types and four republishing options:
- Native publishing does not have any limitations on republishing a publication document that has been moved to or filed in multiple folders. The Add republish cases will use the target folder specified in the publish template for the new publication document. The Version republish cases will version the publication document instead of creating a new publication document, and therefore the versioned publication document will automatically appear updated in the locations it is filed in.
- Publishing to PDF does not have any limitations on republishing a publication document that has been moved to or filed in multiple folders, and functions the same as the native republishing cases.
- Publishing to HTML does not have any limitations on republishing a publication document that has been moved. However, republishing a publication document that has been filed in multiple folders has limitations. Filing the publication document in multiple folders is not recommended for the Add republish cases, and it is not supported for the Version republish cases.
- The Add republish cases will use the target folder specified in the publish template for the new publication document, and therefore it is irrelevant for the republish operation if the publication document has been filed in multiple folders. However, it is not recommended to file a publication document (including subsidiary folder with files) in multiple folders because if you do so, you also have to copy the subsidiary folder with files to all the folders to ensure that Workplace will continue to display the publication document correctly.
- The Version republish cases are not supported when a publication document has been filed in multiple folders because the code is not designed to create copies of the subsidiary folder with files in all folders that the publication document is filed in. At the beginning of the republish operation a check to see if the publication document has been filed in multiple folders is done, and if found to be true the publish request will be set to in-error and the republish operation is aborted.
The publishing cases described above are summarized in the following table:
|
|
Moved to a different folder |
Filed in multiple folders |
Native publishing |
Add cases |
Supported |
Supported |
|
Version cases |
Supported |
Supported |
Publishing to PDF |
Add cases |
Supported |
Supported |
|
Version cases |
Supported |
Supported |
Publishing to HTML |
Add cases |
Supported |
Not recommended |
|
Version cases |
Supported |
Not supported |