Prev Next wish_list

OMhelp Wish List

cref
XML Drop Down Menus Not Working
Home Page
Jump Table
Deprecate Features
Image
Tables
Parent Section
source-highlight
Comment Character
spell
th
$$

cref
Have a way for the cref to refer to current file (so works automatically when one moves or copies the file). Automatically include text used for linking, e.g., cross reference tag, heading, and subheading, in spelling list for this section.

XML Drop Down Menus Not Working
The script bug/drop_down.sh demonstrates this bug. If you run the javascript debugger, the xml file will result in the error message 
 
     TypeError: document.write is not a function
Currently there are calls to the javascript document.write function in the xml version of the output. This was done to group buttons with the corresponding javascript and so that the same button menu could be used in multiple files. This is not allowed because xml parsers cannot handle document.write. A separate file, with the corresponding xml, should be used for these button menus.

Home Page
Make the top level documentation page, on github, the home page for OMhelp.

Jump Table
Put _jump_table just before first heading (after text that comes before first heading).

Deprecate Features
Output a warnings the first time a deprecated feature is used. For example, it should produce a warning when OMhelp is used without the noframe option. This is in preparation for removing deprecated features.

Image
Extend the image and icon commands so they can use images available on the web, in addition to those available locally.

Tables
Add a version of the table command that specifies the number of spaces between columns and the adjustment for each column (center, top, bottom, right, left) and possible other options that tables can have; e.g.,
     $tbl/spaces/$$
     $tbl/spaces/adjust_1/$$
     $tbl/spaces/adjust_1/adjust_2/$$
Parent Section
Add a command that says this section is the parent for all other sections that appear in the same file. Perhaps this would have to be the first section in the file.

source-highlight
Add a language definition for OMhelp to the srcfile command; see bin/highlight.sh .

Comment Character
It would be nice to allow for more than one character in the newlinech command so that C++ // comments can be recognized. Perhaps this should be a new command called nlcomment.

spell
Print a warning when a spell command entry does not appear in the corresponding section (not necessary).

th
Change the $th command to use the same font as $icode.

$$
Only commands that do not allow other commands inside should be terminated by the $$. Use a special termination command for others; e.g., $center could be terminated by $endc.
Input File: omh/wish_list.omh