Embedded References

#Embedded references are a shorthand method for inserting links to records, such as blog posts, individuals, sources and media images, into other blog posts, notes, sources, <Media> or <Gallery> fields. Since the links and displayed text are determined at tree creation time, they will always be correct.

Syntax:

{ref:id[#item][@description]}. In all cases, the "id" refers to the record id.

Blog Posts:

Referencing a blog post will display the post's title by default. The "description" can be used to provide alternate link text, and the "item" can be used to provide a link to a named anchor in the post's content. For instance, {ref:POST1#footnotes@"Footnotes"} can be used to provide a link to the footnotes section at the bottom of a blog post. When providing a reference to another post, a link to that post will be added to the other post's Related Posts section at the bottom of the page.

Examples:

This ( {ref:dna} ) is a link to the post <DNA>.

This ( {ref:references#related@Related Posts} ) is a link to the Related Posts at the bottom of this page.

Individuals:

Similarly, when referencing an individual's record id, their name will be displayed by default. The "description" can be used to provide alternate link text, and the "item" can be used to provide a link to a named anchor in the person's profile page. For instance, {ref:I100#sources@"Bob's sources"} can be used to provide a link to the sources section. (There are no individuals in this blog, so I cannot provide an example.)

Sources:

For sources, the source title is displayed by default and the "item" refers to the referenced page number. Specifying {ref:SOURCE1#23@Bob's obituary} would provide a link to the source and embed the page number in the citation. The <SourceTemplates> option can be used to provide detailed source citations and formatted footnotes. When the source is displayed as a footnote, the first citation will use the <Footnote> template. Subsequent references to that same source will use the <ShortFootnote> template, unless the source reference follows immediately in which it will use the <IbidFootnote> template. The tooltip that appears when you hover your mouse over the footnote number uses the <FullCitation> template. Default templates are built into Gigatrees, so users are not required to setup their own source citation templates.

Examples:

For these examples, the sources were defined as shown here.

This ( {ref:S1} ) is a reference to the 1850 United States Census: Ohio, Hamilton, Anderson [1].

This ( {ref:S1#233B} ) is a reference to the 1850 United States Census: Ohio, Hamilton, Anderson (p. 233B) [2].

This ( {ref:S1#233B@same source} ) is a reference to the same source [3] and page.

This ( {ref:S1#234B@same source} ) is a reference to the same source [4], but references a different page number.

This ( {ref:S2#1@diferent source} ) is a reference to a different source [5].

This ( {ref:S1#234B@same source} ) is a reference to the first source [6] again.

Media Images:

For references to media images, the image is shown by default without a caption. The "description" can be used to provide a caption. The "item" can also be used to alter the default behavior, and may contain multiple parameters delimited by periods. The item can be set to title, caption or credit to use any of the field defined by the <Media> or <Gallery> options. If not otherwise specified, the medium image will be displayed. You can use the item field to specify an alternate image using large or small. You can also use the item field to specify an alternate width for the media image using wXXX. Also by default, the image is left-aligned. You can use the item field to specify an alternate alignment using center, floatleft or floatright. Lastly, by default, the image is hyperlinked to the largest media size defined. You can use the nolink option to prevent this behavior. Since multiple item fields will often be necessary, the items should be delimited by periods as in {ref:M1#large.w400.center.title.credit}.

Example:

This ( {ref:M1#large.w400.center.title.credit} ) is a reference to a media image. Click on the image to enlarge.

Text Footnotes:

You can also add text footnotes by leaving off the "id" and providing a "description" only in the form of {ref:@description}}. The footnote will be added to the footnotes section at the bottom of the post. The footnote will be bi-directionally linked.

Example:

This ( {ref:@This is a text footnote} ) is a footnote [ 7 ].

Help:

An additional feature is to use embedded references to provide help text in the form of {ref:?description}. In this case the "description" is the help text. A footnote will not be created, and the footnote link will display a question mark.

Example:

This ( {ref:?Consider yourself helped.} ) is help text [ ? ].