How to add a link to another article, heading, chapter or manual

Updated Dec 18, 2019

This article will show you how to add a link to an existing article, heading within an article, manual or chapter in your site. The advantage of using this method to add links in your articles is that no matter where you move your articles in your site, ScreenSteps will maintain the link. This prevents your links from breaking if you ever reorganize your site.

Are you using the web or desktop editor?

Highlight text

To link to a heading in the current article select the Heading option. To link to a different article in your knowledge base select the Knowledge Base option.

Link menu

If you are linking to a heading within the same article then select the heading from the list that appears.

If you are linking to a manual, chapter, article, or heading in another article then click on the titles (1) in the knowledge base browser until you find the resources you want to link to. Click the Link button (2), specify behavior when opening the link (3 optional), and then the Done button (4) to create the link.

The inline option will not work for articles that are published to Zendesk.

KB link dialog
Highlight text

To link to a heading in the current article select a heading from Heading Link menu. To link to a different article in your knowledge base select the Knowledge Base Link option.

Link menu

If you are linking to a heading within the same article then select the heading from the list that appears.

If you are linking to a manual, chapter, article, or heading in another article then click on the titles (1) in the knowledge base browser until you find the resources you want to link to. Click the Link button (2), specify behavior when opening the link (3 optional), and then the Link button (4) to create the link.

The inline option will not work for articles that are published to Zendesk.

KB Link dialog
Congratulations, you are done!

10 Comments

reinaldo gregori

What if the article I want to link to does not yet exist? It happens quite frequently to me that while I am writing an article I need to refer to articles or chapters that I haven´t yet written. It would be very helpful if I could "create" these other articles (not their contents, just their names) so I could write them later without having to interrupt the article being written. Is there a way to do that?

Trevor DeVore

@reinaldo - there is not a way to do that at this time.

Julia

Has the functionality to link to an article which hasn't yet been written while writing another article been added to the software as yet? If not, this would be extremely useful in the future.

Trevor DeVore

@Julia - No, it is not possible to create an article from the link dialog.

Cayenne

It also looks like no anchor links will work until/unless the thing is published to zendesk. Then, if it's not ready, have to go and hide it right away, then the links will work.
Does this sound correct? If there's another way, that would be really helpful.
The link changes once it's 'published' so no way to get that without publishing.

Trevor DeVore

@Cayenne - yes, that is correct. ScreenSteps can't generate a link if the article doesn't exist on Zendesk. Otherwise there is no URL to insert into the link. We don't have a way to automatically go back and republish articles with links to an article you just published.

Jeff Jacobson

Is it possible for the links to in referred articles to link to another referred article in the same manual? We have a master "All Products" Manual with articles for features that are shared across products, then inside individual product manuals we add those existing articles by reference (so they can always be updated). However, if we link to another article in that master "all products" article, the link in the referred article still points back to the "all products" link.

Trevor DeVore

@jeff - Can you send your question to support@screensteps.com and provide links that demonstrate the problem you are seeing?

Matthew Eade

Is it possible to link to a chapter in another article?

Trevor DeVore

@Matthew - ScreenSteps does not provide a way to link a chapter title to another article. If you email support@screensteps.com and explain your use case we may be able to provide some additional guidance.

Add your comment

E-Mail me when someone replies to this comment
Previous Article Create a foldable section
Next Article Create an Inline Link

Still Need Help?

Contact Us