V1 Docs: Add ref Shortcode Instructions

[Erin-Cecele]

Before proceeding, check to make sure there isn’t an existing issue for your suggestion or a similar one.

• I have searched the existing issues and determined this is new suggestion.

Idea being proposed

The ref shortcode information to the documentation. The ref shortcode provides a shorthand for linking to a figure or figure state from a markdown template.

What contribution category does your proposal fall under?

Propose/write new section

Supporting Information

No response

[Erin-Cecele]

Helpful information for For Developers section and documentation for new section dedicated to ref shortcode:

parameter	type	description	example
anno	String (optional)	Comma-separated list of annotation ids	{% ref fig=”fig-1” anno=”anno-2” text=”Figure 1” %}
fig	String (required)	Figure id from figures.yaml	{% ref fig=”fig-1” text=”Figure 1” %}
onscroll	Boolean (optional)	Whether the ref should trigger the figure state to change on a scroll interaction. Defaults to false.	{% ref fig=”fig-1” onscroll=”true” text=”Figure 1” %}
region	String (optional)	Comma-separated with format x,y,w,h	{% ref fig=”fig-1” region=”100,200,500,600” text=”Figure 1” %}
transition	Number (optional)	The time delay in ms between slides when linking to a specific image in a sequence. A value of 0 will have no transition.	{% ref fig=”fig-1” start=”003” transition=”10” text=”Figure 1” %}
start	String (optional)	A specific image in a sequence	{% ref fig=”fig-1” start=”003” text=”Figure 1” text=”Figure 1” %}
text	String (required)	The ref text. If onscroll is true, this is inline plain text, otherwise it is a link. Supports inline markdown.	{% ref fig=”fig-1” text=”Figure 1” %}

[Erin-Cecele]

This is related to issue #825 and issue #886