Wiki
Clone wikiKeysight Plugins For Atlassian Products / Confluence Plugins / Keysight Theme Plugin
Introduction
The Keysight Theme plugin contains a Confluence theme with the Keysight logo and colors. While it is not expected the general public will find a Keysight theme useful, there are some bundled features that may be useful. As the source code for this plugin is also available under an Apache 2 license, it can also be used as a reference for others wishing to create a custom theme for their site.
Features at a Glance
Features in Detail
Keysight Theme
Description
The Keysight Theme changes the basic colors to align with the corporate colors. It also places a custom header above the toolbar and a custom footer with some of the legal verbage required for Keysight owned content. In order to change the colors the theme adjusts the Confluence Color Scheme, overrides the request for various icon images and overrides some of the Confluence CSS. Because of these secondary overrides, it makes it difficult to use anything but one of the three Keysight themes for all of the spaces. If installed and the Keysight theme modules are not being used, the Confluence Administrator should also disable the Keysight Theme and Image Redirect Filter modules to prevent the image and css overrides from being active.
Usage
Select the Keysight Theme in the Themes page of the Confluence Administration Section of in the Look and Feel part of the Space Tools.
Purpose
To provide the Keysight Look and Feel for an instance of Confluence
Keysight Color Theme
Description
The Keysight Color Theme just provides a Keysight color palette as a custom color set in Confluence. It does not add the custom header, footer that the full Keysight Theme provides.
Usage
Select the Keysight Color Theme in the Themes page of the Confluence Administration Section of in the Look and Feel part of the Space Tools.
Purpose
This is provided more as an example of how to deploy a custom color set via a plugin.
Keysight Footer Theme
Description
The Keysight Footer Theme is identical to the Keysight Theme with the exception of the Keysight Header which is not provided.
Usage
Select the Keysight Footer Theme in the Themes page of the Confluence Administration Section of in the Look and Feel part of the Space Tools.
Purpose
This was developed for teams that were unwilling to sacrifice the top part of the page to Keysight branding requirements.
Keysight Space Blueprint
Description
The primary function of the Keysight Space Blueprint was to setup spaces with the proper permissions. In addition to the Space Name and Space Key required for a blank space, the Keysight Space Blueprint requests the Space Labels, Group Key, Administrators, Anonymous Access and the Space Description. All of these additional fields are optional. The terms in the Space Labels field will be applied as Space Categories. The Group Key is predicated on the convention of having groups of the form "TEAM-CONFL-2-group-key-ADMIN", "TEAM-CONFL-2-foobar-AUTHORS" and "TEAM-CONFL-2-foobar-USERS". The Group Key is the foobar part of the name. When the space is created, full permissions are given to "TEAM-CONFL-2-foobar-ADMIN", read/write access is given to "TEAM-CONFL-2-foobar-AUTHORS" and if anonymous access is not allowed, read access is given to "TEAM-CONFL-2-foobar-USERS". All users listed in the Administrators list will be given full permissions as well as send an email notification about the space creation. If Anonymous Access is allowed, the user named Anonymous will be given read access and the group ORG-ALL-KEYSIGHT will be given permissions to view, delete own content and comment. Any content in the Space Description** will placed into the description of the space.
Usage
Click on the Spaces dropdown in the Confluence navbar, select Create Space and select the Keysight Space Blueprint. Then fill out the form as requested and press Create.
Purpose
Within Keysight, we gave access to all employees to create spaces. A module in the Keysight Admin Tools for Confluence plugin, there is a module to notify the administrators when a space has been created, by whom and what settings were used allowing the admins the ability to step in and correct inappropriate or duplicate spaces. This blueprint was primarily created to help users get the right permissions setup for the space. This was especially important for users that wanted to allow anonymous access to the space as it's not intuitive that you need to grant access to both the user Anonymous and the group that represents all logged in users.
Page State
Description
The Page State is a simplistic attempt to label the state of pages and provide a trustworthy mechanism to identify pages in a space that are unfinished, incomplete or have errors. The page state control is built into the Keysight Theme is a dropdown widget to the right of the page title that will try to enforce that one and only one label from the set of note, draft, reviewed, finalized, has-errors, incomplete and deprecated. The widget is only activated if the space has the space category of documentation or the page has the label documentation.
Once pages have labels, the space administrator can use the content by label macro to create a summary page identifying which pages in the space need attention.
| Page States | Description |
|---|---|
| Note | A page that has no state such as meeting notes or an automatically generated index page |
| Draft | Initial page state implying that content is still be authored |
| Reviewed | Secondary page state implying that content has been reviewed but the reviewers comments have not yet been incorporated |
| Finalized | Final page state implying that the content is ready for public consumption |
| Has Errors | Used to flag pages that have problems |
| Incomplete | Used to flag pages that are incomlete |
| Deprecated | Used to flag pages that are deprecated |
Usage
When the Page State widget is active, select the appropriate state in the dropdown. To activate the Page State widget for a page, add the term documentation as a label. To activate it for the space, add the term as a space category. Built into the keysight theme is also a "..." menu pick to activate or deactivate the page state widget for the page. The menu pick will not be visible if the Page State widget has been activated for the space by applying the term documentation as a space category.
Purpose
The page state widget is trying to classify every page in a space to help the content owners have confidence in the qualify of the content.
Contact Space Admins Menu Item
Description
A "..." page menu item to bring up a dialog box that when closed will send a message to the space admins.
Usage
Select Contact Space Admins from the "..." page menu, fill out the form and press Send.
Purpose
This was to provide a simple way for users to send a message to the space administrators.
Update Descendant Page Labels Menu Item
Description
A "..." page menu item to bring up a dialog box that can be used to add or remove labels to the current page and all descendants.
Usage
Select Update Descendant Labels from the "..." page menu, provide one or more labels and select Remove Labels or Add Labels.
Purpose
This was to provide a simple way for users to add labels to a branch of the page tree.
API Documentation Macro
Description
This is a macro to interact with a custom website that hosts Doxygen and Sandcastle documentation. As such, it is really of no value outside of Keysight except as an example. The macro sends a regular expression to the remote service which returns a list of matching items each with a nested tree of versions and urls. The macro then renders an interactive indented list. The main idea is to place the macro on a page and it will get the current list of documentation sets by version and display them on the page.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Application Name | The name or a pattern of the applications to include. |
| Show Collapsed | If checked, the indented list will initially show in a collapsed form. |
| Hide Application Name | If checked and only one application is identified on the remote service, the then application name will be hidden. One the versions will be displayed. |
Purpose
We received a number of requests to include Doxygen or Sandcastle information into Confluence. After talking with the end users, the primary reason for the request was to avoid the headache associated with standing up a webserver, dealing with unix/windows file transfers, dealing with the permissions, dealing with the maintenance of the webserver etc. If they could just upload the zip file to Confluence and have it show up, they were done. While there are some commercial Confluence plugins that do this, it was deemed a lot of risky overhead for not much gain. Our solution was to create a very simple webservice that allowed people to upload a zip file and the server would drop it onto the file system, unzip it and host it through apache. This macro was used so that people could easily reference the documentation uploaded to that server. If this is something you would like to explore implementing, feel free to contact us at pdl-atlassian-plugin-development.
Contact Form Macro
Description
This macro places some text that when clicked brings up a dialog box where a use can send an email to a predefined contact person.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Form Identifier | Some arbitrary text that is prepended to the email subject to identify which form the email came from. |
| Contact Person | The person who will receive the email |
| CC the senders email address | If checked and the sender provides an email address, they will receive a copy of the email. |
| Template | One of Keysight Ask, Link, Link - ID Required. The Keysight Ask places a graphic the Keysight has been trained to see as link to sending anonymous feedback to managers. The Link will put up a form, but not require the user to identify themselves. The Link - ID Required will require the user to identify themselves. |
| Dialog Box Title | The text to put in the header of the dialog box. |
| Dialog Box Help | The text printed in the lower left corner of the dialog box. |
Purpose
Within Keysight, the standard department page contained a graphical element that when clicked would allow somebody to send anonymous feedback to the department manager. This macro was written to allow department websites to be migrated into Confluence.
Keysight Product Lifecycle Checkpoint Macro
Description
This macro inserts the graphical icons use to identify project checkpoints within Keysight.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Checkpoint | One of the Keysight checkpoints |
| Icon Size | Large or Small |
Purpose
This was developed to help project manager communicate the state of the project with Confluence rather than Microsoft Powerpoint.
Navigation Box Macro
Description
A macro to create a box wrapping some content. This macro is modeled after the Confluence Panel macro and the BitVoodoo Panelbox macro. It only provides three color styles to provide some flexibility to the authors, but not total freedom so there is some consistency of look across Confluence.
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| Style | One of Keysight Dark Red, Keysight Gray and Keysight Dark Gray |
| Title | Text to put in the header of the navigation box. If none is supplied, no header will be placed in the box. |
| Title Link Destination | The page or url the title should link to. |
An alias for this macro exists that can be activated called panelbox. This was used to replace instances of the BitVoodoo Panelbox plugin.
Purpose
This was developed to give a consistent look for authors creating lists of links often used for navigation or calling out special information. A common practice is to place a navigation box inside of an HTML Block or section with a Layout Width macro (both are in the HTML Elements plugin) to provide a graphical element to highlight text.
Status Flag Macro
Description
This macro is a simplified version of the Confluence status macro. It allows the user to choose the icon representing the status and the color. The author cannot change the text (and often there is no text). Like the Confluence status macro, the author can change the color from a quick popup menu rather than having to open up the macro properties editor.
The colors are roughly interpreted as follows:
| Color | Meaning |
|---|---|
| Gray | Before project is launched |
| Green | On Track |
| Yellow | On Track, but an alert that it may fall off track soon |
| Red | Off Track |
| Blue | Paused |
Usage
To use the macro, insert the macro using the normal Confluence methods, then adjust the parameters as needed.
| Parameters | Description |
|---|---|
| State | One of Gray, Green, Yellow, Red or Blue |
| Style | One of Large Flag, Medium Flag, Small Flag, Rounded Rectangle or On-Track |
Purpose
This macro was developed as a simpler, faster and more constrained and therefore more consistent means of communicating project state.
Updated