README.txt 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. Footnotes Wysiwyg
  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/modules
  7. 3. Enable the "Add Footnote" button in the WYSIWYG or CKEditor module settings.
  8. Note: If you are using the CKEditor module, in addition to adding the button
  9. you must also check the 'Add Footnotes' checkbox for the 'Plugins' setting.
  10. TinyMCE
  11. ----------------------
  12. The TinyMCE plugin provides a simple dialog to enter footnote text that will be
  13. inserted as a [fn]square bracket[/fn] footnote into the text. (Ie the tags and
  14. text are visible as is in your text.)
  15. This is all the plugin currently does. Existing footnotes must be edited in
  16. text, you cannot reopen them in the dialog. The value= attribute is not supported,
  17. again, you must write it manually into the tag.
  18. The plugin reuses the tiny_mce_popup.js - you can also point this at the
  19. tiny_mce_popup.js that resides in the tinymce/jscripts/tiny_mce directory of your
  20. Wysiwyg install by changing the file footnote.htm's <script> tag where the
  21. tiny_mce_popup.js is added.
  22. CKEditor
  23. ------------------------
  24. Note: The recommended CKEditor version that this plugin is known to work
  25. correctly with is CKEditor 3.3.1. Some newer versions (in particular 3.5.2 has
  26. been tested) only partially work. See known issues.
  27. This is a rather sophisticated plugin to show a dialog to insert
  28. <fn> footnotes or edit existing ones. It produces and understands
  29. the <fn>angle bracket</fn> variant and uses the fakeObjects API to
  30. show a nice icon to the user, while producing proper <fn> tags when
  31. the text is saved or View Source is pressed.
  32. If a text contains footnotes of the [fn]square bracket[/fn] variant,
  33. they will be visible in the text and this plugin will not react to them.
  34. This plugin uses Drupal.t() to translate strings and will not as such
  35. work outside of Drupal. (But removing those function calls would be the only
  36. change needed.) While being part of a Wysiwyg compatible module, it could
  37. also be used together with the CKEditor module.
  38. Credits
  39. ---------------------
  40. Original author (TinyMCE): elgreg
  41. Port to Drupal 6.x: hingo
  42. CKEditor support: Owen Barton
  43. Known issues
  44. ----------------------
  45. Translation is currently not implemented. See http://drupal.org/node/672034
  46. The few strings that would need translation are found in tinymce_plugin/footnote.(htm|js)
  47. The Footnotes CKEditor plugin has been verified to work on CKEditor 3.3.1. On
  48. newer versions, in particular 3.5.2 there is a bug that when right clicking on
  49. an existing footnote, the "Edit footnote" entry is missing from the context
  50. menu. Also, if one then clicks on the "Add footnote" toolbar button, the values
  51. of the existing footnote are not shown in the dialog box, rather a new, empty
  52. footnote dialog is shown. If "Ok" is clicked, the old footnote is lost and
  53. replaced with the empty or new values.