Project:HighslideGallery: Difference between revisions
(Created page with "Category:Test = HighslideGallery = This extension makes use of Highslide JS to create image galleries and youtube video links in the Wiki. Image galleries are enabled by s...") |
No edit summary |
||
| Line 1: | Line 1: | ||
= HighslideGallery = | = HighslideGallery = | ||
This extension makes use of Highslide JS to create image galleries and youtube video links in the Wiki. Image galleries are enabled by specifying syntax in the caption field of an image link. All images with Highslide enabled are displayed on the page as processed by MediaWiki, with the exception that clicking on the image will open a Highslide gallery instead of taking to the image informational page. Youtube video links are also supported with the wiki syntax <nowiki><hsyoutube></nowiki>, which will display a link to youtube that will open the video in Highslide. | This extension makes use of Highslide JS to create image galleries and youtube video links in the Wiki. Image galleries are enabled by specifying syntax in the caption field of an image link. All images with Highslide enabled are displayed on the page as processed by MediaWiki, with the exception that clicking on the image will open a Highslide gallery instead of taking to the image informational page. Youtube video links are also supported with the wiki syntax <nowiki><hsyoutube></nowiki>, which will display a link to youtube that will open the video in Highslide. | ||
| Line 6: | Line 5: | ||
== Highslide Syntax == | == Highslide Syntax == | ||
=== Image Galleries === | === Image Galleries === | ||
There are two ways to enable an image to be a part of a Highslide gallery. The simplest form is to add <code>highslide:</code> to the beginning of the caption field. This will open the image in a Highslide gallery when clicked in page, and will be the only image in its own gallery. | There are two ways to enable an image to be a part of a Highslide gallery. The simplest form is to add <code>highslide:</code> to the beginning of the caption field. This will open the image in a Highslide gallery when clicked in page, and will be the only image in its own gallery. To handle this, a custom gallery ID is used to keep the image separate from other Highslide galleries on the page. | ||
Examples: | Examples: | ||
| Line 13: | Line 12: | ||
<code><nowiki>[[File:image.png|200px|highslide:My recent image]]</nowiki></code> | <code><nowiki>[[File:image.png|200px|highslide:My recent image]]</nowiki></code> | ||
The second form is to add multiple images to the same gallery which allows a user to cycle through images. This requires a common gallery ID amongst all of the images which can be done by adding <code>highslide=ID:</code> to the beginning of the caption field. The ID must only contain letters and numbers. | |||
Examples: | Examples: | ||
| Line 21: | Line 20: | ||
<code><nowiki>[[File::image003.png|200px|left|highslide=50:My third image]]</nowiki></code> | <code><nowiki>[[File::image003.png|200px|left|highslide=50:My third image]]</nowiki></code> | ||
Adding additional, seperate galleries just requires a new gallery ID. | |||
=== YouTube Links === | |||
YouTube videos can also be added and displayed in their own Highslide gallery. Instead of displaying the embedded video player in the page, a link is created to the YouTube video which opens in a Highslide gallery when clicked. | |||
Syntax: | |||
<code><nowiki><hsyoutube title="Link text" autoplay>http://www.youtube.com/watch?v=aHjpOzsQ9YI</hsyoutube></nowiki></code> | |||
< | The URL to the YouTube video can be copied directly from the address bar in the browser. The two options <code>title</code> and <code>autoplay</code> are optional. If <code>title</code> is set, the text is used to generate the link on page. If this attribute is not specified, a default "YouTube Video" is displayed. If <code>autoplay</code> is defined, auto play for the video is enabled (default is disabled). | ||
This is an example sentence to show YouTube links in action. First, check out <hsyoutube title="Lindsey Stirling" autoplay>http://www.youtube.com/watch?v=aHjpOzsQ9YI&feature=relmfu</hsyoutube>. Once you are done spending hours following related videos, come back and check out this <hsyoutube>http://www.youtube.com/watch?v=O5gKcjm66qM&list=%2Fwatch%3Fv%3DO5gKcjm66qM&list=UU1CSCMwaDubQ4rcYCpX40Eg&index=0&feature=plcp</hsyoutube>. | |||
</ | |||
Revision as of 12:40, May 10, 2012
HighslideGallery[edit | edit source]
This extension makes use of Highslide JS to create image galleries and youtube video links in the Wiki. Image galleries are enabled by specifying syntax in the caption field of an image link. All images with Highslide enabled are displayed on the page as processed by MediaWiki, with the exception that clicking on the image will open a Highslide gallery instead of taking to the image informational page. Youtube video links are also supported with the wiki syntax <hsyoutube>, which will display a link to youtube that will open the video in Highslide.
For further information on syntax for images, refer to the MediaWiki Images documentation.
Highslide Syntax[edit | edit source]
Image Galleries[edit | edit source]
There are two ways to enable an image to be a part of a Highslide gallery. The simplest form is to add highslide: to the beginning of the caption field. This will open the image in a Highslide gallery when clicked in page, and will be the only image in its own gallery. To handle this, a custom gallery ID is used to keep the image separate from other Highslide galleries on the page.
Examples:
[[File:image.png|200px|highslide:]][[File:image.png|200px|highslide:My recent image]]
The second form is to add multiple images to the same gallery which allows a user to cycle through images. This requires a common gallery ID amongst all of the images which can be done by adding highslide=ID: to the beginning of the caption field. The ID must only contain letters and numbers.
Examples:
[[File::image001.png|200px|left|highslide=50:My first image]][[File::image002.png|200px|left|highslide=50:My second image]][[File::image003.png|200px|left|highslide=50:My third image]]
Adding additional, seperate galleries just requires a new gallery ID.
YouTube Links[edit | edit source]
YouTube videos can also be added and displayed in their own Highslide gallery. Instead of displaying the embedded video player in the page, a link is created to the YouTube video which opens in a Highslide gallery when clicked.
Syntax:
<hsyoutube title="Link text" autoplay>http://www.youtube.com/watch?v=aHjpOzsQ9YI</hsyoutube>
The URL to the YouTube video can be copied directly from the address bar in the browser. The two options title and autoplay are optional. If title is set, the text is used to generate the link on page. If this attribute is not specified, a default "YouTube Video" is displayed. If autoplay is defined, auto play for the video is enabled (default is disabled).
This is an example sentence to show YouTube links in action. First, check out Lindsey Stirling. Once you are done spending hours following related videos, come back and check out this YouTube Video.
