Changeset 941

Timestamp:

03/17/07 15:05:27 (21 months ago)

Author:

kake

Message:

Add config option to omit recent changes from home page (ticket #187).

Location:

trunk

Files:

• Build.PL (modified) (2 diffs)
• Changes (modified) (1 diff)
• INSTALL (modified) (1 diff)
• MANIFEST (modified) (1 diff)
• README.CSS (modified) (1 diff)
• lib/OpenGuides.pm (modified) (1 diff)
• lib/OpenGuides/Config.pm (modified) (5 diffs)
• t/45_home_recent_changes.t (added)
• t/51_display_node.t (modified) (1 diff)
• templates/home_node.tt (modified) (1 diff)

trunk/Build.PL

@@ -41 +41 @@
    qw(use_plucene enable_page_deletion navbar_on_home_page backlinks_in_title
       moderation_requires_password enable_node_image enable_common_categories
-      enable_common_locales);
+      enable_common_locales recent_changes_on_home_page);
 
 my $skip_config = Module::Build->y_n("Skip OpenGuides configuration?", "n");
@@ -94 +94 @@
    install_directory template_path custom_template_path script_url
    custom_lib_path use_plucene indexing_directory enable_page_deletion
-   admin_pass stylesheet_url site_name navbar_on_home_page home_name
+   admin_pass stylesheet_url site_name navbar_on_home_page
+   recent_changes_on_home_page home_name
    site_desc default_city default_country contact_email default_language
    formatting_rules_node backlinks_in_title gmaps_api_key centre_long

trunk/Changes

@@ -13 +13 @@
         Let people add name of copyright holder, licence URL, and info page
           URL for node images (#179).
+        Add config option to omit recent changes from home page.
         Write tests for and fix:
           #48 (Edit conflict page erroneously converts lat/lon to os_x, os_y).

trunk/INSTALL

@@ -149 +149 @@
 
   "Do you want the navigation bar included on the home page?"
+
+Answer "y" or "n".
+
+
+  "Do you want the ten most recent changes included on the home page?"
 
 Answer "y" or "n".

trunk/MANIFEST

@@ -98 +98 @@
 t/43_preview_edits.t
 t/44_node_image.t
+t/45_home_recent_changes.t
 t/51_display_node.t
 t/52_display_diffs.t

trunk/README.CSS

@@ -139 +139 @@
     Purpose: Recent changes summary box on the home node
 
+div#home_page_edit_link
+    Used in: home_node.tt
+    Purpose: "Edit this page" link on the home node - only displayed if neither
+    the navbar or the recent changes box are shown, since both those divs also
+    contain an edit link.
+
 div#search_form
     Used in: footer.tt

trunk/lib/OpenGuides.pm

@@ -285 +285 @@
         $self->display_recent_changes(%args);
     } elsif ( $id eq $self->config->home_name ) {
-        my @recent = $wiki->list_recent_changes(
-            last_n_changes => 10,
-            metadata_was   => { edit_type => "Normal edit" },
-        );
-        @recent = map {
-                          {
+        if ( $self->config->recent_changes_on_home_page ) {
+            my @recent = $wiki->list_recent_changes(
+                last_n_changes => 10,
+                metadata_was   => { edit_type => "Normal edit" },
+            );
+            @recent = map {
+                            {
                               name          => CGI->escapeHTML($_->{name}),
-                              last_modified => CGI->escapeHTML($_->{last_modified}),
+                              last_modified =>
+                                  CGI->escapeHTML($_->{last_modified}),
                               version       => CGI->escapeHTML($_->{version}),
-                              comment       => CGI->escapeHTML($_->{metadata}{comment}[0]),
-                              username      => CGI->escapeHTML($_->{metadata}{username}[0]),
+                              comment       =>
+                                  CGI->escapeHTML($_->{metadata}{comment}[0]),
+                              username      =>
+                                  CGI->escapeHTML($_->{metadata}{username}[0]),
                               url           => $config->script_name . "?"
-                                               . CGI->escape($wiki->formatter->node_name_to_node_param($_->{name}))
-                          }
-                      } @recent;
-        $tt_vars{recent_changes} = \@recent;
+                                             . CGI->escape($wiki->formatter->node_name_to_node_param($_->{name}))
+                            }
+                          } @recent;
+            $tt_vars{recent_changes} = \@recent;
+        }
         return %tt_vars if $args{return_tt_vars};
         my $output = $self->process_template(

trunk/lib/OpenGuides/Config.pm

@@ -10 +10 @@
    script_name install_directory script_url
    custom_lib_path use_plucene indexing_directory enable_page_deletion
-   admin_pass stylesheet_url site_name navbar_on_home_page home_name
+   admin_pass stylesheet_url site_name navbar_on_home_page
+   recent_changes_on_home_page home_name
    site_desc default_city default_country contact_email 
    default_language http_charset ping_services
@@ -79 +80 @@
                      site_name => "Unconfigured OpenGuides site",
                      navbar_on_home_page => 1,
+                     recent_changes_on_home_page => 1,
                      home_name => "Home",
                      site_desc => "A default configuration of OpenGuides",
@@ -152 +154 @@
         site_name => "What's the site called? (should be unique)",
         navbar_on_home_page => "Do you want the navigation bar included on the home page?",
+        recent_changes_on_home_page => "Do you want the ten most recent "
+          . "changes included on the home page?",
         home_name => "What should the home page of the wiki be called?",
         site_desc => "How would you describe the site?",
@@ -240 +244 @@
 =item * navbar_on_home_page (default: true)
 
+=item * recent_changes_on_home_page (default: true)
+
 =item * home_name (default: C<Home>)
 
@@ -290 +296 @@
 =head1 COPYRIGHT
 
-     Copyright (C) 2004-2006 The OpenGuides Project.  All Rights Reserved.
+     Copyright (C) 2004-2007 The OpenGuides Project.  All Rights Reserved.
 
 The OpenGuides distribution is free software; you can redistribute it

trunk/t/51_display_node.t

@@ -38 +38 @@
     is( $@, "", "->display_node doesn't die" );
 
-    like( $output, qr{\<a.*?\Qhref="alternate.cgi?id=Test_Page;action=edit">Edit this page</a>\E}, "...and edit link is redirected to source URL" );
+    like( $output, qr{\<a.*?\Qhref="alternate.cgi?id=Test_Page;action=edit"\E>Edit\s+this\s+page</a>}, "...and edit link is redirected to source URL" );
     $config->home_name( "My Home Page" );
     $output = $guide->display_node( return_output => 1 );
-    like( $output, qr/My Home Page/, "...and defaults to the home node, and takes notice of what we want to call it" );
-    like( $output, qr{\Q<a href="wiki.cgi?action=edit;id=My_Home_Page">Edit this page</a>\E}, "...and home page has an edit link" );
+    like( $output, qr/My\s+Home\s+Page/, "...and defaults to the home node, and takes notice of what we want to call it" );
+    like( $output, qr{\Q<a href="wiki.cgi?action=edit;id=My_Home_Page"\E>Edit\s+this\s+page</a>}, "...and home page has an edit link" );
     my %tt_vars = $guide->display_node( return_tt_vars => 1 );
     ok( defined $tt_vars{recent_changes}, "...and recent_changes is set for the home node even if we have changed its name" );

trunk/templates/home_node.tt

@@ -24 +24 @@
 [% END %]
 
+[% IF !navbar_on_home_page AND !config.recent_changes_on_home_page %]
+  <div id="home_page_edit_link">
+    <a href="[% cgi_url %]?action=edit;id=[% node_param %]">Edit this page</a>
+  </div>
+[% END %]
+
 <div id="maincontent">
-<div id="recent">
+  [% IF config.recent_changes_on_home_page %]
+    <div id="recent">
 
-<h3>Ten most <a href="[% cgi_url %]?action=rc">recent changes</a>
-    (<a href="[% full_cgi_url %]?action=rc;format=rss">RSS</a>):</h3>
+      <h3>Ten most <a href="[% cgi_url %]?action=rc">recent changes</a>
+          (<a href="[% full_cgi_url %]?action=rc;format=rss">RSS</a>):</h3>
 
-<dl>
-  [% FOREACH node = recent_changes %]
-  <dt><a href="[% node.url %]">[% node.name %]</a>
-  [% IF node.version == "1" %]
-    [new]
+      <dl>
+        [% FOREACH node = recent_changes %]
+          <dt><a href="[% node.url %]">[% node.name %]</a>
+            [% IF node.version == "1" %]
+              [new]
+            [% END %]
+          </dt>
+          [% IF node.comment or node.username %]
+            <dd>
+              [% node.comment %]
+              [% IF node.username %]
+                <b><small>([% node.username %])</small></b>
+              [% END %]
+            </dd>
+          [% END %]
+        [% END %]
+      </dl>
+
+      <p><b><a href="[% cgi_url %]?action=edit;id=[% node_param %]">Edit
+      this page</a></b></p>
+
+    </div>
   [% END %]
-  </dt>
-  [% IF node.comment or node.username %]
-    <dd>
-      [% node.comment %]
-      [% IF node.username %]
-        <b><small>([% node.username %])</small></b>
-      [% END %]
-    </dd>
-  [% END %]
-[% END %]
-</dl>
 
-<p><b><a href="[% cgi_url %]?action=edit;id=[% node_param %]">Edit this page</a></b></p>
-
-</div>
-[% content %]
+  [% content %]
 
 </div>