[Home] [Downloads] [Search] [Help/forum]

Gammon Software Solutions forum

See www.mushclient.com/spam for dealing with forum spam. Please read the MUSHclient FAQ!

[Folder]  Entire forum
-> [Folder]  MUSHclient
. -> [Folder]  General
. . -> [Subject]  MUSHclient 4.43 packaged up into a zip file
Home  |  Users  |  Search  |  FAQ
Username:
Register forum user name
Password:
Forgotten password?
(New message)
Subject: MUSHclient 4.43 packaged up into a zip file
Name:
Your forum user name.
Register forum user name
Password:
Your forum password.
Forgotten password?
Message:
Message to be posted (in English, please).
Forum codes:
Check this if your message uses 'forum codes' or templates (auto-detected for new posts).
Forum codes Templates

Save this message ...

Subject review (reverse sequence)

Pages: 1 2  

Posted by WillFa   USA  (517 posts)  [Biography] bio
Date Thu 20 Aug 2009 12:44 AM (UTC)  [ quote  ]
Message
Yea, Thank You MS for trying to save me from myself. Don't fix the exploitable holes, fix the user... :| Stupid Unblock button.

The indenting on code samples is part of the css... It can change.

The wonky cross references are because of the whole See_also vs doc_name vs cascading cross refs (general_doc_xref table) kind of stuff. I've made more headway on that.


[Go to top] top
Posted by Nick Gammon   Australia  (18,772 posts)  [Biography] bio   Forum Administrator
Date Thu 20 Aug 2009 12:01 AM (UTC)  [ quote  ]
Message
Looks good now. The examples seem indented, is that intentional?

Some of the cross-referencing isn't perfect, for example ColourNote does not mention Note, and vice-versa (the online one does).
- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by Nick Gammon   Australia  (18,772 posts)  [Biography] bio   Forum Administrator
Date Wed 19 Aug 2009 11:57 PM (UTC)  [ quote  ]
Message
Ah the old Unblock button. Sounds kind of painful. ;)

Well it works now, thanks. I don't remember ever seeing that button before.
- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by WillFa   USA  (517 posts)  [Biography] bio
Date Wed 19 Aug 2009 11:52 PM (UTC)  [ quote  ]
Message
Weird....

I found this

After you install the Microsoft security update MS05-026 (KB896358), CHM help file topics may not display correctly if the file the help file was received via e-mail, or downloaded from the Internet. Instead, an error message such as ‘Action cancelled’ or ‘DNS error’ is displayed.

Recent Microsoft security updates include changes to the InfoTech protocol, which prevent CHM help files from being displayed correctly if the CHM help file is blocked by Windows Attachment Manager. Even if the security warning is acknowledged, the help file is not displayed correctly. The problem also arises when a blocked CHM help file is opened via the HtmlHelp API.


Unblock a blocked CHM Help File

1. In Windows Explorer, right-click the blocked file, and then click Properties.

2. In the General tab, click Unblock.

Open a blocked CHM Help File

1. Double-click the help file in Windows Explorer.

2. If a security warning dialog appears, uncheck the box ‘Always ask before opening this file’.

3. Click Open to open the help file.



See if that help?
other suggestions at http://www.help-info.de/en/xml/maml_troubleshooting_hh.xml

If this is the case, the problem is because you got the file from my website, and shouldn't affect the installed chm.
[Go to top] top
Posted by Nick Gammon   Australia  (18,772 posts)  [Biography] bio   Forum Administrator
Date Wed 19 Aug 2009 10:59 PM (UTC)  [ quote  ]
Message

res://C:\WINDOWS\system32\shdoclc.dll/dnserror.htm#mk:@MSITStore:C:\Program%20Files\MUSHclient\MushClient.chm::/functions/BoldColour.htm
- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by WillFa   USA  (517 posts)  [Biography] bio
Date Wed 19 Aug 2009 10:44 PM (UTC)  [ quote  ]
Message
you can test from the command line with:

C:\>HH.EXE -mapid 12030 ms-its:C:/xTemp/mushclient.chm


12030 is the help context id to pull up.
ms-its: is a literal string (protocol handler)
the path will change accordingly.

Solving the "exe looks for the .hlp" issue is earlier in the thread. All the html help in mfc links give the overide code.

It's weird that you're getting no pages. On one of the error pages, would you mind right clicking, going to properties, and give me the url that it's trying to hit?

it should be something like:

mk:@MSITStore:C:\Users\WillFa\Desktop\MushClient.chm::/general_doc/contents.htm


I'm working on filtering the unhelpful help pages out of the index and full-text search (i.e. GoToUrl has only menu, hotkey, and summary... btw, I can't figure out why you'd grab the mouse, highlight a link, and then go to a menu and select a menu item to open the highlighted link... instead of clicking on it...)

Also, I'm putting the cross-references in the index instead of the page content. The flow of "Go to the index, find a topic, open the topic to find references" seems to defeat the purpose of having an index.

[Go to top] top
Posted by Nick Gammon   Australia  (18,772 posts)  [Biography] bio   Forum Administrator
Date Wed 19 Aug 2009 08:48 PM (UTC)  [ quote  ]
Message
Sorry it took so long, I got distracted by the templates stuff.

I can't get *any* pages to work (from the contents anyway), it says:

Cannot find server or DNS Error
Internet Explorer

How do you suggest I test? Dropping the file into the MUSHclient folder doesn't work because that looks for the old .hlp file.
- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by WillFa   USA  (517 posts)  [Biography] bio
Date Mon 17 Aug 2009 07:13 AM (UTC)  [ quote  ]
Message
I'm working over some kinks with the cross references. I plan on tweaking the index into something more friendly as well, and will probably hit the Table of Contents while I'm at it...

If you wanted a preliminary look, or a chm to test code, context help, and getting rid of winhelp, yadda yadda...

http://cid-73890baf188d56e7.skydrive.live.com/browse.aspx/Public/MC%20Help%20Files

has a chm.

The default contents page needs work... (understatement) pick a few other topics before you pass judgement, please :)
[Go to top] top
Posted by Nick Gammon   Australia  (18,772 posts)  [Biography] bio   Forum Administrator
Date Sun 16 Aug 2009 08:52 PM (UTC)  [ quote  ]
Message
If you send me the sql, I'll probably create a view of the document names, run my eye over it, and then dummy up some SQL to just fix those.
- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by WillFa   USA  (517 posts)  [Biography] bio
Date Sun 16 Aug 2009 05:09 AM (UTC)  [ quote  ]
Message
Yea, if I go through and sort out all the stragglers so that cross links via doc_name are accurate, would you hate reimporting the whole db; opposed to sql for just the CREATE/INSERTs for the toc table and now a create view...

oh, I made a view that does a union on the 5 major tables (not errors) so I could consistently get to a filename id, title, summary, type (command, func, dialog, general, lua), and doc_name category... I had trouble remembering which table had a name vs command_name vs dialog_name... etc. Those are the 5 values I need for each cross reference link.
[Go to top] top
Posted by Nick Gammon   Australia  (18,772 posts)  [Biography] bio   Forum Administrator
Date Sun 16 Aug 2009 04:38 AM (UTC)  [ quote  ]
Message
BlendPixel and FilterPixel do not, strictly speaking, need a miniwindow, so I put them into utils. They simply modify a number giving another number.

You can probably ignore see_also, for one thing it isn't really third normal form, the way I did it. The idea was that see_also would list related things, perhaps not necessarily in the same document (BlendPixel would be an example).

However, discarding any orphans in see_also you should be able to get reasonable results.

Quote:

Would you object to having a .sql with the full db (in sqlite syntax) available that you can munge and import into mysql?


I don't quite understand the question. You mean your modified version, or something else?
- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by WillFa   USA  (517 posts)  [Biography] bio
Date Sun 16 Aug 2009 03:48 AM (UTC)  [ quote  ]
Message
ARGHHHHHHHHHH! *flail like a muppet* ;)

All the cross references are messed up. Some use the "see_also" field, some have doc_name's. Some of the doc_name's are inconsistent (BlendPixel and FilterPixel are grouped with utils, not miniwindows... ?) Some of the doc_names are null.

There's a few orphaned help topics that aren't in the toc, which is generally okay. There's a topic in the toc that doesn't have a help file (DockToolbarNextTo, apparently killed off - google only shows it in the 4.29 diffs file) - and that causes hhc.exe to barf.

I don't mind standardizing the data - ignoring see_also and related_dialog in favor of having consistent doc_name's. Would you object to having a .sql with the full db (in sqlite syntax) available that you can munge and import into mysql? I won't alter the table schema so the php page won't break.


I'm a little concerned about putting a lot of energy into this when you had posted way back when that you didn't have the energy for it. I'm trying to have all my work cause as little work for you as possible. :)

[Go to top] top
Posted by Nick Gammon   Australia  (18,772 posts)  [Biography] bio   Forum Administrator
Date Sat 15 Aug 2009 04:35 AM (UTC)  [ quote  ]
Message
Quote:

Calls docgen.exe to generate the rtf
Calls makehelp.bat, which calls makehm a bunch of times and then calls hwc.exe to compile the .hlp file using static .hpj and .cnt files.


It:


  • Generates the .rtf file help.rtf from the database
  • Calls WriteMapFile (see code snippet) to quickly write out the mapping file help.hm by doing a few selects (makehm is not used).
  • Calls hcw.exe to read in the help.hpj file (copy below). This generates the mushclient.hlp file.



         WriteMapFile (db);

        // generate help file
        printf ("Generating help file ...\n");
        char * args [] = 
          {"hcw", "/C", "/M", HPJ_FILE, NULL };

        if (_execvp (args [0], args) == -1)
          perror ("Invoking help compiler");
        }


This is the help.hpj file:


; This file is maintained by HCW. Do not modify this file directly.

[OPTIONS]
COMPRESS=12 Hall Zeck
LCID=0xc09 0x0 0x0 ; English (Australian)
REPORT=Yes
CONTENTS=DOC_CONTENTS
TITLE=MUSHclient help
COPYRIGHT=Copyright 2003 Gammon Software Solutions
HLP=..\mushclient.hlp

[FILES]
help.rtf

[MAP]
#include help.hm

[WINDOWS]
main="",,27904,(r14876671),(r12632256),f2


You can see from the above that once you have help.rtf and help.hm files, the help generation is pretty straightforwards.



The contents file is totally a manual process. However after a major change I might do the subsections with a few selects as documented in comments in the docgen program, like this:


  select concat("3 ", command_name, "=CMD_", label) FROM commands ORDER BY command_name;


Stuff like the high-level contents, is simply something I did in a text editor. (It practically never changes).
- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by Nick Gammon   Australia  (18,772 posts)  [Biography] bio   Forum Administrator
Date Sat 15 Aug 2009 04:25 AM (UTC)  [ quote  ]
Message
Latest version:

http://www.gammon.com.au/files/mushclient/src/documentation_4_43.sql.bz2

Quote:

Does http://www.gammon.com.au/scripts/doc.php?general=scripting hit a mysql db that you control ...


Yes, I unzip that file, then just do:


mysql < documentation_4_43.sql


... plus a couple of extra bits to specify the database server location, username, password etc. Basically I bang the whole SQL into the server database, which is therefore a copy of what I have locally .

I use the local copy to generate the help files, and the HTML files (when generated). The server copy is used to serve up pages like the one you mentioned.

The copy process from my local copy to the server copy is effectively the "handover" when a release goes live.


- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by WillFa   USA  (517 posts)  [Biography] bio
Date Sat 15 Aug 2009 04:06 AM (UTC)  [ quote  ]

Amended on Sat 15 Aug 2009 04:08 AM (UTC) by WillFa

Message
Oh regarding the sqlite and mysql conversion statement...

The script starts with require "luasql.sqlite3", changing that to "luasql.mysql" and changing the db:connect(DBpath) to db:connect(DBpath, username, pw, server, port) should be all you need to generate a chm for future versions. I'm making a point to use sql statements that work in both engines.



I'm guessing but I think your current build process basically

Calls docgen.exe to generate the rtf
Calls makehelp.bat, which calls makehm a bunch of times and then calls hwc.exe to compile the .hlp file using static .hpj and .cnt files.

With the new stuff you'd:
Call HTMLhelp.lua which connects to a database, generates the html files, generates the help context ids, generates file lists, generates a Table of contents, generates the index, and then calls hhc.exe to compile the .chm file.

hhc.exe is part of the HTML Help Workshop, which you can download here: http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
[Go to top] top

The dates and times for posts above are shown in Universal Co-ordinated Time (UTC).

To show them in your local time you can join the forum, and then set the 'time correction' field in your profile to the number of hours difference between your location and UTC time.

7,255 views.

This is page 1, subject is 2 pages long: 1 2  [Next page]

[Reply to this subject]  Reply to this subject   [New subject]  Start a new subject   [Refresh] Refresh page

Go to topic:           Search the forum

[Go to top] top

[Home]

Written by Nick Gammon - 5K

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( http://www.gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Internet Contents Rating Association (ICRA) - 2K]    [Web site powered by FutureQuest.Net]