Pol

Pol (Farsi: پل, "Bridge") is a new way for your audience to share contents of your site. You - as a Content Manager (CM) - point out to the most important part of your content, then Pol will transform it to a shareable link using javaScript and CSS so anyone could share it on your targeted social network.

Pol is created by Javid Izadfar and Setareh Karimi at IKA Computing Club as a free and open-source tool; so feel free to use and modify it as you need.

Pol will look great, using Gorbeh for media icons and RangeBrand for official media colors.

License

Pol files are licensed under the MIT License:

• https://opensource.org/licenses/mit-license.html

Contributing

We support and encourage any kind of contribution by anyone. Please read through contributing guidelines. In these guidelines, directions to asking for a new media, reporting a bug and other notes are fully explained.

Supporting Media

Pol currently supports the following social networks:

• Telegram
• Twitter

Usage

To use Pol on your site or blog, follow these steps:

1. Download Pol’s latest release.

2. Add Pol folder to your preferred directory on your project.

3. Add Pol.js to your HTML file:

<!-- Pol js -->
    <script src="js/pol.js"></script>

or

<!-- Pol min.js -->
    <script src="js/pol.min.js"></script>

4. Add Pol.css to your HTML file (Optional):

<!-- Pol css -->
  <link href="css/pol.css" rel="stylesheet">

or

<!-- Pol min.css -->
    <link href="css/pol.min.css" rel="stylesheet">

5. Initiate Pol in your custom js file:

$('body').pol()

see Options for more initialization options.

6. Implement a Pol, using data-pol-media and name your preferred media:

<span data-pol-media="twitter"> .... </span>

Options

Option	Default value	Functionality
url	current page's URL	Includes a link to the source
target	_blank	How should Pol's link behave when is clicked
author	none	Your official account(s) on targeted media. do NOT include "@". Separate accounts using ",".
hashtags	none	Hashtags. do NOT include "#". Separate accounts using ",".

Creators

• Javid Izadfar
  • Email: [email protected]
  • Twitter: twitter.com/JavidIzadfar
  • Github: github.com/Javid-Izadfar
• Setareh Karimi
  • Email: [email protected]
  • Twitter: twitter.com/setarekarimi
  • Github: github.com/setarek