099 - Write a document describing how to add JavaScript and CSS from an extensi

Google's Highly Open Participation Program tries to get young students into Open Source and Joomla! specifically. Everyone is welcome, there are not limits. You can be a coder, documenter, tester, translator to help out. Jump in and start helping!
User avatar
fealebenpae
Joomla! Intern
Joomla! Intern
Posts: 54
Joined: Fri Nov 30, 2007 8:33 pm
Location: Vidin, Bulgaria

099 - Write a document describing how to add JavaScript and CSS from an extensi

Postby fealebenpae » Tue Jan 08, 2008 8:33 am

Hello, nice Joomla folk :)

This time I'll work on this task:
One line summary
Write a document describing how to add JavaScript and CSS to the page from
an extension.

Description
Although it is possible to output JavaScript and CSS fragments, or
references to external files containing JavaScript or CSS, by constructing
the HTML directly, it is cleaner and simpler to use the Joomla! 1.5 API
calls. This document should describe when and how to use each of the
relevant API calls.

The document should comply with current Joomla! Editorial Style Guidelines
and guidelines for the Template Tutorials Project.

Documentation written for this task must be made available under the
Joomla! Electronic Documentation License.

Skills Needed
Prior knowledge of PHP would be useful.

Difficulty
Basic.

Work Product
Document as described above.

Extra Credit (optional)
Check the wiki API reference for all the classes and methods referred to in
the document and suggest additions and improvements that could be made. For
example, class/method descriptions, cross-references, code samples, etc).

Check the Joomla! source code for the classes and methods referred to in
the document and suggest additions and improvements that could be made to
the phpdoc tags.

Time Limit
2 weeks.
Last edited by AmyStephen on Wed Jan 30, 2008 11:08 pm, edited 1 time in total.
And it came to pass that in that time the Great God Om spake unto Brutha, the Chosen One: "Psst!"

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7056
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 099- Write a document describing how to add JavaScript and CSS from an exten

Postby AmyStephen » Tue Jan 08, 2008 2:09 pm

Can you add L33t to that? hehe! Just kidding...  :P

Do you need anything, my friend, or can you write this very important developer document in your sleep?

Thanks for coming back and doing another one. You are a very promising developer and we appreciate you very much!

Amy :)

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7056
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 099- Write a document describing how to add JavaScript and CSS from an exten

Postby AmyStephen » Mon Jan 21, 2008 1:51 am

Hey dude - hows it going? It you get a chance - give us a holler!

Amy :)

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7056
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 099 - Write a document describing how to add JavaScript and CSS from an exte

Postby AmyStephen » Wed Jan 23, 2008 6:42 pm

fealebenpae -

We are nearing the end of the contest and i know things get very busy. I hope you are still planning to participate on this task. If, for some reason you cannot, that's okay, too.

Please let us know at your earliest convenience.

Thanks!
Amy

User avatar
fealebenpae
Joomla! Intern
Joomla! Intern
Posts: 54
Joined: Fri Nov 30, 2007 8:33 pm
Location: Vidin, Bulgaria

Re: 099 - Write a document describing how to add JavaScript and CSS from an exte

Postby fealebenpae » Thu Jan 24, 2008 1:35 am

I'll never try documentation again  ;D It was worse than leet, honestly. Also, don't get me started on Bulgarian Matura exams - whoever came up with this idea has to be shot.

I wouldn't call this attempt successful, mostly due to the little time I had and my innate inability to compose a document readable and understandable for normal human beings.

Although in some cases I could have included JHTML::script and JHTML::stylesheet, I chose not to do so because I think that the JDocument approach is more consistent and frankly, in my opinion those two functions are just wrappers and I can't see the point in them.

I've included thorough code examples, which I think can be used in the API reference. On a side note, by reading the reference I couldn't understand what the $attribs argument in JDocument::addStyleSheet is used for and I think this need attention. I didn't mention $attribs in the document.

Let me know what you think and how I can improve my "tutorial".

Cheers,
Yavor :)
You do not have the required permissions to view the files attached to this post.
And it came to pass that in that time the Great God Om spake unto Brutha, the Chosen One: "Psst!"

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7056
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 099 - Write a document describing how to add JavaScript and CSS from an exte

Postby AmyStephen » Thu Jan 24, 2008 4:14 am

Yavor -

I am always so happy to see you. Thanks!

I will let the documentation folks know a) you have brought in a tutorial and b) you feel better suited for development work.  ;)

Honestly, finding out what one doesn't like to do is valuable, too. I am glad you tried it and it says much about your character that you delivered it.

We'll talk later,
Amy :)

PS - you are really funny.
Last edited by AmyStephen on Thu Jan 24, 2008 4:17 am, edited 1 time in total.

User avatar
fealebenpae
Joomla! Intern
Joomla! Intern
Posts: 54
Joined: Fri Nov 30, 2007 8:33 pm
Location: Vidin, Bulgaria

Re: 099 - Write a document describing how to add JavaScript and CSS from an exte

Postby fealebenpae » Thu Jan 24, 2008 9:48 am

I'd have liked the Facebook task, but then again it's good I couldn't claim it, otherwise I would have botched it with my lack of time this last month. End of the first term in senior year sux0rz  ;D

You're right - it's more than useful to know what you can do and what you can't. GHOP has been a revelation in this part :)

I plan on continuing development in the summer because I have a couple of ideas my fingers are just itching to implement. And who knows, I might show up on these forums next year in Summer of Code?  ;D
And it came to pass that in that time the Great God Om spake unto Brutha, the Chosen One: "Psst!"

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

Re: 099 - Write a document describing how to add JavaScript and CSS from an exte

Postby Chris Davenport » Wed Jan 30, 2008 9:51 pm

Hi Yavor,

This is really very good work.  :)

The only fault I would pick you up on is that the text switches into a pure monospaced font ("Monaco") near the top of page 2.  Only the example code should be monospaced, the regular text should be in the proportional typeface used elsewhere.

Apart from that, an excellent piece of work.  :)

Regards,
Chris.
Chris Davenport - Joomla Production Leadership Team

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

User avatar
fealebenpae
Joomla! Intern
Joomla! Intern
Posts: 54
Joined: Fri Nov 30, 2007 8:33 pm
Location: Vidin, Bulgaria

Re: 099 - Write a document describing how to add JavaScript and CSS from an exte

Postby fealebenpae » Wed Jan 30, 2008 10:04 pm

Thanks for replying, Chris.

Ugh, I must be font-blind  ;D

I'm uploading a fixed version.
You do not have the required permissions to view the files attached to this post.
And it came to pass that in that time the Great God Om spake unto Brutha, the Chosen One: "Psst!"

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7056
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 099 - Write a document describing how to add JavaScript and CSS from an exte

Postby AmyStephen » Wed Jan 30, 2008 11:08 pm

Chris Davenport wrote:Apart from that, an excellent piece of work.  :)


And you say you are no good at documentation!

The fonts look good and Chris liked your work, so go ahead and upload it to Google and we will close this one down.

Please, Yavor, do not be a stranger - hope to see you around, again!

Take care - thanks for all you have done for our community!
Amy :)

User avatar
fealebenpae
Joomla! Intern
Joomla! Intern
Posts: 54
Joined: Fri Nov 30, 2007 8:33 pm
Location: Vidin, Bulgaria

Re: 099 - Write a document describing how to add JavaScript and CSS from an exte

Postby fealebenpae » Thu Jan 31, 2008 12:56 am

Just because it turned out good doesn't mean I'll do it again, if I have a choice :-D

Anyway, thanks for all your help, Amy, you were really wonderful - to everyone, and all the other J! people who sacrifaced a bit of their time to help me out as well. To tell the truth, my college application essay was about GHOP and the open source community in general, because that's something that influenced me A LOT! I really enjoyed participating and I'm glad I was of some service :)

I should check out how the guy with the facebook application is doing - maybe he'd like to team up after the contest or something.

Night, folks :)
And it came to pass that in that time the Great God Om spake unto Brutha, the Chosen One: "Psst!"

DeZzL
Joomla! Apprentice
Joomla! Apprentice
Posts: 22
Joined: Fri Jun 02, 2006 12:37 pm
Contact:

Re: 099 - Write a document describing how to add JavaScript and

Postby DeZzL » Mon Feb 18, 2008 11:22 am

Attachments
[The extension odt has been deactivated and can no longer be displayed.]

I'd love to be able to download that document!

User avatar
fealebenpae
Joomla! Intern
Joomla! Intern
Posts: 54
Joined: Fri Nov 30, 2007 8:33 pm
Location: Vidin, Bulgaria

Re: 099 - Write a document describing how to add JavaScript and

Postby fealebenpae » Mon Feb 18, 2008 11:40 am

DeZzL, here's a link to the document: http://help.joomla.org/ghop/feb2008/tas ... %20099.odt
And it came to pass that in that time the Great God Om spake unto Brutha, the Chosen One: "Psst!"


Return to “Google's Highly Open Participation Contest”

Who is online

Users browsing this forum: No registered users and 1 guest