Online Help mapping with the application


Is there a step by step procedure on implementing online help. What are required mapping files and what needs to be done at the application side.



1 answer

Is your question: You are developing a desktop/web/mobile application that should link to pages in Confluence based on the context of the link?

If that's the case, then there's no built-in mechanism to handle this, nor is there any step-by-step set of instructions. You basically add links in your app to pages on your Confluence implemenation.

However, there are strategies you can employ to make sure this works well. One such strategy, that I use, is to use the web server front-end as a "map" of help links to Confluence pages (currently we do this with URLrewrite, but there are other ways). I replace the links in the app with "GO URLs", and map those GO URLs to actual pages in Confluence. That way, if the page name changes, or if we upgrade to a newer version and the version number in the path changes, I can update the links in once place and not require the app to be rebuilt.

Here's an example.

Our SDK installer includes a readme file that links to a page with additional installation information:

In the release notes, the URL is something like this:

When the page name changes (if it changes), or if we add version 2.0 (and subsequently change the 1.0 URL to /display/1.0/5.+Install..., then I can add a new GO URL for the older content and update it without changing the SDK.



Suggest an answer

Log in or Sign up to answer
Community showcase
Posted Feb 06, 2019 in Confluence

Try out the new editing experience

Hi team, I’m Avinoam, a product manager on Confluence Cloud, and today I’m really excited to let the Community know that all customers can now try out the new editing experience and see some of the ...

887 views 45 7
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