Linking Guide

There are some basics you need to learn to use linking. There are many options. You can link to another item within the current current checklist, you can link to another external checklist continuing where it’s last progress was at, and you can deep-link to another item in an external checklist directly to a specific item. You can also decide to go to the item without returning, or providing a way to Go Back to where you jumped from.

Getting Started - Setting an ID

The first thing to do is for any Items, Sections, Lists or Checklists you want to link to, to set a unique ID on it. You do this is in the Advanced panel in the editor. Below is the Advanced panel for an Item.

label_picture.png

In the ID field you would define a unique ID. Make sure this is unique ID within the checklist, and if setting an ID for a Checklist, make sure it is unique across all of your checklists. Do not put spaces in the ID. Use dashes or underscores for spaces or use camelCase (e.g. id-with-dashes, id_with_underscores, idWithCamelCase). Although not necessary, choose one style and be consistent with it.

Linking Name Differences

Once you have your ID’s defined, you can now have other items link to them.

In the Link ID fields for where you are linking from there is syntax you use for the different options.

Link to item within checklist: #item-id
Link to external checklist: checklist-id
Deep-link to external checklist and item: checklist-id;#item-id

Linking within the Checklist

The primary way to use linking is to link to other items within the checklist on a certain action.

Let's use the Yes / No item type as an example. You can link to a certain item when the user presses yes, and a different item when the user presses no. First, make sure there are ID's on both of the places you want to link to. In this case, we have a Yes / No item asking "Do you want to see a cool picture?" The two items we will be linking to both have been given ID's (see above on how to do that). The first ID is coolPicture and the second is noPicture.

Now that the setup is complete, we need to assign the targets for the Yes button and No buttons. In the Yes/No item, scroll down to the dropdown titled Link. There you will see several options.

Start by checking the Link on Select box. This will ensure that when the user presses Yes or No it will link to the correct target. For more information regarding the Yes/No item click here.

The link option dropdown contains options for the actions. There is more information for each one below, but for this example we will leave it as Goto, which simply navigates to the item with the ID we specify.

Now in the Yes Link ID box, we will put a hashtag followed by our ID for the picture item, #coolPicture. As mentioned above, to link to an ID you must put the # in front of the ID. Do the same with the No Link ID box, we will input #noPicture.


Now, whenever we press Yes it will take us to the picture, and when we press No it will take us to the no picture item. Try it out to the right!


Linking Demo

Linking to an External Checklist

To link to another checklist, make sure to add an ID to the checklist node in the tree you want to link to.

label_photo.png

By linking to external checklists, you can create very modular checklists and share them across other checklists. An example would be say that you fly multiple aircraft. For each of these you may have a preflight brief checklist that you would go through regardless of aircraft. You can create that as its own checklist, and then each of the aircraft can link to it. To link to this checklist in the Link ID field you would put preflight-brief and it would open up the external checklist.

Typically if linking to an external checklist, you want to use the Goto and Return Link Action so that you can return from where you came from.


In-Line Linking

You can link using in-line commands as well. A list of them can be found below in the command reference. Start off by adding an ID to the item or checklist you want to link to. See above for how to do this

Then, in the Label section of the item, we type the following:
Click [Here](goto:#item3) to advance to item 3

This format is how Ambifi interprets links. In order to have any inline link like this, use the following format:
[Text you want to display](command)
The full list of commands to link with is shown below.


Inline Linking Demo

Linking Command Reference

There are many commands that can be used for linking. Here is the Linking Command Reference.

Goto

The Goto command is the simplest form of linking. It simply navigates to the item specified.

  • Dropdown name: Goto
  • Inline Command: goto:

Goto Unchecked

The Goto Unchecked command goes to the specified item and unchecks it, so if it has been checked before, it will now be unchecked.

  • Dropdown name: Goto Unchecked
  • Inline Command: gotoUnchecked:

Goto (New Session)

This command only works when linking to an external checklist. This will link to the new checklist with a new session, essentially restarting it.

  • Dropdown name: Goto (New Session)
  • Inline Command: newSessionAndGoto:

Goto (Reset Items in Range

This command not only navigates to the specified item, but resets all the items it skips over to do so. An example is to the right. Check down to compressions and it will restart if the user says No.

  • Dropdown name: Goto (Reset Items in Range)
  • Inline Command: resetRangeAndGoto:


Reset Items Example

Goto (Check Items in Range)

This command checks off all items that are between the current item and the item that is being linked to.

  • Dropdown name: Goto (Check Items in Range)
  • Inline Command: checkRangeAndGoto:

Goto and Return

This command navigates to a new item or checklist and shows a button on top to allow the user to go back to where they came from.

  • Dropdown name: Goto and Return
  • Inline Command: gotoAndReturn:

Contact
Contact

Need help or have questions?
support@ambifi.com

Want to learn more? Let's get in touch!
+1 (800) 290-6515 sales@ambifi.com