You are here

Home » API reference » Freelinking 7.3

README.txt in Freelinking 7.3

Same filename in this branch
  1. 7.3 README.txt
  2. 7.3 modules/freelinking_prepopulate/README.txt
Same filename and directory in other branches
  1. 5 README.txt
  2. 6.3 README.txt
  3. 6 README.txt
  4. 6.2 README.txt
CONTENTS OF THIS FILE

* Introduction
* Recommended modules
* Installation
* Configuration
* Maintainers

INTRODUCTION

Freelinking implements a filter for the easier creation of HTML links
to other pages in the site or external sites with a wiki style format
such as `[[indicator:identifier]]`.

For example: `[[nodetitle:Page One]]` becomes:

    <a href="/node/1" title="Click to view a local node."
    class="freelink freelink-nodetitle freelink-internal">Page One</a>

Note that there must be no space after the colon after the indicator.

A number of ready-to-use filters are included in the Freelinking
framework (e.g. Nodetitle. Nid, User, Google search, Drupal search,
Drupal projects, Wikipedia, etc.).

There is a framework that allow developers to add new plugins. See the
help file “Creating plugins for Freelinking ver. 3” (available when
you enable Advanced help[1]) for instructions regarding how to add new
plugin.

REQUIREMENTS

* Advanced help hint[1]:
  Will link standard help text to online help and advanced help.

RECOMMENDED MODULES

* Advanced help[2]:
  When this module is enabled the administrator will have access to
  more extensive help.

INSTALLATION

1. Install as you would normally install a contributed drupal
   module. See: Installing modules[3] for further information.
2. Go to Administration » Configuration » Text Formats and activate
   the Freelinking filter for the text formats you want to
   facilitate freelinking for (e.g. Filtered HTML and Full HTML).
3. If you plan to use freelinking for External links, deactivate the
   “Convert URLs into links” filter for the same text formats.
4. Configure the module at Administration » Configuration » Content
   authoring » Freelinking settings.  See next section for details.
5. Clean the cache.

CONFIGURATION

To configure the module, navigate to Administration » Configuration »
Content authoring » Freelinking settings.

The first setting is a pull-down menu to let you set the default
indicator to use when no indicator is specified.  “Nodetitle” mimics
previous versions of Freelinking.

The global options and options to increase performance are global, and
apply to all plugins. Please see the description of each checkbox to
determine what each does.

The rest of the configuration pages are for plugin-specific options.

If you change the configiration, remember to press Save
configuration to make the changes effective.

MAINTAINERS

* eafarris - https://www.drupal.org/user/812 (original creator)
* grayside - https://www.drupal.org/u/grayside
* juampy - https://www.drupal.org/u/juampy
* gisle - https://www.drupal.org/u/gisle (current maintainer)

Any help with development (patches, reviews, comments) are welcome.


[1]: https://www.drupal.org/project/advanced_help_hint
[2]: https://www.drupal.org/project/advanced_help
[3]: https://www.drupal.org/documentation/install/modules-themes/modules-7

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. 

  3. * Introduction

  4. * Recommended modules

  5. * Installation

  6. * Configuration

  7. * Maintainers

  8. 

  9. INTRODUCTION

  10. 

  11. Freelinking implements a filter for the easier creation of HTML links

  12. to other pages in the site or external sites with a wiki style format

  13. such as `[[indicator:identifier]]`.

  14. 

  15. For example: `[[nodetitle:Page One]]` becomes:

  16. 

  17.     
  18.     class="freelink freelink-nodetitle freelink-internal">Page One

  19. 

  20. Note that there must be no space after the colon after the indicator.

  21. 

  22. A number of ready-to-use filters are included in the Freelinking

  23. framework (e.g. Nodetitle. Nid, User, Google search, Drupal search,

  24. Drupal projects, Wikipedia, etc.).

  25. 

  26. There is a framework that allow developers to add new plugins. See the

  27. help file “Creating plugins for Freelinking ver. 3” (available when

  28. you enable Advanced help[1]) for instructions regarding how to add new

  29. plugin.

  30. 

  31. REQUIREMENTS

  32. 

  33. * Advanced help hint[1]:

  34.   Will link standard help text to online help and advanced help.

  35. 

  36. RECOMMENDED MODULES

  37. 

  38. * Advanced help[2]:

  39.   When this module is enabled the administrator will have access to

  40.   more extensive help.

  41. 

  42. INSTALLATION

  43. 

  44. 1. Install as you would normally install a contributed drupal

  45.    module. See: Installing modules[3] for further information.

  46. 2. Go to Administration » Configuration » Text Formats and activate

  47.    the Freelinking filter for the text formats you want to

  48.    facilitate freelinking for (e.g. Filtered HTML and Full HTML).

  49. 3. If you plan to use freelinking for External links, deactivate the

  50.    “Convert URLs into links” filter for the same text formats.

  51. 4. Configure the module at Administration » Configuration » Content

  52.    authoring » Freelinking settings.  See next section for details.

  53. 5. Clean the cache.

  54. 

  55. CONFIGURATION

  56. 

  57. To configure the module, navigate to Administration » Configuration »

  58. Content authoring » Freelinking settings.

  59. 

  60. The first setting is a pull-down menu to let you set the default

  61. indicator to use when no indicator is specified.  “Nodetitle” mimics

  62. previous versions of Freelinking.

  63. 

  64. The global options and options to increase performance are global, and

  65. apply to all plugins. Please see the description of each checkbox to

  66. determine what each does.

  67. 

  68. The rest of the configuration pages are for plugin-specific options.

  69. 

  70. If you change the configiration, remember to press Save

  71. configuration to make the changes effective.

  72. 

  73. MAINTAINERS

  74. 

  75. * eafarris - https://www.drupal.org/user/812 (original creator)

  76. * grayside - https://www.drupal.org/u/grayside

  77. * juampy - https://www.drupal.org/u/juampy

  78. * gisle - https://www.drupal.org/u/gisle (current maintainer)

  79. 

  80. Any help with development (patches, reviews, comments) are welcome.

  81. 

  82. 

  83. [1]: https://www.drupal.org/project/advanced_help_hint

  84. [2]: https://www.drupal.org/project/advanced_help

  85. [3]: https://www.drupal.org/documentation/install/modules-themes/modules-7