1. ver 4.0 docs
- Posted by bernie Aug 15, 2008
- 1428 views
How about a HTML zipped version of the 4.0 Manual.
The CHM version has no way to search for a subject in it.
Thanks in advance !
2. Re: ver 4.0 docs
- Posted by ne1uno Aug 15, 2008
- 1454 views
The CHM version has no way to search for a subject in it.
I am using an old version of html help workshop, I see no way to turn on bookmarks, favorites or search topic. skimming a few tutorials, they make no mention of such things.
you can find the first similar item in the index tab and I put a link to the "table of contents" on the top of each page.
I don't know why it doesn't display the found item automatically when it is the only one, as some other chm do. you have to hit enter or hit the display button near the bottom.
I hope I can find a better help generator soon.
3. Re: ver 4.0 docs
- Posted by jeremy (admin) Aug 16, 2008
- 1413 views
I'll add to my build process uploading a .zip and .tar.gz of the docs. I'll start w/my next upload which should be later today.
Jeremy
4. Re: ver 4.0 docs
- Posted by jeremy (admin) Aug 17, 2008
- 1437 views
New docs are online and with it is html.zip. I will make a link on the site this week so it's more accessable. For now, the link is:
http://openeuphoria.org/docs/html.zip
Jeremy
5. Re: ver 4.0 docs
- Posted by euphoric (admin) Aug 17, 2008
- 1423 views
Seems that none of the 4 Language Reference links work.
6. Re: ver 4.0 docs
- Posted by euphoric (admin) Aug 17, 2008
- 1639 views
Seems that none of the 4 Language Reference links work.
Actually, none of the links work for me.
7. Re: ver 4.0 docs
- Posted by bernie Aug 17, 2008
- 1412 views
New docs are online and with it is html.zip. I will make a link on the site this week so it's more accessable. For now, the link is:
http://openeuphoria.org/docs/html.zip
Jeremy
Thank You !
8. Re: ver 4.0 docs
- Posted by twbeaty Aug 17, 2008
- 1402 views
New docs are online and with it is html.zip. I will make a link on the site this week so it's more accessable. For now, the link is:
http://openeuphoria.org/docs/html.zip
Jeremy
Thank You !
Woo-hoo! Thank you! Thank you! Thank you!
- Travis.
9. Re: ver 4.0 docs
- Posted by jeremy (admin) Aug 17, 2008
- 1443 views
Seems that none of the 4 Language Reference links work.
Actually, none of the links work for me.
Opps! I am away, I am not going to be back for a few hours but will fix it then. I used a new parameter and I guess that changes the way links work. I didn't notice it.
Jeremy
10. Re: ver 4.0 docs
- Posted by jeremy (admin) Aug 17, 2008
- 1423 views
- Last edited Aug 18, 2008
Opps! I am away, I am not going to be back for a few hours but will fix it then. I used a new parameter and I guess that changes the way links work. I didn't notice it.
Sorry about the doc mix up this morning. I am home now and corrected docs are uploaded.
Jeremy
11. Re: ver 4.0 docs
- Posted by jcmarsh Aug 20, 2008
- 1564 views
To: ne1uno
I've been searching the net, and I found the most up-to-date version of "HTML Help Workshop" that Microsoft offers.
It says: "There are no plans to add any new features to HTML Help." So I'm assuming this is the most recent version.
http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
http://msdn.microsoft.com/en-us/library/ms669985.aspx
The version from both links is identical.
12. Re: ver 4.0 docs
- Posted by jcmarsh Aug 20, 2008
- 1411 views
To: ne1uno
Since it looks like you are using HTML Help Workshop already, and the search function is not currently working, here's how to enable it.
How to enable search in chm:
In "HTML Help Workshop", To enable full-text search:
1. Open a project (.hhp) file, and then click Change Project Options.
2. Click the Compiler tab, and select the Compile full-text search information check box.
13. Re: ver 4.0 docs
- Posted by ne1uno Aug 20, 2008
- 1372 views
- Last edited Aug 21, 2008
To: ne1uno
Since it looks like you are using HTML Help Workshop already, and the search function is not currently working, here's how to enable it.
maybe that actually works in a newer version, it's enabled already. I'll try it when I get to download the executable later. I already had the newest docs. I remember that they were no longer updating htmlhelp so I may already have the latest version.
maybe one of the htmlhelp doc chm have a working search and I can decompile it. but thanks.
14. Re: ver 4.0 docs
- Posted by jcmarsh Aug 20, 2008
- 1395 views
- Last edited Aug 21, 2008
To: ne1uno
Since it looks like you are using HTML Help Workshop already, and the search function is not currently working, here's how to enable it.
maybe that actually works in a newer version, it's enabled already. I'll try it when I get to download the executable later. I already had the newest docs. I remember that they were no longer updating htmlhelp so I may already have the latest version.
maybe one of the htmlhelp doc chm have a working search and I can decompile it. but thanks.
I admire your work on the chm Help file for Euphoria 4.0 pre alpha, and I have been looking at it for the last two days. I got the updated version today and was able to decompile and then recompile it using different compiler options. The version I made worked so well I decided to post it on the Archive. It's quite a bit larger than your compiled version, but it includes Search and Favorites, which yours did not at the time of my writing. I developed and tested it on Windows Vista. It should work on all other Windows OSes because the format is the same.
I called it "Enhanced UnOfficial Euphoria version 4 pre alpha chm Help file" after your project.
The name of the file is "jceu4uo.zip" and contains the project file "jceu400.hhp" which can be opened by "HTML Help Workshop" and compiled if all of the files it includes are in the same directory as the project file.
Maybe if you can get it to work on your computer, you can combine the two projects.
15. Re: ver 4.0 docs
- Posted by jcmarsh Aug 20, 2008
- 1424 views
- Last edited Aug 21, 2008
For now, you can view my public files at:
16. Re: ver 4.0 docs
- Posted by jcmarsh Aug 20, 2008
- 1417 views
- Last edited Aug 21, 2008
For now, you can view my public files at:
Correction: http://sites.google.com/site/runintrack/uploads
17. Re: ver 4.0 docs
- Posted by ne1uno Aug 20, 2008
- 1378 views
- Last edited Aug 21, 2008
was able to decompile and then recompile [it] using different compiler options. The version I made worked so well I decided to post it on the Archive.
looks pretty good, I will have to generate the html w/o the in the headers for next time, it messes with the search topics. I see no real difference in the hhp file, so it must be a newer version of htmlhelp dll's or htmlhtml workshop.
careful, next thing you know you will be beta testing 4.0
18. Re: ver 4.0 docs
- Posted by ne1uno Aug 20, 2008
- 1384 views
- Last edited Aug 21, 2008
was able to decompile and then recompile [it] using different compiler options. The version I made worked so well I decided to post it on the Archive.
looks pretty good, I will have to generate the html w/o the &(nbsp); in the headers for next time, it messes with the search topics. I see no real difference in the hhp file, so it must be a newer version of htmlhelp dll's or htmlhtml workshop.
careful, next thing you know you will be beta testing 4.0
19. Re: ver 4.0 docs
- Posted by jcmarsh Aug 21, 2008
- 1381 views
I corrected the search problem by creating a program to remove some of the nbsp strings in the html file set. The updated zip is on my website.
20. Re: ver 4.0 docs
- Posted by ne1uno Aug 21, 2008
- 1458 views
I corrected the search problem by creating a program to remove some of the nbsp strings in the html file set.
I regenerated all the html to remove nbsp and added section headers for titles on each page. this improves the look of search and favorites titles. the htmlhelp from msdn was the same 1.3 version I had. I think you need a newer operating system before they let you download the 1.4 version. but, with the hhp file you included I was able to copy the [WINDOWS] section and enable search and favorites! I added a stp file with a few simple words to limit the size a little.
still to do, why is the htmlhelp generated toc so bad? maybe with the newer version and removal of nbsp it will work better for you? and no bookmarks tab yet.
temp upload new version I updated my version on the archive. have a look.
22. Re: ver 4.0 docs
- Posted by jcmarsh Aug 21, 2008
- 1356 views
Use the following to display toc if you don't know how to already:
Main="Euphoria 4.0","toc.hhc","Index.hhk","eu400_0002.html","eu400_0001.html",,,,,0x63420,,0x387e,,,,,,3,,0
As for links in the toc, it directs you to the page not the section. They may have to be set manually to jump to the right section.
PS. The font yours generates doesn't read that well on my computer. I don't know which font mine uses, I set it to blank.
23. Re: ver 4.0 docs
- Posted by ne1uno Aug 21, 2008
- 1368 views
As for links in the toc, it directs you to the page not the section. They may have to be set manually to jump to the right section. [...] I don't know which font mine uses, I set it to blank.
the exact section would be better, the page name is a comprimize so you don't see a bunch of Note:, Comment: etc links with no context. setting font to blank is a good idea, was Tahoma, 9 the size seems to be ignored anyway here.
thanks to the dev's for putting together the eudoc system, and converting all the include and doc files to use it in so short a time. it would be impractical to fine tune the output html without it.
24. Re: ver 4.0 docs chm links to sections now work - don't know why
- Posted by jcmarsh Aug 28, 2008
- 1330 views
As for links in the toc, it directs you to the page not the section. They may have to be set manually to jump to the right section. [...] I don't know which font mine uses, I set it to blank.
the exact section would be better, the page name is a comprimize so you don't see a bunch of Note:, Comment: etc links with no context. setting font to blank is a good idea, was Tahoma, 9 the size seems to be ignored anyway here.
thanks to the dev's for putting together the eudoc system, and converting all the include and doc files to use it in so short a time. it would be impractical to fine tune the output html without it.
Somehow I got the exact section to work. It's not pretty, just a working copy. I used the latest html.zip posted by Jeremy.
[OPTIONS] Binary TOC=Yes Compatibility=1.1 or later Compiled file=scratch.chm Default Window=main Default topic=eu400_0001.html Display compile progress=No Enhanced decompilation=Yes Flat=Yes Full-text search=Yes Language=0x409 English (United States) [WINDOWS] main="PUT THE TITLE HERE",,,"eu400_0001.html","eu400_0001.html","Jump1.html","Jump1","Jump2.html","Jump2",0x23520,,0xc387e,,,,,,,,0 [FILES] eu400_0001.html [INFOTYPES]
ne1uno, you can look at the file to try out the links. Here's the link: http://sites.google.com/site/runintrack/uploads/eu4chm/test.zip?attredirects=0
Maybe you could help me out to figure out what is different.
25. Re: ver 4.0 docs chm links to sections now work - don't know why
- Posted by jcmarsh Aug 28, 2008
- 1300 views
My bad, it already had this. What we were talking about was the TOC tab.
26. Re: ver 4.0 docs
- Posted by jcmarsh Aug 28, 2008
- 1362 views
ne1uno:
I created another test file, this one splits the topics into subtopics, about 3000 of them. I don't think we should go this way with the official chm, but at least the TOC tab works properly following this model. It's a temporary fix.
http://sites.google.com/site/runintrack/uploads/eu4chm/test.zip?attredirects=0
27. Re: ver 4.0 docs
- Posted by ne1uno Aug 28, 2008
- 1303 views
- Last edited Aug 29, 2008
ne1uno:
I created another test file, this one splits the topics into subtopics, about 3000 of them.
I saw your version of 1086 the other day which has a mostly working CHM toc, not perfect because I think that htmlhelp is getting confused by the [1234] creolehtml markers for the name= sections and unable to make links out of them. seems obvious now. thats why there are no #links in the toc.hhc, just links to pages. it may even be a known bug, maybe instead of brackets it should be a selectable pair in creolehtml and can try paren or braces?
or you will have to go back and manually fixup the toc.hhc or generate the whole thing manually or convert from the html toc. splitting up into 3000+ files is how many CHM are organized. I didn't decompile the test.chm but sub dirs would be the way to go. previous euphoria CHM had larger single section pages. it's really an independent question from the bad links & topics. the best solution may be a plugin to eudoc to generate the html then index.hhk and toc.hhc directly. reworking the html too much will be high maintenance as time goes by. and as eudoc could be used by other libraries and projects that may want to generate chm versions as well as html and pdf, a plugin is worth perusing. line endings and trailing space should be options too at some point.
I believe there will be an index in the html version, modulo someone putting in the time to index and link a good cross section of words. just all the keywords and builtins could be thousands of links. maybe preferring section links with those words in them would be enough. I hope the links will be sufficiently differentiated so the alternate format programs can pickout the section links from the indexed links.
28. Re: ver 4.0 docs
- Posted by jcmarsh Aug 29, 2008
- 1341 views
ne1uno:
I created another test file, this one splits the topics into subtopics, about 3000 of them.
I saw your version of 1086 the other day which has a mostly working CHM toc, not perfect because I think that htmlhelp is getting confused by the [1234] creolehtml markers for the name= sections and unable to make links out of them. seems obvious now. thats why there are no #links in the toc.hhc, just links to pages. it may even be a known bug, maybe instead of brackets it should be a selectable pair in creolehtml and can try paren or braces?
or you will have to go back and manually fixup the toc.hhc or generate the whole thing manually or convert from the html toc. splitting up into 3000+ files is how many CHM are organized. I didn't decompile the test.chm but sub dirs would be the way to go. previous euphoria CHM had larger single section pages. it's really an independent question from the bad links & topics. the best solution may be a plugin to eudoc to generate the html then index.hhk and toc.hhc directly. reworking the html too much will be high maintenance as time goes by. and as eudoc could be used by other libraries and projects that may want to generate chm versions as well as html and pdf, a plugin is worth perusing. line endings and trailing space should be options too at some point.
I believe there will be an index in the html version, modulo someone putting in the time to index and link a good cross section of words. just all the keywords and builtins could be thousands of links. maybe preferring section links with those words in them would be enough. I hope the links will be sufficiently differentiated so the alternate format programs can pickout the section links from the indexed links.
I made a program to automatically generate the index source toc.hhc today. It beats fixing the links by hand. Full links can be scanned from the html files created by eudoc. Currently only uses the first file generated by the eudoc package. Source included in the zip:
http://sites.google.com/site/runintrack/uploads/eu4chm/test.zip?attredirects=0
Are you creating the index.hhk file manually right now or having HTML Help Workshop generate it?
29. Re: ver 4.0 docs
- Posted by DerekParnell (admin) Aug 29, 2008
- 1283 views
I think that htmlhelp is getting confused by the [1234] creolehtml markers
I've just udated creole.e and creolehtml.ex so that it uses underscores rather than square brackets in anchor text. Also, it no longer uses  inside headings.
You can get the current version from the SVN repository for it.
30. Re: ver 4.0 docs
- Posted by ne1uno Aug 29, 2008
- 1269 views
I think that htmlhelp is getting confused by the [1234] creolehtml markers
I've just udated creole.e and creolehtml.ex so that it uses underscores rather than square brackets in anchor text. Also, it no longer uses inside headings.
thanks, I had been editing nbsp in a few places in creolehtml. the change from [123] to _123_ in the name= links, alas, does not make the autogenerated toc in htmlhelp any better. but, the links do look less busy in the browser status bar when viewing the html version of the docs.
in the 0013.html
links after "2.5.7.3 for statement" are unresolved
exit statement break statement continue statement retry statement "2.5.9 Labelled headers" too
somewhere in the past 10 svn revisions.
probably unrelated also in refman_2.txt
loop do label "GONEXT" should be loop label "GONEXT" do
31. Re: ver 4.0 docs
- Posted by ne1uno Aug 29, 2008
- 1255 views
in the 0013.html
links after "2.5.7.3 for statement" are unresolved
exit statement break statement continue statement retry statement "2.5.9 Labelled headers" too
you can see these links at the top of that page. maybe strange it happens as the link numbers roll over from 99 to 100.
to get a hacky log of the unresolved I added in to creole.e,
include std/io.e object ok = write_lines("uns.txt", {"next \n"}) and around 3550 if lIdx = 0 then lPluginResult = Generate_Final(InternalLink ,{"unresolved", vUnresolved[i][2]}) + ok = append_lines("uns.txt" , {sprintf("%s %s",{vUnresolved[i][2], lPluginResult} )})
much nicer to see a list of unresolved as it happens. probably will try to get the final html the link will appear in.
a q&d log output is one of the great debugging tools. append_lines makes it really easy.
32. Re: ver 4.0 docs
- Posted by DerekParnell (admin) Aug 29, 2008
- 1290 views
- Last edited Aug 30, 2008
the change from [123] to _123_ in the name= links, alas, does not make the autogenerated toc in htmlhelp any better.
What's the problem? Something I can do in creole?
in the 0013.html
links after "2.5.7.3 for statement" are unresolved
exit statement break statement continue statement retry statement "2.5.9 Labelled headers" too
somewhere in the past 10 svn revisions.
I'm not getting this. All these are resolved on my system.
probably unrelated also in refman_2.txt
loop do label "GONEXT" should be loop label "GONEXT" do
Ok, that I can fix.
33. Re: ver 4.0 docs
- Posted by ne1uno Aug 30, 2008
- 1284 views
the change from [123] to _123_ in the name= links, alas, does not make the autogenerated toc in htmlhelp any better.
What's the problem? Something I can do in creole?
I had hoped/assumed htmlhelp was using a combination of the name= links and Hn headers to create the toc. maybe is just the headers. I'll probably post process the htmlhelp generated toc using the links & matching text from the creolehtml generated index.html.
thanks for the offer though.
the generated toc does look pretty good now, except for the missing #link problem. you can at least get to the top of each page. all the doc fixups in the past few weeks and unchecking binary toc helped.
I did add one macro to give each page a title so that found topics in the CHM search tab have a little human readable context.
~@ line 267 kan:setValue(lData, "thistext", lThisText) --title for chm
this has an adverse side effect that you can't jump to the exact section, but the other way you would often see topics like Notes: Comments: Eample1: with no context. this CHM may never make it out of alpha.
a posiible bug alert. around 4560 in creole.e lFrom += length(lPluginResult - 2) should probably be length(lPluginResult) - 2 appears in two places. seems to work the same either way with the unresolved's.
34. Re: ver 4.0 docs
- Posted by jcmarsh Aug 30, 2008
- 1293 views
To ne1uno and DerekParnell:
I haven't changed the eudoc system on my computer, just translated it to C and compiled it to use it. Honestly I don't worry about how it works at this point. I'm glad that you guys are developing it. I'm just modifying the output in order to get a decent chm file.
Here's some things I did:
Changed head.html title tag to this to give each page a separate title:
<title>{chaptext}</title>
I'm working on a program written in Euphoria to generate the needed toc.hhc CHM Table of Contents file and Index.hhk Index file used by MS HTML Help Workshop from the HTML files created by eudoc.ex and creolehtml.ex
I hope that you can use it (once it is finished) as part of your "post processing" process in making the CHM documentation file.
35. Re: ver 4.0 docs
- Posted by jcmarsh Aug 31, 2008
- 1243 views
Updated dev chm version to svn 1101, maybe not as great as ne1uno's one, but at least it is automatically generated by several different programs and looks good enough to distribute. Have a look at it.
36. Re: ver 4.0 docs
- Posted by jcmarsh Aug 31, 2008
- 1268 views
the change from [123] to _123_ in the name= links, alas, does not make the autogenerated toc in htmlhelp any better.
What's the problem? Something I can do in creole?
in the 0013.html
links after "2.5.7.3 for statement" are unresolved
exit statement break statement continue statement retry statement "2.5.9 Labelled headers" too
somewhere in the past 10 svn revisions.
I'm not getting this. All these are resolved on my system.
probably unrelated also in refman_2.txt
loop do label "GONEXT" should be loop label "GONEXT" do
Ok, that I can fix.
Can you please add this change to your next update of creole:
creolehtml.ex line 276 of 836
kan:setValue(lData, "thistext", lThisText) -- jcmarsh
This will add the ability to reference the text name of the current page from the template files. It helps to have the current page name in the title HTML tag when compiling as a CHM. I can then add this to my template:
<title>{thistext=*:}{thistext}{:thistext=:}{title}{:thistext}</title>
And always have a unique title.
On another note, I have created an alpha version of htm2chm.ew which will generate toc.hhc and Index.hhk from the creolehtml.ex output. I will post it to my website. It will be part of the chm_source.zip:
http://sites.google.com/site/runintrack/uploads/eu4chm
Oh, and by the way, great work for putting together the eudocs and creole!
37. Re: ver 4.0 docs
- Posted by DerekParnell (admin) Aug 31, 2008
- 1251 views
Can you please add this change to your next update of creole:
Done and uploaded.
38. Re: ver 4.0 docs
- Posted by jcmarsh Sep 01, 2008
- 1259 views
Released a major revision of my CHM file. updated dev to svn1108. updated Windows eubin version (svn1067). Updates will now be probably weekly.
See also ne1's Unofficial Help file for Euphoria 4.0 pre-alpha. Not sure which one is better, but I think mine is easier to maintain.
http://sites.google.com/site/runintrack/uploads/eu4chm
I'm really looking forward to the release of 4.0 - I've been patiently waiting for the next update for maybe a year now. Now there is something that I can possibly do to help the project by helping with the CHM help file. I know from experience that you can't learn a programming language if you can't learn it from its bundled documentation. I think Euphoria's documentation is very well organized and easy to understand. Thank you development team for all your hard work!
39. Re: ver 4.0 docs
- Posted by ne1uno Sep 01, 2008
- 1229 views
See also ne1's Unofficial Help file for Euphoria 4.0 pre-alpha. Not sure which one is better, but I think mine is easier to maintain.
on what could you possibly base the easier to maintain statement? and why would it matter? the hardest part of any project is testing, not sure how to automate that with a help file. a current problem with the docs is unresolved links. did you count how many there are? in yours. have you tried to link your chm to am editor and used F1 to link to a keyword? the last index I saw of yours still had section numbers in front of the words. there are include files with the same names, regex has free which is also a global. I have tagged each word with the include file it is declared in to disambiguate. do you really think I am doing all this from memory or with macros in my editor? I haven't seen the latest version uploaded, no doubt it is improving. you have decided to take a tact that may produce a better chm in the end but as your program uses non of the 4.0 constructs like regex and map, that part is not easier to maintain. and frankly, I would not have the energy to work on this at all if I had to giveup map and set and regex. at some point I will probably include the index and toc programs, maybe when a euphoria 4 anyone can use is released. it's still a bit of a moving target, nature of the beast.
includeing a doc anaomaly to keep this thread on topic. why all the headers Unknown, 4.3.1.1 has one, in sort.e looks like the include std/text.e is confusing constants section and should be moved outside a doc section.
40. Re: ver 4.0 docs
- Posted by jcmarsh Sep 01, 2008
- 1235 views
I think as the documentation improves and as eudoc and creole get better many of the unresolved links will go away. See my post titled: "Need help fixing eudoc creole". I have not tried to link it to an editor because I don't know how to. I don't use v4.0 in my code because I haven't learned it yet. I'm mainly a tester not a developer. I created the generate TOC and generate Index programs to accelerate the creation/testing phase of the CHM project. It seemed easy enough to do and gave me better results than my other attempts so that is what I did. I was concerned by your previous post:
this CHM may never make it out of alpha.
I just didn't want you to despair that the project would never be finished. I saw the benefit of having two CHM projects going concurrently because neither one has all the features of the other and each one can learn from the other's experience. Neither one will be perfect until all of the tools used to create them are out of alpha stages.