|
Prev | Next | whats_new_01 |
section command
used to break the OMhelp search utility.
BlockAlloc example
(which was later replaced by the Getting Started Using OMhelp section).
To be specific,
(b->index == info->index) &&
(b->index == info->index),
was changed to
(b->user == info->user) &&
(b->next == info->next),
Larray and Marray classes were getting to complicated
for an example.
They have been replaced by the BlockAlloc example
(which was later replaced by the Getting Started Using OMhelp section).
omh\Larray and omh\LMarray directories
were moved so they are now subdirectories of omh\example.
This was so that the C++ example is better separated from the
rest of the OMhelp documentation.
LMarray template class was extended to include
binary operations between elements and arrays.
childtable commands
where in mixed case (should have been lower case).
This did not work on Unix Systems and has been fixed.
The example command was changed to be the execute
command.
This was done so that the example would refer to an example use of
OMhelp to document source code
(which was later replaced by the Getting Started Using OMhelp section).
If you used the old example command, you will need to change
$example to $execute.
.. from the beginning of each one.
(This is the standard way to use OMhelp and it was confusing to
always have a .. in the front of the path specifications.)
Larray template class.
index.htm in the directory corresponding to the
web site is automatically linked to the
cross reference tag
specified by the first section in file containing the
root section
.
This makes the corresponding section the default page
for an OMhelp web site.
It has the added advantage that you can avoid the confusion
between this use of index.htm and the
index
command.
On the other hand, because of this automatic linking, you
can not longer use index
as a cross reference tag in a begin
command.
The
Larray C++ template class was added as an example
of embedding OMhelp commands in source code.
It is also an example of a
sub-tree that can be built into a separate web site.
children.omh
did not properly correspond to the commands in format.omh.
The verbatim
and include
commands
enable the use of a single input file for the two different output uses
and thereby fixed the true source of this error
(the true source of the error was not using the single source philosophy).
Sometimes the line following a verbatim
command was indented as if it were part of the verbatim
command.
If there was no section command between a begin and an end,
an improper error message about frames was generated.
This has been corrected and the proper error message is reported.
Non-breaking spaces are now used
for all the spaces within a syntax
command.
This prevents the browser from automatically wrapping lines in a
single syntax specification.
(Unfortunately, Microsoft's internet explorer will wrap lines at other
characters besides white space. Thus there are some characters, such as
parenthesis, at which IE will wrap lines in a syntax command.)
file and files).
A set of See Also entries was entered for a lot of
the sections.
childtable,
or children command does not exist,
the corresponding error message now identifies the input file
where the command occurred.
index and cindex
can now link entries in the keyword index
to specific
headings
within a section.
name.gif
.
For example, the input $icon omh/image/icon.jpg$$
results in the following output:
Fixed some special cases where the bold letters in the headings
for the keyword index
and the reference
were not working properly. For example, Alpha in the index was being displayed
before the bold letter A.
The help tree in the table of
contents
for OMhelp was reorganized.
This makes better use of the new navigation side bar
that was part of the changes on
01-06-14
.
The
cross reference tag
for the keyword index was changed (back to its previous value).
This change was from _index to
_keyindex.
This is to avoid conflicts in closeness of name with the
default home page; i.e., index.
Some changes were made to the OMhelp search utility Java script so that it did
not generate error reports under the browsers.
The change on 01-06-04
broke some
links on Unix servers because it is case sensitive. This has been fixed.
All of the output files and links are in lower case now so that they
work the same under Unix and Microsoft systems.
| Old | New | Description |
hreflist |
_external | External Internet References |
keyindex |
_index | Keyword Index |
contents |
_contents | Table of Contents |
funref |
_reference | Alphabetic Listing of Cross Reference Tags |
_, character.
In addition, the user may no longer use the underbar
as the first character in a
cross reference tag
specified by a begin
command.
_search as a
tag
(provided that the printable
option
is not used).
If two sections have the same cross reference tag,
both the current input file name and the one where the
section was originally defined are displayed in the error message.
cindex commands after the
section
command for the current section.
This is no longer the case.
template section was added to the help for OMhelp
(it was later removed).
The files ../omhelp.htm and
../build.bat
were missing from the distribution and are now included.
The spell
command was modified so that capital letters
separate special spellings.
For example, you can use OMhelp as a special spelling
for the word mhelp
local.wrd are included in the distribution (instead
of the binary file dictionary.bin).
This makes it easier to add a local dictionary
because you only have to supply the file local.wrd.
Another feature was added to the
-debug
option.
The spelling errors (words not in the current dictionary)
are listed in alphabetic order in the file error.wrd.
This is intended to aid in creating versions of local.wrd.
(You may want to merge the current version of local.wrd
with some of the words in error.wrd to get a new local word list.)
index.htm will be loaded into your browser
(often the same as the home page).
Previously, you could not name a section index to take advantage
of this because the OMhelp keyword index was stored in that file.
The keyword index for an OMhelp document
is now stored in the section names keyword
and you can use the name index for you default page.
The -debug
was added.
if -debug is present,
the input file corresponding to each
output page is printed.