How do I add a text "hint" in Confluence Edit

When I am in Edit mode of a Confluence page, there are places where I want to display a "hint" as to what should be entered at a particular location

An example of this is the Task list macro where it gives some useful instruction for when you are creating the tasks.

How do I create that "hint" text (that hint text doesn't appear in the normal viewing mode of the page)

3 answers

There are at a few ways I can think of:

  1. Write a user macro that doesn't display anything when rendered
  2. Use the htmlcomment macro found in Adaptavist's Content Formatting Macros
  3. Use the Hide macro from Run Self-Service Reports for Confluence

To replicate the Instructional text used in templates, use the Confluence Source Editor add-on to add a placeholder:

<ac:placeholder>This is an example of instruction text that will get replaced when a user selects the text and begins typing.</ac:placeholder>

While not straight forward, it's actually pretty easy to do.

  1. Open a template in EDIT mode
  2. Change the text for one of the Instructional Text blocks to what you want on your existing page (or create a new one)
  3. Select and copy the text
  4. Paste it where you want it in your Confluence page
  5. Cancel the editing of the template


Hope that helps!

Suggest an answer

Log in or Sign up to answer
Community showcase
Posted Oct 24, 2018 in Confluence

Atlassian Research opportunity with Confluence templates

Do you use templates with Confluence? Take part in a remote 1-hr workshop. You'll receive USD $100 for your time!   We're looking for people to participate in a   remote 1-hr workshop...

1,566 views 26 14
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you