JV-ShrinkTheWeb - Format and Usage of stwpreview tags

This article explains tag formats with examples, and stwpreview parameters.

Tag Format:

{stwpreview url="" param1="" param2=""}
 

Tag Examples:

Example #1:

{stwpreview url="http://www.jv-extensions.com"}


- Shows thumbnail preview for  http://www.jv-extensions.com" home page with default size

Example #2:

{stwpreview url="http://www.jv-extensions.com" size="lg"}


- Shows thumbnail preview for  http://www.jv-extensions.com" home page whose size is lg


List of stwpreview params and possible values
:

There are several other parameters that can be used in the stwpreview tag. They include:

Attribute

Description with Example

Required STW PRO Feature
Attribute: url

Description: Url of the website whose preview is to be displayed

Allowed Values:

  • Any website url starting with http:// or https://

  • Mandatory attribute

 Example:

{stwpreview url="http://www.jv-extensions.com"}

None

Attribute: size

Description: Size of the thumbnail preview

Allowed Values:

  • xlg / lg / sm / vsm / tny / mcr
  • Default if not given: sm

Example:

{stwpreview url="http://www.jv-extensions.com" size="vsm"}

None

Attribute: link

Description: Hyperlink the thumbnail preview?

Allowed Values:

  • yes / no
  • Default if not given: yes

Example:

{stwpreview url="http://www.jv-extensions.com" link="no"}

None

Attribute: newwin

Description: Open website in new window?

Allowed Values:

  • yes / no
  • Default if not given: yes
  • Requires link attribute to be set to yes

Example:

{stwpreview url="http://www.jv-extensions.com" link="yes" newwin="no"}

None

Attribute: divwrap

Description: Wrap Image Tag Output in DIV?

Allowed Values:

  • yes / no
  • Default if not given: yes

Example:

{stwpreview url="http://www.jv-extensions.com" divwrap="no"}
  None
Attribute: class

Description: CSS Style definition for div tag containing the thumbnail preview

Allowed Values:

  • Any valid CSS style definition
  • Default if not given: jvstw_div
  • Must be defined in media/jvshrinktheweb/assets/css/jvshrinktheweb.css

 Example:

{stwpreview url="http://www.jv-extensions.com" class="myclass"}

None

Attribute: urlonly

Description: Returns only URL of the generated image, without the divs and img tags

Allowed Values:

  • yes / no
  • Default if not given: no

Example:

{stwpreview url="http://www.jv-extensions.com" urlonly="yes"}

None

Attribute: style

Description: Inline CSS for div tag containing the thumbnail preview

Allowed Values:

  • Any valid inline CSS attribute(s)
  • Default if not given: -
  • This option will not be used, if you set divwrap to no

Example:

{stwpreview url="http://www.jv-extensions.com" style="margin-right:10px; float:left;"}

None

Attribute: csize

Description: Custom size of thumbnail preview

Allowed Values:

  • Desired width in pixels
  • Max value is 1280

Example:

{stwpreview url="http://www.jv-extensions.com" csize="468"}

Custom Size Captures

Attribute: fullpage

Description: Capture and show full page of the website

Allowed Values:

  • yes / no
  • Default if not given: no
  • csize attribute must be used.
  • You may also specify fullpage-height attribute with this, to crop the height to a specific value

Example:

{stwpreview url="http://www.jv-extensions.com" fullpage="yes" csize="468"}

Full Length Captures

Attribute: quality

Description: Quality of thumbnail previews in %

Allowed Values:

  • Default if not given: 95

Example:

{stwpreview url="http://www.jv-extensions.com" quality="75"}

Custom Quality

Attribute: delay

Description: Indicates the wait time in seconds for page to load, after which it's preview is captured

Allowed Values:

  • 5 - 45
  • Applies to pages containing Flash and starts once loaded

Example:

{stwpreview url="http://www.jv-extensions.com" delay="20"}

Custom Flash Delay

Attribute: inside

Description: Captures internal pages of the website

Allowed Values:

  • yes / no
  • Default if not given: no

Example:

{stwpreview url="http://www.jv-extensions.com/products/jv-linkdirectory" inside="yes"}

Inside Pages Captures

Attribute: browser-width

Description: Width of Browser size for captures

Allowed Values:

  • Width in pixels of the browser size.

 Example:

{stwpreview url="http://www.jv-extensions.com" browser-width="800"}

Custom Browser Resolution

Attribute: browser-height

Description: Height of Browser size for captures (Widescreen Thumbnails)

Allowed Values:

  • Height in pixels of the browser size

Example:

{stwpreview url="http://www.jv-extensions.com" browser-width="800"}

Custom Browser Resolution

Attribute: cmsgpath

Description: Shows custom images for system thumbnails like errors, thumbnail queued etc.. instead of default

ones. You should have uploaded the system images to a remote path on your server

Allowed Values:

  • Url of the server (starting with http:// or https://) where you have uploaded the system images

Example:

{stwpreview url="http://www.jv-extensions.com" cmsgpath="http://www.jv-extensions.com/myimages/"}
Remote Custom System Messages

Still need help? Contact Support Contact Support