You are here

README.txt in Shorten URLs 7

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.2 README.txt
=======
SUMMARY
=======

This module allows shortening URLs via almost any service. This is accomplished
either via the API or with an included block or page. Over 25 services are
available by default and additional services are easily added. If the shorturl
module or the shurly module is installed, they can be used to shorten URLs
on your own domain as well.

=======
DETAILS
=======

This module includes a number of features that will ensure the best experience
for you and your users. When retrieving a URL, Shorten URLs will time out if the
shortening service you chose does not respond after 3 seconds.  It will then use
a backup service of your choice to make sure you still have a shortened URL. If
retrieving a shortened URL fails, an explanation will be logged.

If you have cURL enabled, you can choose whether to retrieve shortened URLs via
cURL or PHP's native functions. cURL is usually faster. If you don't have cURL
compiled in your PHP package, you will not be able to choose the cURL option.

You can also choose whether to allow users to choose which shortening service to
use on the block and page. Note however that since shortened URLs are cached,
requesting the same shortened URL from different services may return results
from the first service in both instances.


==========
SUBMODULES
==========

This package contains two submodules: Record Shortened URLs and Shorten URLs
Custom Services. The first keeps track of which URLs have been shortened and
displays them to administrators at admin/reports/shorten; the second allows
administrators to add custom URL shortening services through the user interface
(instead of using the API).

===
API
===

Up-to-date API documentation is maintained at http://drupal.org/node/805174.

=====
NOTES
=====

IceCreamYou (http://drupal.org/user/201425) wrote and maintains the module.
Please report issues in the module's queue at
http://drupal.org/project/issues/shorten

File

README.txt
View source
  1. =======
  2. SUMMARY
  3. =======
  4. This module allows shortening URLs via almost any service. This is accomplished
  5. either via the API or with an included block or page. Over 25 services are
  6. available by default and additional services are easily added. If the shorturl
  7. module or the shurly module is installed, they can be used to shorten URLs
  8. on your own domain as well.
  9. =======
  10. DETAILS
  11. =======
  12. This module includes a number of features that will ensure the best experience
  13. for you and your users. When retrieving a URL, Shorten URLs will time out if the
  14. shortening service you chose does not respond after 3 seconds. It will then use
  15. a backup service of your choice to make sure you still have a shortened URL. If
  16. retrieving a shortened URL fails, an explanation will be logged.
  17. If you have cURL enabled, you can choose whether to retrieve shortened URLs via
  18. cURL or PHP's native functions. cURL is usually faster. If you don't have cURL
  19. compiled in your PHP package, you will not be able to choose the cURL option.
  20. You can also choose whether to allow users to choose which shortening service to
  21. use on the block and page. Note however that since shortened URLs are cached,
  22. requesting the same shortened URL from different services may return results
  23. from the first service in both instances.
  24. ==========
  25. SUBMODULES
  26. ==========
  27. This package contains two submodules: Record Shortened URLs and Shorten URLs
  28. Custom Services. The first keeps track of which URLs have been shortened and
  29. displays them to administrators at admin/reports/shorten; the second allows
  30. administrators to add custom URL shortening services through the user interface
  31. (instead of using the API).
  32. ===
  33. API
  34. ===
  35. Up-to-date API documentation is maintained at http://drupal.org/node/805174.
  36. =====
  37. NOTES
  38. =====
  39. IceCreamYou (http://drupal.org/user/201425) wrote and maintains the module.
  40. Please report issues in the module's queue at
  41. http://drupal.org/project/issues/shorten