openguides-commits August 2012

openguides-commits@lists.openguides.org

1 participants
13 discussions

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-08-19 10:13:28 +0100 (Sun, 19 Aug 2012) New Revision: 1435 Modified: trunk/Build.PL trunk/Changes trunk/lib/OpenGuides/Utils.pm Log: Added new allowed elements (fixes #303), changed external link formatting as discussed on openguides-dev. Modified: trunk/Build.PL =================================================================== --- trunk/Build.PL 2012-08-17 16:24:05 UTC (rev 1434) +++ trunk/Build.PL 2012-08-19 09:13:28 UTC (rev 1435) @@ -302,7 +302,7 @@ 'Wiki::Toolkit' => '0.80', 'Wiki::Toolkit::Feed::Atom' => 0, 'Wiki::Toolkit::Feed::RSS' => 0, - 'Wiki::Toolkit::Formatter::UseMod' => 0, + 'Wiki::Toolkit::Formatter::UseMod' => 0.24, #for external_link_class 'Wiki::Toolkit::Plugin::Categoriser' => 0, 'Wiki::Toolkit::Plugin::Diff' => 0, 'Wiki::Toolkit::Plugin::JSON' => 0, Modified: trunk/Changes =================================================================== --- trunk/Changes 2012-08-17 16:24:05 UTC (rev 1434) +++ trunk/Changes 2012-08-19 09:13:28 UTC (rev 1435) @@ -4,8 +4,23 @@ <http://dev.openguides.org/log/trunk>. 0.70 ? + New elements allowed in page content: span, dl, dt, dd (fixes #303). + Changed external link formatting; they're now given a class of + "external" and the previous hardcoded square brackets are no more. + If you want the old behaviour back, put this in your CSS (with + "black" replaced by whatever colour you have your body text in): + a.external:before { + content: "["; + color: black; + } + + a.external:after { + content: "]"; + color: black; + } Updated URLs for Leaflet JavaScript and CSS. - Added meta descriptions to headers of map and list index pages. + Added meta descriptions to headers of map and list index pages + (fixes #301). Implemented new @INDEX_LIST_NO_PREFIX macro. 0.69 07 July 2012 Modified: trunk/lib/OpenGuides/Utils.pm =================================================================== --- trunk/lib/OpenGuides/Utils.pm 2012-08-17 16:24:05 UTC (rev 1434) +++ trunk/lib/OpenGuides/Utils.pm 2012-08-19 09:13:28 UTC (rev 1435) @@ -230,12 +230,14 @@ implicit_links => 0, allowed_tags => [qw(a p b strong i em pre small img table td tr th br hr ul li center blockquote kbd - div code strike sub sup font)], + div code span strike sub sup font dl dt dd + )], macros => \%macros, pass_wiki_to_macros => 1, node_prefix => "$script_name?", edit_prefix => "$script_name?action=edit;id=", munge_urls => 1, + external_link_class => "external", ); my %conf = ( store => $store,

10 years, 7 months

r1434 - in trunk: . lib/OpenGuides t

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-08-17 17:24:05 +0100 (Fri, 17 Aug 2012) New Revision: 1434 Modified: trunk/Changes trunk/lib/OpenGuides/Utils.pm trunk/t/102_macros.t Log: Implemented new @INDEX_LIST_NO_PREFIX macro. Modified: trunk/Changes =================================================================== --- trunk/Changes 2012-08-17 15:36:57 UTC (rev 1433) +++ trunk/Changes 2012-08-17 16:24:05 UTC (rev 1434) @@ -6,6 +6,7 @@ 0.70 ? Updated URLs for Leaflet JavaScript and CSS. Added meta descriptions to headers of map and list index pages. + Implemented new @INDEX_LIST_NO_PREFIX macro. 0.69 07 July 2012 The output of the "show_missing_metadata" action is now alphabetised. Modified: trunk/lib/OpenGuides/Utils.pm =================================================================== --- trunk/lib/OpenGuides/Utils.pm 2012-08-17 15:36:57 UTC (rev 1433) +++ trunk/lib/OpenGuides/Utils.pm 2012-08-17 16:24:05 UTC (rev 1434) @@ -137,33 +137,16 @@ qr/\@INDEX_LIST\s+\[\[(Category|Locale)\s+([^\]]+)]]/ => sub { my ($wiki, $type, $value) = @_; - - # We may be being called by Wiki::Toolkit::Plugin::Diff, - # which doesn't know it has to pass us $wiki - unless ( UNIVERSAL::isa( $wiki, "Wiki::Toolkit" ) ) { - return "(unprocessed INDEX_LIST macro)"; - } - - my @nodes = sort $wiki->list_nodes_by_metadata( - metadata_type => $type, - metadata_value => $value, - ignore_case => 1, - ); - unless ( scalar @nodes ) { - return "\n* No pages currently in " - . lc($type) . " $value\n"; - } - my $return = "\n"; - foreach my $node ( @nodes ) { - $return .= "* " - . $wiki->formatter->format_link( - wiki => $wiki, - link => $node, - ) - . "\n"; - } - return $return; + return $class->do_index_list_macro( + wiki => $wiki, type => $type, value => $value, + include_prefix => 1 ); }, + qr/\@INDEX_LIST_NO_PREFIX\s+\[\[(Category|Locale)\s+([^\]]+)]]/ => + sub { + my ($wiki, $type, $value) = @_; + return $class->do_index_list_macro( + wiki => $wiki, type => $type, value => $value ); + }, qr/\@MAP_LINK\s+\[\[(Category|Locale)\s+([^\]|]+)\|?([^\]]+)?\]\]/ => sub { if ( UNIVERSAL::isa( $_[0], "Wiki::Toolkit" ) ) { @@ -263,6 +246,41 @@ return $wiki; } +sub do_index_list_macro { + my ( $class, %args ) = @_; + my ( $wiki, $type, $value, $include_prefix ) + = @args{ qw( wiki type value include_prefix ) }; + + # We may be being called by Wiki::Toolkit::Plugin::Diff, + # which doesn't know it has to pass us $wiki + if ( !UNIVERSAL::isa( $wiki, "Wiki::Toolkit" ) ) { + if ( $args{include_prefix} ) { + return "(unprocessed INDEX_LIST macro)"; + } else { + return "(unprocessed INDEX_LIST_NO_PREFIX macro)"; + } + } + + my @nodes = sort $wiki->list_nodes_by_metadata( + metadata_type => $type, + metadata_value => $value, + ignore_case => 1, + ); + unless ( scalar @nodes ) { + return "\n* No pages currently in " . lc($type) . " $value\n"; + } + my $return = "\n"; + foreach my $node ( @nodes ) { + my $title = $node; + $title =~ s/^(Category|Locale) // unless $args{include_prefix}; + $return .= "* " + . $wiki->formatter->format_link( wiki => $wiki, + link => "$node|$title" ) + . "\n"; + } + return $return; +} + =item B<get_wgs84_coords> Returns coordinate data suitable for use with Google Maps (and other GIS Modified: trunk/t/102_macros.t =================================================================== --- trunk/t/102_macros.t 2012-08-17 15:36:57 UTC (rev 1433) +++ trunk/t/102_macros.t 2012-08-17 16:24:05 UTC (rev 1434) @@ -11,7 +11,7 @@ plan skip_all => "DBD::SQLite could not be used - no database to test with. ($error)"; } -plan tests => 19; +plan tests => 27; SKIP: { # Clear out the database from any previous runs. @@ -22,35 +22,42 @@ my $wiki = $guide->wiki; # Test @INDEX_LINK - $wiki->write_node( "Test 1", "\@INDEX_LINK [[Category Foo]]" ) + $wiki->write_node( "Category Alpha", "\@INDEX_LINK [[Category Alpha]]", + undef, { category => "category" } ) or die "Can't write node"; - $wiki->write_node( "Test 2", "\@INDEX_LINK [[Category Bar|Bars]]" ) + + $wiki->write_node( "Category Beta", "\@INDEX_LINK [[Category Beta|Betas]]", + undef, { category => "category" } ) or die "Can't write node"; my $output; $output = $guide->display_node( return_output => 1, - id => "Test 1", + id => "Category Alpha", ); - like( $output, qr/View all pages in Category Foo/, + like( $output, qr/View all pages in Category Alpha/, "\@INDEX_LINK has right default link text" ); - like( $output, qr/action=index;cat=foo/, "...and URL looks right" ); + like( $output, qr/action=index;cat=alpha/, "...and URL looks right" ); $output = $guide->display_node( return_output => 1, - id => "Test 2", + id => "Category Beta", ); - like( $output, qr/>Bars<\/a>/, "Default link text can be overridden" ); - like( $output, qr/action=index;cat=bar/, "...and URL looks right" ); + like( $output, qr/>Betas<\/a>/, "Default link text can be overridden" ); + like( $output, qr/action=index;cat=beta/, "...and URL looks right" ); # Test @INDEX_LIST - $wiki->write_node( "Test 3", "\@INDEX_LIST [[Category Foo]]" ) + $wiki->write_node( "Category Foo", "\@INDEX_LIST [[Category Foo]]", + undef, { category => "category" } ) or die "Can't write node"; - $wiki->write_node( "Test 4", "\@INDEX_LIST [[Locale Bar]]" ) + $wiki->write_node( "Locale Bar", "\@INDEX_LIST [[Locale Bar]]", + undef, { category => "locales" } ) or die "Can't write node"; - $wiki->write_node( "Test 5", "\@INDEX_LIST [[Category Nonexistent]]" ) + $wiki->write_node( "Category Empty", "\@INDEX_LIST [[Category Empty]]", + undef, { category => "foo" } ) or die "Can't write node"; - $wiki->write_node( "Test 6", "\@INDEX_LIST [[Locale Nonexistent]]" ) + $wiki->write_node( "Locale Empty", "\@INDEX_LIST [[Locale Empty]]", + undef, { locale => "bar" } ) or die "Can't write node"; $wiki->write_node( "Wibble", "wibble", undef, { @@ -59,31 +66,90 @@ } ) or die "Can't write node"; + $output = $guide->display_node( return_output => 1, - id => "Test 3", + id => "Category Foo", ); like ( $output, qr|<a href=".*">Wibble</a>|, - '@INDEX_LIST works for categories' ); + '@INDEX_LIST works for regular pages in categories' ); + like ( $output, qr|<a href=".*">Category Empty</a>|, + '...and for category pages in categories' ); $output = $guide->display_node( return_output => 1, - id => "Test 5", + id => "Category Empty", ); like ( $output, qr|No pages currently in category|, "...and fails nicely if no pages in category" ); $output = $guide->display_node( return_output => 1, - id => "Test 4", + id => "Locale Bar", ); like ( $output, qr|<a href=".*">Wibble</a>|, - '@INDEX_LIST works for locales' ); + '@INDEX_LIST works for regular pages in locales' ); + like ( $output, qr|<a href=".*">Locale Empty</a>|, + '...and for locale pages in locales' ); $output = $guide->display_node( return_output => 1, - id => "Test 6", + id => "Locale Empty", ); like ( $output, qr|No pages currently in locale|, "...and fails nicely if no pages in locale" ); + # Test @INDEX_LIST_NO_PREFIX + $wiki->write_node( "Category Foo NP", + "\@INDEX_LIST_NO_PREFIX [[Category Foo NP]]", + undef, { category => "category" } ) + or die "Can't write node"; + $wiki->write_node( "Locale Bar NP", + "\@INDEX_LIST_NO_PREFIX [[Locale Bar NP]]", + undef, { category => "locales" } ) + or die "Can't write node"; + $wiki->write_node( "Category Empty NP", + "\@INDEX_LIST_NO_PREFIX [[Category Empty NP]]", + undef, { category => "foo np" } ) + or die "Can't write node"; + $wiki->write_node( "Locale Empty NP", + "\@INDEX_LIST_NO_PREFIX [[Locale Empty NP]]", + undef, { locale => "bar np" } ) + or die "Can't write node"; + $wiki->write_node( "Wibble NP", "wibble", undef, + { + category => "foo np", + locale => "bar np", + } + ) + or die "Can't write node"; + + $output = $guide->display_node( + return_output => 1, + id => "Category Foo NP", + ); + like ( $output, qr|<a href=".*">Wibble NP</a>|, + '@INDEX_LIST_NO_PREFIX works for regular pages in categories' ); + like ( $output, qr|<a href=".*">Empty NP</a>|, + '...and for category pages in categories' ); + $output = $guide->display_node( + return_output => 1, + id => "Category Empty NP", + ); + like ( $output, qr|No pages currently in category|, + "...and fails nicely if no pages in category" ); + $output = $guide->display_node( + return_output => 1, + id => "Locale Bar NP", + ); + like ( $output, qr|<a href=".*">Wibble NP</a>|, + '@INDEX_LIST_NO_PREFIX works for regular pages in locales' ); + like ( $output, qr|<a href=".*">Empty NP</a>|, + '...and for locale pages in locales' ); + $output = $guide->display_node( + return_output => 1, + id => "Locale Empty NP", + ); + like ( $output, qr|No pages currently in locale|, + "...and fails nicely if no pages in locale" ); + # Test @MAP_LINK OpenGuides::Test->write_data( guide => $guide,

10 years, 7 months

r1433 - in trunk: . lib lib/OpenGuides t templates

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-08-17 16:36:57 +0100 (Fri, 17 Aug 2012) New Revision: 1433 Added: trunk/t/410_meta_description.t Modified: trunk/Changes trunk/MANIFEST trunk/lib/OpenGuides.pm trunk/lib/OpenGuides/Utils.pm trunk/templates/header.tt Log: Added meta descriptions to headers of map and list index pages. Modified: trunk/Changes =================================================================== --- trunk/Changes 2012-07-29 19:58:36 UTC (rev 1432) +++ trunk/Changes 2012-08-17 15:36:57 UTC (rev 1433) @@ -5,6 +5,7 @@ 0.70 ? Updated URLs for Leaflet JavaScript and CSS. + Added meta descriptions to headers of map and list index pages. 0.69 07 July 2012 The output of the "show_missing_metadata" action is now alphabetised. Modified: trunk/MANIFEST =================================================================== --- trunk/MANIFEST 2012-07-29 19:58:36 UTC (rev 1432) +++ trunk/MANIFEST 2012-08-17 15:36:57 UTC (rev 1433) @@ -130,6 +130,7 @@ t/407_navbar_placement.t t/408_google_analytics.t t/409_custom_header.t +t/410_meta_description.t t/500_http_response_codes.t t/501_display_node.t t/502_display_diffs.t Modified: trunk/lib/OpenGuides/Utils.pm =================================================================== --- trunk/lib/OpenGuides/Utils.pm 2012-07-29 19:58:36 UTC (rev 1432) +++ trunk/lib/OpenGuides/Utils.pm 2012-08-17 15:36:57 UTC (rev 1433) @@ -386,6 +386,49 @@ return %data; } +=item B<get_index_page_description> + + $tt_vars{page_description} = + OpenGuides::Utils->get_index_page_description( + format => "map", + criteria => [ type => "locale", value => "croydon" ], + ); + +Returns a sentence that can be used as a summary of what's shown on an +index page. + +=cut + +sub get_index_page_description { + my ( $class, %args ) = @_; + my $desc = ( $args{format} eq "map" ) ? "Map" : "List"; + $desc .= " of all our pages"; + + my ( @cats, @locs ); + foreach my $criterion ( @{$args{criteria}} ) { + my ( $type, $name ) = ( $criterion->{type}, $criterion->{name} ); + if ( $type eq "category" ) { + $name =~ s/Category //; + push @cats, $name; + } else { + $name =~ s/Locale //; + push @locs, $name; + } + } + + if ( scalar @cats ) { + $desc .= " labelled with: " . join( ", ", @cats ); + if ( scalar @locs ) { + $desc .= ", and"; + } + } + if ( scalar @locs ) { + $desc .= " located in: " . join( ", ", @locs ); + } + $desc .= "."; + return $desc; +} + =item B<detect_redirect> $redir = OpenGuides::Utils->detect_redirect( content => "foo" ); Modified: trunk/lib/OpenGuides.pm =================================================================== --- trunk/lib/OpenGuides.pm 2012-07-29 19:58:36 UTC (rev 1432) +++ trunk/lib/OpenGuides.pm 2012-08-17 15:36:57 UTC (rev 1433) @@ -1060,6 +1060,13 @@ $tt_vars{criteria} = \@criteria; $tt_vars{not_editable} = 1; } + + $tt_vars{page_description} = + OpenGuides::Utils->get_index_page_description( + format => $args{format} || "", + criteria => \@criteria, + ); + my $feed_base = $self->config->script_url . $self->config->script_name . "?action=index"; foreach my $criterion ( @criteria ) { Added: trunk/t/410_meta_description.t =================================================================== --- trunk/t/410_meta_description.t (rev 0) +++ trunk/t/410_meta_description.t 2012-08-17 15:36:57 UTC (rev 1433) @@ -0,0 +1,86 @@ +use strict; +use OpenGuides; +use OpenGuides::Test; +use Test::More; + +eval { require DBD::SQLite; }; +if ( $@ ) { + my ($error) = $@ =~ /^(.*?)\n/; + plan skip_all => "DBD::SQLite not available ($error)"; +} + +eval { require Test::HTML::Content; }; +if ( $@ ) { + plan skip_all => "Test::HTML::Content not available"; +} + +plan tests => 12; + +OpenGuides::Test::refresh_db(); + +my $config = OpenGuides::Test->make_basic_config; +$config->use_leaflet( 1 ); +my $guide = OpenGuides->new( config => $config ); +my $wiki = $guide->wiki; + +# Write a node and give it a category and locale. +OpenGuides::Test->write_data( guide => $guide, node => "Dog And Bull", + summary => "A pub.", categories => "Pubs", locales => "Croydon", + return_output => 1 ); + +# Display the category and locale indexes individually and together, +# as maps and lists, and check that the header shows up. + +# Category list. +my $output = $guide->show_index( cat => "pubs", return_output => 1, + noheaders => 1 ); +Test::HTML::Content::tag_ok( $output, "meta", { name => "description" }, + "Category index has meta description" ); +like( $output, + qr/List of all our pages labelled with: Pubs\./, + "...with suitable text." ); + +# Locale list. +$output = $guide->show_index( loc => "croydon", return_output => 1, + noheaders => 1 ); +Test::HTML::Content::tag_ok( $output, "meta", { name => "description" }, + "Locale index has meta description" ); +like( $output, + qr/List of all our pages located in: Croydon\./, + "...with suitable text." ); + +# Category + locale list. +$output = $guide->show_index( cat => "pubs", loc => "croydon", + return_output => 1, noheaders => 1 ); +Test::HTML::Content::tag_ok( $output, "meta", { name => "description" }, + "Category+locale index has meta description" ); +like( $output, + qr/List of all our pages labelled with: Pubs, and located in: Croydon\./, + "...with suitable text." ); + +# Category map. +$output = $guide->show_index( cat => "pubs", format => "map", + return_output => 1, noheaders => 1 ); +Test::HTML::Content::tag_ok( $output, "meta", { name => "description" }, + "Category map has meta description" ); +like( $output, + qr/Map of all our pages labelled with: Pubs\./, + "...with suitable text." ); + +# Locale map. +$output = $guide->show_index( loc => "croydon", format => "map", + return_output => 1, noheaders => 1 ); +Test::HTML::Content::tag_ok( $output, "meta", { name => "description" }, + "Locale map has meta description" ); +like( $output, + qr/Map of all our pages located in: Croydon\./, + "...with suitable text." ); + +# Category + locale map. +$output = $guide->show_index( cat => "pubs", loc => "croydon", format => "map", + return_output => 1, noheaders => 1 ); +Test::HTML::Content::tag_ok( $output, "meta", { name => "description" }, + "Category+locale map has meta description" ); +like( $output, + qr/Map of all our pages labelled with: Pubs, and located in: Croydon\./, + "...with suitable text." ); Modified: trunk/templates/header.tt =================================================================== --- trunk/templates/header.tt 2012-07-29 19:58:36 UTC (rev 1432) +++ trunk/templates/header.tt 2012-08-17 15:36:57 UTC (rev 1433) @@ -15,9 +15,13 @@ [% IF contact_email %] <link rev="made" href="mailto:[% contact_email %]" /> [% END %] - [% IF summary %] + + [% IF page_description %] + <meta name="description" content="[% page_description %]" /> + [% ELSIF summary %] <meta name="description" content="[% summary %]" /> [% END %] + [% IF (categories.size AND categories.size > 0) OR (locales.size AND locales.size > 0) %] <meta name="keywords" content="[% IF categories.size AND

10 years, 7 months

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

openguides-commits August 2012