Irrlicht API documentation into CHM
Posted: Tue Feb 16, 2010 9:14 am
I would like to convert the API documentation in a CHM file as in previous releases. Can someone give me some tip from where to start.
Thanks.
Thanks.
Irrlicht Engine
Official forum of the Irrlicht Engine
https://irrlicht.sourceforge.io/forum/
Irrlicht API documentation into CHM
Page 1 of 1
Re: Irrlicht API documentation into CHM
Posted: Tue Feb 16, 2010 9:29 am
Just tell Doxygen to generate CHM files out of the source.
Posted: Tue Feb 16, 2010 10:22 am
Posted: Tue Feb 16, 2010 2:26 pm
Heh 
))
So i'm not the only one missing the chm)
10x
))So i'm not the only one missing the chm
)10x
Posted: Tue Feb 16, 2010 3:56 pm
Yay! I was wondering where the .chm went for this release...
Posted: Tue Feb 16, 2010 5:04 pm
@vins
that link seems to be dead.
**EDIT**
No, it works, just not when I open it in a new tab. But it's slow and has stopped in the middle of download!
I made my own anyway.
It would be nice to know the settings that niko uses to generate the html/chm file. Because it is very different from the standard chm file produced. Also, how to get the examples in it as well.
@vins Your chm file is 6 MB. It should only be about 3-4 MB shouldn't it?
I haven't got it yet so I can't see if it looks the same as Niko's..
that link seems to be dead.
**EDIT**
No, it works, just not when I open it in a new tab. But it's slow and has stopped in the middle of download!
I made my own anyway.
It would be nice to know the settings that niko uses to generate the html/chm file. Because it is very different from the standard chm file produced. Also, how to get the examples in it as well.
@vins Your chm file is 6 MB. It should only be about 3-4 MB shouldn't it?
I haven't got it yet so I can't see if it looks the same as Niko's..
Posted: Tue Feb 16, 2010 5:40 pm
Yeah there are many options and I don't know what to chose and I don't know how to add the Tutorials to the CHM.
@Ulf
This link shoud work: http://violin-bg.com/temp/irrlicht17_doc.chm
Perhaps you've made a better one than me
@Ulf
This link shoud work: http://violin-bg.com/temp/irrlicht17_doc.chm
Perhaps you've made a better one than me
Posted: Tue Feb 16, 2010 6:51 pm
Yea I made a better one but it's still missing the examples.
It is also missing images such as the logo on the intro. page.
I am using Doxygen to generate the HTML files, then using HTML Help Workshop to convert it into CHM.
I haven't worked out how to add extra web pages (such as the examples) to the CHM file.
Doxygen only seems to work from source files. Then when using HTML Help Workshop, it doesn't seem to allow adding in extra pages.
http://sites.google.com/site/projectulf ... 1.7Doc.zip
Fast download too. Thanks gmail for the free website.
It is also missing images such as the logo on the intro. page.
I am using Doxygen to generate the HTML files, then using HTML Help Workshop to convert it into CHM.
I haven't worked out how to add extra web pages (such as the examples) to the CHM file.
Doxygen only seems to work from source files. Then when using HTML Help Workshop, it doesn't seem to allow adding in extra pages.
http://sites.google.com/site/projectulf ... 1.7Doc.zip
Fast download too. Thanks gmail for the free website.
Posted: Tue Feb 16, 2010 9:06 pm
people who know my site probably know that I already have a download for the doc since v1.5, because something has changed since then !!! 
http://irrlicht.sourceforge.net/phpBB2/ ... hp?t=31558
there are 2 versions:
Irrlicht standart
Irrlicht with IrrExtensions
http://irrlicht.sourceforge.net/phpBB2/ ... hp?t=31558
there are 2 versions:
Irrlicht standart
Irrlicht with IrrExtensions
Posted: Tue Feb 16, 2010 9:41 pm
thx it is very useful.
Posted: Wed Feb 17, 2010 4:33 am
@Acki
Thanks for the info.
Are those links new? For the irrlicht v1.7?
Because the standard one does not download.
I get 404 File not found
BTW, I looked at your old link about deleting or editing the doxygen css file and header.
I'll have a go at that later.
Do you know how to get the examples merged into the help file?
Also, how about images such as the irrlicht logo on page 1 of help file?
I gave it a working directory for the images (in the Expert settings) but that didn't work.
Thanks for the info.
Are those links new? For the irrlicht v1.7?
Because the standard one does not download.
I get 404 File not found
BTW, I looked at your old link about deleting or editing the doxygen css file and header.
I'll have a go at that later.
Do you know how to get the examples merged into the help file?
Also, how about images such as the irrlicht logo on page 1 of help file?
I gave it a working directory for the images (in the Expert settings) but that didn't work.
Posted: Wed Feb 17, 2010 1:29 pm
yes, usually it's always the same link with an updated file for the latest version...Ulf wrote:Are those links new? For the irrlicht v1.7?
of course only if I recognise that a new version is out, can last some days though...
oops, thx for the report !!!Ulf wrote:Because the standard one does not download.
I get 404 File not found
since some time I'm using 7zip and I missed to change the link, it still was for a (normal) zip archive...
yes, but you won't succeed, because some important files are missing in the sdk...Ulf wrote:Do you know how to get the examples merged into the help file?
Also, how about images such as the irrlicht logo on page 1 of help file?
(I for myself don't need to care about this, because my IrrExtensions does all the work for me
)well, I made a small package so you can create the doc on your own: MakeIrrlichtDoc.7z
and be sure you read the included "important.txt" !!!
cu,
Acki
Posted: Wed Feb 17, 2010 2:27 pm
Never ever name an important file "important.txt". The right name would be "DO NOT READ UNDER NO CIRCUMSTANCES.txt"Acki wrote:and be sure you read the included "important.txt" !!!