Linking pages from your site

Whether you’re in the content entry phase prior to your new Roam site launching or your site is already live, below is our best practice guide for adding URL links across the Roam platform.

There are a few ways you can create a link:

1. Formatting in Text component

Text component has a couple of options for linking to other pages/documents:

• Link icon

Using the link icon, you can link to a page entry within the platform by following the below steps: 

1. Highlight the word or phrase of text to hyperlink 
2. Click on the link icon shown in the screenshot above and click link to an entry
3. A window will open where you can pick the entry to use as the hyperlink. 
4. Save your entry! 

Please note: When linking to a document, use "Link to entry" and select "Link to an asset".

If linking to external websites, use the "Insert link" option.

• Button

1. Highlight the word you'd like to create a button of e.g. Learn more, Read our guide etc.

2. Select "Button" from formatting (see picture above)

3. To link the button, highlight the word again and use the link icon.

Please note: When linking to a document, use "Link to entry" and select "Link to an asset".

2. Link feature in component

In the example below, we're linking to the "See & Do" page within our Roam website as a button. 

You'll notice here the URL starts with "/see-do" instead of something like "https://www.mywebsite.com/see-do". This is because if you're linking within your own website, Roam will know your domain and automatically append it when a user clicks on it, saving valuable time and increasing speed.

The Link option is available only in Product, Pages and Tabbed Carousel components.

Important note for pre-launch content entry:

During your onboarding, Roam will provide a temporary environment for which you can upload and format all of your content. This will likely be on a temporary domain such as destination.roamhq.io. After launch, this domain will no longer exist and will move over to your destination’s URL.

When you’re linking to internal site pages or search URLs as a button it is important that you don’t reference your temporary address in a link. Eg. destination.roamhq.io/search as this link won’t work once live.

Remember to follow the same structure as the above screenshot. See some more examples below. 

• yourdestination.com.au/search - to link to a search page you would just copy /search
• yourdestination.com.au/see-do - to link to your see & do page you would just copy /see-do
• yourdestination.com.au/see-do/water-activities/water-rafting - to link to a water rafting page you would just copy /see-do/water-activities/water-rafting.
• yourdestination.com.au/products/the-MGC - you would only copy /products/the-MGC