You are here

README.txt in Flash Node 5.3

Same filename and directory in other branches
  1. 5.6 README.txt
  2. 5 README.txt
  3. 5.2 README.txt
  4. 6.3 README.txt
  5. 6.2 README.txt
FLASHNODE MODULE
----------------

Important
---------
If you have used a previous version of Flashnode that needed SWFTools then
you will find that Flashnode no longer appears as part of the SWFTools
group when installing or configuring. Although Flashnode can still use
SWFTools it is no longer dependent upon it and will work, in a limited
manner, without it. As a result the module appears under the 'Other' group
under Administer > Site building > Modules, while the configuration page is
now Administer > Site configuration > Flash node.

Description
-----------
Flashnode is designed to make it very easy to upload Flash content on to a
Drupal based website. When enabled it creates a new content type called
Flash so you can upload movies without writing any code or HTML.

Although Flashnode can put Flash on your pages using simple HTML this will
result in the 'Click here to activate and use this control' message in
Internet Explorer. Once you have Flashnode working it is recommended to
install the SWFTools module (drupal.org/project/swftools).

When SWFTools is available Flashnode will use it to do the actual insertion of
flash. SWFTools lets you choose the flash insertion method that you would like
to use and includes both direct embedding and a variety of javascript methods.

As of flashnode 5.3 you can also upload flv and mp3 files. This makes use
of the built in SWFTools media players to output audio and video content.
Simply upload your SWF or FLV file to Flashnode, and it will be rendered using
the default player. In this way you can use Flashnode as a very simple audio
or video module.

Note that although Flashnode will let you upload mp3 and flv files without
SWFTools being installed you will be unable to play the resulting content and
Flashnode will generate a warning message each time you view the node. Simply
install and configure SWFTools and the content will play.


Using flashnode
---------------
In its simplest form you simply create a flash node, upload a file, write
your body text as normal and hit submit, and the file will display.

You can set other parameters on the input form and these are found under
Basic flash node options and Advanced flash node options. The basic options
let you set whether the movie should appear in the teaser, body or both views,
and you can also adjust the movie size if required.

Advanced options let you change the substitution text that appears if using
a javascript insertion method, and you can also set flashvars and the base
parameter to correctly locate sub-movies.

If the node is using PHP input format then you can generate flashvars via
PHP code to make dynamic movies that receive data from the host website.

Flashnode also allows you to activate an additional input format that lets you
use a simple macro language to re-use flash content on other pages. These
take the form [flashnode|nid=nnn] and can be supplemented with parameters to
size and scale the content or pass different flashvars.

If you have used an earlier version of Flashnode or flash module please take
a look at UPDATE.txt for additional information.


Large files!
------------
Please note that if you are working with large files then you might exceed
the upload limit for your Drupal configuration. If this happens then when
you submit a flash node you might see a message asking you to upload a valid
file even though you provided an swf, mp3 or flv. If you see that message then
double check the file size, or try uploading a smaller file.

File

README.txt
View source
  1. FLASHNODE MODULE
  2. ----------------
  3. Important
  4. ---------
  5. If you have used a previous version of Flashnode that needed SWFTools then
  6. you will find that Flashnode no longer appears as part of the SWFTools
  7. group when installing or configuring. Although Flashnode can still use
  8. SWFTools it is no longer dependent upon it and will work, in a limited
  9. manner, without it. As a result the module appears under the 'Other' group
  10. under Administer > Site building > Modules, while the configuration page is
  11. now Administer > Site configuration > Flash node.
  12. Description
  13. -----------
  14. Flashnode is designed to make it very easy to upload Flash content on to a
  15. Drupal based website. When enabled it creates a new content type called
  16. Flash so you can upload movies without writing any code or HTML.
  17. Although Flashnode can put Flash on your pages using simple HTML this will
  18. result in the 'Click here to activate and use this control' message in
  19. Internet Explorer. Once you have Flashnode working it is recommended to
  20. install the SWFTools module (drupal.org/project/swftools).
  21. When SWFTools is available Flashnode will use it to do the actual insertion of
  22. flash. SWFTools lets you choose the flash insertion method that you would like
  23. to use and includes both direct embedding and a variety of javascript methods.
  24. As of flashnode 5.3 you can also upload flv and mp3 files. This makes use
  25. of the built in SWFTools media players to output audio and video content.
  26. Simply upload your SWF or FLV file to Flashnode, and it will be rendered using
  27. the default player. In this way you can use Flashnode as a very simple audio
  28. or video module.
  29. Note that although Flashnode will let you upload mp3 and flv files without
  30. SWFTools being installed you will be unable to play the resulting content and
  31. Flashnode will generate a warning message each time you view the node. Simply
  32. install and configure SWFTools and the content will play.
  33. Using flashnode
  34. ---------------
  35. In its simplest form you simply create a flash node, upload a file, write
  36. your body text as normal and hit submit, and the file will display.
  37. You can set other parameters on the input form and these are found under
  38. Basic flash node options and Advanced flash node options. The basic options
  39. let you set whether the movie should appear in the teaser, body or both views,
  40. and you can also adjust the movie size if required.
  41. Advanced options let you change the substitution text that appears if using
  42. a javascript insertion method, and you can also set flashvars and the base
  43. parameter to correctly locate sub-movies.
  44. If the node is using PHP input format then you can generate flashvars via
  45. PHP code to make dynamic movies that receive data from the host website.
  46. Flashnode also allows you to activate an additional input format that lets you
  47. use a simple macro language to re-use flash content on other pages. These
  48. take the form [flashnode|nid=nnn] and can be supplemented with parameters to
  49. size and scale the content or pass different flashvars.
  50. If you have used an earlier version of Flashnode or flash module please take
  51. a look at UPDATE.txt for additional information.
  52. Large files!
  53. ------------
  54. Please note that if you are working with large files then you might exceed
  55. the upload limit for your Drupal configuration. If this happens then when
  56. you submit a flash node you might see a message asking you to upload a valid
  57. file even though you provided an swf, mp3 or flv. If you see that message then
  58. double check the file size, or try uploading a smaller file.