Interface ConfigStepMenu

All Superinterfaces:
ConfigStep

public interface ConfigStepMenu extends ConfigStep
Creates an XML file representing a menu of some kind containing models, symbols, documents etc. type: post-step Example XML:

  <menu-xml>
 
  </menu-xml>
 
  • Method Details

    • getTarget

      String getTarget()
      The target file, relative to the output directory. XML tag: "target"
      Returns:
      The target file, relative to the output directory.
    • getMenu

      The root menu item. XML tag: "menu-bar"
      Returns:
      The root menu item.
    • setMenu

      void setMenu(ConfigStepMenu.Menu menu)
    • 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 with the "copy-on-publish" property set.
    • setCopiedDocsTarget

      void setCopiedDocsTarget(String docsTarget)
    • isShowModelPrefix

      boolean isShowModelPrefix()
    • isShowObjectPrefix

      boolean isShowObjectPrefix()
    • isShowDocumentPrefix

      boolean isShowDocumentPrefix()
    • isGeneratePDF

      boolean isGeneratePDF()
    • getTargetRelURL

      String getTargetRelURL()