{ "content": [ { "type": "text", "text": "# HTML::FormatPS (perldoc)\n\n## NAME\n\nHTML::FormatPS - Format HTML as PostScript\n\n## SYNOPSIS\n\nuse HTML::TreeBuilder;\n$tree = HTML::TreeBuilder->new->parsefile(\"test.html\");\nuse HTML::FormatPS;\n$formatter = HTML::FormatPS->new(\nFontFamily => 'Helvetica',\nPaperSize => 'Letter',\n);\nprint $formatter->format($tree);\nOr, for short:\nuse HTML::FormatPS;\nprint HTML::FormatPS->formatfile(\n\"test.html\",\n'FontFamily' => 'Helvetica',\n'PaperSize' => 'Letter',\n);\n\n## DESCRIPTION\n\nThe HTML::FormatPS is a formatter that outputs PostScript code. Formatting of HTML tables and\nforms is not implemented.\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **METHODS**\n- **SEE ALSO**\n- **ISSUES**\n- **TO DO**\n- **INSTALLATION**\n- **BUGS AND LIMITATIONS**\n- **AVAILABILITY**\n- **AUTHORS**\n- **COPYRIGHT AND LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "HTML::FormatPS", "section": "", "mode": "perldoc", "summary": "HTML::FormatPS - Format HTML as PostScript", "synopsis": "use HTML::TreeBuilder;\n$tree = HTML::TreeBuilder->new->parsefile(\"test.html\");\nuse HTML::FormatPS;\n$formatter = HTML::FormatPS->new(\nFontFamily => 'Helvetica',\nPaperSize => 'Letter',\n);\nprint $formatter->format($tree);\nOr, for short:\nuse HTML::FormatPS;\nprint HTML::FormatPS->formatfile(\n\"test.html\",\n'FontFamily' => 'Helvetica',\n'PaperSize' => 'Letter',\n);", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 19, "subsections": [] }, { "name": "DESCRIPTION", "lines": 75, "subsections": [] }, { "name": "METHODS", "lines": 7, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "ISSUES", "lines": 4, "subsections": [] }, { "name": "TO DO", "lines": 12, "subsections": [] }, { "name": "INSTALLATION", "lines": 2, "subsections": [] }, { "name": "BUGS AND LIMITATIONS", "lines": 3, "subsections": [] }, { "name": "AVAILABILITY", "lines": 6, "subsections": [] }, { "name": "AUTHORS", "lines": 6, "subsections": [] }, { "name": "COPYRIGHT AND LICENSE", "lines": 6, "subsections": [] } ], "sections": { "NAME": { "content": "HTML::FormatPS - Format HTML as PostScript\n", "subsections": [] }, "VERSION": { "content": "version 2.12\n", "subsections": [] }, "SYNOPSIS": { "content": "use HTML::TreeBuilder;\n$tree = HTML::TreeBuilder->new->parsefile(\"test.html\");\n\nuse HTML::FormatPS;\n$formatter = HTML::FormatPS->new(\nFontFamily => 'Helvetica',\nPaperSize => 'Letter',\n);\nprint $formatter->format($tree);\n\nOr, for short:\n\nuse HTML::FormatPS;\nprint HTML::FormatPS->formatfile(\n\"test.html\",\n'FontFamily' => 'Helvetica',\n'PaperSize' => 'Letter',\n);\n", "subsections": [] }, "DESCRIPTION": { "content": "The HTML::FormatPS is a formatter that outputs PostScript code. Formatting of HTML tables and\nforms is not implemented.\n\nHTML::FormatPS is built on top of HTML::Formatter and so further detail may be found in the\ndocumentation for HTML::Formatter.\n\nYou might specify the following parameters when constructing the formatter object (or when\ncalling formatfile or formatstring):\n\nPaperSize\nWhat kind of paper should we format for. The value can be one of these: A3, A4, A5, B4, B5,\nLetter, Legal, Executive, Tabloid, Statement, Folio, 10x14, Quarto.\n\nThe default is \"A4\".\n\nPaperWidth\nThe width of the paper, in points. Setting PaperSize also defines this value.\n\nPaperHeight\nThe height of the paper, in points. Setting PaperSize also defines this value.\n\nLeftMargin\nThe left margin, in points.\n\nRightMargin\nThe right margin, in points.\n\nHorizontalMargin\nBoth left and right margin at the same time. The default value is 4 cm.\n\nTopMargin\nThe top margin, in points.\n\nBottomMargin\nThe bottom margin, in points.\n\nVerticalMargin\nBoth top and bottom margin at the same time. The default value is 2 cm,\n\nPageNo\nThis parameter determines if we should put page numbers on the pages. The default value is\ntrue; so you have to set this value to 0 in order to suppress page numbers. (The \"No\" in\n\"PageNo\" means number/numero!)\n\nFontFamily\nThis parameter specifies which family of fonts to use for the formatting. Legal values are\n\"Courier\", \"Helvetica\" and \"Times\". The default is \"Times\".\n\nFontScale\nThis is a scaling factor for all the font sizes. The default value is 1.\n\nFor example, if you want everything to be almost three times as large, you could set this to\n2.7. If you wanted things just a bit smaller than normal, you could set it to .92.\n\nLeading\nThis option (pronounced \"ledding\", not \"leeding\") controls how much is space between lines.\nThis is a factor of the font size used for that line. Default is 0.1 -- so between two\n12-point lines, there will be 1.2 points of space.\n\nStartPage\nAssuming you have PageNo on, StartPage controls what the page number of the first page will\nbe. By default, it is 1. So if you set this to 87, the first page would say \"87\" on it, the\nnext \"88\", and so on.\n\nNoProlog\nIf this option is set to a true value, HTML::FormatPS will make a point of *not* emitting\nthe PostScript prolog before the document. By default, this is off, meaning that\nHTML::FormatPS *will* emit the prolog. This option is of interest only to advanced users.\n\nNoTrailer\nIf this option is set to a true value, HTML::FormatPS will make a point of *not* emitting\nthe PostScript trailer at the end of the document. By default, this is off, meaning that\nHTML::FormatPS *will* emit the bit of PostScript that ends the document. This option is of\ninterest only to advanced users.\n", "subsections": [] }, "METHODS": { "content": "new\nmy $formatter = FormatterClass->new(\noption1 => value1, option2 => value2, ...\n);\n\nThis creates a new formatter object with the given options.\n", "subsections": [] }, "SEE ALSO": { "content": "HTML::Formatter\n", "subsections": [] }, "ISSUES": { "content": "* Output is in ISO Latin1 format. The underlying HTML parsers tend to now work in Unicode\n(perl native) code points. There is an impedance mismatch between these, which may give\nissues with complex characters within HTML.\n", "subsections": [] }, "TO DO": { "content": "* Support for some more character styles, notably including: strike-through, underlining,\nsuperscript, and subscript.\n\n* Support for Unicode.\n\n* Support for Win-1252 encoding, since that's what most people mean when they use characters\nin the range 0x80-0x9F in HTML.\n\n* And, if it's ever even reasonably possible, support for tables.\n\nI would welcome email from people who can help me out or advise me on the above.\n", "subsections": [] }, "INSTALLATION": { "content": "See perlmodinstall for information and options on installing Perl modules.\n", "subsections": [] }, "BUGS AND LIMITATIONS": { "content": "You can make new bug reports, and view existing ones, through the web interface at\n.\n", "subsections": [] }, "AVAILABILITY": { "content": "The project homepage is .\n\nThe latest version of this module is available from the Comprehensive Perl Archive Network\n(CPAN). Visit to find a CPAN site near you, or see\n.\n", "subsections": [] }, "AUTHORS": { "content": "* Nigel Metheringham \n\n* Sean M Burke \n\n* Gisle Aas \n", "subsections": [] }, "COPYRIGHT AND LICENSE": { "content": "This software is copyright (c) 2015 by Nigel Metheringham, 2002-2005 Sean M Burke, 1999-2002\nGisle Aas.\n\nThis is free software; you can redistribute it and/or modify it under the same terms as the Perl\n5 programming language system itself.\n", "subsections": [] } } } }