Drupaldocs.org - is there an offline version?
carlmcdade - January 6, 2005 - 14:09
Has anyone put the API documentation in an offline format?
I am getting a cheap laptop to do my reading and writing on and won't have an nternet connection. So want to have the docs on hand along with some other items.
I did a search and found nothing. Does anyone have any idea about how large the documentation files are in terms of megabytes?
Sort of
The documention is generated dynamically by api.module, which you can find in contrib. If you set up a local copy, you can use it offline. The docs it uses are located in contrib/docs/developer. It also reads the doxygen from the Drupal source code.
193mb and three hours later.....
I mirrored the site on to my PC. Large it is. 193mb and three hours later I have it on disk. I am going to have to put this on CD because it is a lot larger than I expected.
Going to investigate putting it into CHM now.
---------------------------
info for Drupal installation
__________________________
Carl McDade
Information Technology Consult
Team Macromedia
www.hivemindz.com
It was worth the time it
It was worth the time it took. The almost 200 mb files are now in a lighting quick 12mb CHM. It is so cool! Even the search form works within the chm which makes up for the lack of a search tab on the CHM ui.
I am not sure I can host this file at 12mb, if it gets popular it would kill my bandwidth. If someone wants to host this let me know. In the meantime I this I will up it to a Yahoo! briefcase or something.
I welcome ideas for where it should be made available.
---------------------------
info for Drupal installation
__________________________
Carl McDade
Information Technology Consult
Team Macromedia
www.hivemindz.com
I have uploaded this to an
I have uploaded this to an offsite server. If you get a PHP error it is becuase I am back porting the script to PHP v4.0.6 this is an old server and the PHP has never been updated.
http://www.light.nu/drupaldev/
I am going to try and get the paging links to work. They work in the chm ide but not in the compiled chm. Probably a path problem to be sorted out. But anyway enjoy.
btw, I have also created an issue to try and get someone to upload this to Drupal.org
---------------------------
info for Drupal installation
__________________________
Carl McDade
Information Technology Consult
Team Macromedia
www.hivemindz.com
www.fireorb.org
Carl, I think you and I are
Carl, I think you and I are having some kind of cosmic convergence thing, either that or I am spending too much time on the drupal site! The drupaldocs.org site was down (as was drupal.org) the other day and I was wishing for this; the day before though I was wishing they would install the 'printer-friendly page' module!
... I'd still like a printable form of the drupaldocs. I find I learn coding best by having a hardcopy of various parameters and such on my lap in front of my computer. Any possiblilites?
I have to check the size and
I have to check the size and the navigation of a PDF version. The problem with PDFs is that they do need some hand work to make sure they print correctly. The file size also can be a factor here. The HTML drupaldoc.org site was almost 200 meg so a PDF might be really big. It might not be practical if it is 2000 pages long. But I will take a look into it anyway.
The easiest thing would be for Drupal.org to use Doxygen to create a both a CHM and a PDF version since those functions are built in already.
---------------------------
proof that Drupal will work on PHP5
www.hivemindz.com
www.fireorb.org
__________________________
Carl McDade
Information Technology Consult
Team Macromedia
I don't think you want
I don't think you want this. Printable PDF is 5000+ pages and still going strong...... Even given the nightmare of sorting and filtering out uneeded page this stopped being a practical thing at 1500 pages double-sided.
---------------------------
proof that Drupal will work on PHP5
www.hivemindz.com
www.fireorb.org
__________________________
Carl McDade
Information Technology Consult
Team Macromedia
yikes! thanks for looking
yikes! thanks for looking into that.
I'd really like to see a PDF
I'd really like to see a PDF of DrupalDocs too. Maybe doing 3 seperate PDFs--one for Drupal 4.5, one for 4.6 and one for HEAD--would be more manageable? How are you generating these PDFs? If you're doing it so that there's only 1 function per page, there may be a way to fix that. JavaDoc PDFs are very thorough but very compact.
(Believe me, I would LOVE to do this myself but I've got too much other Drupal stuff to do)
Dan
--
Dan Kurtz - http://www.brickswithoutclay.com
The Rockridge Institute - http://www.rockridgeinstitute.org
I'd appreciate having a
I'd appreciate having a printable version of the Drupal API as well. Sitting back on my comfy sofa would be a whole lot better than staring at a desktop LCD screen.
Converting a Drupal book into a .CHM help file using Doxygen
Does anyone of you know how i can convert a drupal book - which is online on my drupal powered website - using Doxygen?
Many thanks in advance!!
Yes you can. The xml does
Yes you can. The xml does give some errors and may clip some tags but you do get a working CHM.
Hiveminds Magazine
http://www.hiveminds.co.uk
for web publishers and community builders
Any hints how?
Thanks for letting me know that it's possible.
Could anyone give me some hints how? where can i find "the xml"?
Thanks!
where can i find the xml?
where can i find the xml?
Sorry
I looks like the handbook was changed again. A few months ago there were doc book xml links. Now there's nothing.
What happened? You'll have to ask on the docs mailinglist.
Hiveminds Magazine
http://www.hiveminds.co.uk
for web publishers and community builders
The "Export DXML" module
...seems to be what I was looking for:
http://drupal.org/node/39121
i just downloaded it but still need to check it out.