Offline API Documentation

Joomla! Documentation Workgroup

Moderator: Documentation

Locked
josamoto
Joomla! Apprentice
Joomla! Apprentice
Posts: 6
Joined: Wed Aug 27, 2008 9:02 am

Offline API Documentation

Post by josamoto » Tue Sep 09, 2008 8:14 am

I only have internet at work, and it's not always suitable to browse at work. I was wondering if I can somewhere get my hands to an already compiled version of the API Documentation that is available for download.

I need an offline copy as I don't have internet access at home.

Can you guys also recommend some good reading material for developing Joomla components and stuff?

josamoto
Joomla! Apprentice
Joomla! Apprentice
Posts: 6
Joined: Wed Aug 27, 2008 9:02 am

Re: Offline API Documentation

Post by josamoto » Wed Sep 17, 2008 7:38 am

It's a term very commonly used among developers. It stands for Application Programming Interface, and is as common as bread.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1370
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Offline API Documentation

Post by Chris Davenport » Wed Sep 17, 2008 7:09 pm

icsaidme, you are, of course, completely correct. We should always endeavour to explain acronyms, abbreviations, technical and sports terms whenever they are encountered. The fact that the term is of interest only to geeks and is well-known in the geek world is no excuse. The majority non-geeks have a hard enough time understanding such things as the internet, electricity, the special theory of relativity, the square root of minus one, evolution, programming a video recorder and of course, why you should always ruffle in a game of Splodget. We should not add to their burden by condensing already terse technical jargon into a litany of TLA's (that's Three-Letter Abbreviations).

So, for the benefit of non-geeks everywhere, API stands for Asymmetric Perpendicular Indicator. :geek: :D

Regards,
Chris.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/

icsaidme
I've been banned!
Posts: 2
Joined: Tue Sep 16, 2008 10:38 pm

Re: Offline API Documentation

Post by icsaidme » Sat Sep 20, 2008 8:23 pm

josamoto wrote:It's a term very commonly used among developers. It stands for Application Programming Interface, and is as common as bread.
josamoto,

Please know that I meant you no harm. I had several reasons for my post. One is to serve as a lesson (if you will), a reminder, or tip (whichever applies) for you and others in this community. Your response, “as common as bread”, may be a truism in your world but, can you imagine the confusion it may cause someone whose job/vocation/interest is in Animal Protection, Academia, or even something that has been at the forefront of the news for some time now like, Air Pollution?

My second reason was to seek clarity or affirmation for myself. I guessed that A stood for Application and that I stood for Interface prior to my search but nevertheless I was unsure. . My internet search produced 82 possibilities. From the results of my search I was able to deduce that API stood for Application Programming Interface. (The reason I included it as one of the many possibilities in my original post.) With 82 possibilities to choose from what do you think the chances are that 100 percent of the people will be able to reason to the correct conclusion? Simply, I wanted more information so that I could make a decision as to whether or not your post could help me.

There are a number of people out there who are afraid to post. Some are too embarrassed to ask what others might deem a stupid question. Some might be embarrassed because they feel their English is too poor. Whatever their reason is that prevents them from posting is both unfortunate and counter productive. One will never know how many people their post has helped, be it question or answer. If I’m not mistaken this is the primary goal of having a forum in the first place. It is most likely the reason they ask all of us to refrain from sending Private Messages (PMs), (so that others will benefit from the posts) and the reason they instruct us to search the forum prior to posting to see if the question and answer has already been addressed (eliminating repetition). This is reason three for my post which was really more for other newbie’s (noob’s) and I thought, by chance, the forum moderator, Chris, might see the value in it and post as sticky (rewritten of course). In other words I was trying to help.

Finally, josamoto, I was also trying to draw attention to your post which like several other’s in here, the document section, appear to have been ignored or disregarded (most of the other unanswered posts are older than yours). Lucky for you that Chris has come to your rescue, at least you know he cares. It’s Unfortunate, though, that he still has not (as far as I can tell) answered your questions. Do you find it at all bothersome; the fact that your question was posed on Sept 9th and eight days later he completely passes you over with the sole and blatantly obvious intent to publicly deride me just one day after my post? Here we are, another thee days have passed and you know he has read your post now and yet nary a peep. So now I owe you another apology because even though I had no intention of doing so, I derailed your course of thought with my post. I’m sorry for that!

It’s just a suggestion and I don’t want to get you in trouble for not following the rules of the forum but maybe you should start another thread to get the focus back on you. Either way I will take my battle with Chris, elsewhere. And yes, this reply was intended for his eyes too and anyone else, whom he has berated, debased, ridiculed, or tried to humiliate.

Warm regards,

User avatar
Tonie
Joomla! Master
Joomla! Master
Posts: 16553
Joined: Thu Aug 18, 2005 7:13 am

Re: Offline API Documentation

Post by Tonie » Sun Sep 21, 2008 1:53 pm

At the moment, it's not available for download. Too much work, for not enough people. That's basically the problem.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1370
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Offline API Documentation

Post by Chris Davenport » Sun Sep 21, 2008 2:17 pm

@icsaidme, my apologies. My feeble attempt at humour was obviously not appreciated.

@josamoto, my apologies to you too as I seem to have missed your original post. The contents of http://api.joomla.org are available for download from http://api.joomla.org/joomladoc157framework.tar.gz.

Regards,
Chris.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/

User avatar
Tonie
Joomla! Master
Joomla! Master
Posts: 16553
Joined: Thu Aug 18, 2005 7:13 am

Re: Offline API Documentation

Post by Tonie » Sun Sep 21, 2008 6:04 pm

Ok, didn't know it was downloadable. Thanks for the update.

josamoto
Joomla! Apprentice
Joomla! Apprentice
Posts: 6
Joined: Wed Aug 27, 2008 9:02 am

Re: Offline API Documentation

Post by josamoto » Thu Sep 25, 2008 12:02 pm

Thanks for the handy links! It would be really nice to have like a download link on the API site to allow developers to download different versions thereof.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1370
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Offline API Documentation

Post by Chris Davenport » Thu Sep 25, 2008 3:57 pm

Good idea. I'll try to get that into the next update cycle.

Regards,
Chris.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/

josamoto
Joomla! Apprentice
Joomla! Apprentice
Posts: 6
Joined: Wed Aug 27, 2008 9:02 am

Re: Offline API Documentation

Post by josamoto » Fri Sep 26, 2008 7:08 am

Thanks for the help Chris. It's nice to have people around that appear to always have the answer and are always willing to help.

BTW, any idea where I can get the 1945 Asymmetric Perpendicular Indicator. Mine's broken coz I tried to connect it to my Synthetic Optical Actuator Prototype...it didn't work...

:geek:

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1370
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Offline API Documentation

Post by Chris Davenport » Fri Sep 26, 2008 8:24 am

The 1945 is obsolete and probably a security risk. Upgrade immediately. :p

Chris.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/

samaras
Joomla! Apprentice
Joomla! Apprentice
Posts: 44
Joined: Tue Aug 25, 2009 10:37 am
Location: Joburg,RSA
Contact:

Re: Offline API Documentation

Post by samaras » Tue Oct 20, 2009 7:19 am

Chris Davenport wrote:@icsaidme, my apologies. My feeble attempt at humour was obviously not appreciated.

@josamoto, my apologies to you too as I seem to have missed your original post. The contents of http://api.joomla.org are available for download from http://api.joomla.org/joomladoc157framework.tar.gz.

Regards,
Chris.
Hi your link above is broken. Can you please post the updated one?

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1370
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Offline API Documentation

Post by Chris Davenport » Tue Oct 20, 2009 7:37 am

samaras wrote: Hi your link above is broken. Can you please post the updated one?
There is always a link to the current version of that file on the front page of http://api.joomla.org.

Regards,
Chris.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/

samaras
Joomla! Apprentice
Joomla! Apprentice
Posts: 44
Joined: Tue Aug 25, 2009 10:37 am
Location: Joburg,RSA
Contact:

Re: Offline API Documentation

Post by samaras » Tue Oct 20, 2009 9:22 am

OK. I see that(I think). Is it on the dropdown menu -select package- . Because I have been clicking all of them but all get to do is actually browse the api instead of downloading. Am I missing something?

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1370
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Offline API Documentation

Post by Chris Davenport » Tue Oct 20, 2009 9:36 am

About half way down the page there is the following text:
You can download a copy of this website for offline use (subject to the terms of the Joomla! Electronic Documentation License) from here.
Click on the word "here".

Regards,
Chris.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/

samaras
Joomla! Apprentice
Joomla! Apprentice
Posts: 44
Joined: Tue Aug 25, 2009 10:37 am
Location: Joburg,RSA
Contact:

Re: Offline API Documentation

Post by samaras » Wed Oct 21, 2009 6:20 am

Thank You very much. I missed that.


Locked

Return to “docs.joomla.org - Feedback/Information”