[Rt-commit] rt branch, 4.0/static-docs, updated. rt-4.0.6-326-g6d99f81

[Thomas Sibley]

The branch, 4.0/static-docs has been updated
       via  6d99f8123222f343da681e58fff65c90b5118379 (commit)
       via  a5257eadfbd282deeb06ff821c321756b65426bf (commit)
       via  1fe17d450aabc9b9ab9aa6b8d9cf15667dd8bec4 (commit)
      from  702ba5bccd0976b3ad03c95475fdf7bbcda58b76 (commit)

Summary of changes:
 devel/tools/rt-static-docs   | 12 ++++--------
 sbin/rt-test-dependencies.in |  7 +++++++
 2 files changed, 11 insertions(+), 8 deletions(-)

- Log -----------------------------------------------------------------
commit 1fe17d450aabc9b9ab9aa6b8d9cf15667dd8bec4
Author: Thomas Sibley <trs at bestpractical.com>
Date:   Thu Sep 6 09:55:39 2012 -0700

    Declare dependencies for rt-static-docs

diff --git a/devel/tools/rt-static-docs b/devel/tools/rt-static-docs
index fb220f1..23625b5 100755
--- a/devel/tools/rt-static-docs
+++ b/devel/tools/rt-static-docs
@@ -51,8 +51,8 @@ use strict;
 use warnings;
 
 use Getopt::Long;
+use File::Spec;
 use File::Path 'make_path';
-use File::Basename 'basename';
 use RT::Pod::HTMLBatch;
 
 my %opts;
diff --git a/sbin/rt-test-dependencies.in b/sbin/rt-test-dependencies.in
index 112abfb..0c224a8 100755
--- a/sbin/rt-test-dependencies.in
+++ b/sbin/rt-test-dependencies.in
@@ -75,6 +75,7 @@ GetOptions(
     'with-DASHBOARDS',
     'with-USERLOGO',
     'with-SSL-MAILGATE',
+    'with-HTML-DOC',
 
     'download=s',
     'repository=s',
@@ -104,6 +105,7 @@ my %default = (
     'with-DASHBOARDS' => 1,
     'with-USERLOGO' => 1,
     'with-SSL-MAILGATE' => @RT_SSL_MAILGATE@,
+    'with-HTML-DOC' => @RT_DEVEL_MODE@,
 );
 $args{$_} = $default{$_} foreach grep !exists $args{$_}, keys %default;
 
@@ -358,6 +360,10 @@ $deps{'USERLOGO'} = [ text_to_hash( << '.') ];
 Convert::Color
 .
 
+$deps{'HTML-DOC'} = [ text_to_hash( <<'.') ];
+Pod::Simple 3.07
+.
+
 my %AVOID = (
     'DBD::Oracle' => [qw(1.23)],
     'Email::Address' => [qw(1.893 1.894)],

commit a5257eadfbd282deeb06ff821c321756b65426bf
Author: Thomas Sibley <trs at bestpractical.com>
Date:   Thu Sep 6 09:56:12 2012 -0700

    HTML escape the contents of README and UPGRADING in the generated doc
    
    Jim noted that <email addresses> in the README were being parsed as bad
    HTML tags.

diff --git a/devel/tools/rt-static-docs b/devel/tools/rt-static-docs
index 23625b5..28e0b3a 100755
--- a/devel/tools/rt-static-docs
+++ b/devel/tools/rt-static-docs
@@ -53,6 +53,7 @@ use warnings;
 use Getopt::Long;
 use File::Spec;
 use File::Path 'make_path';
+use HTML::Entities qw(encode_entities);
 use RT::Pod::HTMLBatch;
 
 my %opts;
@@ -104,7 +105,7 @@ for my $file (<README* docs/UPGRADING*>) {
         or warn "Can't open $dest: $!", next;
 
     print $html "<pre>";
-    print $html $_ while <$source>;
+    print $html encode_entities($_) while <$source>;
     print $html "</pre>";
 
     close $source; close $html;
diff --git a/sbin/rt-test-dependencies.in b/sbin/rt-test-dependencies.in
index 0c224a8..abb1049 100755
--- a/sbin/rt-test-dependencies.in
+++ b/sbin/rt-test-dependencies.in
@@ -362,6 +362,7 @@ Convert::Color
 
 $deps{'HTML-DOC'} = [ text_to_hash( <<'.') ];
 Pod::Simple 3.07
+HTML::Entities
 .
 
 my %AVOID = (

commit 6d99f8123222f343da681e58fff65c90b5118379
Author: Thomas Sibley <trs at bestpractical.com>
Date:   Thu Sep 6 10:08:11 2012 -0700

    Remove the suggestion that users run this themselves since the HTML is not Mason safe

diff --git a/devel/tools/rt-static-docs b/devel/tools/rt-static-docs
index 28e0b3a..5d263af 100755
--- a/devel/tools/rt-static-docs
+++ b/devel/tools/rt-static-docs
@@ -136,12 +136,7 @@ documentation, collects and converts it into a nice set of HTML files, and tops
 it off with a helpful index.
 
 Best Practical uses this to publish documentation under
-L<http://bestpractical.com/rt/docs/>.  You can run it yourself, if you'd like,
-on your local RT and browse the documentation specific to your installation
-(extensions included!).
-
-    rt-static-docs --to /opt/rt4/local/html/Documentation/ --rt /opt/rt4
-    # now browse to http://your.rt/Documentation/
+L<http://bestpractical.com/rt/docs/>.
 
 =head1 OPTIONS
 

-----------------------------------------------------------------------