...
Crystal Export provides a drag-n-drop template editor which lets you customize customise the look and feel of the converted document including header & footer, page size, margins, etc.
...
Name | Description | |
|---|---|---|
Simple Elements - can be used in header, footer and in content (as long as there is no Content Element). The content of element is either auto generated (e.g. page number) or added by the user. | ||
 Page Number | Displays current page number and/or total page numbers. The total page number is calculated based on total converted pages in a section. The format of page number can be controlled using | |
 Container | Used for grouping elements and controling their alignments and the flow direction of the child elements. The flow of elements can be controlled using | |
 Spacer | This element can be used to create space between two different elements when you don’t want them to fill the entire space. The ratio of space this takes can be controlled using Example:   | |
 Text | Plain text element that can be a Single line/paragraph of text with simple formatting. | |
Confluence Elements - can be used in header, footer and in content (as long as there is no Content Element). The content of element is derived from Confluence (e.g. title of the page being exported). | ||
 Title | Title of the Confluence page being exported. | |
Content Elements - can only be used as the main content of page. The content of element is either derived from Confluence (e.g. the Confluence page’s content) or be auto-generated (e.g. table of contents) or added by the user (e.g. rich text) | ||
 Table Of Contents | Generates table of contents based on the headings in the Confluence pages being exported. | |
 Confluence Content | Inserts selected Confluence page’s  Jira Issues | Inserts given Jira issues rendered using selected layout as content. |
 Rich Text | Allows the end user to insert custom rich text as the content. Overflowing content will be shown with a scroll bar in template editor but during conversion, will overflow to new pages. | |
Other Commands | ||
 Undo | Revert the last action | |
 Redo | Redo the reverted actions | |
...
The indicator will be shown for elements on hover & when selected. It shows you the name of selected/hovered element and also provides options to control the element. The Move option allows you to move the element, and the Select Parent option selects the containing/parent element of currently selected element. The Delete option remove the selected element.
Creating and Managing Layouts
Click on Crystal Export from Apps section in top navigation bar.
Click on “Manage Layouts” button on sidebar.
You’ll be redirected to the Manage Layouts page.
Click on Add New button to create a new template.
To edit an existing template click on Edit button.
To remove an existing template click on Remove button
| Info |
|---|
NOTE: Creating and managing layouts requires basic HTML, CSS knowledge. |
Layout Editor
Layouts define how the issue data should be rendered. Considering the complexity of Jira issue and related data, and for maximum flexibility; Crystal Export allows you to define the layouts using Handlebars HTML Templates and SCSS.
Layout (Handlebars)
The structure of issue layout is defined using Handlebars Templates. The list of issues and other data will be provided via the context of Handlebars template. The layout of a single issue should be provided inside a each block so as to render all the issues.
Read more about handlebars on the language guide.
Stylesheet (SCSS)
Stylesheet lets you add styles to the HTML template provided in the layout. Crystal Export supports SCSS for allowing the user to create complex styles with simplicity.
Read more about SCSS on the documentation.