.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "EMBOSS::GUI::XHTML 3pm" .TH EMBOSS::GUI::XHTML 3pm "2020-11-25" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" EMBOSS::GUI::XHTML \- generate HTML for EMBOSS::GUI .SH "AUTHOR" .IX Header "AUTHOR" Luke McCarthy .SH "SYNOPSIS" .IX Header "SYNOPSIS" Not for public consumption. Use \s-1EMBOSS::GUI\s0 instead. .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\s-1EMBOSS::GUI::XHTML\s0 generates the \s-1HTML\s0 required by \s-1EMBOSS::GUI.\s0 The appearance of \s-1EMBOSS::GUI\s0 can be customized by editing or replacing the default style sheet. There is very little that cannot be accomplished in this way. If new \&\s-1HTML\s0 is absolutely required, simply create a new module that provides the methods described below and specify the new module in the \s-1EMBOSS::GUI\s0 constructor. .PP Public methods are described below: .IP "new(%args)" 4 .IX Item "new(%args)" Returns a new \s-1EMBOSS::GUI::XHTML\s0 object. .Sp \&\f(CW%args\fR is a hash of optional named arguments. The following arguments are \&\f(CW%recognized:\fR .RS 4 .ie n .IP "static => $boolean" 4 .el .IP "static => \f(CW$boolean\fR" 4 .IX Item "static => $boolean" If \f(CW$boolean\fR is true, the generated \s-1HTML\s0 will assume that, where possible, the pages of the interface have been generated statically and will be linked appropriately. See also the mkstatic script in the \s-1EMBOSS::GUI\s0 distribution. .ie n .IP "frames => $boolean" 4 .el .IP "frames => \f(CW$boolean\fR" 4 .IX Item "frames => $boolean" If \f(CW$boolean\fR is true, the generated \s-1HTML\s0 will assume that the main menu is in its own frame and doesn't have to be added to each page. .ie n .IP "script_url => $url" 4 .el .IP "script_url => \f(CW$url\fR" 4 .IX Item "script_url => $url" Specifies the \s-1URL\s0 of the main \s-1EMBOSS::GUI CGI\s0 script. This parameter is required if static pages are generated, otherwise the \s-1URL\s0 will be determined from the \s-1CGI\s0 environment. .ie n .IP "style_url => $url" 4 .el .IP "style_url => \f(CW$url\fR" 4 .IX Item "style_url => $url" Specifies the \s-1URL\s0 of the style sheet to use. .ie n .IP "image_url => $url" 4 .el .IP "image_url => \f(CW$url\fR" 4 .IX Item "image_url => $url" Specifies a \s-1URL\s0 prefix to place before image links. .ie n .IP "manual_url => $url" 4 .el .IP "manual_url => \f(CW$url\fR" 4 .IX Item "manual_url => $url" Specifies a \s-1URL\s0 prefix to place before manual links. This prefix is only used if static pages are generated. .RE .RS 4 .RE .IP "\fBintro_page()\fR" 4 .IX Item "intro_page()" Generates an introductory page describing \s-1EMBOSS\s0 and the \s-1GUI.\s0 .IP "menu_page(@entries)" 4 .IX Item "menu_page(@entries)" Generates the main menu page. .Sp \&\f(CW@entries\fR is either a list of applications as returned by \fBEMBOSS::GUI::apps()\fR, or a list of groups as returned by \fBEMBOSS::GUI::groups()\fR. .ie n .IP "input_page($acd, $hide_optional)" 4 .el .IP "input_page($acd, \f(CW$hide_optional\fR)" 4 .IX Item "input_page($acd, $hide_optional)" Generates the application-specific input page. .Sp \&\f(CW$acd\fR is an \s-1EMBOSS::ACD\s0 object that describes the application. .Sp \&\f(CW$hide_optional\fR is a boolean value that determines whether optional parameters (also called additional parameters in the \s-1EMBOSS\s0 documenation) will appear in the input page. .IP "input_page($output_dir)" 4 .IX Item "input_page($output_dir)" Generates an output page based on the contents of the specified directory. .Sp \&\f(CW$output_dir\fR is a directory containing the output of an \s-1EMBOSS\s0 application. .ie n .IP "manual_page($app, $manual)" 4 .el .IP "manual_page($app, \f(CW$manual\fR)" 4 .IX Item "manual_page($app, $manual)" Generates the application-specific manual page. .Sp \&\f(CW$app\fR is the name of the application. .Sp \&\f(CW$manual_html\fR is the full text of the \s-1HTML\s0 application manual. .IP "default_output_page($refresh_delay)" 4 .IX Item "default_output_page($refresh_delay)" Generates the default output page to be used as a placeholder until the application has finished running and the actual output is available. .Sp \&\f(CW$refresh_delay\fR is the number of seconds to wait between page reloads. .IP "error_page(@error)" 4 .IX Item "error_page(@error)" Generates an error page. .Sp \&\f(CW@error\fR is the text of the error message. All elements of the list are joined into a single string, so this method has the same syntax as print, warn, die, etc. .IP "\fBframeset_page()\fR" 4 .IX Item "frameset_page()" Generates a page that sets up the menu and main content frames. .SH "BUGS" .IX Header "BUGS" If the user has asked to see only required fields, sections containing only optional fields will still be visible, even though the fields they contain are hidden. Fixing this requires better section handling in \s-1EMBOSS::ACD.\s0 .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 2004 Luke McCarthy. All rights reserved. This program is free software. You may copy or redistribute it under the same terms as Perl itself.