modules/inline/README.txt

/* $Id: README.txt,v 1.10 2009/01/28 21:43:05 sun Exp $ */

-- SUMMARY --

Inline module allows you to display files uploaded with the current node
inline, i.e. with a link to the original file, using special tags. The tags
will be replaced with links to the corresponding files. If a tag refers to an
image, it will be replaced with the image.

Inline module does not attempt to resize a images. It assumes that the user 
will optimize the size and resolution of images prior to uploading it. A
configuration setting of this module allows to specify the maximum display
width and height for inline images. If the original image is not bigger than
the maximum width and height, it will be displayed as-is, otherwise its
dimensions will be recalculated, maintaining the same aspect ratio.

For a full description visit the project page:
  http://drupal.org/project/inline
Bug reports, feature suggestions and latest developments:
  http://drupal.org/project/issues/inline


-- REQUIREMENTS --

* Upload module (Drupal core)

* ImageCache (optional)


-- INSTALLATION --

* Install as usual, see http://drupal.org/node/70151 for further information.


-- CONFIGURATION --

* Enable "Inline content" in the input formats you intend to use. To do this, go
  to Administer >> Input formats and click on one of the "Configure" links. For
  instance, you can click on the "Configure" link for "Filtered HTML" and then
  you will see a list of filters including "Inline content". Turn that on and
  click on "Save".

* When using the optional Inline Upload module:

  Go to Administer >> Site configuration >> Inline and edit the maximum width
  and height for inline images.  If an image exceeds those dimensions, it will
  be displayed as text link to download (like any other attachment than images).

  Please note that this configuration setting no longer applies if the optional
  ImageCache module is installed.


-- USAGE --

* For more details on using the module, see the help text by clicking:
  /filter/tips/1#filter-inline after you install it.

  [inline_upload|file=#|title=Custom title text]
  or
  [inline_upload|file=filename.ext|title=Any title]

  You can specify the file you want to display in two ways:
  - specifying #, which will display the #th uploaded file
  - specifying filename

  If the file is not found, a 'NOT FOUND' message will be output.

  Specifying the file by number can cause problems if files are deleted or
  changed. In this case, specifying by name is recommended.

  You can also specify a title for the file, by using an optional 'title=Title'
  parameter. In this case, it will be used as a title for the file link or as
  an ALT tag for an image. If no title is specified, the file name is used as
  title.


-- EXAMPLES --

* Suppose you uploaded three files (in this order):
  - imag1.png (referred as file #1)
  - file2.pdf (referred as file #2)
  - imag3.png (referred as file #3)

* [inline_upload|file=2] or
  [inline_upload|file=file2.pdf]
  will be replaced with <a href="file2.pdf">file2.pdf</a>

* [inline_upload|file=1|title=test] or
  [inline_upload|file=imag1.png|title=test]
  will be replaced with <img src="imag1.png" alt="test" />


-- CONTACT --

Current maintainers:
* Daniel F. Kudwien (sun) - dev@unleashedmind.com

Previous maintainers:
* Richard Archer (Richard Archer) - http://www.juggernaut.com.au
* Matteo Ferrari (matteo) - webmaster@cantincoro.org

This project has been sponsored by:
* UNLEASHED MIND
  Specialized in consulting and planning of Drupal powered sites, UNLEASHED
  MIND offers installation, development, theming, customization, and hosting
  to get you started. Visit http://www.unleashedmind.com for more information.

1	/* $Id: README.txt,v 1.10 2009/01/28 21:43:05 sun Exp $ */
2
3	-- SUMMARY --
4
5	Inline module allows you to display files uploaded with the current node
6	inline, i.e. with a link to the original file, using special tags. The tags
7	will be replaced with links to the corresponding files. If a tag refers to an
8	image, it will be replaced with the image.
9
10	Inline module does not attempt to resize a images. It assumes that the user
11	will optimize the size and resolution of images prior to uploading it. A
12	configuration setting of this module allows to specify the maximum display
13	width and height for inline images. If the original image is not bigger than
14	the maximum width and height, it will be displayed as-is, otherwise its
15	dimensions will be recalculated, maintaining the same aspect ratio.
16
17	For a full description visit the project page:
18	http://drupal.org/project/inline
19	Bug reports, feature suggestions and latest developments:
20	http://drupal.org/project/issues/inline
21
22
23	-- REQUIREMENTS --
24
25	* Upload module (Drupal core)
26
27	* ImageCache (optional)
28
29
30	-- INSTALLATION --
31
32	* Install as usual, see http://drupal.org/node/70151 for further information.
33
34
35	-- CONFIGURATION --
36
37	* Enable "Inline content" in the input formats you intend to use. To do this, go
38	to Administer >> Input formats and click on one of the "Configure" links. For
39	instance, you can click on the "Configure" link for "Filtered HTML" and then
40	you will see a list of filters including "Inline content". Turn that on and
41	click on "Save".
42
43	* When using the optional Inline Upload module:
44
45	Go to Administer >> Site configuration >> Inline and edit the maximum width
46	and height for inline images. If an image exceeds those dimensions, it will
47	be displayed as text link to download (like any other attachment than images).
48
49	Please note that this configuration setting no longer applies if the optional
50	ImageCache module is installed.
51
52
53	-- USAGE --
54
55	* For more details on using the module, see the help text by clicking:
56	/filter/tips/1#filter-inline after you install it.
57
58	[inline_upload\|file=#\|title=Custom title text]
59	or
60	[inline_upload\|file=filename.ext\|title=Any title]
61
62	You can specify the file you want to display in two ways:
63	- specifying #, which will display the #th uploaded file
64	- specifying filename
65
66	If the file is not found, a 'NOT FOUND' message will be output.
67
68	Specifying the file by number can cause problems if files are deleted or
69	changed. In this case, specifying by name is recommended.
70
71	You can also specify a title for the file, by using an optional 'title=Title'
72	parameter. In this case, it will be used as a title for the file link or as
73	an ALT tag for an image. If no title is specified, the file name is used as
74	title.
75
76
77	-- EXAMPLES --
78
79	* Suppose you uploaded three files (in this order):
80	- imag1.png (referred as file #1)
81	- file2.pdf (referred as file #2)
82	- imag3.png (referred as file #3)
83
84	* [inline_upload\|file=2] or
85	[inline_upload\|file=file2.pdf]
86	will be replaced with <a href="file2.pdf">file2.pdf</a>
87
88	* [inline_upload\|file=1\|title=test] or
89	[inline_upload\|file=imag1.png\|title=test]
90	will be replaced with <img src="imag1.png" alt="test" />
91
92
93	-- CONTACT --
94
95	Current maintainers:
96	* Daniel F. Kudwien (sun) - dev@unleashedmind.com
97
98	Previous maintainers:
99	* Richard Archer (Richard Archer) - http://www.juggernaut.com.au
100	* Matteo Ferrari (matteo) - webmaster@cantincoro.org
101
102	This project has been sponsored by:
103	* UNLEASHED MIND
104	Specialized in consulting and planning of Drupal powered sites, UNLEASHED
105	MIND offers installation, development, theming, customization, and hosting
106	to get you started. Visit http://www.unleashedmind.com for more information.
107