Editing User:Lethosor/JSMenu

This is my project page for JavaScript plugins. The script can be found [[User:Lethosor/main.js|here]]. Note that it uses jQuery - the version on this wiki is 1.4.2. 

'''BIG SCARY WARNING:''' This page is currently under construction, as is the project it describes. Continuing to read this page may lead to disappointment when my project fails to accomplish anything interesting.

==Installation (not really)==
You need to  import [[User:Lethosor/main.js|this script]] in your [[Special:Mypage/common.js|user JavaScript page]] (although technically you can also use [[Special:Mypage/vector.js|this page]] if you use the vector theme (the default). You can find your theme under Preferences &rarr; Appearance.)

Add the following line (don't worry if the page doesn't exist yet):
<pre>
importScript("User:Lethosor/main.js");
</pre>
<sub>If you don't have permission to create that page, [[User talk:Lethosor|send me a message]].</sub>

Save the page, then reload again. "LethosorMenu" should appear in the navigation bar at the top (by the "Log out" link). If it doesn't, follow the instructions on your user JavaScript page to empty the cache.

==Advanced options==
Under construction for now, most of this is still to be worked on before it's released.

This script accepts multiple options to control execution. You can set plugins to run on page load or with a shortcut.

This script uses [http://en.wikipedia.org/wiki/Json JSON] to pass options. 

Create the following page, anywhere under your user page that you want:
<pre>LE_USER_OPTS = {}</pre>

Then import it in your user JavaScript file with the following:
<pre>
importScript("User:(USERNAME)/(Script you just created).js");
importScript("User:Lethosor/main.js");
</pre>

Note that you can import your settings ''after'' this script, but you will need to use this code instead:
<pre>
importScript("User:Lethosor/main.js");
importScript("User:(USERNAME)/(Script you just created).js");
LE.update_opts();
</pre>

===menu===
This object controls basic appearance and functionality of the menu itself.
====show_overlay====
<code>true</code> shows the grey overlay when the menu appears. <code>false</code> doesn't.

==Technical==
I use <code>delegate()</code> for some event handlers, which won't work prior to jQuery 1.4.2. It's deprecated in 1.9.0, but it works.