You are here

Home » API reference » Linkit 7.3

readme.txt in Linkit 7.3

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
  3. 7.2 README.txt
SUMMARY
=======
Linkit provides an easy interface for internal and external linking with editors and fields by using an autocomplete
field. Linkit links to nodes, users, managed files, terms and have basic support for all entities by default.

ADVANTAGES
==========
Linkit has three major advantages over traditional linking

1. The user does not have to copy or remember a URL.
2. It is a sustainable solution for internal linking.
3. It has a user friendly UI.

FEATURES
========
* Basic support for all entities.
* Token support (for better descriptions on search results in Linkit).
* Provides a link button, similar to the ordinary link button in most editors.
* Can be attached to fields.
* The button opens a dialog with an autocomplete field for searching content.
* Support for IMCE.
* Settings are handled by profiles, similar to the profiles of the WYSIWYG module. Thus, it is possible to customize
the behavior of Linkit in detail.
* Works with and without Pathologic.
* Internal absolute URL:s converts automatically into Drupal paths, very simple for users who are used to copy-pasting.
* Tested to work in multiple server environments, e.g. with and without clean URL:s, Drupal installation in a
subdirectory or on a different port.
* Uses BAC
* Fully exportable with Features module.

Since Drupal's own autocomplete was not enough, we developed our own Better Autocomplete which provides a rich
autocomplete experience. It is GPL and bundled with Linkit 7.x-2.x and 7.x-3.x.

INSTALLATION
============

* Normal module installation procedure,see http://drupal.org/documentation/install/modules-themes/modules-7
for further information.
* Enable the Linkit button in your editor or on your field.

CONFIGURATION
=============
(admin/config/content/linkit)
After the installation, you have to create a Linkit profile. The profile will contain information about which
attributes and plugins to use.

DEPENDENCIES
============
* ctools
* Entity API

EDITOR SUPPORT
==============
* WYSIWYG with TinyMCE or CKEditor.
* CKEditor.

EXTRA plugins
=============

* Linkit References
* Linkit panel pages
* Linkit Views (is included in 6.x)
* Linkit Picker
* Linkit Upload
* Linkit Target
* Adds the target attribute. (is included in 7.x-3.0 and above)
* Linkit Markdown

API
===
Our new robust and flexible API

* Makes it easy for developers to extend Linkit with custom plugins. Example implementations included.
* Has support for altering db queries, using tags.
* Makes it possible to add HTML attributes to links (or alter existing attributes' interface)
* There is a API file called linkit.api.php

MAINTAINERS
===========
Current maintainer:
*Anon -https://www.drupal.org/u/anon

File

readme.txt
View source 
  1. SUMMARY

  2. =======

  3. Linkit provides an easy interface for internal and external linking with editors and fields by using an autocomplete

  4. field. Linkit links to nodes, users, managed files, terms and have basic support for all entities by default.

  5. 

  6. ADVANTAGES

  7. ==========

  8. Linkit has three major advantages over traditional linking

  9. 

  10. 1. The user does not have to copy or remember a URL.

  11. 2. It is a sustainable solution for internal linking.

  12. 3. It has a user friendly UI.

  13. 

  14. FEATURES

  15. ========

  16. * Basic support for all entities.

  17. * Token support (for better descriptions on search results in Linkit).

  18. * Provides a link button, similar to the ordinary link button in most editors.

  19. * Can be attached to fields.

  20. * The button opens a dialog with an autocomplete field for searching content.

  21. * Support for IMCE.

  22. * Settings are handled by profiles, similar to the profiles of the WYSIWYG module. Thus, it is possible to customize

  23. the behavior of Linkit in detail.

  24. * Works with and without Pathologic.

  25. * Internal absolute URL:s converts automatically into Drupal paths, very simple for users who are used to copy-pasting.

  26. * Tested to work in multiple server environments, e.g. with and without clean URL:s, Drupal installation in a

  27. subdirectory or on a different port.

  28. * Uses BAC

  29. * Fully exportable with Features module.

  30. 

  31. Since Drupal's own autocomplete was not enough, we developed our own Better Autocomplete which provides a rich

  32. autocomplete experience. It is GPL and bundled with Linkit 7.x-2.x and 7.x-3.x.

  33. 

  34. INSTALLATION

  35. ============

  36. 

  37. * Normal module installation procedure,see http://drupal.org/documentation/install/modules-themes/modules-7

  38. for further information.

  39. * Enable the Linkit button in your editor or on your field.

  40. 

  41. CONFIGURATION

  42. =============

  43. (admin/config/content/linkit)

  44. After the installation, you have to create a Linkit profile. The profile will contain information about which

  45. attributes and plugins to use.

  46. 

  47. DEPENDENCIES

  48. ============

  49. * ctools

  50. * Entity API

  51. 

  52. EDITOR SUPPORT

  53. ==============

  54. * WYSIWYG with TinyMCE or CKEditor.

  55. * CKEditor.

  56. 

  57. EXTRA plugins

  58. =============

  59. 

  60. * Linkit References

  61. * Linkit panel pages

  62. * Linkit Views (is included in 6.x)

  63. * Linkit Picker

  64. * Linkit Upload

  65. * Linkit Target

  66. * Adds the target attribute. (is included in 7.x-3.0 and above)

  67. * Linkit Markdown

  68. 

  69. API

  70. ===

  71. Our new robust and flexible API

  72. 

  73. * Makes it easy for developers to extend Linkit with custom plugins. Example implementations included.

  74. * Has support for altering db queries, using tags.

  75. * Makes it possible to add HTML attributes to links (or alter existing attributes' interface)

  76. * There is a API file called linkit.api.php

  77. 

  78. MAINTAINERS

  79. ===========

  80. Current maintainer:

  81. *Anon -https://www.drupal.org/u/anon