Interface ConfigStepMenu
- All Superinterfaces:
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>
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
A document menu item.static interface
Common interface for all menu items.static interface
Adds a menu item for showing the latest changes to models and symbols.static interface
A list menu item.static interface
A menu that can contain other menus or menu items.static interface
A model menu item.static interface
Adds a menu item for showing models and symbols with new revisions.static interface
Adds a menu item for plugin items.static interface
A symbol menu item. -
Method Summary
Modifier and TypeMethodDescriptionThe target for documents with the "copy-on-publish" property set.getMenu()
The root menu item.The target file, relative to the output directory.boolean
boolean
boolean
boolean
void
setCopiedDocsTarget
(String docsTarget) void
setMenu
(ConfigStepMenu.Menu menu)
-
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
ConfigStepMenu.Menu getMenu()The root menu item. XML tag: "menu-bar"- Returns:
- The root menu item.
-
setMenu
-
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
-
isShowModelPrefix
boolean isShowModelPrefix() -
isShowObjectPrefix
boolean isShowObjectPrefix() -
isShowDocumentPrefix
boolean isShowDocumentPrefix() -
isGeneratePDF
boolean isGeneratePDF() -
getTargetRelURL
String getTargetRelURL()
-