News:

MASM32 SDK Description, downloads and other helpful links
MASM32.com New Forum Link
masmforum WebSite

New CHM "masmlib" help file

Started by hutch--, October 11, 2007, 05:36:58 AM

Previous topic - Next topic

hutch--

This is the next one I have finished. It is the reference for the masm32 library in the later CHM format for late versions of Windows where Winhelp is no longer supported. It all seems to be working OK. Any feedback is welcome and in particular if I have missed any links or similar errors.

LATER
I have removed the original attachment and replaced it with the version I am happy with. I am in debt to Yves for his assistance in tracking a number of link errors and for the suggestions along with examples that he has posted. i ended up writing an index file generator and have the format that I prefer with help files of this type, a table of contents for the headings and an index of the items in the file.

[attachment deleted by admin]
Download site for MASM32      New MASM Forum
https://masm32.com          https://masm32.com/board/index.php

Vortex


Jimg

Are you accepting UI and artistic requests at this point, or only content?

ToutEnMasm

Ok very good work in which i have don't see missing links but ...
I have decompiled it with the html help workshop and see a very poor index file.
If we want to call it by F1 perhap's this don't work !?
        ToutEnMasm

ToutEnMasm


I have put the decompiled files in my html editor.
I found
deads links
Emcryption components: There is only one file for three differents links
Floattostr : bad link  FloatToStr/2  delet /2     in Floating point conversion.htm
Three files have no link on them
imalloc.htm
masm32.inc.htm
masm32.lib.htm

a generator for the index files is downloadable on the manos forum (application)


ToutEnMasm


I made here my best critic,another file with an index and the list of them.
Corrections has been made for links and files not called.


[attachment deleted by admin]

hutch--

Gratsie,

Two of the files should not be there and I will fix the links to the others.

LATER : here is the fixed version will all of Yves corrections.

When you convert from Winhelp format using htmlhelp lworkshop you get the results in very degraded form. i run them all through a convertor I had to write to rename the files to their topic name and rename the links to a readable name. I do as much reformatting of the mess as possible with the convertor and the result is more or less runnable.

I still have to manually format every file which is slow and tedious and so far I have written a TOC generator which seems to work OK. I need to do an index file generator as well but I have to get its format first.

[attachment deleted by admin]
Download site for MASM32      New MASM Forum
https://masm32.com          https://masm32.com/board/index.php

ToutEnMasm

Hello,
I also modify the hhelp (macros) to put an index in it.
If you want an index generarator there is one on the manos forum (application)


[attachment deleted by admin]

hutch--

Jim,

> Are you accepting UI and artistic requests at this point, or only content?

I will listen to most things but I will only act on errors and siimilar as I have a lot more to do with these help files.
Download site for MASM32      New MASM Forum
https://masm32.com          https://masm32.com/board/index.php

Jimg

Alright, here are some suggestions you might want to consider-

Use a cascading style sheet (.css) for your setup.  It makes it much easier to change something on many or all pages if the need ever occurs, and cuts down on the overall size by eliminating repeated code.

Include the project file (.hpp) in the chm to make it easier for users to play around, find/fix problems,etc. if they have the inclination.  (Also as I found out the hard way, it makes a good backup in case of disaster.)  You will have to manually type in the file name, it doesn't show up on the browse.

Add the Options window button to the top.   I would also add the Print button, but it can be reached from the options button.

Add the search tab to the navigation pane.  It adds a little to the size, but so much to the functionality it's well worth it.

In your table of contents, using %20 for a blank in the file names causes errors when I compile.  Why don't you just use a blank?

I personally find light gray on dark gray letters hard to read, but that may be just me.

Let me know if I can be of any assistance. ( I am currently responsible for the WinAsm Studio help file.)


hutch--

Jim,

Thanks for the offer, trhe main problem for me is to get enough work done to convert all of the Winelp format files to CHM. The CSS file makes sense but not if you saw the condition I get the HTML files in after conversion from Winhelp. I changed the standard buttons by creating a Window type in the help workshop.I5s easy enough to add the print button back into the file but I did not see the point of doing it.

None of the config files for the project use %20, the all use a normal space as I generate these files myself rather than the terrible interface in the help workshop.

The next thing I have to write is a nested TOC generator, the one I have at the moment only does one deep.

I get the impression that a new help file is much easier to create than a converted Winhelp one, the layout of my old Winhelp files was OK and internally tidy but much was lodst in conversion which made the formatting very slow to make it readable.
Download site for MASM32      New MASM Forum
https://masm32.com          https://masm32.com/board/index.php

Jimg

There are 10 occurances of separate being mispelled-
Quote"J:\MasmHelpFiles\Masmlib\AboutBox.htm"
66: seperate static text control, the first two can only be displayed as a

"J:\MasmHelpFiles\Masmlib\ArgByNumber.htm"
56: any combination of these three. It may be used in two seperate modes,
62: In <b>seperate argument mode</b> you specify the argument you wish to obtain with the <b>"num"</b> parameter and you set the <b>"npos"</b> parameter to zero.<br>

"J:\MasmHelpFiles\Masmlib\CreateMMF.htm"
24: seperate processes.<br>

"J:\MasmHelpFiles\Masmlib\index.htm"
24: Each procedure has been written as a seperate module to prevent any

"J:\MasmHelpFiles\Masmlib\nrandom.htm"
18: in a seperate procedure atached to the library module. The variable is <b>nrandom_seed</b> and this variable should be set with a DWORD size number prior to the use of this algorithm.<br></div><br></div>

"J:\MasmHelpFiles\Masmlib\OpenFileDialog.htm"
26: seperate variable and used in the macro.You should test for the user

"J:\MasmHelpFiles\Masmlib\SaveFileDialog.htm"
26: seperate variable and used in the macro.You should test for the user

"J:\MasmHelpFiles\Masmlib\String Sorting.htm"
67: There are three seperate sorting algorithms that can be used by the two

"J:\MasmHelpFiles\Masmlib\szMultiCat.htm"
19: 3. <b>args</b> is the comma seperated parameter list.<br></div><br><big style="color: white;"><big><b>Return Value</b></big></big><br><div style="margin-left: 40px;">

hutch--

Jim,

Thanks, at least I am consistent when misspelling a word.  :bg
Download site for MASM32      New MASM Forum
https://masm32.com          https://masm32.com/board/index.php