Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

HTMLDOC 1.8.27 Software Users Manual ESP-003-20060620 Easy Software Products Co

HTMLDOC 1.8.27 Software Users Manual ESP-003-20060620 Easy Software Products Copyright 1997-2006, All Rights Reserved. Table of Contents Introduction...................................................................................................................................................IN-1 History................................................................................................................................................IN-1 Organization of This Manual.............................................................................................................IN-2 Support...............................................................................................................................................IN-2 Encryption Support .............................................................................................................................IN-2 Copyright, Trademark, and License Information ...............................................................................IN-2 Chapter 1 - Installing HTMLDOC................................................................................................................1-1 Requirements........................................................................................................................................1-1 Installing HTMLDOC..........................................................................................................................1-1 Installing HTMLDOC on Microsoft Windows ..............................................................................1-1 Installing HTMLDOC on MacOS X ..............................................................................................1-2 Installing HTMLDOC on Linux....................................................................................................1-3 Installing HTMLDOC on Solaris ...................................................................................................1-3 Licensing HTMLDOC ..........................................................................................................................1-3 Uninstalling HTMLDOC ......................................................................................................................1-4 Uninstalling HTMLDOC on Microsoft Windows.........................................................................1-4 Uninstalling HTMLDOC on MacOS X.........................................................................................1-4 Uninstalling HTMLDOC on Linux ................................................................................................1-4 Uninstalling HTMLDOC on Solaris..............................................................................................1-4 Chapter 2 - Getting Started............................................................................................................................2-1 Starting HTMLDOC .............................................................................................................................2-1 Choosing a HTML File........................................................................................................................2-2 Setting the Output File ..........................................................................................................................2-3 Generating the Document .....................................................................................................................2-4 Chapter 3 - Generating Books........................................................................................................................3-1 Overview..............................................................................................................................................3-1 Choosing HTML Files ..........................................................................................................................3-2 Selecting a Title File .............................................................................................................................3-2 Setting the Output Format....................................................................................................................3-3 Setting the Output File ..........................................................................................................................3-3 Generating the Document .....................................................................................................................3-3 Saving Your Book................................................................................................................................3-3 Chapter 4 - HTMLDOC from the Command-Line ......................................................................................4-1 Getting to the Command-Line on Windows .........................................................................................4-1 The Basics of Command-Line Access ..................................................................................................4-2 What Are All These Commands?..................................................................................................4-2 Converting Multiple HTML Files........................................................................................................4-3 Generating Books.................................................................................................................................4-3 What are all these commands? .......................................................................................................4-3 Setting the Title File.............................................................................................................................4-4 Putting It All Together...................................................................................................................4-4 Chapter 5 - Using HTMLDOC on a Web Server.........................................................................................5-1 The Basics .............................................................................................................................................5-1 Using HTMLDOC as a CGI Program..................................................................................................5-1 Server-Side Preferences.................................................................................................................5-2 Configuring HTMLDOC with Apache..........................................................................................5-2 Configuring HTMLDOC with Microsoft IIS .................................................................................5-3 Additional Configuration for IIS 6.0 ..............................................................................................5-7 HTMLDOC 1.8.27 Software Users Manual i Table of Contents Chapter 5 - Using HTMLDOC on a Web Server Using HTMLDOC From Server-Side Scripts and Programs...............................................................5-8 Calling HTMLDOC from a Shell Script ........................................................................................5-9 Calling HTMLDOC from Perl .....................................................................................................5-10 Calling HTMLDOC from PHP....................................................................................................5-10 Calling HTMLDOC from C .........................................................................................................5-12 Calling HTMLDOC from Java....................................................................................................5-13 Chapter 6 - HTML Reference........................................................................................................................6-1 General Usage .......................................................................................................................................6-1 Elements...............................................................................................................................................6-2 Comments .............................................................................................................................................6-4 Header/Footer Strings....................................................................................................................6-6 FONT Attributes ...................................................................................................................................6-7 Headings...............................................................................................................................................6-7 Numbered Headings .......................................................................................................................6-8 Images ...................................................................................................................................................6-8 Links.....................................................................................................................................................6-8 META Attributes ..................................................................................................................................6-9 Page Breaks..........................................................................................................................................6-9 Tables ....................................................................................................................................................6-9 Chapter 7 - GUI Reference.............................................................................................................................7-1 The HTMLDOC GUI...........................................................................................................................7-1 Document File Operations.............................................................................................................7-1 New................................................................................................................................................7-1 Open...............................................................................................................................................7-1 Save ................................................................................................................................................7-2 Save As..........................................................................................................................................7-2 Generate.........................................................................................................................................7-2 Close ...............................................................................................................................................7-2 The Input Tab.......................................................................................................................................7-3 Document Type ..............................................................................................................................7-3 Input Files......................................................................................................................................7-3 Add Files........................................................................................................................................7-3 Edit Files........................................................................................................................................7-3 Delete Files....................................................................................................................................7-4 Move Up........................................................................................................................................7-4 Move Down ....................................................................................................................................7-4 Logo Image....................................................................................................................................7-4 Title File/Image ..............................................................................................................................7-4 The Output Tab .....................................................................................................................................7-5 Output To.......................................................................................................................................7-5 Output Path....................................................................................................................................7-5 Output Format................................................................................................................................7-5 Output Options ...............................................................................................................................7-5 Compression ...................................................................................................................................7-6 JPEG Quality ..................................................................................................................................7-6 The Page Tab........................................................................................................................................7-7 Page Size........................................................................................................................................7-7 2-Sided...........................................................................................................................................7-7 Landscape .......................................................................................................................................7-7 Top, Left, Right, and Bottom .........................................................................................................7-7 HTMLDOC 1.8.27 Software Users Manual ii Table of Contents Chapter 7 - GUI Reference Header and Footer ..........................................................................................................................7-8 The TOC Tab ........................................................................................................................................7-9 Table of Contents...........................................................................................................................7-9 Numbered Headings .......................................................................................................................7-9 Header and Footer ..........................................................................................................................7-9 Title................................................................................................................................................7-9 The Colors Tab...................................................................................................................................7-10 Body Color ...................................................................................................................................7-10 Body Image..................................................................................................................................7-10 Text Color....................................................................................................................................7-10 Link Color....................................................................................................................................7-10 Link Style .....................................................................................................................................7-10 The Fonts Tab .....................................................................................................................................7-11 Base Font Size ..............................................................................................................................7-11 Line Spacing................................................................................................................................7-11 Body Typeface.............................................................................................................................7-11 Heading Typeface........................................................................................................................7-11 Header/Footer Size .......................................................................................................................7-12 Header/Footer Font......................................................................................................................7-12 Character Set................................................................................................................................7-12 Options.........................................................................................................................................7-12 The PS Tab.........................................................................................................................................7-12 PostScript Level...........................................................................................................................7-12 Send Printer Commands ...............................................................................................................7-13 Include Xerox Job Comments ......................................................................................................7-13 The PDF Tab......................................................................................................................................7-13 PDF Version .................................................................................................................................7-13 Page Mode ....................................................................................................................................7-14 Page Layout ..................................................................................................................................7-14 First Page ......................................................................................................................................7-14 Page Effect...................................................................................................................................7-14 Page Duration ...............................................................................................................................7-14 Effect Duration .............................................................................................................................7-14 The Security Tab................................................................................................................................7-15 Encryption ....................................................................................................................................7-15 Permissions..................................................................................................................................7-15 Owner Password..........................................................................................................................7-15 Options.........................................................................................................................................7-15 User Password ..............................................................................................................................7-16 The Options Tab.................................................................................................................................7-16 HTML Editor...............................................................................................................................7-16 Browser Width.............................................................................................................................7-16 Search Path ...................................................................................................................................7-17 Proxy URL...................................................................................................................................7-17 Tooltips........................................................................................................................................7-17 Modern Look ................................................................................................................................7-17 Strict HTML .................................................................................................................................7-17 Save Options and Defaults ...........................................................................................................7-17 The File Chooser................................................................................................................................7-18 Show .............................................................................................................................................7-18 Favorites .......................................................................................................................................7-18 File List........................................................................................................................................7-18 HTMLDOC 1.8.27 Software Users Manual iii Table of Contents Chapter 7 - GUI Reference Filename .......................................................................................................................................7-18 Dialog Buttons.............................................................................................................................7-19 Chapter 8 - Command-Line Reference.........................................................................................................8-1 Basic Usage..........................................................................................................................................8-1 Options.................................................................................................................................................8-1 -d directory .....................................................................................................................................8-1 -f filename......................................................................................................................................8-2 -t format ..........................................................................................................................................8-2 -v....................................................................................................................................................8-2 --batch filename.book....................................................................................................................8-2 --bodycolor color ............................................................................................................................8-2 --bodyfont typeface........................................................................................................................8-3 --bodyimage filename....................................................................................................................8-3 --book.............................................................................................................................................8-3 --bottom margin.............................................................................................................................8-3 --browserwidth pixels....................................................................................................................8-3 --charset charset.............................................................................................................................8-4 --color .............................................................................................................................................8-4 --compression[=level]....................................................................................................................8-4 --continuous...................................................................................................................................8-5 --cookies 'name=\"value with space\"; name=value' ......................................................................8-5 --datadir directory..........................................................................................................................8-5 --duplex..........................................................................................................................................8-5 --effectduration seconds .................................................................................................................8-5 --embedfonts..................................................................................................................................8-5 --encryption ....................................................................................................................................8-5 --firstpage page..............................................................................................................................8-6 --fontsize size.................................................................................................................................8-6 --fontspacing spacing.....................................................................................................................8-6 --footer lcr......................................................................................................................................8-7 --format format ...............................................................................................................................8-8 --gray ..............................................................................................................................................8-8 --header lcr.....................................................................................................................................8-8 --headfootfont font.........................................................................................................................8-9 --headfootsize size ..........................................................................................................................8-9 --headingfont typeface.................................................................................................................8-10 --help............................................................................................................................................8-10 --helpdir directory........................................................................................................................8-10 --jpeg[=quality]............................................................................................................................8-10 --landscape...................................................................................................................................8-10 --left margin.................................................................................................................................8-10 --linkcolor color...........................................................................................................................8-10 --links...........................................................................................................................................8-11 --linkstyle style .............................................................................................................................8-11 --logoimage filename...................................................................................................................8-11 --no-compression.........................................................................................................................8-11 --no-duplex ...................................................................................................................................8-11 --no-embedfonts...........................................................................................................................8-11 --no-encryption .............................................................................................................................8-11 --no-jpeg .......................................................................................................................................8-11 --no-links ......................................................................................................................................8-12 HTMLDOC 1.8.27 Software Users Manual iv Table of Contents Chapter 8 - Command-Line Reference --no-localfiles...............................................................................................................................8-12 --no-numbered ..............................................................................................................................8-12 --no-pscommands .........................................................................................................................8-12 --no-strict ......................................................................................................................................8-12 --no-title.......................................................................................................................................8-12 --no-toc .........................................................................................................................................8-12 --no-xrxcomments ........................................................................................................................8-12 --numbered...................................................................................................................................8-12 --nup pages ...................................................................................................................................8-12 --outdir directory..........................................................................................................................8-12 --outfile filename ..........................................................................................................................8-13 --owner-password password........................................................................................................8-13 --pageduration seconds................................................................................................................8-13 --pageeffect effect........................................................................................................................8-14 --pagelayout layout......................................................................................................................8-15 --pagemode mode .........................................................................................................................8-15 --path dir1;dir2;dir3;...;dirN.........................................................................................................8-15 --permissions permission[,permission,...]....................................................................................8-16 --portrait.......................................................................................................................................8-16 --pscommands..............................................................................................................................8-16 --quiet...........................................................................................................................................8-16 --referer url ...................................................................................................................................8-16 --right margin...............................................................................................................................8-17 --size size ......................................................................................................................................8-17 --strict...........................................................................................................................................8-17 --textcolor color ............................................................................................................................8-17 --textfont typeface........................................................................................................................8-18 --title .............................................................................................................................................8-18 --titlefile filename........................................................................................................................8-18 --titleimage filename....................................................................................................................8-18 --tocfooter lcr...............................................................................................................................8-18 --tocheader lcr..............................................................................................................................8-18 --toclevels levels..........................................................................................................................8-18 --toctitle string ..............................................................................................................................8-19 --top margin ..................................................................................................................................8-19 --user-password password ............................................................................................................8-19 --verbose .......................................................................................................................................8-19 --version.......................................................................................................................................8-19 --webpage .....................................................................................................................................8-19 --xrxcomments.............................................................................................................................8-19 Environment Variables.......................................................................................................................8-20 HTMLDOC_DATA .....................................................................................................................8-20 HTMLDOC_DEBUG..................................................................................................................8-20 HTMLDOC_HELP ......................................................................................................................8-20 HTMLDOC_NOCGI...................................................................................................................8-20 Messages .............................................................................................................................................8-21 BYTES: Message .........................................................................................................................8-21 DEBUG: Messages......................................................................................................................8-21 ERRnnn: Messages......................................................................................................................8-21 INFO: Messages ...........................................................................................................................8-21 PAGES: Message .........................................................................................................................8-21 REMOTEBYTES: Message........................................................................................................8-21 HTMLDOC 1.8.27 Software Users Manual v Table of Contents Chapter 8 - Command-Line Reference TIMING: Message.......................................................................................................................8-22 Appendix A - License Agreement ..................................................................................................................A-1 Introduction ..........................................................................................................................................A-1 Source Code and the GNU GPL...................................................................................................A-1 Trademarks ....................................................................................................................................A-2 Binary Distribution Rights............................................................................................................A-2 Binaries and Support.....................................................................................................................A-2 End-User License Agreement ..............................................................................................................A-3 TERMS AND CONDITIONS OF SOFTWARE LICENSE........................................................A-3 LIMITED WARRANTY AND DISCLAIMER OF WARRANTY; LIMITATION OF LIABILITY...........................................................................................................................A-4 Appendix B - Book File Format .....................................................................................................................B-1 Introduction ..........................................................................................................................................B-1 The Header ...........................................................................................................................................B-1 The Options ..........................................................................................................................................B-2 The Files..............................................................................................................................................B-2 Putting It All Together.........................................................................................................................B-2 Older Book Files..................................................................................................................................B-3 Appendix C - Release Notes...........................................................................................................................C-1 Changes in HTMLDOC v1.8.27 ..........................................................................................................C-1 Changes in HTMLDOC v1.8.26 ..........................................................................................................C-1 Changes in HTMLDOC v1.8.25 ..........................................................................................................C-1 Changes in HTMLDOC v1.8.24 ..........................................................................................................C-1 Changes in HTMLDOC v1.8.23 ..........................................................................................................C-2 Changes in HTMLDOC v1.8.22 ..........................................................................................................C-2 Changes in HTMLDOC v1.8.21 ..........................................................................................................C-2 Changes in HTMLDOC v1.8.20 ..........................................................................................................C-2 Changes in HTMLDOC v1.8.19 ..........................................................................................................C-3 Changes in HTMLDOC v1.8.18 ..........................................................................................................C-3 Changes in HTMLDOC v1.8.17 ..........................................................................................................C-3 Changes in HTMLDOC v1.8.16 ..........................................................................................................C-4 Changes in HTMLDOC v1.8.15 ..........................................................................................................C-4 Changes in HTMLDOC v1.8.14 ..........................................................................................................C-4 Changes in HTMLDOC v1.8.13 ..........................................................................................................C-4 Changes in HTMLDOC v1.8.12 ..........................................................................................................C-4 Changes in HTMLDOC v1.8.8 ............................................................................................................C-5 Changes in HTMLDOC v1.8.7 ............................................................................................................C-5 Changes in HTMLDOC v1.8.6 ............................................................................................................C-5 Changes in HTMLDOC v1.8.5 ............................................................................................................C-5 Changes in HTMLDOC v1.8.4 ............................................................................................................C-5 Changes in HTMLDOC v1.8.3 ............................................................................................................C-5 Changes in HTMLDOC v1.8.2 ............................................................................................................C-5 Changes in HTMLDOC v1.8.1 ............................................................................................................C-6 Changes in HTMLDOC v1.8 ...............................................................................................................C-6 Appendix D - Compiling HTMLDOC from Source....................................................................................C-6 Requirements.......................................................................................................................................C-6 Compiling under UNIX/Linux .............................................................................................................C-6 Compiling on Windows Using Visual C++ .........................................................................................C-6 HTMLDOC 1.8.27 Software Users Manual vi Table of Contents Appendix D - Compiling HTMLDOC from Source Installing with Visual C++ ...................................................................................................................C-6 HTMLDOC 1.8.27 Software Users Manual vii HTMLDOC 1.8.27 Software Users Manual viii Introduction This document describes how to use the HTMLDOC software, version 1.8.27. HTMLDOC converts Hyper-Text Markup Language ("HTML") input files into indexed HTML, Adobe® PostScript®, or Adobe Portable Document Format ("PDF") files. HTMLDOC supports most HTML 3.2 elements, some HTML 4.0 elements, and can generate title and table of contents pages. It does not currently support stylesheets. HTMLDOC can be used as a standalone application, in a batch document processing environment, or as a web-based report generation application. No restrictions are placed upon the output produced by HTMLDOC. HTMLDOC is available both as open source software under the terms of the GNU General Public License and as commercial software under the terms of a traditional commercial End-User License Agreement. History Like many programs HTMLDOC was developed in response to a need our company had for generating high-quality documentation in printed and electronic forms. For a while we used FrameMaker® and a package from sgi that generated "compiled" Standard Generalized Markup Language ("SGML") files that could be used by the Electronic Book Technologies ("EBT") documentation products; EBT was bought by INSO who was bought by StellentTM who apparently has dropped the whole product line. When sgi stopped supporting these tools we turned to INSO, but the cost of their tools is prohibitive to small businesses. In the end we decided to write our own program to generate our documentation. HTML seemed to be the source format of choice since WYSIWYG HTML editors are widely (and freely) available and at worst you Introduction IN-1 can use a plain text editor. We needed HTML output for documentation on our web server, PDF for customers to read and/or print from their computers, and PostScript for our own printing needs. The result of our efforts is the HTMLDOC software which is available for Linux®/UNIX®, MacOS® X, and Microsoft® Windows®. Among other things, this software users manual is produced using HTMLDOC. Organization of This Manual This manual is organized into tutorial and reference chapters and appendices: Chapter 1 - Installing HTMLDOC • Chapter 2 - Getting Started • Chapter 3 - Generating Books • Chapter 4 - HTMLDOC from the Command-Line • Chapter 5 - HTMLDOC from a Web Server • Chapter 6 - HTML Reference • Chapter 7 - GUI Reference • Chapter 8 - Command-Line Reference • Appendix A - License Agreement • Appendix B - Book File Format • Appendix C - Release Notes • Appendix D - Compiling HTMLDOC from Source • Support Commercial support is available from Easy Software Products when you purchase the HTMLDOC Professional Membership. More information is available at the HTMLDOC web page at the following URL: http://www.easysw.com/htmldoc/ Encryption Support HTMLDOC includes code to encrypt PDF document files using the RC4 algorithm with up to a 128-bit key. While this software and code may be freely used and exported under uploads/s1/ guide-htmldoc.pdf