URL References
URL references provide a shorthand method for adding links to images in your Media Gallery and to other pages. The links are determined at creation time, so they will always be correct. References can also be used to add footnotes and help text.
Syntax:
Footnotes:
Footnotes do not use the id or #item fields. To add a footnote, you need only provide a description, i.e. {ref:@description}. When adding a footnote, a footnote number will be automatically created and linked to the Footnotes section at the bottom of the page, which will in turn be linked to where the footnote occurs on the page. Hovering over the footnote number will also display the footnote. Let's try a couple
[
1
] of footnotes
[
2
]. This is the another footnote
[
3
]. Here is a longer one
[
4
]. Lastly, this footnote contains an auto-hyperlinked URL.
[
5
].
Help:
Help text is similar to footnotes, but uses a question mark to delimit the descriptior, i.e. {ref:?description}. Help text is also not added to or linked from the footnote section [
?
].
Pages:
When using references to link to other <Pages>, the page's title will be displayed in the link by default. This can be overriden by providing a description. To link to a named anchor on that page, use the item field.
Examples:
This ( {ref:start} ) is a link to the page Quick Start Guide.
This ( {ref:url-references#related@Related Pages} ) is a link to the Related Pages at the bottom of this page.
Media Images:
When using references to link to a <Media> image, BlüeBox's default behavior is to display the medium format image, linked to a large format image, without a caption. The description field can be used to provide a caption (When doing so, the %MediaImageAlternateDescription% placeholder should be used within page templates for accessing the value). The item field can be used to alter the default behavior. The item can be set to title, caption or credit to use any of those image properties as the caption. You can also use the item field to specify the displayed image format using large, medium, small or thumb (When doing so, the %MediaImageReference% placeholder should be used within page templates for accessing the value). Use gallery to display the image using the photo.mosaic plugin (all other item fields will be ignored). You can also use the item field to specify an alternate width for the media image using wXXX (When doing so, the %MediaImageWidth% placeholder should be used within page templates for accessing the value). Also by default, the image is left-aligned. You can use the item field to specify an alternate alignment using floatleft or floatright which will embedd the image in it surrounding text. The HTML <center> tag can be used to center an image. Lastly, you can use the nolink option to prevent this linking to an image. Since multiple item fields will often be necessary, the items should be delimited by periods as in {ref:M1#large.w400.title.credit}.
Examples:
This ( {ref:M1} ) is a reference to a media image displayed in medium format, left-aligned without a caption.
This ( <center><i>{ref:M1#large.w400.title.credit}</i></center>> ) is a reference to the same image in large format displaying both the title and credit fields and reducing its with to 400 pixels. It also uses HTML formatting to center the image and italicize the caption.
This ( {ref:M2#small.caption@} ) is a reference to a different image in small format, displaying the caption. In this case, the description field is empty, so it is ignored.
This ( {ref:M2#small.caption@Kowabunga Baby!} ) is the same reference, but the caption has been overriden by the new description.
This ( <center>{ref:M3#medium.title.caption}</center> ) is a reference to another image displaying all three fields and centered.
This ( <center>{ref:M3#medium.title.caption.w150}</center> ) is the same image displaying all three fields and centered and now at only 150 pixels.
This ( <center>{ref:M1#thumb@thumb} {ref:M2#thumb@thumb} {ref:M3#thumb@thumb}</center> ) displays the three images as thumbnails.
This ( {ref:M1#small.floatleft.w200@This is a new caption, that is wider then the image.} ) floats the image in the left inside content.
This ( {ref:M2#small.floatright} ) floats the image to the right content.
This ( {ref:M3#nolink.title} ) creates a reference that is not linked to a larger image.
This ( {ref:M17#nolink.small.w300.caption} ) is a reference to a media image containing a URL reference in its caption field.
Footnotes:
| [1] | Couple: meaning three |
| [2] | This is the second text footnote |
| [3] | This is the third text footnote |
| [4] | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean volutpat commodo felis, id molestie tellus dictum eu. Nunc et sem non libero pharetra ornare non a sapien. Donec id ultrices nunc. Sed nec odio vel tortor mattis cursus. Vivamus egestas, mauris a ultrices tempus, metus eros porttitor sapien, vel posuere risus metus eget diam. Nulla volutpat hendrerit faucibus. Vestibulum et dui sit amet lorem venenatis venenatis dignissim vitae dui. Nunc odio felis, faucibus id iaculis sit amet, iaculis vel lorem. Nam suscipit convallis fermentum. Proin euismod libero et eros suscipit ullamcorper. Vestibulum ac ipsum massa. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean volutpat commodo felis, id molestie tellus dictum eu. Nunc et sem non libero pharetra ornare non a sapien. Donec id ultrices nunc. Sed nec odio vel tortor mattis cursus. Vivamus egestas, mauris a ultrices tempus, metus eros porttitor sapien, vel posuere risus metus eget diam. Nulla volutpat hendrerit faucibus. Vestibulum et dui sit amet lorem venenatis venenatis dignissim vitae dui. Nunc odio felis, faucibus id iaculis sit amet, iaculis vel lorem. Nam suscipit convallis fermentum. Proin euismod libero et eros suscipit ullamcorper. Vestibulum ac ipsum massa. |
| [5] | Annales de Theokesberia, p. 112 (https://books.google.com/books?id=vPUUAAAAQAAJ&pg=pa112) |
