Embed Link
When readers click on an embed link a new card loads at the position of the link, i.e. directly inside the current card. That means, embed links are like normal links but with a special loading behavior.
Create an embed link
Embed links are written like normal links, but with an additional building block. This block contains a special keyword: embed.
When you click an embed link, the target card does not replace the current one. Rather, the target card gets displayed inside the current card at the position of the link.
Imagine embed links as a supplement to the current card. They are meant for additional or belated content. Consequently, they do not replace the old card or disable other links.
The embed keyword only works as the third building block on a link. You must write your link with separate blocks for linktext and linktarget.
Workflow tip: Instead of the keyword embed you can use the shorthand e.
Sticky embed links
When readers click on an embed link the link disappears. If you want the link's text to remain visible after clicking, you can add a special keyword: sticky.
Practice tip: Click the first embed link in the example above, then the second. Afterwards, hit reset and go again. But this time click the second link before the first. See what happened?
Workflow tip: Instead of the keyword sticky you can use the shorthand s. Just like the keywords, their shorthands must be separated with a comma: e,s.
Practice tip: If :SWITCH: and :CHECK: are new to you, read up on switch lines and how to check a switch.
Embed links inside paragraphs
Like normal links embed links can occur inside a paragraph. If they do, their target card gets embedded below that paragraph.
The rule of thumb is that an embedded card gets loaded directly below its embed link. In this example that means below the paragraph with the embed link.
This creates a situation where the order in which the links are clicked affects the order of paragraphs in the resulting text.
Embed link shorthands
You can also create embed links with the :EMBED: tag or the short tag :E:. These links do not need the embed keyword.
Here's an example with a variety of embed links:
Practice tip: The double pipes || are a valid tag for writing links. Make sure you have a firm grasp of simple links to get the most out of interactions in Hypstory.