StickyNote plugin
Written by kksou   
Tuesday, 04 November 2008

The Sticky Note plugin allows you to display a pop-up sticky note from within your content item or article.

This is a demo of the Sticky Note plugin. There are 2 modes of display:
  • Every time the page loads
  • Once per browser session using cookies

You can use it to display a promotional text or broadcast important messages to your users.

The original DHTML script was written by dynamicdrive.com. What I've done is to wrap the original code into a Joomla plugin/mambot so that you can easily display a sticky note in any of your content item.


Demo

You should see a sticky note displayed when you first load this page. The sticky note automatically disappears in 5 seconds.

If you missed the sticky note, you can view it again by reloading this page.

Latest Version

v1.0.2 (for Joomla 1.0) and v1.5.1 (for Joomla 1.5)
Released December 19, 2008

  • Fixed the warning meesage: "Notice: Undefined property: Plugin_StickyNote::$menu_width in StickyNote.lib.php on line 304"
  • Fixed the warning meesage: "Undefined property: Plugin_StickyNote::$menu_height in StickyNote.lib.php on line 305"

Unique Features

  1. Easily display a sticky note within a content item or article.
  2. Two different modes of display: 1) Every time the page loads 2) Once per browser session using cookies
  3. Toggle the "fading" effect on and off.
  4. Specify whether sticky note should automatically disappear after x seconds.
  5. You can easily customize the menu through css.

How to use the "Sticky Note" plugin

Important: If you're using Joomla 1.5.8, please refer to the article:
How to enter HTML tags, javascript and PHP codes in Joomla 1.5.8?
Otherwise you might find that all your HTML tags, Javascript and PHP scripts will be removed the moment you click the Save or Apply button.

  1. To insert the Accordion Menu Apple style, use the syntax:
  2. {StickyNote}
    ... msg ... 
    {/StickyNote}
    

    Note that you can use any standard HTML tags in the msg, e.g. <h3>, <img>, <ul>, <ol>, <br>, <p>etc.

  3. Display Mode: The default display mode is defined in the Parameters in the Plugin Manager. "Always" means the sticky note will appear every time the page loads. "Oncepersession" means that the sticky note will only appear once per browser session using cookies.
  4. You can also overwrite the global setting of the display mode in your content item.

    To set the display mode as "always" for the current content item (regardless of the setting in the Parameters page), use the following:

    {StickyNote displaymode:always}
    ... msg ... 
    {/StickyNote}
    

    To set the display mode as "oncepersession" for the current content item (regardless of the setting in the Parameters page), use the following:

    {StickyNote displaymode:oncepersession}
    ... msg ... 
    {/StickyNote}
    


  5. Auto Hide Box: In the Parameters of the Plugin Manager is a field called "Auto Hide Box". If you set it to "yes", it means that the Sticky Note will automatically hide itself (after a number of seconds as defined in the next field). If you set it to "no", it means that the Sticky Note will remain there until the user closes it.
  6. You can also overwrite the global setting of the "Auto Hide Box" in your content item.

    To set the "Auto Hide Box" to yes for the current sticky note (regardless of the setting in the Parameters page), use the following:

    {StickyNote autohidebox:yes}
    ... msg ... 
    {/StickyNote}
    

    To set the "Auto Hide Box" to no for the current sticky note (regardless of the setting in the Parameters page), use the following:

    {StickyNote autohidebox:no}
    ... msg ... 
    {/StickyNote}
    

  7. Auto Hide Time: In the Parameters of the Plugin Manager is a field called "Auto hide after x seconds". If you have set the previous field "Auto Hide Box" to "yes", the sticky note will automatically hide after the number of seconds as specified in this field.
  8. You can also overwrite the global setting of this field in your content item.

    For example, to automatically hide the current sticky note after 10 seconds (regardless of the setting in the Parameters page), use the following:

    {StickyNote autohidebox:yes autohidetime:10}
    ... msg ... 
    {/StickyNote}
    
  9. Auto Hide Box: In the Parameters of the Plugin Manager is a field called "Do not display in Home Page". If you set it to "yes", it means that the Sticky Note will not be displayed if your article or content item is displayed in the home page. If you set it to "no", it means that the Sticky Note will be shown even in the home page.
  10. You can also overwrite the global setting of the "Do not display in Home Page" in your content item.

    To set the "Do not display in Home Page" to yes for the current sticky note (regardless of the setting in the Parameters page), use the following:

    {StickyNote homepagehide:1}
    ... msg ... 
    {/StickyNote}
    

    To set the "Do not display in Home Page" to no for the current sticky note (regardless of the setting in the Parameters page), use the following:

    {StickyNote homepagehide:0}
    ... msg ... 
    {/StickyNote}
    

Download

How to install (Joomla 1.0.x)

  1. Download the plugin and unzip it into a folder.
  2. From the Installers menu, select mambots. In the field "Install directory", enter the folder location (where you unzipped the file) and click Install.
  3. From the Mambots menu, select Site Mambots.
  4. Make sure the plugin "StickyNote" is published. If you see a cross in the Published column, just click on it. It will turn into a green tick.

You are now ready to use this plugin!

How to install (Joomla 1.5.x)

  1. Download the plugin and unzip it into a folder.
  2. From the Extensions menu, select Install/Uninstall. In the field "Install directory", enter the folder location (where you unzipped the file) and click Install.
  3. From the Extensions menu, select Plugin Manager.
  4. Enable the plugin "StickyNote" - make sure there is a green tick in the Enabled column.
  5. Very Important: If you're using Joomla 1.5.8 and above, please refer to the article:
    How to enter HTML tags, javascript and PHP codes in Joomla 1.5.8?. Otherwise you might find that all your HTML tags, Javascript and PHP scripts will be removed the moment you click the Save or Apply button.

You are now ready to use this plugin!

Display Sticky Note in module

This plugin is used for displaying a sticky note associated with a content item or article.

If you wish to display sticky notes from within modules, I will write another module for this purpose.

Version History

  • v1.0.1 (for Joomla 1.0) and v1.5.1 (for Joomla 1.5)
    Released December 9, 2008
    • Fixed the warning message "Undefined variable: module on line 43"
    • Fixed the warning message "Undefined offset: 0 on line 55"


User reviews   Average user ratings:    3.5   (from 4 users)
  1. acara2000
    November 15, 2008 10:43am

  2. jerryhou
    November 16, 2008 8:42pm

  3. Morgan Grip
    November 24, 2008 1:46am
    ?

    Where can i download it?

  4. kksou
    November 24, 2008 1:54am

    Hi Morgan,

    It's right inside this article. Search for the heading "Download", or click on this link.

    Regards,
    /kksou

Note: You have to be a registered member to leave a comment. Free registration here.

 
< Prev   Next >

Blog - Forum - Privacy Policy - Contact Us
Copyright © 2006-2009. kksou.com. All Rights Reserved