Wiki
Clone wikiKeysight Plugins For Atlassian Products / Confluence Plugins / Learning Products Plugin
Introduction
The Learning Products plugin provides a number of macros used by the teams within Keysight that develop product documentation. In general they flag blocks of content for special automated processing.
Features at a Glance
| Feature | Description |
|---|---|
| LP Caution Macro | A macro to create a yellow caution callout. |
| LP Code Macro | A macro to flag code blocks during word and pdf export. |
| LP Do Not Publish Macro | A macro to flag blocks of test that should not be published. |
| LP Hide Modular Macro | A macro to flag blocks of text that should be removed from exported content. |
| LP Important Macro | A macro to create a blue important callout. |
| LP Internal Macro | A macro to flag blocks of text that should be removed from exported content. |
| LP Note Macro | A macro to create a grey note callout. |
| LP Prototype Macro | A macro to prototype new flags. |
| LP Publish Keysight Only | A macro to flag blocks of test that should only be published to Keysight internal audiences. |
| LP Tip Macro | A macro to create a green tip callout. |
| LP Warning Macro | A macro to create a red warnign callout. |
Features in Detail
LP Caution Macro
Description
This is similar to the Confluence Note macro, but uses a Keysight branding compliant style to highlight text with a caution icon and a bounded in a box with a yellow background.
The macro can either render the graphic using CSS or with a raster image in a table. Exports to word or pdf will always use the raster image in the table while html defaults to css. The html rendering can be changed by setting the macro parameter.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Render with | One of CSS or Tables. Controls how the macro is rendered for html output. |
Purpose
T
LP Caution Macro
Description
This is similar to the Confluence Note macro, but uses a Keysight branding compliant style to highlight text with a caution icon and a bounded in a box with a yellow background.
The macro can either render the graphic using CSS or with a raster image in a table. Exports to word or pdf will always use the raster image in the table while html defaults to css. The html rendering can be changed by setting the macro parameter.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Render with | One of CSS or Tables. Controls how the macro is rendered for html output. |
Purpose
To highlight caution text in a Keysight branding style compliant way.
LP Code Macro
Description
This is a wrapper around the Confluence Code macro. When exporting to Word or pdf, it places markers before and after the code block so that a post processing engine can apply syntax highlighting.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Language | One of C++, C#, HTML, Plain Text or XML. |
Purpose
Needed to identify blocks of code that need to be syntax highlighted as Confluence performs that step in javascript and therefore does not apply it for Word of pdf output.
LP Do Not Publish Macro
Description
This macro flags a block of text that should be excluded from post processing.
Usage
To use the macro, insert the macro using the normal Confluence methods. There are no parameters to adjust.
Purpose
To flag content that should be excluded by the post processing.
LP Hide Modular Macro
Description
This macro flags a block of text for post processing. It will render the content in a panel box with a header of Hide Modular to let users know how it will be post processed.
Usage
To use the macro, insert the macro using the normal Confluence methods. There are no parameters to adjust.
Purpose
To flag content that needs to be process by the Hide Modular method. At present, this just strips the block out of the exported content.
LP Important Macro
Description
This is similar to the Confluence Info macro, but uses a Keysight branding compliant style to highlight text with a important icon and a bounded in a box with a blue background.
The macro can either render the graphic using CSS or with a raster image in a table. Exports to word or pdf will always use the raster image in the table while html defaults to css. The html rendering can be changed by setting the macro parameter.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Render with | One of CSS or Tables. Controls how the macro is rendered for html output. |
Purpose
To highlight important text in a Keysight branding style compliant way.
LP Internal Macro
Description
This macro flags a block of text for post processing. It will render the content in a panel box with a header of Internal Content to let users know how it will be post processed.
Usage
To use the macro, insert the macro using the normal Confluence methods. There are no parameters to adjust.
Purpose
To flag content that needs to be process by the Internal Content method. At present, this just strips the block out of the exported content.
LP Note Macro
Description
This is similar to the Confluence Info macro, but uses a Keysight branding compliant style to highlight text with a note icon and a bounded in a box with a gray background.
The macro can either render the graphic using CSS or with a raster image in a table. Exports to word or pdf will always use the raster image in the table while html defaults to css. The html rendering can be changed by setting the macro parameter.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Render with | One of CSS or Tables. Controls how the macro is rendered for html output. |
Purpose
To highlight important text in a Keysight branding style compliant way.
LP Prototype Macro
Description
This macro is used to prototype new LP macros. It allows the owner of the post processing engine to prototype the macro in Confluence and test the post processing before the new macro is incorporated into this plugin.
Usage
To use the macro, insert the macro using the normal Confluence methods.
| Parameters | Description |
|---|---|
| Tag | The tag to use. The macro will bound the block with "LP_${Tag}START" and "LP${TAG}_STOP". |
Purpose
To prototype new LP macros.
LP Publish Keysight Only Macro
Description
This macro flags a block of text that should only be published to Keysight internal audiences.
Usage
To use the macro, insert the macro using the normal Confluence methods. There are no parameters to adjust.
Purpose
To flag content that should be limited to Keysight internal consumption.
LP Tip Macro
Description
This is similar to the Confluence Tip macro, but uses a Keysight branding compliant style to highlight text with a tip icon and a bounded in a box with a green background.
The macro can either render the graphic using CSS or with a raster image in a table. Exports to word or pdf will always use the raster image in the table while html defaults to css. The html rendering can be changed by setting the macro parameter.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Render with | One of CSS or Tables. Controls how the macro is rendered for html output. |
Purpose
To highlight important text in a Keysight branding style compliant way.
LP Warning Macro
Description
This is similar to the Confluence Warn macro, but uses a Keysight branding compliant style to highlight text with a warning icon and a bounded in a box with a red background.
The macro can either render the graphic using CSS or with a raster image in a table. Exports to word or pdf will always use the raster image in the table while html defaults to css. The html rendering can be changed by setting the macro parameter.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Render with | One of CSS or Tables. Controls how the macro is rendered for html output. |
Purpose
To highlight important text in a Keysight branding style compliant way.
Updated