1 # Blosxom Plugin: uf_xfolk_meta
2 # Author(s): Gavin Carr <gavin@openfusion.com.au>
4 # Documentation: 'perldoc uf_xfolk_meta'
10 # Uncomment next line to enable debug output (don't uncomment debug() lines)
11 #use Blosxom::Debug debug_level => 1;
13 # --- Configurable variables -----
17 # URL to use as base URL for tag links
18 tagbase => "$blosxom::url/tags",
20 # Extra CSS classes to add to the microformat container e.g. to turn display off
22 #class => 'nodisplay',
24 # Whether to automatically add microformat to story bodies. If not set,
25 # you must explicitly add $uf_adr_meta::adr to a template somewhere.
26 auto_append_to_body => 1,
28 # What markup style to use for your adr, if auto-appending.
29 # 3 styles are currently defined:
30 # 'div-span' uses a 'div' elt for the container, and 'span' elements for the fields
31 # 'ul' uses a 'ul' list for the container, and 'li' elements for the fields
32 # 'dl' uses a 'dl' list for the container, 'dt' elements for field names, and
33 # 'dd' elements for the fields themselves
40 # --------------------------------
44 # Attributes which if set will cause us to skip this plugin (looks like an hcard)
45 my @skip_attr = qw(fn name);
47 $config{style} = 'div-span' unless $config{style} eq 'ul' or $config{style} eq 'dl';
51 # Return the first existing metadata item key and value given a list of keys
54 my $meta_attr = $attr;
55 $meta_attr =~ s/-/_/g;
56 my $value = $blosxom::meta{$meta_attr};
57 $value = eval "\$meta::$attr" unless defined $value;
58 return wantarray ? ( $attr, $value ) : $value if defined $value;
60 return wantarray ? () : undef;
64 my ($pkg, $path, $filename, $story_ref, $title_ref, $body_ref) = @_;
66 # Skip if any of the @skip_attr are set
68 return 1 if $blosxom::meta{$_} || eval "\$meta::$_";
71 my $story_style = _get_meta( 'xfolk_style' ) || $config{style};
72 my $ctag = $story_style eq 'div-span' ? 'div' : $story_style;
73 my $etag = $story_style eq 'div-span' ? 'span' :
74 $story_style eq 'ul' ? 'li' : 'dd';
77 my $url = _get_meta('url', 'taggedlink');
78 my $title = _get_meta('title');
79 my $tags = _get_meta('tags');
80 my $description = _get_meta('description');
81 return 1 unless defined $url && defined $title;
84 my $container_classes = 'xfolkentry';
85 if (my $meta_class = _get_meta('xfolk_class')) {
86 $container_classes .= " $meta_class";
89 $container_classes .= " $config{class}" if $config{class};
91 $xfolk .= qq(<$ctag class="$container_classes">\n);
92 $xfolk .= qq(<dt>URL</dt>) if $story_style eq 'dl';
93 $xfolk .= qq(<$etag class="xfolk_link"><a class="taggedlink" href="$url" title="$title">$title</a></$etag>\n);
95 $xfolk .= qq(<dt>Tags</dt>) if $story_style eq 'dl';
96 $xfolk .= qq(<$etag class="xfolk_tags">);
98 for (split /\s*,\s*/, $tags) {
99 push @tags, qq(<a rel="tag" href="$config{tagbase}/$_">$_</a>);
101 $xfolk .= join ', ', @tags if @tags;
102 $xfolk .= qq(</$etag>\n);
105 $xfolk .= qq(<dt>Description</dt>) if $story_style eq 'dl';
106 $xfolk .= qq(<$etag class="description">$description</$etag>\n)
108 $xfolk .= qq(</$ctag>\n);
109 # debug(1, "uf_xfolk_meta: $xfolk\n");
111 my $autoappend = _get_meta( 'xfolk_autoappend' );
112 $autoappend = $config{auto_append_to_body} unless defined $autoappend;
113 return 1 unless $autoappend;
115 $$body_ref .= "\n\n$xfolk\n\n";
126 uf_xfolk_meta - plugin to create a 'xfolk' (bookmark) microformat tag
131 uf_xfolk_meta is a plugin to create an 'xfolk' (bookmark) microformat tag
132 from metadata in your post. The microformat tag is created in the
133 $uf_xfolk_meta::xfolk variable for use in templates or by other plugins,
134 or if the 'auto_append_to_body' config variable is set (it is by default),
135 uf_xfolk_meta will append the tag to your story body automatically.
137 =head2 REQUIRED METADATA ITEMS
141 =item url (or taggedlink)
143 The URL for the bookmarked page.
147 The title to use for the bookmarked page.
151 If any required metadata is missing the plugin just skips the story.
153 =head2 OPTIONAL METADATA ITEMS
159 Comma-separated list of tags applying to the bookmarked page.
163 Description or summary of the bookmarked page.
167 =head2 Config Elements
169 uf_xfolk_meta also supports a couple of config elements that can be used to
170 override plugin config data on a per-story basis:
174 =item XFolk-Class (metamail) / xfolk_class (meta)
176 This class (or list of classes) is appended to the class list applied to the
177 top-level xfolk element in the rendered xfolk i.e. it overrides the
178 'class' config variable.
180 =item XFolk-Autoappend (metamail) / xfolk_autoappend (meta)
182 This is a flag (0 or 1) indicating whether the rendered xfolk should be
183 automatically appended to the story body. It overrides the 'auto_append_to_body'
186 =item XFolk-Style (metamail) / xfolk_style (meta)
188 One of the following styles: 'div-span', 'ul', 'dl', used to render the xfolk.
189 It overrides the 'style' config variable.
195 uf_xfolk_meta should be loaded after the meta plugins (meta
196 itself, or the metaclear/metamail/metadir/metafile family).
200 Microformats.org: http://www.microformats.org/, http://microformats.org/wiki/xfolk.
202 Blosxom: http://blosxom.sourceforge.net/
206 Gavin Carr <gavin@openfusion.com.au>, http://www.openfusion.net/
210 Copyright 2007, Gavin Carr.
212 This plugin is licensed under the same terms as blosxom itself i.e.
214 Permission is hereby granted, free of charge, to any person obtaining a
215 copy of this software and associated documentation files (the "Software"),
216 to deal in the Software without restriction, including without limitation
217 the rights to use, copy, modify, merge, publish, distribute, sublicense,
218 and/or sell copies of the Software, and to permit persons to whom the
219 Software is furnished to do so, subject to the following conditions:
221 The above copyright notice and this permission notice shall be included
222 in all copies or substantial portions of the Software.
224 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
225 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
226 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
227 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
228 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
229 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
230 OTHER DEALINGS IN THE SOFTWARE.