[Rt-commit] rt branch, 4.0/static-docs, created. rt-4.0.6-313-g269602f

[? sunnavy]

The branch, 4.0/static-docs has been created
        at  269602f9a2e3f7031d73dab7006a9cdb0c49d573 (commit)

- Log -----------------------------------------------------------------
commit 269602f9a2e3f7031d73dab7006a9cdb0c49d573
Author: sunnavy <sunnavy at bestpractical.com>
Date:   Mon Aug 27 20:49:33 2012 +0800

    add rt-static-docs to extract documents

diff --git a/devel/tools/rt-static-docs b/devel/tools/rt-static-docs
new file mode 100755
index 0000000..356a8c4
--- /dev/null
+++ b/devel/tools/rt-static-docs
@@ -0,0 +1,96 @@
+#!/usr/bin/env perl
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
+#                                          <sales at bestpractical.com>
+#
+# (Except where explicitly superseded by other copyright notices)
+#
+#
+# LICENSE:
+#
+# This work is made available to you under the terms of Version 2 of
+# the GNU General Public License. A copy of that license should have
+# been provided with this software, but in any event can be snarfed
+# from www.gnu.org.
+#
+# This work is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
+# CONTRIBUTION SUBMISSION POLICY:
+#
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+#
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+#
+# END BPS TAGGED BLOCK }}}
+
+use strict;
+use warnings;
+
+use Getopt::Long;
+use File::Basename 'basename';
+use Pod::Simple::HTMLBatch;
+
+my %opts;
+GetOptions( \%opts, "help|h", 'rt-root=s', 'to=s' );
+
+if ( $opts{'help'} ) {
+    require Pod::Usage;
+    print Pod::Usage::pod2usage( -verbose => 2 );
+    exit;
+}
+
+die "--to is not supplied" unless $opts{to};
+unless ( -e $opts{to} ) {
+    require File::Path;
+    File::Path::make_path( $opts{to} );
+}
+
+if ( $opts{'rt-root'} ) {
+    chdir $opts{'rt-root'};
+}
+
+my @dirs = ( 'docs', 'lib' );
+
+my $batch = Pod::Simple::HTMLBatch->new;
+$batch->contents_page_start('');
+$batch->contents_page_end('');
+$batch->batch_convert( join( ':', @dirs ), $opts{to} );
+
+__END__
+
+=head1 NAME
+
+rt-static-docs - generate doc shipped with RT
+
+=head1 SYNOPSIS
+
+    rt-static-docs --rt-root /path/to/rt --to /path/to/output
+
+=head1 DESCRIPTION
+
+This script is used to generate documents shipped with RT.
+

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