modules/attached_node/README.txt

$Id: README.txt,v 1.1 2004/10/18 18:00:39 javanaut Exp $

The attached_node module allows users to include a reference to a node within
the body of another node.  Textually, this appears in the body text as a type
of tag.  This tag is translated by a filter into a teaser version of the node
being referenced.


INSTALLATION

Unpack the attached_node distribution into the modules directory.

Then, enable the attached_node module in the administer --> modules page 
of the admin section.

Go to the input filters page within the adminster section to configure a filter.

By default, the filter "Filtered HTML" is enabled to all users of the site.  If
you wanted to allow all users of the site to use the attached_node functionality,
click "configure" under the Operations column of this table.  Alternatively,
you can pick whichever filter you want to add attached_node functionality to.

Under the configuration section, click the checkbox on the "Attached Node Filter"
line, then click the "Save configuration" button.

If you want your users to be able to configure how the nodes are rendered, you
can click on the "configure filters" tab.  Here, in the "Attached Nodes codes"
section, you can specify node properties that users are allowed to override. A
common thing to override is the "title" property.

There is one exception to this, and that is for image nodes.  There is a parameter
named "res" that users set to specify the resolution of the image to display.
This has to match one of the pre-rendered resolutions configured on the image
admin page.

If things go haywire on your site with attached_nodes, you can pull the plug on
output filtering by unchecking the "Enable Attached Node codes" checkbox and
clicking the "Save configuration" button.  This was originally for development
purposes, but was left in for the occasional odd situation.

Click on the "rearrange filters" tab to set the order in which filters are
applied.  Since the Attached Node filter outputs HTML with line breaks and other
things, you'll probably want this filter to be the last one applied to the output.
If, for instance, the HTML filter is run after the Attached Node filter, then
much of the output could be rearranged or removed.  Just give it a large (heavy)
weight.  The default is 10, which should send it to the bottom of the 
list (where it belongs).


USAGE

The tag format is fairly simple.  The most basic tag would be in the following form:

      [node:<node id>]

Parameters follow the <node id> part and are comma separated name="value" pairs:

      [node:123,res="640x480"]
      [node:123,res="original",title="Original version of the picture"]

Note that the values must be encased in double quotes.  This is to allow users
to include commas in the value.  The side effect is that double quotes cannot
be used (currently) without causing problems.

Questions/comments/etc:
mark@nullcraft.org

Mark Howell
(javanaut)
1	javanaut	1.2	$Id: README.txt,v 1.1 2004/10/18 18:00:39 javanaut Exp $
2
3			The attached_node module allows users to include a reference to a node within
4			the body of another node. Textually, this appears in the body text as a type
5			of tag. This tag is translated by a filter into a teaser version of the node
6			being referenced.
7
8
9			INSTALLATION
10
11			Unpack the attached_node distribution into the modules directory.
12
13			Then, enable the attached_node module in the administer --> modules page
14			of the admin section.
15
16			Go to the input filters page within the adminster section to configure a filter.
17
18			By default, the filter "Filtered HTML" is enabled to all users of the site. If
19			you wanted to allow all users of the site to use the attached_node functionality,
20			click "configure" under the Operations column of this table. Alternatively,
21			you can pick whichever filter you want to add attached_node functionality to.
22
23			Under the configuration section, click the checkbox on the "Attached Node Filter"
24			line, then click the "Save configuration" button.
25
26			If you want your users to be able to configure how the nodes are rendered, you
27			can click on the "configure filters" tab. Here, in the "Attached Nodes codes"
28			section, you can specify node properties that users are allowed to override. A
29			common thing to override is the "title" property.
30
31			There is one exception to this, and that is for image nodes. There is a parameter
32			named "res" that users set to specify the resolution of the image to display.
33			This has to match one of the pre-rendered resolutions configured on the image
34			admin page.
35
36			If things go haywire on your site with attached_nodes, you can pull the plug on
37			output filtering by unchecking the "Enable Attached Node codes" checkbox and
38			clicking the "Save configuration" button. This was originally for development
39			purposes, but was left in for the occasional odd situation.
40
41			Click on the "rearrange filters" tab to set the order in which filters are
42			applied. Since the Attached Node filter outputs HTML with line breaks and other
43			things, you'll probably want this filter to be the last one applied to the output.
44			If, for instance, the HTML filter is run after the Attached Node filter, then
45			much of the output could be rearranged or removed. Just give it a large (heavy)
46			weight. The default is 10, which should send it to the bottom of the
47			list (where it belongs).
48
49
50			USAGE
51
52			The tag format is fairly simple. The most basic tag would be in the following form:
53
54			[node:<node id>]
55
56			Parameters follow the <node id> part and are comma separated name="value" pairs:
57
58			[node:123,res="640x480"]
59			[node:123,res="original",title="Original version of the picture"]
60
61			Note that the values must be encased in double quotes. This is to allow users
62			to include commas in the value. The side effect is that double quotes cannot
63			be used (currently) without causing problems.
64
65			Questions/comments/etc:
66			mark@nullcraft.org
67
68			Mark Howell
69			(javanaut)