Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

Next challenges

Recent achievements

  • Global
  • Personal

Recognition

  • Give kudos
  • Received
  • Given

Leaderboard

  • Global

Trophy case

Kudos (beta program)

Kudos logo

You've been invited into the Kudos (beta program) private group. Chat with others in the program, or give feedback to Atlassian.

View group

It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Providing context-sensitive help using Confluence knowledge base

Will we be able to a add link into our software application so that a user can click through to the relevant page of our Confluence knowledge base for context-sensitive help? Can we do this using just Confluence, or do we require a plug-in? 

thank you.

3 answers

2 accepted

1 vote
Answer accepted

Hello Caroline,

I was searching for an answer to this myself, and I wanted to let you know about what I found.

  1. I found an old post by Sarah Maddox: Confluence 4.0 Context Sensitive Online Help Mapping.

    According to Sarah, in Confluence Server, there is a built-in file called help-paths.properties. This file is located in your WEB-INF/lib folder.

    You will need to find confluence-X.XX.X.jar file (according to your version). From here, copy it, extract it, and you will find the help-paths.properties file. For more information on editing JAR files in Confluence, see How to edit files in Confluence JAR files.

  2. Of course, the mapping isn't necessary to perform the context-sensitive help. You can also just use labels and some of the suggestions that are mentioned here: Is there a possibility of creating context-sensitive help from Confluence?

  3. I also discovered the following add-on here: Scroll CHM Exporter
    This add-on is not available for Confluence Cloud.

Lastly, the following 2 articles:

I just wanted to pass on any information I had, so I hope this can help you.

Regards,

Shannon

Thanks Shannon.

1 vote
Answer accepted

Hey @Caroline Eddy and @[deleted]

 

I love all the writing from Sarah Maddox on the subject, she's such an amazing thinker and nice person.

I figured I'd chime in with a few additional suggestions to the great resources @Shannon Spaniol already shared.

You could display your Confluence knowledge base space(s) as an online help center using Scroll Viewport and then set up some direct links to your apps.

To make the context sensitive help even more valuable to your users, you could use Scroll Versions to create variants of content for different use cases/variations of your app.

This way, your users would click a help link in your app and be taken to a branded help site with meaningful content for their specific use case.

 

Let me know if that doesn't make sense. I feel like the explaining part of my brain may be running out of ☕️.

Thanks Matt, I think Scroll Viewport will work for what we are wanting to do.

Like Matt Reiner _K15t_ likes this

That's great! I'd recommend you try out the app after Monday.

Got a pretty big release hitting then. 🙂

Let me know if you need a hand with anything.

0 votes
Deleted user Jun 04, 2019

Dear Confluence staff, 

 

I have the same question. 

 

Thank you.

Lynn

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Posted in Confluence

What do you think is the most *delightful* Confluence feature? Comment for a prize!

- Create your own custom emoji 🔥 - "Shake for Feedback" on mobile 📱 - An endless supply of GIFs via GIPHY 🤩 Is there anything quite as nice as a pleasant surprise? Comment below with what...

415 views 23 8
Join discussion

Community Events

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

Find an event

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

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you