Download documentation for Appcelerator [closed]

L

7

5

I tried finding a way to download documentation of titanium appcelerator for offline reading

I searched a lot but couldn't find any direct or indirect way to download it

Has anyone downloaded documentation ?

Languish answered 17/11, 2012 at 20:25 Comment(1)

I found this annoying too. From the API documentation site, I haven't found a way to print it either. – Incardinate 19/11, 2012 at 15:42

M

0

I made a shell script out of user1537325's answer. This is specific to Ubuntu 12.04, but you can probably modify it to your own OS without too much trouble. Be sure to upvote his answer as well.

https://gist.github.com/eric-hu/4952258

Warning: The layout and color scheme of the generated docs look different from those of the online docs for Titanium 3.0. I'm not sure if there are differences yet. The output from jsduck also included many warnings about "Unknown type".

Moonscape answered 14/2, 2013 at 11:39 Comment(2)

Thanks for the code . Problem is that currently I am on windows machine . I Will check this code when I get access to ubuntu – Languish 14/2, 2013 at 13:9

Ah, I was just providing this answer for the general community. I uploaded the generated html here. Hopefully you have git on Windows :P – Moonscape 15/2, 2013 at 6:51

L

7

It is not possible (as far as I know) to make the docs offline directly using the online version.

However it is possible to build the docs using the source code, as we all know that Titanium is open-source.

Download the source from: https://github.com/appcelerator/titanium_mobile, or clone the repo with: git clone https://github.com/appcelerator/titanium_mobile.git
Unzip the source code
cd titanium_mobile-master
Ensure that you have python installed, as well as pyyml and pygments, you can install them with: sudo easy_install pyyml, pygments
Ensure you have jsduck installed in your system, if not then install it with: gem install jsduck
write this command: apidoc/docgen.py --format=jsduck --output=dist/apidoc
cd dist/apidoc
jsduck --touch-examples-ui --output Whole titanium.js, where Whole is the output directory containing the generated docs

If you want the builtins to be included in your generated docs make the last command: jsduck --builtin-classes --touch-examples-ui --output Whole titanium.js

That is it, you have a full searchable Ti docs offline.

Lapstrake answered 19/12, 2012 at 19:6 Comment(1)

Also, take a look at github.com/appcelerator/doctools, which contains the jsduck tag definitions and some scripts to build the docs. – Uhf 28/8, 2013 at 9:21

L

2

By the way, I have found a working solution for one of the most common problems Ti developers face.

Working offline with Titanium Studio:

After going offline, Titanium Studio won't allow you to neither create new projects nor build/package existing projects, to work this around:

-- I have applied this procedure prior to inventing the one below, so I am not sure if it has any effect: http://developer.appcelerator.com/question/119830/use-titanium-withour-internet-connection-or-logged-off, Adam Fisher's procedure.

Open Titanium Studio while offline.
go to: ~/.titanium
vim auth_session.json
change the false to true.
Done

Now you can build and create new project as you like.

Lapstrake answered 19/12, 2012 at 19:20 Comment(0)

T

0

There's an app for the Mac called Dash (http://kapeli.com/dash). Dash is an off-line documentation browser for software developers. It supports many languages, one of which is the Titanium API; it's a must...if you use a Mac.

However, all the documentation for the Titanium API is available as JSON files (http://docs.appcelerator.com/titanium/data/index.html), so I guess it's just a matter of building an off-line JSON reader.

R

Trauma answered 17/11, 2012 at 20:25 Comment(0)

W

0

You cannot directly download the API documentations from the appcelerator site, but you can use offline surfing softwares to download the website for offline reading

Here are some links from where you'll get some notes

Training resources from appcelerator
You can download and read Appcelerator Titanium Smartphone App Development Cookbook which will help you for developing applications with titanium
http://docs.appcelerator.com/titanium/2.0/index.html#!/guide/BNAPP_ebook
Also you can refer this answers Learning titanium

Waltz answered 19/11, 2012 at 4:27 Comment(2)

Thanks. Ebook seems to be quite helpful at present – Languish 20/11, 2012 at 11:6

now a days titanium is very familiar and hence more helps and documentations are available. You can easily use them from the above links – Waltz 20/11, 2012 at 11:13

M

0

I made a shell script out of user1537325's answer. This is specific to Ubuntu 12.04, but you can probably modify it to your own OS without too much trouble. Be sure to upvote his answer as well.

https://gist.github.com/eric-hu/4952258

Warning: The layout and color scheme of the generated docs look different from those of the online docs for Titanium 3.0. I'm not sure if there are differences yet. The output from jsduck also included many warnings about "Unknown type".

Moonscape answered 14/2, 2013 at 11:39 Comment(2)

Thanks for the code . Problem is that currently I am on windows machine . I Will check this code when I get access to ubuntu – Languish 14/2, 2013 at 13:9

Ah, I was just providing this answer for the general community. I uploaded the generated html here. Hopefully you have git on Windows :P – Moonscape 15/2, 2013 at 6:51

R

0

You can download the .mobi file from "http://docs.appcelerator.com/titanium/2.0/index.html#!/guide/BNAPP_ebook" and use a mobi to pdf to converter to convert it to pdf format. You can use the free service provided at : http://www.mobi-to-pdf.com/ to do the conversion. Hope this helps.

Renowned answered 9/6, 2014 at 9:0 Comment(0)

C

0

If you use Mac OS X you can install Dash

Dash link

Dash screenshot

Curculio answered 31/3, 2016 at 10:42 Comment(0)

Recommended topics

Hot tags