Add "target" and "rel" parameters to figure shortcode

Also:

- Remove unnecessary space from `figure` tag if no class is specified.
  - Update related tests.
- Add test cases for the changes made to the figure shortcode.
- Document the newly added target and rel parameters
- Add more detail to the documentation of all figure shortcode parameters.
This commit is contained in:
Kaushal Modi 2018-02-05 14:06:29 -05:00 committed by Bjørn Erik Pedersen
parent 00539094ec
commit 09728efbfd
2 changed files with 36 additions and 10 deletions

View File

@ -80,15 +80,41 @@ Hugo ships with a set of predefined shortcodes that represent very common usage.
The `figure` shortcode can use the following named parameters: The `figure` shortcode can use the following named parameters:
* `src` src
* `link` : URL of the image to be displayed.
* `title`
* `caption` link
* `class` : If the image needs to be hyperlinked, URL of the destination.
* `attr` (i.e., attribution)
* `attrlink` target
* `alt` : Optional `target` attribute for the URL if `link` parameter is set.
* `width`
rel
: Optional `rel` attribute for the URL if `link` parameter is set.
alt
: Alternate text for the image if the image cannot be displayed.
title
: Image title.
caption
: Image caption.
class
: `class` attribute of the HTML `figure` tag.
height
: `height` attribute of the image.
width
: `width` attribute of the image.
attr
: Image attribution text.
attrlink
: If the attribution text needs to be hyperlinked, URL of the destination.
#### Example `figure` Input #### Example `figure` Input

View File

@ -218,7 +218,7 @@ You have created the shortcode at `/layouts/shortcodes/img.html`, which loads th
Would be rendered as: Would be rendered as:
{{< code file="img-output.html" copy="false" >}} {{< code file="img-output.html" copy="false" >}}
<figure > <figure>
<img src="/media/spf13.jpg" /> <img src="/media/spf13.jpg" />
<figcaption> <figcaption>
<h4>Steve Francia</h4> <h4>Steve Francia</h4>