TweetThisMODX

Package Description

An easy way for content and social media marketers to get their content and pages shared is to use a technique known as TweetThis. A Tweet link around a compelling or shareworthy block of copy text that makes it easy for the user to Tweet it, sharing your fantastic content.

What's great is that the functionality sits within your copy text layout, so it can be used frequently on a page without disrupting the layout. An example use might be on a title or quote. 

Usage/Installation Instructions

--------------------

EXTRA: TweetThisMODX

--------------------

Version: 1.2.3

 Author: StuntRocket

Easily add "Tweet This" functionality to your MODX Revolution website.

TweetThisMODX Demo

--------------------

DESCRIPTION

--------------------

A great way for content and social media marketers to get their content shared is to use a technique known as TweetThis. A Tweet link around a compelling or shareworthy block of copy text, that makes it easy for the user to Tweet it, sharing your fantastic content.

What's great is that the functionality sits within your copy text layout, so it can be used frequently on a page without disrupting the layout. An example use might be on a title or quote. 

--------------------

FEATURES

--------------------

1) Add Tweet This link to text in Chunks, Templates, Content and Text Template Variables.

2) Four styling combinations.

3) Easy enable and disable.

4) Customisable class names on HTML elements.

--------------------

 BENEFITS

--------------------

1) Get your content shared by your viewers.

2) Easy to install and use.

--------------------

DEPENDENCIES

--------------------

TweetThisMODX depends on MODX. JQuery is not needed because it uses native Javascript.

--------------------

ENABLE/DISABLE

--------------------

If you want to globally disable TweetThisModx, head into your MODX System Settings and within the TweetThisModx Namespace look for tweetthismodx.enabled. Set this to No to disable the plugin for the entire site.

Disabling the plugin this way does not disrupt your text, it just removes the button. The Extra is Enabled by default.

--------------------

USAGE

--------------------

In the Chunk or Template where you want to show a "TweetThis" button next to a block of text use the following Snippet call:

[[TweetThis? &text=`Your Tweetable Text Here`]]

This will display your text with a small button next to it. When clicked the button will open a Tweet dialogue in the user's browser with the text and URL inserted ready for them to Tweet.

--------------------

On Page Styling

--------------------

Both of the main elements (text and link) have two basic styling options.

The text element can have a Twitter blue background or a Twitter blue underline.

The link element can either be text (Tweet This), or a Twitter icon. The examples below show the four style options that are available.

Text: ttm_highlight or ttm_underline

Link: ttm_link or ttm_link_text

Example Style Combinations:

[[TweetThis? &text=`My Text` &text_class=`ttm_highlight` &link_class=`ttm_link_text`]]

[[TweetThis? &text=`My Text` &text_class=`ttm_underline` &link_class=`ttm_link_text`]]

[[TweetThis? &text=`My Text` &text_class=`ttm_highlight` &link_class=`ttm_link`]]

[[TweetThis? &text=`My Text` &text_class=`ttm_underline` &link_class=`ttm_link`]]

You can use multiple style configurations on the same page.

Remember: You can set your preferred style as default. See below for instructions for doing this.

--------------------

CUSTOM CSS CLASSES

--------------------

The idea with "Tweet This" functionality is that it sits within your regular copy text. For this reason the styling is minimal.

If you do want to style the text or button elementS yourself they each have a CSS class that you can target in your stylesheets.

If you would like to use your own default class names, head into your MODX System Settings and look for the following two Settings in the TweetThisModx Namespace:

tweetthismodx.highlight_class (Default: ttm_underline)

tweetthismodx.link_class (Default: ttm_link)

Respectively these affect the text and the button. Obviously you'll need to create the corresponding CSS declarations in your own stylesheet.

Advanced usage with custom CSS classes defined on page/template/chunk.

If you don't know what CSS styling is or how to edit CSS files, you'll probably want to leave this alone or ask a developer to help you.

--------------------

HAVING PROBLEMS?

--------------------

If there are any problems, please create an issue on the GitHub Repository

https://github.com/stuntrocket/TweetThisModx

--------------------

AUTHOR

--------------------

StuntRocket Home