/[drupal]/contributions/modules/attached_node/README.txt
ViewVC logotype

Diff of /contributions/modules/attached_node/README.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.2, Sat Oct 23 19:46:52 2004 UTC revision 1.3, Wed Dec 8 23:05:33 2004 UTC
# Line 1  Line 1 
1  $Id: README.txt,v 1.1 2004/10/18 18:00:39 javanaut Exp $  $Id: README.txt,v 1.2 2004/10/23 19:46:52 javanaut Exp $
2    
3    The attached_node module allows users to include a representation of a node within
4    the body of another node.  The content of a node can thus be embedded within a
5    Drupal page, or within a blog post, or with a box or DIV or any other HTML
6    statement.  The format of the representation of the embedded node depends on
7    stylesheet settings (see the attached_node class in
8    modules/attached_node/attached_node.css).
9    
10    A common use of this module is to embed image nodes within other HTML content. If
11    you have the image.module installed and properly configured this module is able to
12    display inline images with any node content.
13    
 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.  
14    
15    
16  INSTALLATION  INSTALLATION
17    
18  Unpack the attached_node distribution into the modules directory.  1. Unpack the attached_node distribution into the modules directory.
19    
20  Then, enable the attached_node module in the administer --> modules page  2. Enable the attached_node module in the administer --> modules page
21  of the admin section.  of the admin section.
22    
23  Go to the input filters page within the adminster section to configure a filter.  3. Once enabled, there will be new option within the "input formats" area of the
24    "administer" area of Drupal.  To get to it, go "input formats" (admin/filters), and
25    then click on the first "Configure" link, under "permissions and settings".  This is
26    the configure link for "filtered HTML".
27    
28    Within this page (admin/filters/1), be sure that the box for "Attached Node Filter -
29    Allows you to create meta tags that link to other nodes" is checked off.  Then click
30    the "Save configuration" button.
31    
32    Alternatively, you can pick whichever filter you want (not just "Filtered HTML") to
33    add attached_node functionality to.
34    
35    
36    WHAT IT DOES
37    
38    Once you have enabled the attached node filter as described above, you (or any user
39    who can post) can add an embedded reference to any page using the syntax:
40    
41  By default, the filter "Filtered HTML" is enabled to all users of the site.  If  [node:##]
 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.  
42    
43  Under the configuration section, click the checkbox on the "Attached Node Filter"  To do this, the page/node must be using "Filtered HTML" as its input format.  That
44  line, then click the "Save configuration" button.  can be set as the default, or it can be turned on a node by node basis.
45    
46    
47    
48    ADVANCED CONFIGURATION/USAGE
49    
50  If you want your users to be able to configure how the nodes are rendered, you  If you want your users to be able to configure how the nodes are rendered, you
51  can click on the "configure filters" tab.  Here, in the "Attached Nodes codes"  can click on the "configure filters" tab of the same "Filtered HTML" filter.
52  section, you can specify node properties that users are allowed to override. A  Here, in the "Attached Nodes codes" section, you can specify node properties
53  common thing to override is the "title" property.  that users are allowed to override. A common thing to override is the "title"
54    property.
55    
56  There is one exception to this, and that is for image nodes.  There is a parameter  There is one exception to this, and that is for image nodes.  There is a parameter
57  named "res" that users set to specify the resolution of the image to display.  named "res" that users set to specify the resolution of the image to display.
58  This has to match one of the pre-rendered resolutions configured on the image  This has to match one of the pre-rendered resolutions configured on the image
59  admin page.  admin page.
60    
 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.  
   
61  Click on the "rearrange filters" tab to set the order in which filters are  Click on the "rearrange filters" tab to set the order in which filters are
62  applied.  Since the Attached Node filter outputs HTML with line breaks and other  applied.  Since the Attached Node filter outputs HTML with line breaks and other
63  things, you'll probably want this filter to be the last one applied to the output.  things, you'll probably want this filter to be the last one applied to the output.
# Line 47  weight. The default is 10, which should Line 67  weight. The default is 10, which should
67  list (where it belongs).  list (where it belongs).
68    
69    
70  USAGE  ADVANCED USAGE
71    
72  The tag format is fairly simple.  The most basic tag would be in the following form:  The tag format is fairly simple.  The most basic tag would be in the following form:
73    
# Line 62  Note that the values must be encased in Line 82  Note that the values must be encased in
82  to include commas in the value.  The side effect is that double quotes cannot  to include commas in the value.  The side effect is that double quotes cannot
83  be used (currently) without causing problems.  be used (currently) without causing problems.
84    
85    Thanks to:
86    Rich Cowan for documentation suggestions and contributions.
87    
88    
89  Questions/comments/etc:  Questions/comments/etc:
90  mark@nullcraft.org  mark@nullcraft.org
91    
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3
  ViewVC Help
Powered by ViewVC 1.1.2