[<command-line arguments [&]]
[continuation]
Organization
Author, department
Date
Document Title
<null line>

The first line is optional and may contain the command line arguments for minio (except the file name). You can use the "&" to continue the command line arguments.

notes /web/pub/images /web/pub/hdr.html /web/pub/ftr.html

For the above example, the correspondence is described below.

Any line beginning with a percent sign (%) is treated as a comment. That line will not show up in the HTML file that is created. The exception to this is for the header lines that define the title, author, date, etc. Those are positional lines and comments don't apply there. However, the optional first line defining command line arguments may be commented out. You may place as many consequtive comments at the beginning of the file as you wish.

The command line arguments are listed below. You may place command line arguments directly in the document to process and avoid having to enter them at the command line. See section 2.1.1.

Usage: perl minio.pl [file.txt] [-arguments]

• Table of Contents

The optional table of contents continues immediately after the document header and one null line and is specified as follows.

Title <null line> Table of Contents <null line> 1 Section 1 1.1 Sub-section 1 ... n.n Sub-section n <null line>

• Appending Arguments

Even if you have specified in-line arguments in the text file, you can still add arguments at the comand line. For example, you may want to add "-force" to force the overwrite of existing files.

• Configure Redirection

The sub-section is specified as "n.n Description". It is numbered with the number you specify and must match the TOC entry exactly. A dot (n.n) must be included to distinguish it as sub-section. A link will be created from the TOC entry to this sub-section heading. This HTML "UL" block is subordinate to the section list and is in effect until the next section.

For example:

3.1 Sub-sections

A link will be created from the TOC entry to this section heading.

This is the same as the first level except that its scope is within a first level sub-section.

For example:

3.1.3 Second Level

An un-numbered list can be created using the "o" symbol as described below. This list is in effect until a new sub-section or new section is detected. It is used anywhere after the TOC. It makes sense to use it within a sub-section. Its primary use is to provide indented bullet items within a sub-section.

Lists are also useful in creating just a bulleted list with line breaks.

The format argument will also change the type of list symbol used in bullet lists.

Examples:

o History of Greece

  The history of Greece is very colorful. It has spanned many 
  thousands of years.

Produces:

• History of Greece

The history of Greece is very colorful. It has spanned many thousands of years.

A dash list is specified using "-" and is used to create an unnumbered list that can follow a sectino or the bullet list. It can be used anywhere after the TOC but should be used within the scope of a bullet list or wherever an item list is needed where each item is followed immediately by the next item (See examples – below). The processing rule is this:

• Aligned Lists

You can also have aligned lists where the body of the list is on the same line as the list item.

The following:

- Gold     = trading at $300.
- Silver   = trading at $200.
- Platinum = trading at $700.

Produces:

• Gold  - trading at $300.
• Silver  - trading at $200.
• Platinum - trading at $700.
• Other Examples
• Item 1
• Item 2
• Item 3
• Following Bullet
• Nail

We need the nail. Without it, the hammer is useless.

• See costs specified above

The list was ended by a new section.

Quick lists are good for indented lists between other text as the following example illustrates.

Each item is prefaced by a period and is ended by a null line. The HTML wraps the list in a decorative table.

References to sections in your document can be used in many ways to produce links to the relevant sections themselves. An example is the best way to illustrate this.

The following:

When you write "See section 3.2", a link is created to 
section 3.2. Sub-sections also work (section 4.1.1).
Parenthesis can be used in a reference to section (section 5).

Produces:

When you write "See section 3.2", a link is created to section 3.2. Sub-sections also work (see section 4.1.1). Parenthesis can be used in a reference to a section (section 5).

The following:

- See section 2
- See HTML (section 5)
- See Style Sheets (section 5.1)
- See section 3.2.2.o 'Other Examples'
- See [Build and airplane] in section 4.1.1.
- Click [here] in section3.2.2.o 'Other Examples'

Produces:

• See section 2
• See HTML (section 5)
• See Style Sheets (section 5.1)
• See Other Examples
• See Build and airplane.
• Click here

Note that in the last two links, the text within the brackets is the hotlink text. In this way, you can determine the link name but reference the section. The very last link is a to a non-numbered bullet or dash link. The ending .o specifies it is a bullet link. This link refers to the non-numbered section titled 'Other Examples' under sub-section 3.2.2. Any non-numbered subsection is linkable if it is alpha-numeric with spaces, dashes or underscores.

This type of link uses the actual URL specified as the hot link text. Links can be to other sites or local. For a local link, you need only specify the URL type and directory and/or file.

http:public/minio.html

results in public/minio.html.

The following:

One can write a site link "see ftp://ftp.csupomona.edu" and a link
will be made. One can also write "Send Email to help@davelyon.org" or
for just a mail link (without preceeding "Send Email to"), one can
specify mailto:user@address.

Produces:

One can write "see ftp://ftp.csupomona.edu"and a link will be made. One can also write "Send Email to help@davelyon.org or for just a mail link (without preceeding "Send Email to"), one can specify user@address.

• New Windows Links

If you speicify a link as:

http:+//www.davelyon.org

You will get a new window (Javascript call). Click http://www.davelyon.org.

• A Note on Frames

If you are using frames and want a link to display in the current frame, you will need to write a local link. To have the frame set replaced with a new window and reference a link, use a site link. To avoid using a site link for something that is in the local website, just use two colons (directory/page.html). This is know as a "top" link in Minio.

This does not apply to Email or telnet links.

A URL can specified such that the URL is not the hot link text. For example, I could write:

Click http://www.csupomona.edu (here)

which results in "Click here".

The word "here" would be the hot link text (not the URL).

For an image link, the following:

http://www.davelyon.org (/images/new.gif 80,100)
w  h

results in . The width and height are optional.

The image "SRC" is contained inside the parenthesis.

The above links can also be used within a table. See the example below.

Using "(See Figure 1)" with no quotes causes an image reference as you see in



this image. The in-line reference will be to imgpre_image1.gif. The ".gif" extension is the default or whatever you specified with "-imgpre". To override, use "(See Figure 1/jpg)". The figure number corresponds to the image number. The directory for all image files is specified when you run minio.

There is an alternate figure directive that has less restrictions and can be used more than once per line. See below.

figure#(width,height)

Example:

figure1(200,200)

Loads the image in a 200 x 200 pixel space. The coordinates are optional.

The file naming is the same as if you used "(See Figure 1)".

• Literal References

You can also do literal image references by specifying the following syntax. Note that the width and height are optional.

image(/path/file width,height)

You can create a footnote by using the forward and backward slash.

For example:

This formula is not without cost. \3

/3 The costs associated with the study were not verified.

Produces:

This formula is not without cost.³

³ The costs associated with the study were not verified.

• Rules

You can have as many references (\#) to a footnote as you want. The reference must be prefaced by a space and must be placed after text. The footnote referenced must be unique and be the first item in a line (/#). Order is strictly enforced.

While generally not necessary, you can embed html code within the text file you want to process. There are several ways to do this.

• In-Line

The format is as follows.

html[HTML-CODE]

Example:

The following example is wrapped for clarity but the html keyword and html code with closing bracket must be on one line.

html[<table border=4 bgcolor="#c0c0c0"><tr> <th>APPROVED</th></tr></table><br>]

Produces:

APPROVED



• Applicability

The html directive can be used anywhere a link can be used (section 4.3) and can also be used within a preformatted text block.

• Block

You can specify a block of html or javascript as follows.

<script> ........ </script>

<html> ........ </html>

Example:

One

Two

• Include File

The include command can be used to import another file containing html code. The syntax is described below.

$include file

There are no paragraph or newline breaks added except those that are used before and after other constructs such as paragraphs, tables, etc. You may need to add breaks at the beginning and end of the included file, depending on placement of the file.

• Search Links

The search links can be used to create a search link to Amazon's A9 search engine (Book), Google (Find), or Wikipedia (Wikipedia).

Book:(Flip the Switch) Find:(Flip the Switch) Wikipedia:(Abraham Lincoln)

Produces:

Flip the Switch

Flip the Switch

Abraham Lincoln

If you know the author, you can also append "by First Last".

• Print

The Print link can be placed once per line and can be used to bring up the printer dialog to print the document. You can define the CSS to determine the print area using the "print" class (see minio.css).

The following:

You may wish to Print:(print) this document.

Produces:

You may wish to print this document.

Note
To have the print link not show up in the print-out, use PrintH.