Derik: New page: Hopefully this sandbox will eventually represent a documentation of the useful bits of our javascript; mediawiki-originated, cribbed from wikia and other sites, and original. It is my fe...

2009-03-23T09:38:41Z

New page: Hopefully this sandbox will eventually represent a documentation of the useful bits of our javascript; mediawiki-originated, cribbed from wikia and other sites, and original. It is my fe...

New page

Hopefully this sandbox will eventually represent a documentation of the useful bits of our javascript; mediawiki-originated, cribbed from wikia and other sites, and original.

It is my fervent wish that by documenting it thus, redundant code can be minimized.

==A-F==

<dt><a href="/wiki/User:Derik/javascript#addClickHandler.28_element.2C_handlerFunction_.29|addClickHandler( element, handlerFunction )
]]
:'''IN:''' ''wikibits.js'' - Same as [[User:Derik/javascript#addHandler.28_element.2C_event.2C_handlerFunction_.29|addHandler()]] (below) but a neater markup specific to click events.

 
<dt>[[User:Derik/javascript#addHandler.28_element.2C_event.2C_handlerFunction_.29|addHandler( element, event, handlerFunction )
]]
:'''IN:''' ''wikibits.js'' - bind an elevent to an element. Same as [[User:Derik/javascript#hookEvent.28hookName.2C_hookFunct.29|hoolEvent()]] but on an element-level rather than window-level. 

<tt>addHandler( elementNode, 'keydown', refreshSearch );</tt>

 
<dt>[[User:Derik/javascript#addOnloadHook.28functionName.29|addOnloadHook(functionName)
]]
:'''IN:''' ''wikibits.js'' - Adds a function to an array of functions that will be executed once the page is fully loaded. 
To add the function "initSearch()", the format is <tt>addOnloadHook(initSearch);</tt>

 
<dt>[[User:Derik/javascript#changeText.28el.2C_newText.29|changeText(el, newText)
]]

:'''IN:''' ''wikibits.js'' - replaces the inner text of an element ''el'' with the ''newText'' provided 

<div style="width: 90%; margin: 0 auto .2em auto; background-color:#efefef; border: 2px solid #eeeeee; padding: 2px; text-align: left;">'''Note:''' ''This function uses the element.innerText attribute to perform this replacement. It may mangle HTML?''</div>

 
<dt>[[User:Derik/javascript#escapeQuotes.28text.29|escapeQuotes(text)
]]
:'''IN:''' ''wikibits.js'' - Just what you'd expect, escapes quotes with backslashes.

 
<dt>[[User:Derik/javascript#escapeQuotesHTML.28text.29|escapeQuotesHTML(text)
]]
:'''IN:''' ''wikibits.js'' - Just what you'd expect, escapes quotes with HTML entities.

 

==G-M==

<dt>[[User:Derik/javascript#getElementsByClassName.28node.2C_tagName.2C_classNameObj.29|getElementsByClassName(node, tagName, classNameObj)
]]
:'''IN:''' ''wikibits.js'' - returns an array of element nodes with the class found in ''classNameObj'' within the element ''node''. ''tagName'' can also be used, or set to '*' to match all HTML tags. ''classNameObj'' can (apparently) be either an array (with multiple classes) or a string All variables are required. 

'''Example:''' <tt>getElementsByClassName(document, 'sup', Array('reference'));</tt> — retrieve all elements anyehere on the page.
'''Example:''' <tt>getElementsByClassName(document.getElementById('content'), 'a', 'new');</tt> — retrieve all red links within the page-content area only.

 
<dt>[[User:Derik/javascript#getFirstHeading.28.29|getFirstHeading()
]]

:'''IN:''' ''Monacobook.js'' - Returns an element handle for the first H1 ont he page with a class 'firstHeading'. (The page title)

<div style="width: 90%; margin: 0 auto .2em auto; background-color:#efefef; border: 2px solid #eeeeee; padding: 2px; text-align: left;">'''Note:''' ''Based on showEras() from Wookiepedia, but our implementation is cleaner!''</div>
 
<dt>[[User:Derik/javascript#hookEvent.28hookName.2C_hookFunct.29|hookEvent(hookName, hookFunct)
]]
:'''IN:''' ''wikibits.js'' - binds a function to a window-level event by hookName, where hookName is the common javascrit-internal name for that event-- ''minus'' the leading "on." 

To bind the function "updateSearch()" to execution when a onkeydown event occurs, the format is <tt>hookEvent(keydown, updateSearch);</tt>

 

<dt>[[User:Derik/javascript#injectSpinner.28_element.2C_idString_.29.3B|injectSpinner( element, idString );
]]
:'''IN:''' ''wikibits.js'' - Inserts an "in progress" spinner after the provided element for Ajax-y goodness. You can remove it later with [[User:Derik/javascript#removeSpinner.28_idString_.29.3B|removeSpinner()]]

<div style="width: 90%; margin: 0 auto .2em auto; background-color:#efefef; border: 2px solid #eeeeee; padding: 2px; text-align: left;">'''Note:''' ''The spinner graphic is very gay.''</div>

 

<dt>[[User:Derik/javascript#insertTags.28tagOpen.2C_tagClose.2C_sampleText.29|insertTags(tagOpen, tagClose, sampleText)
]]
:'''IN:''' ''wikibits.js'' - Adds text to the edit window (when in edit mode) at the point of the cursor. 
''tagOpen'' = add before selected text, ''tagClose'' = add after the selected text, sampleText = text to wedge between the two. (example content the user will change.) 

To simply insert a tag, format is <tt>insertTags('disambig','','');</tt>

 
<dt>[[User:Derik/javascript#jsMsg.28_message.2C_className_.29|jsMsg( message, className )
]]
:'''IN:''' ''wikibits.js'' - Pops a notice box up at the top of the page. Functions just like you'd think...

 

 

==N-S==

<dt>[[User:Derik/javascript#redirectToFragment.28anchorName.29.3B|redirectToFragment(anchorName);
]]
:'''IN:''' ''wikibits.js'' - scrolls the window to an anchor ''anchorName''. 
You will never use this, ever, it's part of the redirect-to-subsection mechanism, which isn't currently(Jan-14-09) working on the site. I'm only documenting so I can go back later and figure out ''why'' it's not working, since we seem to have code related it installed.

 
<dt>[[User:Derik/javascript#removeSpinner.28_idString_.29.3B|removeSpinner( idString );
]]
:'''IN:''' ''wikibits.js'' - removes the "in progress" spinner added by [[User:Derik/javascript#injectSpinner.28_element.2C_idString_.29.3B|injectSpinner()]]

 

<dt>[[User:Derik/javascript#showFactions.28_idString_.29.3B|showFactions( idString );
]]
:'''IN:''' ''Monacobook.js'' - Looks for an element with the provided ''idString'', then clones it into the first heading and changes its display mode to "block." (Used to display faction symbols.)

<div style="width: 90%; margin: 0 auto .2em auto; background-color:#efefef; border: 2px solid #eeeeee; padding: 2px; text-align: left;">'''Note:''' ''Based on showEras() from Wookiepedia.''</div>
 

==T-Z==

<dt>[[User:Derik/javascript#toggle_element_activation.28disable.2Cenable.29|toggle_element_activation(disable,enable)
]]

:'''IN:''' ''wikibits.js'' - given two html element id strings (not the elements themselves!,) disables the first element and enables the second. (Used for complicated forms.)

 
<dt>[[User:Derik/javascript#toggle_element_check.28check.2C_uncheck.29|toggle_element_check(check, uncheck)
]]
:'''IN:''' ''wikibits.js'' - given two element id strings that refer to ''checkboxes'', checks the first element and unchecks the second. (Used for complicated forms.)

 
<dt>[[User:Derik/javascript#toggleVisibility.28_levelId.2C_otherId.2C_linkId.29|toggleVisibility(_levelId, _otherId, _linkId)

]]
:'''IN:''' ''wikibits.js'' - toggles the element element in and out of visibility while alternately hiding/inlining the second two elements. ''Used for the "enhanced" version of the [[Special:RecentChanges]] page.''

 

==_-9==

User:Derik/javascript - Revision history

Derik: New page: Hopefully this sandbox will eventually represent a documentation of the useful bits of our javascript; mediawiki-originated, cribbed from wikia and other sites, and original. It is my fe...