Prev Next Top
This application contains an extensive feedback system; it has four components:
- The status bar:
It displays the completion report of the last command. Usually it contains the name of the last command but it may contain an error message that explains why the last command was not successful (ex. if you open a binary file instead of your source HTML document).
- The title bar:
It contains the application name "HTMLslicer" and the file path of the selected source document file.
- The Drop Area and Activity Report text area:
It contains a list of processing steps that went through while generating the resulting HTML pages and the TOC file. Each step uses one line. Each line starts by an alert-level tag followed by a detailed message. (See Drop Area and Activity Report below).
- The generated report file:
A file named "JHSplitterLog.txt" is generated and is located in the same directory as your source HTML document. It contains the same information displayed in the text area plus extra information. This file will help resolve problems that you might encounter while processing your source HTML document. (See Generated Report File below)
The messages generated by this application contain two parts: An alert-level tag as a prefix and a body part that follows. There are four possible alert-level tags:
- INFO:
This represents the lowest alert level, it just confirms that the step or operation went successfully.
- WARN:
This represents a low alert level, it means that the related step or operation completed fully but with some compromises.
- ERR:
This represents an error message, it means that the step or operation has not been accomplished for the reason explained in the message.
- FAIL:
This represents an application-level error message; the application cannot continue properly under such a circumstance.
This text area contains a long list of messages; each corresponds to a processing step of your source document. The steps are in the following general sequence:
- Opening of all the required files
- Slicing the source HTML document (there is one line report for each segment or slice)
- Naming of the segments
- Adjusting the hyperlinks contained in the segments
- Saving of all segments using the specified templates (there is one line report for each segment) Important Note: If a segment name is identical to your source document file name, the latter will be renamed with "0-" prefix. You get a full set of your resulting HTML pages without overwriting your precious source file. A warning message will be generated. ATTENTION: If a segment name is identical to any other file that is already located in the directory, it will be overwritten; pay special attention to the names of your templates located there.
- Creation of the TOC (Table of Content) HTML file (if requested by the setup)
- Creation of the required JavaHelp metadata files (if requested by the setup)
A report file named JHSplitterLog.txt is created (replacing the previous one, if any) when a source document file has been selected. Each time the File > Slice HTML command is given (on the same file), a report of the activity is appended to the file. Each report is separated by the following message:
"INFO: ========================================="
Each report contains three sections, each one is separated by a series of dashes (i.e. --------) in this order:
- The section of collected information. It is a list of main headings of the segments, followed by a list of heading titles with their eventual bookmarks ID (i.e. the NAME attribute of the HTML <A> tag).
- The content of item type identifiers (See TOC Template) from the selected TOC template (An item type identifier describes the format to be used for generating an item of the table of content).
- A copy of the Drop Area and Activity Report text area display
Any error found will also be reported in the report file.
Prev Next Top