PDF clone of Connect IQ SDK documentation

I have made a PDF version by reprocessing the HTML provided in the SDK. I did this as it allows me to do a full text search easily.
It includes the SDK release notes, Programmers Guide, user experience guide, class list, method list and the full api docs.

My goal was a learning developer, sometimes i am not sure which document will have the critical clue i am looking for.
The existing navigation is topic based and perfect in many cases. This just provides an alternative i find handy at times.

For example if i want to get up to speed on heart rate, there may be many aspects to that.
Initially i may not be sure if i am looking for a class, a method, perhaps some description that may be in a guide,
a sample or some release note with a relevant change.

Notes:
- internal hyperlinks between the documents do not work, the original HTML is better for this.
- PDF 'outline' is provided and links to all the API classes and methods
- File size about 20mb
- PDF for SDK 2.2.6 and 2.3.0.beta1 available

For the link i provided, by default you may be viewing in the Dropbox viewer, which is not as good as
using the adobe acrobat reader. The reader includes support for the 'outline' and is just a richer way
to use this document based on topic, similar to the HTML experience. Downloading the file then opening
with a good PDF reader is suggested.

Files can be found here.
www.dropbox.com/.../AACMwTAop7AISN1C00Xt6Qhla

https://www.dropbox.com/sh/d0h9khfq25xcepx/AACMwTAop7AISN1C00Xt6Qhla?dl=0

I have started a new thread here with a more suitable title as this topic started in an unrelated thread.

Top Replies

OttawaDeveloper over 7 years ago +1

Thanks Travis. The API DOCS section itself in HTML has some search capability. The issue i was having is that there is useful information in many places, such as the programmers guide, experience guide…

All Replies

PiotrekZ5 over 7 years ago

Good work!
Thank you.

FlipStone over 7 years ago

!

Thanks!

a1234.garmin over 7 years ago

I'd suggest to correct download link at the end to :
dl=1

This disables internal Dropbox viewer and document will be downloaded.

OttawaDeveloper over 7 years ago

I updated to include the 2.3.5 SDK now.

re. dl=1 - i tried it but think it better this way. The link is to a folder, you can selectively download the file(s) you wish from the dropbox page. Do not want to force people to download all files in the folder.

Travis.ConnectIQ over 7 years ago

I'm not familiar with the documentation generation process yet, but I believe we should be able to generate a single uuber-document in HTML using our current tools pretty easily. I don't know about doing PDF though.

I'll ask around and see if this is something that we can do.

Travis

OttawaDeveloper over 7 years ago

Thanks Travis. The API DOCS section itself in HTML has some search capability. The issue i was having is that there is useful information in many places, such as the programmers guide, experience guide, device info, what you can build etc. If you don't know exactly where to look it gets pretty frustrating 'hunting and pecking' searching through multiple documents. I used some tools to search through all HTML files but then when you clicked on a result you were inside raw HTML, not in a easy to read browser. I used PDF as i could render all the HTML documents into one file, and then use the text search within a single PDF file. Sometimes to find something you have to try several keywords until you find something relevant to what you need. So this works ok. Anyhow key thing is to get a really good search that looks in as many of your documentation pages as is possible to help the developer to find information more quickly. So if it can be done in HTML with a good search tool that would be good for all i hope. I have automated my PDF process so it is not too hard for me to update this from time to time.

OttawaDeveloper over 7 years ago

I updated to include the 2.4.1 SDK now.
Unchanged link is in the first post.

OttawaDeveloper over 7 years ago

updated to 2.4.3 now, same link as per first post

OttawaDeveloper over 7 years ago

I am not sure how useful people find these PDF file.
I use them for myself pretty often so i have done updated versions for SDK 2.4.5 and 3.0 beta.
They are available using the same link from the start of this thread.
https://www.dropbox.com/sh/d0h9khfq2...00Xt6Qhla?dl=0

OttawaDeveloper over 6 years ago

I have continued to update this. there is PDF doc file for SDK 3.0.7 now.