Package se.conciliate.extensions.publish.custom.step

Interface ConfigStepDocuments

All Superinterfaces:
ConfigStep
public interface ConfigStepDocuments extends ConfigStep
Creates XML files for published documents. type: write-step Example XML: 

  <documents>
      <target>xml/documents</target>
      <internal-docs-target>xml/internal-docs</target>
      <copied-docs-target>copied-documents</copied-docs-target>
  </documents>

  • Method Details

    • getTarget

      String getTarget()
      The target directory of the generated XML, relative to the output directory. The generated files will be on the form "[document-uuid].xml". XML tag: "target"
      Returns:
      The target directory.

    • setTarget

      void setTarget(String target)

    • getInternalDocsTarget

      String getInternalDocsTarget()
      Specifies an additional target for "managed" documents, i.e. documents with content created in the 2c8 Modeling Tool editor. If this target is specified then an extra copy of these XML files will be stored in the specified target directory. XML tag: "internal-docs-target"
      Returns:
      Something I'm sure.

    • setInternalDocsTarget

      void setInternalDocsTarget(String internalDocsTarget)

    • getCopiedDocsTarget

      String getCopiedDocsTarget()
      The target for documents with the "copy-on-publish" property set. When the publish encounters these documents, it will follow the link in the document (for all languages) and make a copy of the actual file referred to in this target directory. The file name of the created file will be: "[document-uuid]_[language-iso-code].[file-ending] where the file ending will be kept from the original file. XML tag: "copied-docs-target"
      Returns:
      The target for documents.

    • setCopiedDocsTarget

      void setCopiedDocsTarget(String docsTarget)

    • isShowPrefix

      boolean isShowPrefix()

    • getTargetRelURL

      String getTargetRelURL()