PDF'd documentation

Ansca can you give us documentation .pdf files like previous betas?

Thanks. [import]uid: 7022 topic_id: 1536 reply_id: 301536[/import]

We’re moving to all HTML. It’s impractical for us to release both PDF and HTML at this time. [import]uid: 54 topic_id: 1536 reply_id: 4321[/import]

I understand. Will you rewrite it in the near future? So I can print or save the printer-friendly version, if you won’t. [import]uid: 7022 topic_id: 1536 reply_id: 4324[/import]

I take it you prefer to read paper documentation? We’re updating the docs in near real time, correcting problems, adding indexes, and of course new features, so a static format like PDF really isn’t practical. [import]uid: 54 topic_id: 1536 reply_id: 4326[/import]

I don’t want to print them. I just wanted to put them in a organized folder to read them each time I want. But you’re right, updating HTML pages it’s easier and requires less time, so you can focus on updating and fixing Corona. :wink:

Doesn’t matter, I’ll keep up to date browsing the online docs. [import]uid: 7022 topic_id: 1536 reply_id: 4327[/import]

Hi,

As i liked the pdf version of last year as well,
is there a change to make the HTML available as a download ?

This makes it a bit faster to check the documentation offline as sometimes
the site seems a bit slow and as time is crucial sometimes :slight_smile:

Would be great if you can do this for us.

Thanks,
Jespar
[import]uid: 2734 topic_id: 1536 reply_id: 5002[/import]

I’ve zipped up the API reference and attached it at the bottom of this page. I’ll look at including this in the DMG automatically going forward.

Do you guys want the individual pages as well? or is one big html blob fine? [import]uid: 3 topic_id: 1536 reply_id: 5076[/import]

Hi Seanh,

Thanks so far, but:

The downloaded version has all the internal links to the website. I like to see the links local as like Anchors so i could use it as local reference.

See any change to accomplish that???
Thanks,
Freshworks [import]uid: 2734 topic_id: 1536 reply_id: 5094[/import]

seanh,
It would be nice to be able to export the documentation as a PDF (that has working links and TOC). You may be able to add some kind of HTMLtoPDF conversion plugin to the site so you don’t have to maintain the PDF version.

One of the first things I did when I signed up for the Corona SDK is I looked for a PDF version of the API Reference doc to save on my laptop and iPhone for offline reference. [import]uid: 8194 topic_id: 1536 reply_id: 5157[/import]

Me too. And I printed it all out cause I hate reading on the screen. [import]uid: 295 topic_id: 1536 reply_id: 5197[/import]

Woops, worry about the bad links. I’ve updated the zip that’s up there. [import]uid: 3 topic_id: 1536 reply_id: 5198[/import]

I’ll see what I can do for PDFs, but I don’t really have a timeframe on getting anything.

What does a pdf get you now that the html in that zip has correct anchors? [import]uid: 3 topic_id: 1536 reply_id: 5202[/import]

Hi seanh,

Thanks for fixing up the anchors.

Have you ever tried Doxygen, it’s a real easy tool to generate local documentations.

http://en.wikipedia.org/wiki/Doxygen

Cheers,
Jespar
[import]uid: 2734 topic_id: 1536 reply_id: 5220[/import]

Hi to all,

Another solution is generate a .chm file with the html pages :slight_smile: [import]uid: 1019 topic_id: 1536 reply_id: 5221[/import]

And I want to see how you open the chm file on a Mac. [import]uid: 5712 topic_id: 1536 reply_id: 5229[/import]

It could be a solution and also a fine one when you use

http://chmox.sourceforge.net/

CHM isn’t really a macos type, but anything better then online documentation witch could be verry slow :slight_smile:

Cheers,
Jespar
[import]uid: 2734 topic_id: 1536 reply_id: 5230[/import]

New user here seeking PDF docs, searched forums, found link…

PDF allows highlighting, adding notes, samples, etc. Some of us are used to reading/referencing docs in PDF in one window while working in another, i.e. more productive.

SUGGESTION: quarterly update of all User Guides in PDF would be greatly appreciated.
[import]uid: 21304 topic_id: 1536 reply_id: 17364[/import]

The old pdfs like in the beta will probably never come back, they just weren’t sustainable for us.

A fresh copy of the zipped html docs should probably be make though. If you wanted I could convert the html to a pdf, but I’m not sure how that would look. [import]uid: 3 topic_id: 1536 reply_id: 17374[/import]

I can adjust to HTML, not a big deal. However, I encountered lots of errors from the website, mainly connectivity issues with MySQL database server and your apache/drupal server? I did a couple of screen grab, but the general text error is below:

If the website is down, the docs will be down? Something to brought up to the next meeting and/or to-do list for PDF? I will use/adjust to HTML docs for now, thank you.

[text]
Warning: array_keys() [function.array-keys]: The first argument should be an array in /home/ansca-web/public_html/developer.anscamobile.com/includes/theme.maintenance.inc on line 220

Warning: Invalid argument supplied for foreach() in /home/ansca-web/public_html/developer.anscamobile.com/includes/theme.maintenance.inc on line 220
Home
Drupal
Site off-line

The site is currently not available due to technical problems. Please try again later. Thank you for your understanding.

If you are the maintainer of this site, please check your database settings in the settings.php file and ensure that your hosting provider’s database server is running. For more help, see the handbook, or contact your hosting provider.

The mysqli error was: Lost connection to MySQL server at ‘reading authorization packet’, system error: 0.
[/text]
[import]uid: 21304 topic_id: 1536 reply_id: 17539[/import]