Import custom StyleBooks

After you have built your StyleBook, you have to import it to Citrix ADM to use it. Citrix ADM allows you to import a single StyleBook in YAML form or multiple StyleBook YAML files as a bundle in a .zip, .tgz, or .gz form. The Citrix ADM system validates your StyleBooks on import. The StyleBook is now ready to be used for creating configurations.

Citrix ADM also has a built-in YAML editor that you can use to compose the StyleBook YAML contents. The YAML editor allows you to validate your YAML constructs from the Citrix ADM GUI itself. You do not need to use a separate tool for these validation checks. The content is validated against YAML standards and any deviation is highlighted. You can then correct the content and attempt to import the StyleBook into Citrix ADM. The built-in YAML editor provides two advantages while writing your own StyleBook.

• Color coded. The editor displays the StyleBook content parsed as per YAML guidelines, and the color coding helps you to differentiate easily between the keys and the values defined in the YAML content.
• YAML validation. The content is validated for any YAML errors as you type in and any deviation is immediately highlighted. This validation allows you to write text that conforms to YAML guidelines even before you import the StyleBook in Citrix ADM.

Note

Currently, the editor validates the content according to YAML guidelines. It does not validate for code correctness and typographical errors.

Use HTML formatting tags in the StyleBook description and header

In the StyleBook definition, you can include a header field and use HTML formatting tags for the text. You can also include images as part of the header and it will be rendered at the top of the configuration form. This feature allows you to add infographics for the StyleBook users that helps in understanding the StyleBook configuration. If you use images in the header, ensure to use base64 encoded image format in the <img> tag.

name: app-stylebook-with-HTML-tags
namespace: com.examples.stylebooks
version: "1.0"
display-name: "Example App StyleBook"
header: 'This <b> StyleBook </b> defines all the app configuration for <i>Load Balanced Application </i>. The following image describes the target deployment for the app <img src="data:image/png;base64,…" />'
<!--NeedCopy-->