100 - Write a document describing how to use the JPagination class

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!
jbelani1
Joomla! Apprentice
Joomla! Apprentice
Posts: 26
Joined: Thu Nov 29, 2007 7:19 pm

100 - Write a document describing how to use the JPagination class

Postby jbelani1 » Sun Jan 13, 2008 4:47 am

Hi all I'm Josh, and I am back and ready for another task  :).  I think that this task is going to be perfect for me because after completing the previous one I have a better knowledge of how Joomla! components work.  Here are the task details:

One line summary
Write a document describing how to use the JPagination class in a component.

Description
The document should begin by describing what the JPagination class is used
for and give a concrete example, with screenshot(s), of the class in use.
If you are not already familiar with JPagination you will find plenty of
examples of its use in the Joomla! 1.5 core components. Using the core
component code as a source of examples, describe how a component developer
can make full use of the JPagination class.

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 experience with 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.


I'm excited to continue to aid the Joomla! community!

-Josh
Last edited by AmyStephen on Mon Feb 04, 2008 8:20 am, edited 1 time in total.

User avatar
jlleblanc
Joomla! Guru
Joomla! Guru
Posts: 963
Joined: Fri Aug 19, 2005 12:37 am
Location: Washington, DC / NoVA
Contact:

Re: 100 - Write a document describing how to use the JPagination class

Postby jlleblanc » Sun Jan 13, 2008 5:15 am

Excellent! Can't wait to read it :)
Joseph L. LeBlanc: http://www.jlleblanc.com
Frontend components start here: /components/com_[name]/[name].php
Backend components start here: /administrator/components/com_[name]/admin.[name].php

jbelani1
Joomla! Apprentice
Joomla! Apprentice
Posts: 26
Joined: Thu Nov 29, 2007 7:19 pm

Re: 100 - Write a document describing how to use the JPagination class

Postby jbelani1 » Wed Jan 16, 2008 12:50 am

Hi all,

I'm just giving a quick update.  Right now I am doing research about the JPagination class and how it is used, and trying to find code snippets for examples in the document.

I hope to get an outline for the document up within the next two days, and a rough draft soon after.

-Josh

User avatar
jlleblanc
Joomla! Guru
Joomla! Guru
Posts: 963
Joined: Fri Aug 19, 2005 12:37 am
Location: Washington, DC / NoVA
Contact:

Re: 100 - Write a document describing how to use the JPagination class

Postby jlleblanc » Wed Jan 16, 2008 1:06 am

No problem, writing well takes time!
Joseph L. LeBlanc: http://www.jlleblanc.com
Frontend components start here: /components/com_[name]/[name].php
Backend components start here: /administrator/components/com_[name]/admin.[name].php

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

Re: 100 - Write a document describing how to use the JPagination class

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

jbelani1 -

How is it going? Please find a moment to give a status update on your progress and hopefully provide a draft for review.

The contest is coming to an end and we want time to review all the work, too, so, the sooner you can do so, the better.

Thanks!
Amy :)

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

Re: 100 - Write a document describing how to use the JPagination class

Postby AmyStephen » Tue Jan 29, 2008 1:58 am

Last week of the contest warning - Hope to hear from you!

Amy :)


Return to “Google's Highly Open Participation Contest”

Who is online

Users browsing this forum: No registered users and 2 guests