You are here

README.txt in Share Message 8

Same filename and directory in other branches
  1. 7 README.txt
PROJECT
-------
http://drupal.org/project/sharemessage


INSTALLATION
------------
1. Download and extract the module to your sites/all/modules/contrib folder.
2. Enable the module on the Drupal Modules page (admin/modules) or using
   $ drush en

If you want to enable Sharrre plugin, do the following:
- Local library:
  1. Download the latest version of Sharrre at http://jster.net/library/sharrre.
  2. Put the minimized sharrre JS file in /libraries/sharrre and enable the
     libraries module.
- External library:
  1. Set the external URL for the library in Sharrre settings.


HOW TO ADD SHARING WIDGETS
--------------------------
1. Go to admin/config/services/sharemessage/sharemessage-settings and configure
   your default sharing options. Available options are documented in detail in
   the section "SETTINGS" below.
2. Open the "list" tab and click on "Add Share Message". Enter the values you
   want to be shared, note that you can use available tokens in order to make
   Share Messages display dynamic content.
3. If you don't want to use the default settings you configured on the settings
   page before, you can override those by checking "Override default settings".
4. Check the "Provide a block" setting.
5. Go to admin/structure/block and configure look for a block that has the name
   of your Share Message. Use the block settings to control where your share
   message is shown. (Mind the used tokens!).

Alternatively you can use an Entity Reference field on any node/entity with
display format "Rendered entity" to display Share Messages on within nodes and
fieldable entities.


ENFORCE OVERRIDING SHARE MESSAGES
---------------------------------
It is possible to enforce overriding of certain Share Messages if two Share
Messages point to the same URL.
This may be useful for example if you have a Share Message on a product page and
one on the checkout complete, while both point on the product page, you will
want to display another Share Message in case the user shares the checkout
complete message.

To accomplish this enforcement of the override, you can just enable the option
"Enforce the usage of this Share Message on the page it points to" on the Share
Message that is displayed on the checkout page.

Be careful if your site uses the querystring "?smid=" somewhere in another con-
text, this may lead to unexpected effects/conflicts. In that case, you can
disable this feature with a global setting.


OPTIONS
-------
- AddThis Profile ID:
  Optional. Enter your AddThis profile ID in order to be able to track your
  shares on your AddThis account.

- Default visible services:
  Determines which service buttons will be displayed on a share widget. You can
  override this per Share Message.
 
- Show additional services button:
  If checked, a button, which displays a list of additional services in a popup,
  will be displayed.
 
- Show AddThis counter:
  Adds a share counter that counts all shares and displays the amount of shares
  on a certain page.
 
- Default icon style:
  The size of the share buttons in pixel.

- Use local service definitions file:
  Enable this if your server is located behind some firewall that is blocking
  access to http://cache.addthiscdn.com/services/v1/sharing.en.json and the
  services select field is empty.

REQUIREMENTS
--------------------------------------------------------------------------------
- Social Share Privacy library:
  http://panzi.github.io/SocialSharePrivacy/

  Download minimized js from:
  http://panzi.github.io/SocialSharePrivacy/javascripts/jquery.socialshareprivacy.min.js
  copy file to:
  /libraries/socialshareprivacy/jquery.socialshareprivacy.min.js

  Download minimized css from:
  http://panzi.github.io/SocialSharePrivacy/stylesheets/jquery.socialshareprivacy.min.css
  copy file to:
  /libraries/socialshareprivacy/stylesheets/jquery.socialshareprivacy.min.css

  Download compressed files from:
  http://panzi.github.io/SocialSharePrivacy/
  extract files and copy content of images folder to:
  /libraries/socialshareprivacy/images


EXPORT/IMPORT
-------------
Using entities EntityAPIControllerExportable class, Share Messages are fully
export-/importable. In order to export a Share Message open the list
(admin/config/services/sharemessage) and use the "export" operation. Importing
can be done by following the "Import Share Message" link on the same page. Just
paste your exported sharemessage code and import it.


TESTING SHARES ON FACEBOOK
-------------
In order to test your shares on facebook, you can share your nodes or pages the
usual way, by clicking on the like button. This has the huge disadvantage, that
facebook may cache your share requests of the same page. To avoid this annoying
issue, use facebooks debugger tool: http://developers.facebook.com/tools/debug.


LOCAL SERVICES DEFINITION
-------------
When using the option "Use local service definitions file", the available
services might be outdated. If you see that they are outdated the services
definitions file, that is shipped with the module, has to be updated. Please
create a new issue for that at https://drupal.org/project/issues/sharemessage .


CREDITS
-------------
This module was developed and is maintained by MD Systems (by Miro Dietiker,
Berdir, s_leu). The Development has been sponsored by Kampaweb GmbH
http://kampaweb.ch/ and MD Systems http://www.md-systems.ch.

File

README.txt
View source
  1. PROJECT
  2. -------
  3. http://drupal.org/project/sharemessage
  4. INSTALLATION
  5. ------------
  6. 1. Download and extract the module to your sites/all/modules/contrib folder.
  7. 2. Enable the module on the Drupal Modules page (admin/modules) or using
  8. $ drush en
  9. If you want to enable Sharrre plugin, do the following:
  10. - Local library:
  11. 1. Download the latest version of Sharrre at http://jster.net/library/sharrre.
  12. 2. Put the minimized sharrre JS file in /libraries/sharrre and enable the
  13. libraries module.
  14. - External library:
  15. 1. Set the external URL for the library in Sharrre settings.
  16. HOW TO ADD SHARING WIDGETS
  17. --------------------------
  18. 1. Go to admin/config/services/sharemessage/sharemessage-settings and configure
  19. your default sharing options. Available options are documented in detail in
  20. the section "SETTINGS" below.
  21. 2. Open the "list" tab and click on "Add Share Message". Enter the values you
  22. want to be shared, note that you can use available tokens in order to make
  23. Share Messages display dynamic content.
  24. 3. If you don't want to use the default settings you configured on the settings
  25. page before, you can override those by checking "Override default settings".
  26. 4. Check the "Provide a block" setting.
  27. 5. Go to admin/structure/block and configure look for a block that has the name
  28. of your Share Message. Use the block settings to control where your share
  29. message is shown. (Mind the used tokens!).
  30. Alternatively you can use an Entity Reference field on any node/entity with
  31. display format "Rendered entity" to display Share Messages on within nodes and
  32. fieldable entities.
  33. ENFORCE OVERRIDING SHARE MESSAGES
  34. ---------------------------------
  35. It is possible to enforce overriding of certain Share Messages if two Share
  36. Messages point to the same URL.
  37. This may be useful for example if you have a Share Message on a product page and
  38. one on the checkout complete, while both point on the product page, you will
  39. want to display another Share Message in case the user shares the checkout
  40. complete message.
  41. To accomplish this enforcement of the override, you can just enable the option
  42. "Enforce the usage of this Share Message on the page it points to" on the Share
  43. Message that is displayed on the checkout page.
  44. Be careful if your site uses the querystring "?smid=" somewhere in another con-
  45. text, this may lead to unexpected effects/conflicts. In that case, you can
  46. disable this feature with a global setting.
  47. OPTIONS
  48. -------
  49. - AddThis Profile ID:
  50. Optional. Enter your AddThis profile ID in order to be able to track your
  51. shares on your AddThis account.
  52. - Default visible services:
  53. Determines which service buttons will be displayed on a share widget. You can
  54. override this per Share Message.
  55. - Show additional services button:
  56. If checked, a button, which displays a list of additional services in a popup,
  57. will be displayed.
  58. - Show AddThis counter:
  59. Adds a share counter that counts all shares and displays the amount of shares
  60. on a certain page.
  61. - Default icon style:
  62. The size of the share buttons in pixel.
  63. - Use local service definitions file:
  64. Enable this if your server is located behind some firewall that is blocking
  65. access to http://cache.addthiscdn.com/services/v1/sharing.en.json and the
  66. services select field is empty.
  67. REQUIREMENTS
  68. --------------------------------------------------------------------------------
  69. - Social Share Privacy library:
  70. http://panzi.github.io/SocialSharePrivacy/
  71. Download minimized js from:
  72. http://panzi.github.io/SocialSharePrivacy/javascripts/jquery.socialshareprivacy.min.js
  73. copy file to:
  74. /libraries/socialshareprivacy/jquery.socialshareprivacy.min.js
  75. Download minimized css from:
  76. http://panzi.github.io/SocialSharePrivacy/stylesheets/jquery.socialshareprivacy.min.css
  77. copy file to:
  78. /libraries/socialshareprivacy/stylesheets/jquery.socialshareprivacy.min.css
  79. Download compressed files from:
  80. http://panzi.github.io/SocialSharePrivacy/
  81. extract files and copy content of images folder to:
  82. /libraries/socialshareprivacy/images
  83. EXPORT/IMPORT
  84. -------------
  85. Using entities EntityAPIControllerExportable class, Share Messages are fully
  86. export-/importable. In order to export a Share Message open the list
  87. (admin/config/services/sharemessage) and use the "export" operation. Importing
  88. can be done by following the "Import Share Message" link on the same page. Just
  89. paste your exported sharemessage code and import it.
  90. TESTING SHARES ON FACEBOOK
  91. -------------
  92. In order to test your shares on facebook, you can share your nodes or pages the
  93. usual way, by clicking on the like button. This has the huge disadvantage, that
  94. facebook may cache your share requests of the same page. To avoid this annoying
  95. issue, use facebooks debugger tool: http://developers.facebook.com/tools/debug.
  96. LOCAL SERVICES DEFINITION
  97. -------------
  98. When using the option "Use local service definitions file", the available
  99. services might be outdated. If you see that they are outdated the services
  100. definitions file, that is shipped with the module, has to be updated. Please
  101. create a new issue for that at https://drupal.org/project/issues/sharemessage .
  102. CREDITS
  103. -------------
  104. This module was developed and is maintained by MD Systems (by Miro Dietiker,
  105. Berdir, s_leu). The Development has been sponsored by Kampaweb GmbH
  106. http://kampaweb.ch/ and MD Systems http://www.md-systems.ch.