now that the documentation is on the wiki, is there still a html version that I could use for off-line use. [Question]
I have created a SDL2 devpak for devcpp but it would be nice for me to be able include documentation in the devpak.
I have got an old off-line html version of sdl1.2 (around 2006) and an even older chm version (2004)
I agree, this would be a boon.
What is the policy with the docs in the the headers/C code, is that
out of date or of any use?On Thu, Oct 24, 2013 at 12:35 AM, mattbentley wrote:
I agree, this would be a boon.
SDL mailing list
SDL at lists.libsdl.org
http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org
In the absence of it (offline docs) having been done already, I’ve started on the conversion. I’ve done 23 pages so far, covering the intro,migration, function lists and about half the category files. when that’s done there’ll just be a few hundred functions and some types and such like. I’ll post again when it is done, and can make it available if anyone else wants it. 
The html is greatly simplified, as is the css. I’ve tried to keep the look similar, but code examples will be in monochrome for the moment.
this is just a little progess report on the simplified offline (should work for any os) sdl2 documentation I am working on.
I have done about 294 pages so far, just 301 functions (pages) to go. Keeping it up to date when it’s done will be a bit time consuming, unless the wiki pages were rsync-able, as I have restricted download capacity, so can’t do regular recursive wgets just to do a diff to see what’s changed.
That’s a whole lot of work done in a month. Where are you planning on putting this up once you’re done and in what format will they be in? I’ll be keeping an eye out for offline docs c:On Wed, Nov 20, 2013 at 01:55:24PM +0000, timsoft wrote:
this is just a little progess report on the simplified offline (should work for any os) sdl2 documentation I am working on.
I have done about 294 pages so far, just 301 functions (pages) to go. Keeping it up to date when it’s done will be a bit time consuming, unless the wiki pages were rsync-able, as I have restricted download capacity, so can’t do regular recursive wgets just to do a diff to see what’s changed.
SDL mailing list
SDL at lists.libsdl.org
http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org
Holy moly!
Did you see I put up an automated dump of the documentation?
http://www.libsdl.org/tmp/SDL-wiki.zipOn Wed, Nov 20, 2013 at 5:55 AM, timsoft wrote:
this is just a little progess report on the simplified offline (should
work for any os) sdl2 documentation I am working on.
I have done about 294 pages so far, just 301 functions (pages) to go.
Keeping it up to date when it’s done will be a bit time consuming, unless
the wiki pages were rsync-able, as I have restricted download capacity, so
can’t do regular recursive wgets just to do a diff to see what’s changed. [image:
Smile]
SDL mailing list
SDL at lists.libsdl.org
http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org
Ouch, might’ve been some good info before starting this offline doc.On Thu, Nov 21, 2013 at 07:07:05PM -0800, Sam Lantinga wrote:
Holy moly!
Did you see I put up an automated dump of the documentation?
http://www.libsdl.org/tmp/SDL-wiki.zipOn Wed, Nov 20, 2013 at 5:55 AM, timsoft wrote:
this is just a little progess report on the simplified offline (should
work for any os) sdl2 documentation I am working on.
I have done about 294 pages so far, just 301 functions (pages) to go.
Keeping it up to date when it’s done will be a bit time consuming, unless
the wiki pages were rsync-able, as I have restricted download capacity, so
can’t do regular recursive wgets just to do a diff to see what’s changed. [image:
Smile]
SDL mailing list
SDL at lists.libsdl.org
http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org
SDL mailing list
SDL at lists.libsdl.org
http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org
hi Sam, no I didn’t see your automated dump. 
I have finally completed my simplified off-line version of the wiki.
I don’t think the work is entirely wasted though.
in a zip it is 602kb and includes all the pages currently referenced in CategoryAPI
plus a bunch of extra ones. I made the left hand menu a jscript so it could be updated without having to edit all 621 files
it is about 25 times smaller in KB than the automated one, and because I moved all the structures pages into a sub-folder, it happily extracts on systems like windows which are case insensitive ( think SDL_VERSION and SDL_version )
It’s target is windows developers using orwell’s devcpp or codeblocks (I think uses the same format devpack)
and those who have no or a slow or expensive internet connection.
Would you like a copy put up somewhere?
I have uploaded the documentation to my sourceforge project page. It isn’t related to that project, but at least it is available as a download for folks to help themselves.
http://sourceforge.net/projects/winsender/files/sdl2doc.zip/download
see changes in the menu on the offline doc for more info.
just extract the files to a blank directory, and point your browser at FrontPage.html
it should work in all OS’s including ones whose file systems are case insensitive.
The zip file is about 601Kb in size
this BB messed up the link, so here is another attempt
http://sourceforge.net/projects/winsender/files/sdl2doc.zip/download
http://sourceforge.net/projects/winsender/files/sdl2doc.zip/download
Woah, you essentially cloned the Wiki. This looks pretty good. The reason
the zip in /tmp is bigger is probably because it includes other languages.On Tue, Dec 10, 2013 at 3:55 AM, timsoft wrote:
this BB messed up the link, so here is another attempt
http://sourceforge.net/projects/winsender/files/sdl2doc.zip/download
[image: Very Happy]
http://sourceforge.net/projects/winsender/files/sdl2doc.zip/download
SDL mailing list
SDL at lists.libsdl.org
http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org
yes, my version only has the english one, but also my version is simplified. so for example there isn’t a "
Code:
<span …>
" for every single line, like in the wiki, and only headers which are actually referenced have id’s.
It means the average page size is 2kb instead of 20kb