20 Jun 1995 - Preliminary Information

# The SpHyDir Project

SpHyDir is an Object Oriented tool that builds documents for Web Browsers such as Netscape, Mosaic, and Web Explorer. With SpHyDir the user concentrates on the important issues of content and overall document structure. Since SpHyDir automatically generates the HTML (Hypertext Markup Language), it is possible to generate flawless Web documents without studying obscure syntax diagrams.

A Web document is an ordinary text file that contains formatting instructions in the form of HTML "tags". Normally, these tags are processed by a Web Browser (such as Netscape Navigator) and are then viewed on a computer screen. If the final image "looks right" then many authors are satisfied. This is resonable when producing a single personal home page.

A library of information should adopt a common document structure. Similar information should have a common format. The same type of information should be presented in the same way on all files. The reader should be able to jump to releated information, or to view a sequence of documents covering a larger topic. Traditional printed books solve this problem with chapters, page numbers, a table of contents, an index, and the editorial control of a professional publisher.

SpHyDir is the Structured Professional Hypertext Directory Manager.

- It is Structured because it sees a Library that contains Documents that are made up of interlinked HTML Files. Each File contains Sections (Chapter, Topic, Appendix) which in turn contain figures, paragraphs, lists, and tables. Each of these document elements is presented as an Object and the overall document is structured as a tree of such Objects.

- It is Professional because it makes it easy for the author to control more of the advanced Web features than any other tool. Simple HTML editors and Word Processing packages insert only the most basic tag options. A professional job requires more: alternate text should be provided if the user chooses not to fetch images automatically, image sizes should be included in each reference so the browser can operate at maximum efficiency, parameters should be used to generate special effects efficiently rather than transmitting images, etc.

- It is Hypertext because links between documents and to other files can be made through simple Drag-and-Drop. To build a link to a remote Web resource, just display the resource in Web Explorer. SpHyDir will pick the URL reference out of the WE window and attach it to text or to an image in the document under construction.

- The Directories of an HTML library contain related files. An editor or word processor handles one file at a time. SpHyDir manages the structure of interrelated files and automatically generates navigational information such as Next and Previous pointers.

SpHyDir runs in OS/2 Warp and follows the Workplace model of its user interface. The user drags a document into the workarea. New elements are added to the document by dragging empty paragraph, image, list, or forms objects and dropping them into the document. Hypertext links are created by dragging files from the library or URL references from a Web Browser and dropping them on existing text or images.

SpHyDir only reads Web (HTML) documents. However, after editing it produces both a revised *.HTM file and a second *.IPF file that is input to the OS/2 Help compiler. IPF source can be used to generate INF documentation and HLP program help files. INF files can be viewed in OS/2 and (with a tool from IBM) in Windows. Viewing information from a local hypertext file is faster, and there are additional keyword search functions not available through the Web. The document you are now viewing (and its related files) are also available as SPHYDIR.INF. Since this represents a useful example of many SpHyDir features, the source is available for download along with the SpHyDir program.

Project Status (June 20)

SpHyDir changes weekly (sometimes daily). The Status document keeps users aware of bugs fixed and new features that have been added.

SpHyDir Project Objectives

SpHyDir is designed to manage large documents or libraries on the Web. It doesn't provide access to every formatting option, and may not be the best choice for the unusual graphic layout common in things like advertising brochures.

The SpHyDir Idea

To understand SpHyDir, you need to see the screen layout.

SpHyDir is not for Everyone

There is a large, vocal community of people who feel very strongly about HTML syntax. Avoiding HTML entirely will probably offend them.

How to Get SpHyDir

SpHyDir can be downloaded to your machine right now. Of course, it only runs in OS/2 Warp.

Using SpHyDir

How to do the most common things.

The Toobar and Document Objects

Definition and use of document objects (sections, images, paragraphs, lists, points, etc.).

Managing Links

Creating hypertext links from images or hotwords to other documents in the Web.

The Subdocument Tree

Hypertext works better if the individual files are small. Logical documents are constructed by linking files together as subdocuments. SpHyDir manages the process.

Extending SpHyDir with Rexx Code

SpHyDir is written in Rexx. Rather than including every feature that anyone might want, the SpHyDir strategy is to define interfaces at strategic points to external Rexx programs that the user can code.

Forms Support

Web forms provide for simple data entry through simple text fields, check boxes, radio buttons, and selection lists.

Bugs and Restrictions

Supported and Unsupported HTML

Character Sets

PCLT

Copyright 1995 PCLT -- SpHyDir Web Document Manager -- H. Gilbert
May be distributed with SpHyDir program

This document generated by SpHyDir, another fine product of PC Lube and Tune.