AscToHTM Documentation for AscToHTM conversion utility
This documentation can be downloaded in .zip format.

The HTML version of this document has, of course, been produced using AscToHTM itself, no post-processing has been done to the HTML pages produced. The contents list, the navigation bar and all the hyperlinks have been generated from a single source document A2HDOCO.TXT (nearing 4,000 lines and still growing) and a few small configuration files. See section 6.1 of this document to see a list of the actual files involved.

This document describes AscToHTM V2.3, which will be available in late April 1998, and which will introduce full wildcard support and the directory page feature (see 6.3.9) for the first time.

1 Introduction

1.1 AscToHTM's design objectives
1.2 Expected uses of AscToHTM
1.3 Other uses of AscToHTM

2 Installation

2.1 VMS installation
2.2 Windows installation

2.2.1 InstallShield version
2.2.2 Simple .ZIP file version
2.2.3 Console application

3 How AscToHTM works

3.1 The big assumption
3.2 The analysis pass
3.3 The output pass

3.3.1 Generating HTML
3.3.2 Generating a contents list
3.3.3 Splitting the document into many HTML pages

4 Running AscToHTM

4.1 Windows version

4.1.1 Normal activation
4.1.2 Execution from a command line
4.1.3 Drag'n'Drop execution

4.2 VMS and console application versions

4.2.1 Command line arguments
4.2.2 Command line qualifiers The /CONTENTS qualifier The /DEBUG qualifier The /DOS qualifier The /SIMPLE qualifier The /POLICY qualifier The /INDEX qualifier

4.3 Making your first attempt

4.3.1 From the command line
4.3.2 From Windows

4.4 Refining your results

4.4.1 Using a policy file
4.4.2 Using a link dictionary
4.4.3 Using multiple policy files
4.4.4 Creating DOS -compatible files

4.5 Processing several files at once

4.5.1 Using wildcards
4.5.2 Using a steering command file

4.6 Other tips and tricks

4.6.1 General
4.6.2 Link dictionary
4.6.3 Contents List detection
4.6.4 Using "Send to" in Windows 95/NT
4.6.5 Tables

5 HTML markup produced

5.1 Text layout

5.1.1 Indentation
5.1.2 Hanging paragraph indents
5.1.3 Bullets Bullet chars Numbered bullets Alphabetic bullets Roman Numeral bullets

5.1.4 Centred text
5.1.5 Definitions Definition lines Definition paragraphs

5.2 Text formatting

5.2.1 Quoted lines
5.2.2 Emphasis

5.3 Added hyperlinks

5.3.1 Contents List lines
5.3.2 Cross-references
5.3.3 URLs
5.3.4 Usenet Newsgroups
5.3.5 E-mail addresses
5.3.6 User-specified keywords

5.4 Section headings

5.4.1 Numbered headers
5.4.2 Capitalised headers
5.4.3 Underlined headers
5.4.4 Numbered paragraphs

5.5 Pre-formatted text

5.5.1 Lines and form feeds
5.5.2 User defined pre -formatted text
5.5.3 Automatically detected pre-formatted text Tables Code samples Ascii art and diagrams Other formatted text

5.6 Added value markup

5.6.1 Document Title
5.6.2 Contents lists Contents lists in default conversions Contents lists in conversions to a single HTML file Contents lists in conversions to multiple HTML files

5.6.3 Directory page
5.6.4 Headers, footers and JavaScript

6 Using Document Policy files

6.1 An example conversion
6.2 Analysis policies

6.2.1 General Analysis policies "Indent position(s)" "Definition Char" "Hanging paragraph position(s)" "Page width" "Text justification" "Expect blank lines between paras" "New paragraph offset" "Keep it simple" "Min chapter size" "Short line length" "Expect code samples"

6.2.2 Bullet policies "Expect Numbered bullets" "Expect alphabetic bullets" "Expect Roman Numeral bullets" "Bullet Char"

6.2.3 Headings "First Section Number" "Expect Numbered Headings" "Expect Underlined Headings" "Expect Capitalised Headings" "Expect Second Word Headings" "Smallest possible section number" "Largest possible section number" "xxxx level 1 = "" N.N at indent 2"

6.2.4 Pre-formatted text "Minimum automatic <PRE> size" "Minimum TABLE column separation"

6.2.5 Contents List policies

6.3 Output policies

6.3.1 Added HTML details "Document Title" "Use first heading as title" "Use first line as title" "Document keywords" "Document description" "HTML Script file" "HTML header" "HTML footer" "Background Image" Various colour policies

6.3.2 Hyperlinks "Create hyperlinks" "Create mailto links" "Create NEWS links" "Only use known groups" "Recognised USENET groups" "Cross-refs at level"

6.3.3 File generation "Input directory" "Output directory" "Use .HTM extension" "Use DOS filenames" "DOS filename root" "Split level" "Min HTML File size" "Add navigation bar" "Output policy file" "Output policy filename" "Generate diagnostics files"

6.3.4 Contents "Add contents list" "Expect contents list" "Use any existing contents list" "Generate external contents file" "External contents list filename" "Hyperlinks on numbers"

6.3.5 Preprocessor policies "Use Preprocessor" "Include document section(s)"

6.3.6 Style "Document style sheet" "Highlight definition text" "Use <DL> markup for defn. paras" "Allow automatic centring" "Automatic centring tolerance" "Largest allowed <Hn> tag" and "Smallest allowed <Hn> tag" "Ignore multiple blank lines" "Search for emphasis" "Allow definitions inside PRE" "Use < CODE>..</CODE> markup" "Use <P> markup for paragraphs"

6.3.7 Table Generation "Attempt TABLE generation" "Default TABLE border size" "Default TABLE header rows" "Default TABLE header cols" "Default TABLE cell spacing" "Default TABLE cell padding" "Default TABLE colour" "Default TABLE border colour" "Default TABLE caption" "Default TABLE width" Other table related policies

6.3.8 Link Dictionary
6.3.9 Directory Page "Make Directory" "Directory filename" "Show file titles in Directory" "Indent headings in Directory" "Directory title" "Directory keywords" "Directory description" "Directory return hyperlink text" "Directory Script file" "Directory header file" "Directory footer file"

6.4 Saving and loading policy files

6.4.1 Overview
6.4.2 Generating policy files for your document Partial policy files Full policy files

6.4.3 Naming policy files

7 Using the preprocessor

7.1 Marking up sections of text

7.1.1 User SECTIONS
7.1.2 TABLE sections
7.1.3 CONTENT sections
7.1.4 HTML sections
7.1.5 CODE sections
7.1.6 DIAGRAM sections
7.1.7 PRE (pre-formatted text) sections

7.2 Commands that influence the <HEAD>..</HEAD> of a file

7.2.1 The TITLE command
7.2.2 The DESCRIPTION command
7.2.3 The KEYWORDS command
7.2.4 The STYLE_SHEET command

7.3 One line pre-processor commands

7.3.1 The INCLUDE command
7.3.2 The HTML_LINE command

7.4 The TABLE commands

8 Purchasing AscToHTM

8.1 Why should I purchase AscToHTM?
8.2 What happens if I don't register the shareware version of AscToHTM?
8.3 Can't I get something for nothing?
8.4 I'm convinced. How to I purchase AscToHTM?

9 Contacts on the Web

9.1 The home page
9.2 E-mail
9.3 Support

10 Known problems

10.1 Bug fixes
10.2 Features
10.3 Coming soon... or not.

11 Policy Dictionary
12 Change History

12.1 Version 1.01 (April '97)
12.2 Version 1.04 (early July '97)

12.2.1 Bug fixes
12.2.2 New functions
12.2.3 Other changes

12.3 Version 1.05 (late July '97)

12.3.1 Bug fixes
12.3.2 New functions
12.3.3 Other changes

12.4 Version 1.1 (August '97)

12.4.1 Bug fixes
12.4.2 New functions
12.4.3 Other changes

12.5 Version 2.00 (October '97)

12.5.1 Bug fixes
12.5.2 New functions
12.5.3 Other changes

12.6 Version 2.10 (never officially released)

12.6.1 Bug fixes
12.6.2 New functions
12.6.3 Other changes

12.7 Version 2.20 (Feb '98)

12.7.1 Bug fixes
12.7.2 New functions
12.7.3 Other changes

12.8 Version 2.3

12.8.1 Bug fixes
12.8.2 New functions
12.8.3 Other changes

Prev | Next | Contents

Converted from a single text file by AscToHTM
© 1997, 1998 John A. Fotheringham