You are here

Home » API reference » Footnotes 8.2

README.txt in Footnotes 8.2

Same filename and directory in other branches
  1. 5.2 README.txt
  2. 5 README.txt
  3. 6.2 README.txt
  4. 6 README.txt
  5. 7.3 README.txt
  6. 7.2 README.txt
INTRODUCTION
------------------

The Footnotes module is used to easily create automatically numbered footnote references in an article or post (such as a reference to a URL).

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/footnotes

 * To submit bug reports and feature suggestions, or track changes:
   https://www.drupal.org/project/issues/footnotes

REQUIREMENTS
------------------

The Footnote module for Drupal 8 requires the following modules and plugins:

 * FakeObjects (https://www.drupal.org/project/fakeobjects)
 * CKEditor plugin (http://ckeditor.com/addon/fakeobjects)

INSTALLATION
----------------
* Before you can use the FakeObjects module, you need to download the plugin from http://ckeditor.com/addon/fakeobjects and place it in /libraries/fakeobjects.

* In all other steps, install the module as you would normally install a contributed Drupal module. Visit
https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules for further information.

CONFIGURATION
-------------------
* To use the footnotes filter in some input formats, go to Configuration ->
   Text formats.

* For the Text formats you want to support footnotes markup, select configure and activate a suitable footnotes filter.

* In the place where you want to add a footnote enclose the footnote text within an fn tag:<code>[fn]like this[/fn]</code>. By default, footnotes are placed at the end of the text. You can also use a <code>[footnotes]</code> or <code>[footnotes /]</code> tag to position it anywhere you want.

* The filter will take the text within the tag and move it to a footnote at the
bottom of the page. In it's place it will place a number which is also a link to
the footnote. Footnotes supports both <code>[fn]square brackets[/fn]</code> and <code><fn>angle brackets</fn></code>.

* You can also use a "value" attribute to a) set the numbering to start from the given value, or b) to set an arbitrary text string as label.

Ex:

 [fn value="5"]This becomes footnote #5. Subsequent are #6, #7...[/fn]
 [fn value="*"]This footnote is assigned the label "*"[/fn]
 
Using value="" you can have multiple references to the same footnote in the text body.

 [fn value="5"]This becomes footnote #5.[/fn]
 [fn value="5"]This is a reference to the same footnote #5, this text itself is discarded.[/fn]

TROUBLESHOOTING & FAQ
------------------------------

Q: When trying to install the Footnotes module, I get the message: Before you can use the FakeObjects module, you need to download the plugin from ckeditor.com and place it in /libraries/fakeobjects."

A: To avoid this error message, please follow the guidelines in the Required modules and the Installation sections of this Readme file. Please mind that the Drupal 8.x-2.x branch of the Footnotes module only supports the CKEditor and does not support the TinyMCE.

File

README.txt
View source 
  1. INTRODUCTION

  2. ------------------

  3. 

  4. The Footnotes module is used to easily create automatically numbered footnote references in an article or post (such as a reference to a URL).

  5. 

  6.  * For a full description of the module, visit the project page:

  7.    https://www.drupal.org/project/footnotes

  8. 

  9.  * To submit bug reports and feature suggestions, or track changes:

  10.    https://www.drupal.org/project/issues/footnotes

  11. 

  12. REQUIREMENTS

  13. ------------------

  14. 

  15. The Footnote module for Drupal 8 requires the following modules and plugins:

  16. 

  17.  * FakeObjects (https://www.drupal.org/project/fakeobjects)

  18.  * CKEditor plugin (http://ckeditor.com/addon/fakeobjects)

  19. 

  20. INSTALLATION

  21. ----------------

  22. * Before you can use the FakeObjects module, you need to download the plugin from http://ckeditor.com/addon/fakeobjects and place it in /libraries/fakeobjects.

  23. 

  24. * In all other steps, install the module as you would normally install a contributed Drupal module. Visit

  25. https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules for further information.

  26. 

  27. CONFIGURATION

  28. -------------------

  29. * To use the footnotes filter in some input formats, go to Configuration ->

  30.    Text formats.

  31. 

  32. * For the Text formats you want to support footnotes markup, select configure and activate a suitable footnotes filter.

  33. 

  34. * In the place where you want to add a footnote enclose the footnote text within an fn tag:[fn]like this[/fn]. By default, footnotes are placed at the end of the text. You can also use a [footnotes] or [footnotes /] tag to position it anywhere you want.

  35. 

  36. * The filter will take the text within the tag and move it to a footnote at the

  37. bottom of the page. In it's place it will place a number which is also a link to

  38. the footnote. Footnotes supports both [fn]square brackets[/fn] and angle brackets.

  39. 

  40. * You can also use a "value" attribute to a) set the numbering to start from the given value, or b) to set an arbitrary text string as label.

  41. 

  42. Ex:

  43. 

  44.  [fn value="5"]This becomes footnote #5. Subsequent are #6, #7...[/fn]

  45.  [fn value="*"]This footnote is assigned the label "*"[/fn]

  46.  

  47. Using value="" you can have multiple references to the same footnote in the text body.

  48. 

  49.  [fn value="5"]This becomes footnote #5.[/fn]

  50.  [fn value="5"]This is a reference to the same footnote #5, this text itself is discarded.[/fn]

  51. 

  52. TROUBLESHOOTING & FAQ

  53. ------------------------------

  54. 

  55. Q: When trying to install the Footnotes module, I get the message: Before you can use the FakeObjects module, you need to download the plugin from ckeditor.com and place it in /libraries/fakeobjects."

  56. 

  57. A: To avoid this error message, please follow the guidelines in the Required modules and the Installation sections of this Readme file. Please mind that the Drupal 8.x-2.x branch of the Footnotes module only supports the CKEditor and does not support the TinyMCE.