129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

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!
chalet16
Joomla! Apprentice
Joomla! Apprentice
Posts: 40
Joined: Fri Nov 30, 2007 1:14 pm

129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby chalet16 » Fri Dec 28, 2007 4:24 pm

Hello everyone,
My name is Witchakorn Kamolpornwijit (First-Last) and my nickname is Chalet.
My task is write plugin for footnotes. This is my second GHOP tasks. :)

From : http://code.google.com/p/google-highly-open-participation-joomla/issues/detail?id=129
Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript
Describe the task.

Implement Brand Spanking New's Footnotes with CSS and Javascript

Resources:

    * Brand Spanking New website -
http://www.brandspankingnew.net/archive ... cript.html
    * To install Joomla! on an XAMPP localhost:

  # XAMPP - http://www.apachefriends.org
  # Download Joomla! - http://help.joomla.org/content/view/1942/302/
  # Install Joomla! on a localhost -
http://help.joomla.org/content/view/1947/306/

    * Coding resources:

  # The core code! :-)
  # Plugins - http://forum.joomla.org/index.php?topic=233628
  # Model View Controller -
http://dev.joomla.org/component/option, ... orld_mvc1/
  # Modules and Components - http://www.jlleblanc.com/blogcategory/0/
  # Internationalization -
http://forum.joomla.org/index.php/topic ... msg1102267

    * IRC #joomlaGHOP on freenode

Skills needed

    * Knowledge of PHP
    * Knowledge of Joomla! v 1.5 Extension Development
    * Creativity and problem solving skills.

Difficulty

Basic
Work Product

    * Installable Joomla! v 1.5 extension(s) with internationalization
support.

Licensing

All code must be created using the GNU General Public License version 2.
http://www.gnu.org/licenses/old-license ... .html#SEC4

Documentation written for this task must be made available under the
Joomla! Electronic Documentation License.
Extra Credit (Optional)

1. Register your project at Joomlacode
2. When you are ready to release, submit your extension to the Joomla!
Extensions Directory.

Implement the sidenotes version, too.
Time Limit

2 weeks.
Last edited by AmyStephen on Thu Jan 03, 2008 6:27 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: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby jlleblanc » Fri Dec 28, 2007 7:47 pm

Welcome to the contest! Let us know if you need any pointers on the code.
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

chalet16
Joomla! Apprentice
Joomla! Apprentice
Posts: 40
Joined: Fri Nov 30, 2007 1:14 pm

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby chalet16 » Sat Dec 29, 2007 4:06 am

Could you review my 0.1alpha version here?
http://joomlacode.org/gf/project/footnotes/frs/

Thank you.

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

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby jlleblanc » Mon Dec 31, 2007 4:41 am

Good start. Your method for replacing the {footnote} tokens looks ok. The installation package is missing the CSS and JS files in the XML manifest, so it's throwing up JS errors when the article loads.
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

chalet16
Joomla! Apprentice
Joomla! Apprentice
Posts: 40
Joined: Fri Nov 30, 2007 1:14 pm

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby chalet16 » Mon Dec 31, 2007 7:55 am

jlleblanc wrote:Good start. Your method for replacing the {footnote} tokens looks ok. The installation package is missing the CSS and JS files in the XML manifest, so it's throwing up JS errors when the article loads.

I am sorry.I forgot about that! :o I have edit that in my 0.1 beta at the same JoomlaCode project.

Thank you for your review. :D
Please Check My 0.1beta

Merry Christmas and Happy New Year
Last edited by chalet16 on Mon Dec 31, 2007 1:36 pm, 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: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby jlleblanc » Mon Dec 31, 2007 5:03 pm

Ahh, I'm seeing it now; looking nice ;D

At the moment, I have two footnotes in a sample article, but they both point to the anchor #footnotes_2.
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

chalet16
Joomla! Apprentice
Joomla! Apprentice
Posts: 40
Joined: Fri Nov 30, 2007 1:14 pm

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby chalet16 » Mon Dec 31, 2007 5:21 pm

jlleblanc wrote:Ahh, I'm seeing it now; looking nice ;D

At the moment, I have two footnotes in a sample article, but they both point to the anchor #footnotes_2.

It is correct because it should anchor to footer
in the same place and it is '#footnotes_2' beacuse
I use article id.

Am I wrong?  ???
Last edited by chalet16 on Mon Dec 31, 2007 5:28 pm, edited 1 time in total.

chalet16
Joomla! Apprentice
Joomla! Apprentice
Posts: 40
Joined: Fri Nov 30, 2007 1:14 pm

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby chalet16 » Mon Dec 31, 2007 5:58 pm

I have make code more easy readable with space and description in 0.1stable

Thank you for every review :D.

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

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby jlleblanc » Mon Dec 31, 2007 8:48 pm

chalet16 wrote:It is correct because it should anchor to footer
in the same place and it is '#footnotes_2' beacuse
I use article id.

Am I wrong?  ???



Oh, I see now. That's what I get for not looking at the original demo. :-[  Disregard my last comment.  :)
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

chalet16
Joomla! Apprentice
Joomla! Apprentice
Posts: 40
Joined: Fri Nov 30, 2007 1:14 pm

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby chalet16 » Tue Jan 01, 2008 2:41 am

Final Review. :D
Last edited by chalet16 on Tue Jan 01, 2008 4:47 am, edited 1 time in total.

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

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby AmyStephen » Tue Jan 01, 2008 7:59 am

Witchakorn -

You do remarkable work! Looks really great.

One problem - my numbers are not superscripts.

Minor issue:
On the plugin, it says:
Use build-in CSS

Should be:
Use built-in CSS

This is great!
Amy :)

chalet16
Joomla! Apprentice
Joomla! Apprentice
Posts: 40
Joined: Fri Nov 30, 2007 1:14 pm

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby chalet16 » Tue Jan 01, 2008 10:52 am

AmyStephen wrote:Witchakorn -

You do remarkable work! Looks really great.

One problem - my numbers are not superscripts.

Minor issue:
On the plugin, it says:
Use build-in CSS

Should be:
Use built-in CSS

This is great!
Amy :)

Thank you for review. Now I have fix both of that in my 0.11

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

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby jlleblanc » Tue Jan 01, 2008 3:59 pm

On my end, both IE and FF and get the superscripts. The code is looking good. :)

The only suggestion I have would be to place the JS and CSS files in a subfolder so they don't clutter up /plugins/content. You can create a 'footnotes' folder and place them in there. Just add the folder into your package and make this modification to your XML manifest:

Code: Select all

   <files>
      <filename plugin="footnotes">footnotes.php</filename>
      <filename>footnotes/footnotes-side.css</filename>
      <filename>footnotes/footnotes-side.js</filename>
      <filename>footnotes/footnotes-std.css</filename>
      <filename>footnotes/footnotes-std.js</filename>
   </files>


You'll need to make a few quick path changes to the HTML you generate as well.
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: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby AmyStephen » Tue Jan 01, 2008 4:44 pm

Joe -

On the folder issue, is there a way to specify the folder name, only, and not each file?

Are you using the default template and getting the superscripts? I wonder why I don't?

I love this extension - really cool stuff!

Amy :)

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

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby jlleblanc » Tue Jan 01, 2008 8:34 pm

AmyStephen wrote:Joe -

On the folder issue, is there a way to specify the folder name, only, and not each file?


No, you need to specify each individual file to be copied.

AmyStephen wrote:Are you using the default template and getting the superscripts? I wonder why I don't?


Yes and yes. On both FF on Mac and IE on PC.
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

chalet16
Joomla! Apprentice
Joomla! Apprentice
Posts: 40
Joined: Fri Nov 30, 2007 1:14 pm

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby chalet16 » Wed Jan 02, 2008 11:30 am

jlleblanc wrote:
AmyStephen wrote:Joe -

On the folder issue, is there a way to specify the folder name, only, and not each file?


No, you need to specify each individual file to be copied.

But I found that can be use in xml too. Please review my plugin again in 0.12 version.

AmyStephen wrote:Joe -

On the folder issue, is there a way to specify the folder name, only, and not each file?

Are you using the default template and getting the superscripts? I wonder why I don't?

I love this extension - really cool stuff!

Amy :)

I have add in my new 0.11 version

Thank you for every review  :D
Chalet

chalet16
Joomla! Apprentice
Joomla! Apprentice
Posts: 40
Joined: Fri Nov 30, 2007 1:14 pm

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby chalet16 » Thu Jan 03, 2008 5:42 am

How about my lastest 1.12 version?  :)

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

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby AmyStephen » Thu Jan 03, 2008 6:26 am

Yea!!!! That is CLASSY!  8)

The subscript works beautifully, now. I really like this extension.

OK, that was easier than I thought!  :P Just say !

Code: Select all

   <files>
      <filename plugin="footnotes">footnotes.php</filename>
      <folder>footnotes</folder>
   </files>


Really nice code - elegant - like this, instead of an IF statement:

Code: Select all

$document->addScript( JURI::base() .'plugins/content/footnotes-' . $pluginParams->def('place','std') . '.js');


13, right?  ??? Impressive.

Joe already said things looked good. Looks good to me, too.  I accept this task as complete. Maybe you could go grab the Facebook task and see if you might find SOMETHING challenging.  ;)

Doing good things, Witchakorn. Upload the extension to Google and we'll close the task.
Amy :)

chalet16
Joomla! Apprentice
Joomla! Apprentice
Posts: 40
Joined: Fri Nov 30, 2007 1:14 pm

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby chalet16 » Thu Jan 03, 2008 2:59 pm

AmyStephen wrote:Yea!!!! That is CLASSY!  8)

The subscript works beautifully, now. I really like this extension.

OK, that was easier than I thought!  :P Just say !

Code: Select all

   <files>
      <filename plugin="footnotes">footnotes.php</filename>
      <folder>footnotes</folder>
   </files>


Really nice code - elegant - like this, instead of an IF statement:

Code: Select all

$document->addScript( JURI::base() .'plugins/content/footnotes-' . $pluginParams->def('place','std') . '.js');


13, right?  ??? Impressive.

Joe already said things looked good. Looks good to me, too.  I accept this task as complete. Maybe you could go grab the Facebook task and see if you might find SOMETHING challenging.  ;)

Doing good things, Witchakorn. Upload the extension to Google and we'll close the task.
Amy :)

I claimed Facebook task now but today I'm very busy. I think I will do it 2-3 days later.

Thank you and everyone that  review and discuss my plugin.
:D

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

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby AmyStephen » Thu Jan 03, 2008 3:11 pm

You are too cool!

Ok. I suppose you can take a few days off.  ;)

Sincerely, thanks for taking the Facebook app on - talk about some potential there! Can't wait to hear your progress and test your work. This is going to be fun!

Talk to you later,
Amy :)

PS - Did you add your plugin to the Joomla! Extension Directory? Hope so!

gperetz
Joomla! Fledgling
Joomla! Fledgling
Posts: 1
Joined: Fri Jan 25, 2008 8:39 pm

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby gperetz » Fri Jan 25, 2008 8:44 pm

I'm hoping to backport this v.1.5 plugin to Joomla! v.1.0, since I desperately need this feature and can't upgrade to 1.5 until more add on modules/components become 1.5-native (~6 months). Any advice or help would be appreciated. Thanks.

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

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS and Javascript

Postby AmyStephen » Sat Jan 26, 2008 1:13 am

This is a Google contest. If you want to ask this question in the Joomla! 101 Forums, that could work. But, this is not an appropriate place. These pre-university students are not Joomla! v 1.0.x developers, anyway.

Thanks for understanding!
Amy :)

mtrange
Joomla! Intern
Joomla! Intern
Posts: 51
Joined: Mon Feb 25, 2008 7:36 pm

Joomla! v 1.5 Plugin for Footnotes -- Issues

Postby mtrange » Tue Apr 08, 2008 1:05 am

I am looking for a working plugin for footnote creation within j 1.5 and have used the plugin available at http://www.brandspankingnew.net/archive/2006/01/footnotes-with-css-and-javascript.html which I think may be the one discussed in this thread.

My usage of the plugin can be seen at http://www.strangelove.com/strangewritings.

The plugin does not appear to handle the table fo contents (returns to a blank page) and when the "article index" is clicked upon, the resulting page shows the footnotes WITHIN the page, not at the bottom.

Is an updated version of this plugin available?

Is there a working FOOTNOTE creation plugin available for Joomla!

thank you,

Dr. Strangelove

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

Re: 129 - Create a Joomla! v 1.5 Plugin for Footnotes with CSS a

Postby AmyStephen » Tue Apr 08, 2008 1:52 am

Nice looking site! Very appealing for students.

Never really thought about table of contents with this plugin. The most current release appears to be from January and is available on JoomlaCode.

I'm not certain what it would take to make it work for table of contents, but it could be a bit tricky. It really wasn't intended to be used that way. It's just not a feature. Whether the developer will choose to add additional features is truly up to him. Of course, it's GPL, so anyone can hack the code for their own needs, too. If you do so, you might consider sharing the improvements with the developer.

Please use the tracker for this extension for any additional questions you might have. The tracker has a place to add feature requests, too. This is a forum for the GHOP contest and not a place for support questions.

Hope that helps,
Amy :)


Return to “Google's Highly Open Participation Contest”

Who is online

Users browsing this forum: No registered users and 1 guest