Inserting a symbol to show required key presses?

Nicholas DeMarco July 7, 2020

Some documentation clearly shows what keys are required to perform a task. The Atom Flight Manual (for the Atom editor) is one example.

 

On this page, the manual tells you to press ctrl + left to move left one word. The keypresses (ctrl + left) are clearly shown in a shadowed box.

I've looked at the CSS to make this happen. Before I start cobbling something together on my own, is there a macro or other add-in to do something like this?

Yes, I have searched for keypress, keystroke. Most searches return results on how to assign macros to keystrokes.

5 answers

0 votes
dellagustin_sap
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
July 30, 2024

I could not find a way to style keypress / keyboard keystrokes natively, so I created an issue suggesting this feature: https://jira.atlassian.com/browse/CONFSERVER-97031

Please vote it up if you think this is relevant.

As a workaround, one can use monospaced text and adjust it by changing the CSS style. For instance, I tested it with the CSS Stylesheet macro (3rd party plugin) and the following CSS style:

 

code {
 background-color: lightgrey;
    padding: 2px 8px;
    border-radius: 6px;
}
0 votes
Nicholas DeMarco July 7, 2020

I suspected that might be the case. I'll add creating the macro to Jira. ;-)

0 votes
Joshua Sneed Contegix
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
July 7, 2020

Hi Nicholas,

I do not believe there is any out of the box options that suit that need. There may be a plugin with similar functionality, but I was not able to find one in the marketplace. I do know that creating a page from a template allows for instructional text, but it does not persist if edited. You may want to consider creating a macro with this functionality. Cheers!

0 votes
Nicholas DeMarco July 7, 2020

Hi Joshua, I'm supplementing my original question to make this more clear.

 

As a page editor, and within a confluence page (e.g. the Atom Flight Manual cited above), I should be able to clearly direct the page's reader to press a key sequence to perform some function (e.g. "press [Ctrl] + [Alt] + [Del]" to initiate self-destruct).

Is there a macro or other suggested way to show a nicer representation of the key?

0 votes
Joshua Sneed Contegix
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
July 7, 2020

Hi Nicholas,

It sounds like you're looking for Confluence's Keyboard Shortcuts. Cheers!

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events