You are here

README.txt in Footnotes 5

The Footnotes module can be used to create automatically numbered footnotes
within a text. In the place, where you want to add a footnote, enclose the
footnote text within an fn tag: <fn>like this</fn>. 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.

There is also another filter which does the same with a Textile markup style.
Use it together with the Textile module.

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. For Textile
use "footnotes." tag. 


INSTALL INSTRUCTIONS FOR FOOTNOTES.MODULE
----

1. Copy the contents of this module to modules/footnotes folder.
2. Login as site administrator.
3. Activate footnotes on the administer->modules page.
4. To use the footnotes filter in some input formats, go to administer->input formats.
5. For selected input formats, select configure and activate a suitable footnotes filter. 

Note: Typically you want the footnotes filter to be pretty early in the chain. 
For instance the Footnotes Textile style filter outputs Textile markup, so it 
should definitively be before your Textile filter. If you need to lift the 
Footnotes filter higher up, click "rearrange".

Also see section about HTML filter below.


HTML FILTER
----

Footnotes.module is designed such that it can be used together with Drupal's html filter,
and in particular you should have footnotes first and html filter later.

This version of Footnotes has been redesigned so that it only outputs html tags that 
are allowed in a default installation of HTML filter. (Tags used are A, OL and LI.)


KNOWN ISSUES
----

This version uses a new markup for the list of footnotes. It is an OL list with 
CSS taking away the browser generated list numbers and moving the link numbers 
towards the left. All IE versions have a bug that the numbers are slightly lower 
than the baseline of the footnote text. (If you know how to fix this, please tell.)
In addition IE 5.5 has a more serious bug that the footnote number will be on top of
the first letters of the footnote text. There doesn't seem to be a way to fix this.


COPYRIGHT AND ACKNOWLEDGEMENTS
----

Footnotes.module is copyrighted by Henrik Ingo. It is licensed by the same conditions as Drupal 
itself. (GPL license)

Footnotes.module was originally created by henrik.ingo@avoinelama.fi ("hingo" on drupal.org)
in the summer of 2006.

The HTML footnotes were seriously enhanced by "beginner" (on drupal.org)
and later on by other users comments and code snippets.

Footnotes was originally developed for http://openlife.cc/onlinebook
Beginner was the second to use it on his site at 
http://www.reuniting.info/wisdom/sources/metaphysical/a_course_in_miracles_sacred_sexuality_holy_relationship

I wish to thank all contributors for letting me experience the miracle of maintaining an
Open Source module living its own life!

File

README.txt
View source
  1. The Footnotes module can be used to create automatically numbered footnotes
  2. within a text. In the place, where you want to add a footnote, enclose the
  3. footnote text within an fn tag: like this. The filter will take the
  4. text within the tag and move it to a footnote at the bottom of the page.
  5. In it's place it will place a number which is also a link to the footnote.
  6. There is also another filter which does the same with a Textile markup style.
  7. Use it together with the Textile module.
  8. By default, footnotes are placed at the end of the text. You can also use a
  9. or tag to position it anywhere you want. For Textile
  10. use "footnotes." tag.
  11. INSTALL INSTRUCTIONS FOR FOOTNOTES.MODULE
  12. ----
  13. 1. Copy the contents of this module to modules/footnotes folder.
  14. 2. Login as site administrator.
  15. 3. Activate footnotes on the administer->modules page.
  16. 4. To use the footnotes filter in some input formats, go to administer->input formats.
  17. 5. For selected input formats, select configure and activate a suitable footnotes filter.
  18. Note: Typically you want the footnotes filter to be pretty early in the chain.
  19. For instance the Footnotes Textile style filter outputs Textile markup, so it
  20. should definitively be before your Textile filter. If you need to lift the
  21. Footnotes filter higher up, click "rearrange".
  22. Also see section about HTML filter below.
  23. HTML FILTER
  24. ----
  25. Footnotes.module is designed such that it can be used together with Drupal's html filter,
  26. and in particular you should have footnotes first and html filter later.
  27. This version of Footnotes has been redesigned so that it only outputs html tags that
  28. are allowed in a default installation of HTML filter. (Tags used are A, OL and LI.)
  29. KNOWN ISSUES
  30. ----
  31. This version uses a new markup for the list of footnotes. It is an OL list with
  32. CSS taking away the browser generated list numbers and moving the link numbers
  33. towards the left. All IE versions have a bug that the numbers are slightly lower
  34. than the baseline of the footnote text. (If you know how to fix this, please tell.)
  35. In addition IE 5.5 has a more serious bug that the footnote number will be on top of
  36. the first letters of the footnote text. There doesn't seem to be a way to fix this.
  37. COPYRIGHT AND ACKNOWLEDGEMENTS
  38. ----
  39. Footnotes.module is copyrighted by Henrik Ingo. It is licensed by the same conditions as Drupal
  40. itself. (GPL license)
  41. Footnotes.module was originally created by henrik.ingo@avoinelama.fi ("hingo" on drupal.org)
  42. in the summer of 2006.
  43. The HTML footnotes were seriously enhanced by "beginner" (on drupal.org)
  44. and later on by other users comments and code snippets.
  45. Footnotes was originally developed for http://openlife.cc/onlinebook
  46. Beginner was the second to use it on his site at
  47. http://www.reuniting.info/wisdom/sources/metaphysical/a_course_in_miracles_sacred_sexuality_holy_relationship
  48. I wish to thank all contributors for letting me experience the miracle of maintaining an
  49. Open Source module living its own life!