The R Project SVN R

Rev

Rev 7002 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 7002 Rev 7133
Line -... Line 1...
- 
 
 1 
# Subroutines for converting R documentation into HTML
- 
 
 2 
 
- 
 
 3 
# Copyright (C) 1997 Friedrich Leisch
- 
 
 4 
# Modifications for Windows (C) 1998, 1999 B. D. Ripley
- 
 
 5 
#
- 
 
 6 
# This program is free software; you can redistribute it and/or modify
- 
 
 7 
# it under the terms of the GNU General Public License as published by
- 
 
 8 
# the Free Software Foundation; either version 2, or (at your option)
- 
 
 9 
# any later version.
- 
 
 10 
#
- 
 
 11 
# This program is distributed in the hope that it will be useful, but
- 
 
 12 
# WITHOUT ANY WARRANTY; without even the implied warranty of
- 
 
 13 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the GNU
- 
 
 14 
# General Public License for more details.
- 
 
 15 
#
- 
 
 16 
# A copy of the GNU General Public License is available via WWW at
- 
 
 17 
# http://www.gnu.org/copyleft/gpl.html.	 You can also obtain it by
- 
 
 18 
# writing to the Free Software Foundation, Inc., 59 Temple Place,
- 
 
 19 
# Suite 330, Boston, MA  02111-1307  USA.
1 
# The head of a html page (e.g. used for packages list)
 20 
# The head of a html page (e.g. used for packages list)
2 
# Arguments:
 21 
# Arguments:
3 
#  $title      of the page
 22 
#  $title      of the page
4 
#  $top        relative path to $R_HOME/doc/html (must be "." if we
 23 
#  $top        relative path to $R_HOME/doc/html (must be "." if we
5 
#              already are there)
 24 
#              already are there)
Line 26... Line 45...
26 
        "<div align=center>\n";
 45 
        "<div align=center>\n";
27 
 
 46 
 
28 
    $retval .= "<A HREF=\"$prev\"><IMG SRC=\"$top/left.jpg\"\n" .
 47 
    $retval .= "<A HREF=\"$prev\"><IMG SRC=\"$top/left.jpg\"\n" .
29 
	"ALT=\"[$prevtext]\" WIDTH=30 HEIGHT=30 BORDER=0></A>\n"
 48 
	"ALT=\"[$prevtext]\" WIDTH=30 HEIGHT=30 BORDER=0></A>\n"
30 
	    if $prev;
 49 
	    if $prev;
31
50 
 
32 
    $retval .=
 51 
    $retval .=
33 
	"<A HREF=\"$up\"><IMG SRC=\"$top/up.jpg\"" .
 52 
	"<A HREF=\"$up\"><IMG SRC=\"$top/up.jpg\"" .
34 
        "ALT=\"[$uptext]\" WIDTH=30 HEIGHT=30 BORDER=0></A>\n"
 53 
        "ALT=\"[$uptext]\" WIDTH=30 HEIGHT=30 BORDER=0></A>\n"
35 
	    if $up;
 54 
	    if $up;
36 
 
 55 
 
37 
    $retval .= "<A HREF=\"$next\"><IMG SRC=\"$top/right.jpg\"\n" .
 56 
    $retval .= "<A HREF=\"$next\"><IMG SRC=\"$top/right.jpg\"\n" .
38 
    "ALT=\"[$nextext]\" WIDTH=30 HEIGHT=30 BORDER=0></A>\n"
 57 
    "ALT=\"[$nextext]\" WIDTH=30 HEIGHT=30 BORDER=0></A>\n"
39 
	if $next;
 58 
	if $next;
40
59 
 
41 
    $retval .= "</DIV>\n\n";
 60 
    $retval .= "</DIV>\n\n";
42 
 
 61 
 
43 
    $retval;
 62 
    $retval;
44 
}
 63 
}
45 
 
 64 
 
Line 55... Line 74...
55 
	"<LINK REL=STYLESHEET TYPE=\"text/css\" SRC=\"../../../doc/html/R.css\">" .
 74 
	"<LINK REL=STYLESHEET TYPE=\"text/css\" SRC=\"../../../doc/html/R.css\">" .
56 
	"</HEAD><BODY>\n\n";
 75 
	"</HEAD><BODY>\n\n";
57 
 
 76 
 
58 
    if($pkgname){
 77 
    if($pkgname){
59 
	$retval .= "<table width=100%><tr>" .
 78 
	$retval .= "<table width=100%><tr>" .
60 
	    "<td>$name($pkgname)</td>" .
 79 
	    "<td>$name {$pkgname}</td>" .
61 
	    "<td align=right>R Documentation</td></tr></table><p>";
 80 
	    "<td align=right>R Documentation</td></tr></table><p>";
62 
    }
 81 
    }
63
82 
 
64 
    $retval .= html_title2($title);
 83 
    $retval .= html_title2($title);
65 
}
 84 
}
66 
 
 85 
 
67 
sub html_functionfoot
 86 
sub html_functionfoot
68 
{
 87 
{
69 
    my $retval;
 88 
    my $retval;
70
89 
 
71 
    if($HTML){
 90 
    if($HTML){
72 
	$retval .= "\n\n<p align=center><hr><div align=center>" .
 91 
	$retval .= "\n\n<p align=center><hr><div align=center>" .
73 
	    "<a href=\"00Index.$HTML\">[Package Contents]</a></div>\n\n";
 92 
	    "<a href=\"00Index.$HTML\">[Package Contents]</a></div>\n\n";
74 
    }
 93 
    }
75 
 
 94 
 
Line 80... Line 99...
80 
 
 99 
 
81 
sub html_title2
 100 
sub html_title2
82 
{
 101 
{
83 
    my $title = $_[0];
 102 
    my $title = $_[0];
84 
 
 103 
 
- 
 
 104 
    if($opt_chm) {
- 
 
 105 
	"\n<h2 align=center><FONT COLOR=\"#0000FF\">" .
- 
 
 106 
	    "<tt>$title</tt></FONT></h2>\n\n";
- 
 
 107 
    } else {
85 
    "<h2>$title</h2>\n\n";
 108 
	"\n<h2>$title</h2>\n\n";
- 
 
 109 
    }
86 
}
 110 
}
87 
 
 111 
 
88 
sub html_title3
 112 
sub html_title3
89 
{
 113 
{
90 
    my $title = $_[0];
 114 
    my $title = $_[0];
91 
 
 115 
 
- 
 
 116 
    if($opt_chm) {
- 
 
 117 
	"\n<h3><FONT COLOR=\"#666666\">" .
- 
 
 118 
	    "<tt>$title</tt></FONT></h3>\n\n";
- 
 
 119 
    } else {
92 
    "<h3>$title</h3>\n\n";
 120 
	"\n<h3>$title</h3>\n\n";
- 
 
 121 
    }
93 
}
 122 
}
94 
 
 123 
 
95 
sub html_alphabet
 124 
sub html_alphabet
96 
{
 125 
{
97 
    "<p align=center>\n"
 126 
    "<p align=center>\n"
98 
    . "<A HREF=\"#A\">A</A>\n"
127 
    . "<A HREF=\"#A\">A</A>\n"
99 
    . "<A HREF=\"#B\">B</A>\n"
128 
    . "<A HREF=\"#B\">B</A>\n"
100 
    . "<A HREF=\"#C\">C</A>\n"
129 
    . "<A HREF=\"#C\">C</A>\n"
101 
    . "<A HREF=\"#D\">D</A>\n"
130 
    . "<A HREF=\"#D\">D</A>\n"
102 
    . "<A HREF=\"#E\">E</A>\n"
131 
    . "<A HREF=\"#E\">E</A>\n"
103 
    . "<A HREF=\"#F\">F</A>\n"
132 
    . "<A HREF=\"#F\">F</A>\n"
104 
    . "<A HREF=\"#G\">G</A>\n"
133 
    . "<A HREF=\"#G\">G</A>\n"
105 
    . "<A HREF=\"#H\">H</A>\n"
134 
    . "<A HREF=\"#H\">H</A>\n"
106 
    . "<A HREF=\"#I\">I</A>\n"
135 
    . "<A HREF=\"#I\">I</A>\n"
107 
    . "<A HREF=\"#J\">J</A>\n"
136 
    . "<A HREF=\"#J\">J</A>\n"
108 
    . "<A HREF=\"#K\">K</A>\n"
137 
    . "<A HREF=\"#K\">K</A>\n"
109 
    . "<A HREF=\"#L\">L</A>\n"
138 
    . "<A HREF=\"#L\">L</A>\n"
110 
    . "<A HREF=\"#M\">M</A>\n"
139 
    . "<A HREF=\"#M\">M</A>\n"
111 
    . "<A HREF=\"#N\">N</A>\n"
140 
    . "<A HREF=\"#N\">N</A>\n"
112 
    . "<A HREF=\"#O\">O</A>\n"
141 
    . "<A HREF=\"#O\">O</A>\n"
113 
    . "<A HREF=\"#P\">P</A>\n"
142 
    . "<A HREF=\"#P\">P</A>\n"
114 
    . "<A HREF=\"#Q\">Q</A>\n"
143 
    . "<A HREF=\"#Q\">Q</A>\n"
115 
    . "<A HREF=\"#R\">R</A>\n"
144 
    . "<A HREF=\"#R\">R</A>\n"
116 
    . "<A HREF=\"#S\">S</A>\n"
 145 
    . "<A HREF=\"#S\">S</A>\n"
117 
    . "<A HREF=\"#T\">T</A>\n"
146 
    . "<A HREF=\"#T\">T</A>\n"
118 
    . "<A HREF=\"#U\">U</A>\n"
147 
    . "<A HREF=\"#U\">U</A>\n"
119 
    . "<A HREF=\"#V\">V</A>\n"
148 
    . "<A HREF=\"#V\">V</A>\n"
120 
    . "<A HREF=\"#W\">W</A>\n"
149 
    . "<A HREF=\"#W\">W</A>\n"
121 
    . "<A HREF=\"#X\">X</A>\n"
150 
    . "<A HREF=\"#X\">X</A>\n"
122 
    . "<A HREF=\"#Y\">Y</A>\n"
151 
    . "<A HREF=\"#Y\">Y</A>\n"
123 
    . "<A HREF=\"#Z\">Z</A>\n"
 152 
    . "<A HREF=\"#Z\">Z</A>\n"
124 
    . "</p>\n";
 153 
    . "</p>\n";
125 
}
 154 
}
126 
 
 155 
 
- 
 
 156 
sub chm_pagehead
127 
1;
 157 
{
- 
 
 158 
    my ($title) = @_;
128 
 
 159 
 
- 
 
 160 
    my $retval = "<HTML><HEAD><TITLE>$title</TITLE></HEAD>\n" .
- 
 
 161 
	"<BODY TEXT=\"#000000\" BGCOLOR=\"#FFFFFF\" " .
- 
 
 162 
	"LINK=\"#0000F0\" VLINK=\"#660066\" ALINK=\"#FF0000\" " .
- 
 
 163 
	"BACKGROUND=\"white\">\n" .
- 
 
 164 
	"<h1 align=center>\n" .
- 
 
 165 
        "<FONT COLOR=\"#999999\" " .
- 
 
 166 
        "size=\"+3\"><tt>\n" .
- 
 
 167 
        "$title\n" .
- 
 
 168 
        "</tt></FONT><img src=\"logo.jpg\" alt=\"[R logo]\" align=center></h1>\n\n" .
- 
 
 169 
        "<hr>\n\n";
- 
 
 170 
    $retval .= "<OBJECT TYPE=\"application/x-oleobject\" CLASSID=\"clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e\">\n";
- 
 
 171 
    $retval .= "<PARAM NAME=\"Keyword\" VALUE=\".. Contents\">\n" .
- 
 
 172 
	"</OBJECT>\n\n";
- 
 
 173 
    $retval;
- 
 
 174 
}
129 
 
 175 
 
- 
 
 176 
sub chm_functionhead
- 
 
 177 
{
- 
 
 178 
    my ($title, $pkgname, $name) = @_;
- 
 
 179 
 
- 
 
 180 
    my $retval = "<HTML><HEAD><TITLE>$title</TITLE></HEAD>\n" .
- 
 
 181 
	"<BODY TEXT=\"#000000\" BGCOLOR=\"#FFFFFF\" " .
- 
 
 182 
	"LINK=\"#0000F0\" VLINK=\"#660066\" ALINK=\"#FF0000\" " .
- 
 
 183 
	"BACKGROUND=\"white\">\n\n";
- 
 
 184 
 
- 
 
 185 
    if($pkgname){
- 
 
 186 
	$retval .= "<table width=100%><tr>" .
- 
 
 187 
	    "<td>$name($pkgname)</td>" .
- 
 
 188 
	    "<td align=right>R Documentation</td></tr></table><p>";
- 
 
 189 
    }
130 
 
 190 
 
- 
 
 191 
    $retval .= "<OBJECT TYPE=\"application/x-oleobject\" CLASSID=\"clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e\">\n";
- 
 
 192 
    foreach(@aliases) {
- 
 
 193 
#	print "alias: $_\n";
- 
 
 194 
	$retval .= "<PARAM NAME=\"Keyword\" VALUE=\"R:   $_\">\n";
- 
 
 195 
    }
- 
 
 196 
    $title =~ s/\"/'/go;  #'
- 
 
 197 
    $title =~ s/,//go;  # commas seem to give problems
- 
 
 198 
    $retval .= "<PARAM NAME=\"Keyword\" VALUE=\" $title\">\n" .
- 
 
 199 
	"</OBJECT>\n\n";
- 
 
 200 
    $retval .= html_title2($title);
131 
 
 201 
 
- 
 
 202 
}
- 
 
 203 
 
- 
 
 204 
1;