Skip to content

Commit

Permalink
Grrr, GitHub flavoured markdown doesn't support DL
Browse files Browse the repository at this point in the history
  • Loading branch information
Bloke committed Oct 23, 2019
1 parent 4f493f2 commit b87fd62
Showing 1 changed file with 7 additions and 18 deletions.
25 changes: 7 additions & 18 deletions README.textile
Original file line number Diff line number Diff line change
Expand Up @@ -136,24 +136,13 @@ bc. <txp:smd_thumbnail />

h4. Attributes (in addition to standard txp:thumbnail tag attributes)

; @add_stamp="boolean"@
: Adds the image file modification time to the end of the thumbnail's URL. Use @add_stamp="1"@ to switch this feature on. This helps prevent stale images, but may prevent browsers from cacheing the thumbnails properly, thus increasing bandwidth usage.
: Default: @0@.
; @class="class name"@
: HTML @class@ to apply to the @wraptag@ and/or @<img>@ attribute value. If omitted, the name of the profile will be used as a @class@ name for the @<img>@ tag. If you specify a @wraptag@ and omit the @class@, the profile name will be used as a @class@ on both the container and the @<img>@ tag.
; @display="value"@
: By default, this tag outputs a full @<img>@ tag. If you just require the image URL so you can make your own image tags, set @display="url"@.
: Default: @thumbnail@.
; @force_size="value"@
: Usually when you set one or other width/height to @0@ in a profile, the browser scales the missing dimension automatically. It does this by omitting the @width=@ or @height=@ attribute in the @img@ tag. This may cause visual artefacts as the page is rendered and the browser calculates the sizes. If you wish the plugin to add the actual dimension to the @<img>@ tag (the size at the time the thumbnail was created), tell the plugin with this attribute. Choose one or both of @width@ or @height@. Comma-separate as required.
: Default: unset.
; @form="form name"@
: You can construct your own @<img>@ tags using the given form. If not specified, you may use the tag as a container.
; @type="value"@
: Use this attribute to display thumbnails of the given profile name (e.g., @type="large"@). If you do not specify this attribute, the default profile will be used. If there is no default profile you'll see warning messages.
; @quiet="boolean"@
: Use quiet="1" to suppress warnings about missing images.
: Default: @0@.
* @add_stamp="boolean"@ Adds the image file modification time to the end of the thumbnail's URL. Use @add_stamp="1"@ to switch this feature on. This helps prevent stale images, but may prevent browsers from cacheing the thumbnails properly, thus increasing bandwidth usage. Default: @0@.
* @class="class name"@ HTML @class@ to apply to the @wraptag@ and/or @<img>@ attribute value. If omitted, the name of the profile will be used as a @class@ name for the @<img>@ tag. If you specify a @wraptag@ and omit the @class@, the profile name will be used as a @class@ on both the container and the @<img>@ tag.
* @display="value"@ By default, this tag outputs a full @<img>@ tag. If you just require the image URL so you can make your own image tags, set @display="url"@. Default: @thumbnail@.
* @force_size="value"@ Usually when you set one or other width/height to @0@ in a profile, the browser scales the missing dimension automatically. It does this by omitting the @width=@ or @height=@ attribute in the @img@ tag. This may cause visual artefacts as the page is rendered and the browser calculates the sizes. If you wish the plugin to add the actual dimension to the @<img>@ tag (the size at the time the thumbnail was created), tell the plugin with this attribute. Choose one or both of @width@ or @height@. Comma-separate as required. Default: unset.
* @form="form name"@ You can construct your own @<img>@ tags using the given form. If not specified, you may use the tag as a container.
* @type="value"@ Use this attribute to display thumbnails of the given profile name (e.g., @type="large"@). If you do not specify this attribute, the default profile will be used. If there is no default profile you'll see warning messages.
* @quiet="boolean"@ Use quiet="1" to suppress warnings about missing images. Default: @0@.

The tag works inside @<txp:images>@ or can be used standalone by specifying the @id@ or @name@ attribute. If using it as a container or with the @form@ attribute you display the various pieces of thumbnail information using the @<txp:smd_thumbnail_info>@ tag.

Expand Down

0 comments on commit b87fd62

Please sign in to comment.