Irrlicht API documentation into CHM

If you are a new Irrlicht Engine user, and have a newbie-question, this is the forum for you. You may also post general programming questions here.
Post Reply
vins
Posts: 51
Joined: Mon Aug 16, 2004 6:14 pm
Location: Sofia, Bulgaria
Contact:

Irrlicht API documentation into CHM

Post by vins »

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.
randomMesh
Posts: 1186
Joined: Fri Dec 29, 2006 12:04 am

Re: Irrlicht API documentation into CHM

Post by randomMesh »

Just tell Doxygen to generate CHM files out of the source.
"Whoops..."
vins
Posts: 51
Joined: Mon Aug 16, 2004 6:14 pm
Location: Sofia, Bulgaria
Contact:

Post by vins »

Thanks alot!
If someone wants a link:
http://home.violin-bg.com/public/temp/i ... 17_doc.chm
Bear_130278
Posts: 237
Joined: Mon Jan 16, 2006 1:18 pm
Location: Odessa,Russian Federation

Post by Bear_130278 »

Heh 8)))
So i'm not the only one missing the chm 8))
10x
Do you like VODKA???
Image
Image
d3jake
Posts: 198
Joined: Sat Mar 22, 2008 7:49 pm
Location: United States of America

Post by d3jake »

Yay! I was wondering where the .chm went for this release...
The Open Descent Foundation is always looking for programmers! http://www.odf-online.org
"I'll find out if what I deleted was vital here shortly..." -d3jake
Ulf
Posts: 281
Joined: Mon Jun 15, 2009 8:53 am
Location: Australia

Post by Ulf »

@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..
I can hear birds chirping
:twisted:

I live in the Eye of Insanity.
vins
Posts: 51
Joined: Mon Aug 16, 2004 6:14 pm
Location: Sofia, Bulgaria
Contact:

Post by vins »

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
Posts: 281
Joined: Mon Jun 15, 2009 8:53 am
Location: Australia

Post by Ulf »

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.
I can hear birds chirping
:twisted:

I live in the Eye of Insanity.
Acki
Posts: 3496
Joined: Tue Jun 29, 2004 12:04 am
Location: Nobody's Place (Venlo NL)
Contact:

Post by Acki »

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 !!! :lol:
http://irrlicht.sourceforge.net/phpBB2/ ... hp?t=31558

there are 2 versions:
Irrlicht standart
Irrlicht with IrrExtensions
while(!asleep) sheep++;
IrrExtensions:Image
http://abusoft.g0dsoft.com
try Stendhal a MORPG written in Java
teto
Posts: 159
Joined: Thu Dec 03, 2009 9:37 pm
Location: /home
Contact:

Post by teto »

thx it is very useful.
Ulf
Posts: 281
Joined: Mon Jun 15, 2009 8:53 am
Location: Australia

Post by Ulf »

@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.
I can hear birds chirping
:twisted:

I live in the Eye of Insanity.
Acki
Posts: 3496
Joined: Tue Jun 29, 2004 12:04 am
Location: Nobody's Place (Venlo NL)
Contact:

Post by Acki »

Ulf wrote:Are those links new? For the irrlicht v1.7?
yes, usually it's always the same link with an updated file for the latest version...
of course only if I recognise that a new version is out, can last some days though... :lol:

Ulf wrote:Because the standard one does not download.
I get 404 File not found
oops, thx for the report !!!
since some time I'm using 7zip and I missed to change the link, it still was for a (normal) zip archive... :oops:
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?
yes, but you won't succeed, because some important files are missing in the sdk...
(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
while(!asleep) sheep++;
IrrExtensions:Image
http://abusoft.g0dsoft.com
try Stendhal a MORPG written in Java
Sylence
Posts: 725
Joined: Sat Mar 03, 2007 9:01 pm
Location: Germany
Contact:

Post by Sylence »

Acki wrote:and be sure you read the included "important.txt" !!!
Never ever name an important file "important.txt". The right name would be "DO NOT READ UNDER NO CIRCUMSTANCES.txt" ;)
Software documentation is like sex. If it's good you want more. If it's bad it's better than nothing.
Post Reply