You are here

Home » API reference » Freelinking 6.3

README.txt in Freelinking 6.3

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

* Introduction
* Installation
* Usage
* Related modules
* Troubleshooting
* Maintainers

Introduction
============
The freelinking module 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 [[pluginname:identifier]].

For example: [[nodetitle:page one]] becomes:
<a href="/node/1" title="page one" class="freelink freelink-nodetitle freelink-internal">page one</a>

There are plenty of plugins to use (Google search, Drupal search, Drupal projects, Wikipedia...) and
there is an API to add new plugins. Read PLUGIN.txt for more instructions regarding how to add new
plugin.

Installation
===========
1. Download and enable the module.
2. Optionally configure the module at admin/config/freelinking.
3. Go to Configuration > Text Formats and activate Freelinking filter at Filtered HTML
   and Full HTML filters.
4. Clean the cache.
5. Edit a node or open a new one and type in the body the above example to verify that
   it works.

Usage
=====
Normally you will type [[pluginname:target|title]]. The title is optional and if you do not specity
a plugin name the default one configured at Freelinking Settings page will be used.

Here is an example of each plugin:

Nodetitle: [[nodetitle:First page]] becomes
<a class="freelink freelink-nodetitle freelink-internal" title="node/1" href="/node/1">test</a>

Notes: If you have two nodes with the same title, there is no way to control what node is linked to. 
If you change the title of the page linked to, the freelink will no longer work.
Wikitools provide some tools to detect and prevent duplicate titles: https://www.drupal.org/project/wikitools

Drupal.org project: [[drupalproject:freelinking]] becomes
<a class="freelink freelink-drupalproject freelink-external" href="http://drupal.org/project/freelinking">freelinking</a>

Drupal.org nid: [[drupalorgnid:1]] becomes
<a class="freelink freelink-drupalorgnid freelink-external" href="http://drupal.org/node/1">Drupal.org: "About Drupal"</a>

Search: [[search:test]] becomes
<a class="freelink freelink-search freelink-internal" title="search/node/test" href="/search/node/test">test</a>

Node nid: [[nid:2]] becomes
<a class="freelink freelink-nid freelink-internal" title="node/2" href="/node/2">First page</a>

Google search: [[google:drupal]] becomes
<a class="freelink freelink-google freelink-external" title="http://www.google.com/search" href="http://www.google.com/search?q=drupal&hl=en">Google Search "drupal"</a>

File: [[file:logo.png]] becomes
<a class="freelink freelink-file freelink-internal" href="http://drupal7.localhost/sites/drupal7.localhost/files/logo.png">logo.png</a>

Wikisource, Wiktionary, Wikibooks, Wikinews and Wikipedia: [[wikipedia:Main Page]] becomes
<a class="freelink freelink-wikipedia freelink-external" href="http://en.wikipedia.org/wiki/Main_Page">Main_Page</a>

User profile: [[u:1]] becomes
<a class="freelink freelink-user freelink-internal" title="user/1" href="/user/1">admin</a>

Related modules
===============
* Freelinking offers a Freelinking Prepopulate submodule that provides a "create node"
  plugin. Nodetitle may use this to provide links to create content that does
  not exist. This submodule requires Prepopulate.
* Freelinking for casetracker adds a plugin "case" to provide a detailed status of a case tracker case.
  http://drupal.org/project/freelinking_casetracker

Troubleshooting
==============
If you do not see freelinking working at all. There must be some conflict with other input formats. Try
first to disable all other input formats and only leave Freelinking activated. Clean the cache and then test editing a node
with a freelink and save it. If it works, try adding other input formats until you get to the right order in which they
have to be in order to work correctly.

Maintainers
===========
* eafarris <eafarris@gmail.com> (Original Creator)
* grayside <grayside@gmail.com>
* juampy   http://drupal.org/user/682736

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. =====================

  3. 

  4. * Introduction

  5. * Installation

  6. * Usage

  7. * Related modules

  8. * Troubleshooting

  9. * Maintainers

  10. 

  11. Introduction

  12. ============

  13. The freelinking module implements a filter for the easier creation of HTML links to other pages

  14. in the site or external sites with a wiki style format such as [[pluginname:identifier]].

  15. 

  16. For example: [[nodetitle:page one]] becomes:

  17. page one

  18. 

  19. There are plenty of plugins to use (Google search, Drupal search, Drupal projects, Wikipedia...) and

  20. there is an API to add new plugins. Read PLUGIN.txt for more instructions regarding how to add new

  21. plugin.

  22. 

  23. Installation

  24. ===========

  25. 1. Download and enable the module.

  26. 2. Optionally configure the module at admin/config/freelinking.

  27. 3. Go to Configuration > Text Formats and activate Freelinking filter at Filtered HTML

  28.    and Full HTML filters.

  29. 4. Clean the cache.

  30. 5. Edit a node or open a new one and type in the body the above example to verify that

  31.    it works.

  32. 

  33. Usage

  34. =====

  35. Normally you will type [[pluginname:target|title]]. The title is optional and if you do not specity

  36. a plugin name the default one configured at Freelinking Settings page will be used.

  37. 

  38. Here is an example of each plugin:

  39. 

  40. Nodetitle: [[nodetitle:First page]] becomes

  41. test

  42. 

  43. Notes: If you have two nodes with the same title, there is no way to control what node is linked to. 

  44. If you change the title of the page linked to, the freelink will no longer work.

  45. Wikitools provide some tools to detect and prevent duplicate titles: https://www.drupal.org/project/wikitools

  46. 

  47. Drupal.org project: [[drupalproject:freelinking]] becomes

  48. freelinking

  49. 

  50. Drupal.org nid: [[drupalorgnid:1]] becomes

  51. Drupal.org: "About Drupal"

  52. 

  53. Search: [[search:test]] becomes

  54. test

  55. 

  56. Node nid: [[nid:2]] becomes

  57. First page

  58. 

  59. Google search: [[google:drupal]] becomes

  60. Google Search "drupal"

  61. 

  62. File: [[file:logo.png]] becomes

  63. logo.png

  64. 

  65. Wikisource, Wiktionary, Wikibooks, Wikinews and Wikipedia: [[wikipedia:Main Page]] becomes

  66. Main_Page

  67. 

  68. User profile: [[u:1]] becomes

  69. admin

  70. 

  71. Related modules

  72. ===============

  73. * Freelinking offers a Freelinking Prepopulate submodule that provides a "create node"

  74.   plugin. Nodetitle may use this to provide links to create content that does

  75.   not exist. This submodule requires Prepopulate.

  76. * Freelinking for casetracker adds a plugin "case" to provide a detailed status of a case tracker case.

  77.   http://drupal.org/project/freelinking_casetracker

  78. 

  79. Troubleshooting

  80. ==============

  81. If you do not see freelinking working at all. There must be some conflict with other input formats. Try

  82. first to disable all other input formats and only leave Freelinking activated. Clean the cache and then test editing a node

  83. with a freelink and save it. If it works, try adding other input formats until you get to the right order in which they

  84. have to be in order to work correctly.

  85. 

  86. Maintainers

  87. ===========

  88. * eafarris  (Original Creator)

  89. * grayside 

  90. * juampy   http://drupal.org/user/682736