You are here

Home » API reference » Footnotes 6.2

README.txt in Footnotes 6.2

Same filename in this branch
  1. 6.2 README.txt
  2. 6.2 tinymce_footnotes/README.txt
  3. 6.2 footnotes_wysiwyg/README.txt
Same filename and directory in other branches
  1. 7.3 footnotes_wysiwyg/README.txt
  2. 7.2 footnotes_wysiwyg/README.txt
Footnotes Wysiwyg 6.x-0.1
--------------------
Installation Instructions:
1. Make sure you have enabled wither the WYSIWYG or CKEditor module. Otherwise
nothing will happen.
2. Enable the module in /admin/build/modules
3. Enable the "Add Footnote" button in the WYSIWYG or CKEditor module settings.

Note: If you are using the CKEditor module, in addition to adding the button
you must also check the 'Add Footnotes' checkbox for the 'Plugins' setting.


TinyMCE
----------------------
The TinyMCE plugin provides a simple dialog to enter footnote text that will be 
inserted as a [fn]square bracket[/fn] footnote into the text. (Ie the tags and
text are visible as is in your text.)

This is all the plugin currently does. Existing footnotes must be edited in
text, you cannot reopen them in the dialog. The value= attribute is not supported,
again, you must write it manually into the tag.

The plugin reuses the tiny_mce_popup.js - you can also point this at the 
tiny_mce_popup.js that resides in the tinymce/jscripts/tiny_mce directory of your 
Wysiwyg install by changing the file footnote.htm's <script> tag where the 
tiny_mce_popup.js is added.


CKEditor
------------------------
This is a rather sophisticated plugin to show a dialog to insert
<fn> footnotes or edit existing ones. It produces and understands
the <fn>angle bracket</fn> variant and uses the fakeObjects API to
show a nice icon to the user, while producing proper <fn> tags when 
the text is saved or View Source is pressed. 

If a text contains footnotes of the [fn]square bracket[/fn] variant, 
they will be visible in the text and this plugin will not react to them.

This plugin uses Drupal.t() to translate strings and will not as such
work outside of Drupal. (But removing those function calls would be the only
change needed.) While being part of a Wysiwyg compatible module, it could 
also be used together with the CKEditor module. 


Credits
---------------------

Original author (TinyMCE): elgreg
Port to Drupal 6.x: hingo
CKEditor support: Owen Barton

Known issues
----------------------

Translation is currently not implemented. See http://drupal.org/node/672034
The few strings that would need translation are found in tinymce_plugin/footnote.(htm|js)

File

footnotes_wysiwyg/README.txt
View source 
  1. Footnotes Wysiwyg 6.x-0.1

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

  3. Installation Instructions:

  4. 1. Make sure you have enabled wither the WYSIWYG or CKEditor module. Otherwise

  5. nothing will happen.

  6. 2. Enable the module in /admin/build/modules

  7. 3. Enable the "Add Footnote" button in the WYSIWYG or CKEditor module settings.

  8. 

  9. Note: If you are using the CKEditor module, in addition to adding the button

  10. you must also check the 'Add Footnotes' checkbox for the 'Plugins' setting.

  11. 

  12. 

  13. TinyMCE

  14. ----------------------

  15. The TinyMCE plugin provides a simple dialog to enter footnote text that will be 

  16. inserted as a [fn]square bracket[/fn] footnote into the text. (Ie the tags and

  17. text are visible as is in your text.)

  18. 

  19. This is all the plugin currently does. Existing footnotes must be edited in

  20. text, you cannot reopen them in the dialog. The value= attribute is not supported,

  21. again, you must write it manually into the tag.

  22. 

  23. The plugin reuses the tiny_mce_popup.js - you can also point this at the 

  24. tiny_mce_popup.js that resides in the tinymce/jscripts/tiny_mce directory of your 

  25. Wysiwyg install by changing the file footnote.htm's