Add custom PDoc HTML template to source tree.
This commit is contained in:
Andrew Dupont
parent
0445d37116
commit
2895be3587
Binary file not shown.
|
After Width: | Height: | Size: 671 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 981 B |
Binary file not shown.
|
After Width: | Height: | Size: 584 B |
Binary file not shown.
|
After Width: | Height: | Size: 786 B |
Binary file not shown.
|
After Width: | Height: | Size: 125 B |
Binary file not shown.
|
After Width: | Height: | Size: 4.0 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.9 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 778 B |
Binary file not shown.
|
After Width: | Height: | Size: 6.7 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 970 B |
Binary file not shown.
|
After Width: | Height: | Size: 599 B |
Binary file not shown.
|
After Width: | Height: | Size: 343 B |
Binary file not shown.
|
After Width: | Height: | Size: 946 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.9 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 630 B |
|
|
@ -0,0 +1,282 @@
|
|||
if (typeof PDoc === "undefined") window.PDoc = {};
|
||||
|
||||
// Poor-man's history manager. Polls for changes to the hash.
|
||||
(function() {
|
||||
var PREVIOUS_HASH = null;
|
||||
|
||||
document.observe("dom:loaded", function() {
|
||||
var hash = window.location.hash;
|
||||
if (hash && hash !== PREVIOUS_HASH) {
|
||||
document.fire("hash:changed",
|
||||
{ previous: PREVIOUS_HASH, current: hash });
|
||||
PREVIOUS_HASH = hash;
|
||||
}
|
||||
|
||||
window.setTimeout(arguments.callee, 100);
|
||||
});
|
||||
})();
|
||||
|
||||
// Place a "frame" around the element described by the hash.
|
||||
// Update the frame when the hash changes.
|
||||
PDoc.highlightSelected = function() {
|
||||
if (!window.location.hash) return;
|
||||
element = $(window.location.hash.substr(1));
|
||||
if (element) PDoc.highlight(element.up('li, div'));
|
||||
};
|
||||
|
||||
document.observe("hash:changed", PDoc.highlightSelected);
|
||||
|
||||
PDoc.highlight = function(element) {
|
||||
var self = arguments.callee;
|
||||
if (!self.frame) {
|
||||
self.frame = new Element('div', { 'class': 'highlighter' });
|
||||
document.body.appendChild(self.frame);
|
||||
}
|
||||
|
||||
var frame = self.frame;
|
||||
|
||||
element.getOffsetParent().appendChild(frame);
|
||||
|
||||
var offset = element.positionedOffset();
|
||||
var w = parseFloat(element.getStyle('width')),
|
||||
h = parseFloat(element.getStyle('height'));
|
||||
|
||||
frame.setStyle({
|
||||
position: 'absolute',
|
||||
top: (offset.top - 5) + 'px',
|
||||
left: (offset.left - 5) + 'px',
|
||||
width: (w + 5) + 'px',
|
||||
height: (h + 10) + 'px'
|
||||
});
|
||||
|
||||
// Defer this call because Safari hasn't yet scrolled the viewport.
|
||||
(function() {
|
||||
var frameOffset = frame.viewportOffset(frame);
|
||||
if (frameOffset.top < 0) {
|
||||
window.scrollBy(0, frameOffset.top - 10);
|
||||
}
|
||||
}).defer();
|
||||
|
||||
};
|
||||
|
||||
// Live API search.
|
||||
var Filterer = Class.create({
|
||||
initialize: function(element, options) {
|
||||
this.element = $(element);
|
||||
this.options = Object.extend({
|
||||
interval: 0.1,
|
||||
resultsElement: '.search-results'
|
||||
}, options || {});
|
||||
|
||||
this.element.writeAttribute("autocomplete", "off");
|
||||
this.element.up('form').observe("submit", Event.stop);
|
||||
|
||||
// // The Safari-only "search" input type is prettier
|
||||
// if (Prototype.Browser.WebKit)
|
||||
// this.element.type = "search";
|
||||
|
||||
this.menu = this.options.menu;
|
||||
this.links = this.menu.select('a');
|
||||
|
||||
this.resultsElement = this.options.resultsElement;
|
||||
this.resultsElement.setStyle({
|
||||
overflowX: 'hidden'
|
||||
});
|
||||
|
||||
this.events = {
|
||||
filter: this.filter.bind(this),
|
||||
keydown: this.keydown.bind(this)
|
||||
};
|
||||
|
||||
this.menu.setStyle({ opacity: 0.9 });
|
||||
this.addObservers();
|
||||
|
||||
this.element.value = '';
|
||||
},
|
||||
|
||||
addObservers: function() {
|
||||
this.element.observe('keyup', this.events.filter);
|
||||
},
|
||||
|
||||
filter: function(event) {
|
||||
if (this._timer) window.clearTimeout(this._timer);
|
||||
|
||||
// Clear the text box on ESC
|
||||
if (event.keyCode && event.keyCode === Event.KEY_ESC) {
|
||||
this.element.value = '';
|
||||
}
|
||||
|
||||
if ([Event.KEY_UP, Event.KEY_DOWN, Event.KEY_RETURN].include(event.keyCode))
|
||||
return;
|
||||
|
||||
var value = $F(this.element).strip().toLowerCase();
|
||||
if (value === "") {
|
||||
this.onEmpty();
|
||||
return;
|
||||
}
|
||||
|
||||
var urls = this.findURLs(value);
|
||||
this.buildResults(urls);
|
||||
},
|
||||
|
||||
keydown: function(event) {
|
||||
if (![Event.KEY_UP, Event.KEY_DOWN, Event.KEY_RETURN].include(event.keyCode))
|
||||
return;
|
||||
|
||||
// ignore if any modifier keys are present
|
||||
if (event.shiftKey || event.ctrlKey || event.altKey || event.metaKey)
|
||||
return;
|
||||
|
||||
event.stop();
|
||||
|
||||
var highlighted = this.resultsElement.down('.highlighted');
|
||||
if (event.keyCode === Event.KEY_RETURN) {
|
||||
// Follow the highlighted item.
|
||||
if (!highlighted) return;
|
||||
window.location.href = highlighted.down('a').href;
|
||||
} else {
|
||||
var direction = (Event.KEY_DOWN === event.keyCode) ? 1 : -1;
|
||||
highlighted = this.moveHighlight(direction);
|
||||
}
|
||||
|
||||
|
||||
if ([Event.KEY_UP, Event.KEY_DOWN].include(event.keyCode) &&
|
||||
!Prototype.Browser.WebKit) {
|
||||
// If up/down key is held down, list should keep scrolling.
|
||||
// Safari does this automatically because it fires the keydown
|
||||
// event over and over.
|
||||
this._timer = window.setTimeout(this.scrollList.bind(this, direction), 1000);
|
||||
}
|
||||
},
|
||||
|
||||
moveHighlight: function(direction) {
|
||||
var highlighted = this.resultsElement.down('.highlighted');
|
||||
// move the focus
|
||||
if (!highlighted) {
|
||||
// if there is none, highlight the first result
|
||||
var highlighted = this.resultsElement.down('li').addClassName('highlighted');
|
||||
} else {
|
||||
var method = (direction === 1) ? 'next' : 'previous';
|
||||
highlighted.removeClassName('highlighted');
|
||||
var adjacent = highlighted[method]('li');
|
||||
if (!adjacent) {
|
||||
adjacent = method == 'next' ? this.resultsElement.down('li') :
|
||||
this.resultsElement.down('li:last-of-type');
|
||||
}
|
||||
adjacent.addClassName('highlighted');
|
||||
highlighted = adjacent;
|
||||
}
|
||||
|
||||
// Adjust the scroll offset of the container so that the highlighted
|
||||
// item is always in view.
|
||||
var distanceToBottom = highlighted.offsetTop + highlighted.offsetHeight;
|
||||
if (distanceToBottom > this.resultsElement.offsetHeight + this.resultsElement.scrollTop) {
|
||||
// item is too low
|
||||
this.resultsElement.scrollTop = distanceToBottom - this.resultsElement.offsetHeight;
|
||||
} else if (highlighted.offsetTop < this.resultsElement.scrollTop) {
|
||||
// item is too high
|
||||
this.resultsElement.scrollTop = highlighted.offsetTop;
|
||||
}
|
||||
|
||||
return highlighted;
|
||||
},
|
||||
|
||||
scrollList: function(direction) {
|
||||
this.moveHighlight(direction);
|
||||
this._timer = window.setTimeout(this.scrollList.bind(this, direction), 100);
|
||||
},
|
||||
|
||||
buildResults: function(urls) {
|
||||
this.resultsElement.update();
|
||||
var ul = this.resultsElement;
|
||||
urls.each( function(url) {
|
||||
var a = new Element('a', {
|
||||
'class': url.type.gsub(/\s/, '_'),
|
||||
href: PDoc.pathPrefix + url.path
|
||||
}).update(url.name);
|
||||
var li = new Element('li', { 'class': 'menu-item' });
|
||||
li.appendChild(a);
|
||||
ul.appendChild(li);
|
||||
});
|
||||
this.showResults();
|
||||
},
|
||||
|
||||
|
||||
findURLs: function(str) {
|
||||
var results = [];
|
||||
for (var i in PDoc.elements) {
|
||||
if (i.toLowerCase().include(str)) results.push(PDoc.elements[i]);
|
||||
}
|
||||
return results;
|
||||
},
|
||||
|
||||
onEmpty: function() {
|
||||
this.hideResults();
|
||||
},
|
||||
|
||||
showResults: function() {
|
||||
this.resultsElement.show();
|
||||
document.stopObserving("keydown", this.events.keydown);
|
||||
document.observe("keydown", this.events.keydown);
|
||||
},
|
||||
|
||||
hideResults: function() {
|
||||
this.resultsElement.hide();
|
||||
document.stopObserving("keydown", this.events.keydown);
|
||||
}
|
||||
});
|
||||
|
||||
document.observe('dom:loaded', function() {
|
||||
new Filterer($('search'), {
|
||||
menu: $('api_menu'),
|
||||
resultsElement: $('search_results')
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
Event.observe(window, 'load', function() {
|
||||
var menu = $('menu');
|
||||
var OFFSET = menu.viewportOffset().top;
|
||||
|
||||
Event.observe(window, 'scroll', function() {
|
||||
var sOffset = document.viewport.getScrollOffsets();
|
||||
if (sOffset.top > OFFSET) {
|
||||
menu.addClassName('fixed');
|
||||
} else menu.removeClassName('fixed');
|
||||
});
|
||||
});
|
||||
|
||||
(function() {
|
||||
function menuButtonMouseOver(event) {
|
||||
var menuButton = $('api_menu_button');
|
||||
var target = event.element();
|
||||
if (target === menuButton || target.descendantOf(menuButton)) {
|
||||
$('api_menu').show();
|
||||
}
|
||||
}
|
||||
|
||||
function menuButtonMouseOut(event) {
|
||||
var menuButton = $('api_menu_button');
|
||||
var menu = $('api_menu');
|
||||
var target = event.element(), related = event.relatedTarget;
|
||||
|
||||
if (related === menu || related.descendantOf(menu)) return;
|
||||
menu.hide();
|
||||
}
|
||||
|
||||
function menuMouseOut(event) {
|
||||
var menu = $('api_menu'), related = event.relatedTarget;
|
||||
if (related && !related.descendantOf(menu)) {
|
||||
arguments.callee.timer = Element.hide.delay(0.5, menu);
|
||||
} else {
|
||||
window.clearTimeout(arguments.callee.timer)
|
||||
}
|
||||
}
|
||||
|
||||
document.observe('dom:loaded', function() {
|
||||
$('api_menu_button').observe('mouseover', menuButtonMouseOver);
|
||||
$('api_menu_button').observe('mouseout', menuButtonMouseOut);
|
||||
|
||||
$('api_menu').observe('mouseout', menuMouseOut);
|
||||
});
|
||||
})();
|
||||
|
|
@ -0,0 +1,251 @@
|
|||
/* Unobtrustive Code Highlighter By Dan Webb 11/2005
|
||||
Version: 0.4
|
||||
|
||||
Usage:
|
||||
Add a script tag for this script and any stylesets you need to use
|
||||
to the page in question, add correct class names to CODE elements,
|
||||
define CSS styles for elements. That's it!
|
||||
|
||||
Known to work on:
|
||||
IE 5.5+ PC
|
||||
Firefox/Mozilla PC/Mac
|
||||
Opera 7.23 + PC
|
||||
Safari 2
|
||||
|
||||
Known to degrade gracefully on:
|
||||
IE5.0 PC
|
||||
|
||||
Note: IE5.0 fails due to the use of lookahead in some stylesets. To avoid script errors
|
||||
in older browsers use expressions that use lookahead in string format when defining stylesets.
|
||||
|
||||
This script is inspired by star-light by entirely cunning Dean Edwards
|
||||
http://dean.edwards.name/star-light/.
|
||||
*/
|
||||
|
||||
// replace callback support for safari.
|
||||
if ("a".replace(/a/, function() {return "b"}) != "b") (function(){
|
||||
var default_replace = String.prototype.replace;
|
||||
String.prototype.replace = function(search,replace){
|
||||
// replace is not function
|
||||
if(typeof replace != "function"){
|
||||
return default_replace.apply(this,arguments)
|
||||
}
|
||||
var str = "" + this;
|
||||
var callback = replace;
|
||||
// search string is not RegExp
|
||||
if(!(search instanceof RegExp)){
|
||||
var idx = str.indexOf(search);
|
||||
return (
|
||||
idx == -1 ? str :
|
||||
default_replace.apply(str,[search,callback(search, idx, str)])
|
||||
)
|
||||
}
|
||||
var reg = search;
|
||||
var result = [];
|
||||
var lastidx = reg.lastIndex;
|
||||
var re;
|
||||
while((re = reg.exec(str)) != null){
|
||||
var idx = re.index;
|
||||
var args = re.concat(idx, str);
|
||||
result.push(
|
||||
str.slice(lastidx,idx),
|
||||
callback.apply(null,args).toString()
|
||||
);
|
||||
if(!reg.global){
|
||||
lastidx += RegExp.lastMatch.length;
|
||||
break
|
||||
}else{
|
||||
lastidx = reg.lastIndex;
|
||||
}
|
||||
}
|
||||
result.push(str.slice(lastidx));
|
||||
return result.join("")
|
||||
}
|
||||
})();
|
||||
|
||||
var CodeHighlighter = { styleSets : new Array };
|
||||
|
||||
CodeHighlighter.addStyle = function(name, rules) {
|
||||
// using push test to disallow older browsers from adding styleSets
|
||||
if ([].push) this.styleSets.push({
|
||||
name : name,
|
||||
rules : rules,
|
||||
ignoreCase : arguments[2] || false
|
||||
})
|
||||
|
||||
function setEvent() {
|
||||
// set highlighter to run on load (use LowPro if present)
|
||||
if (typeof Event != 'undefined' && typeof Event.onReady == 'function')
|
||||
return Event.onReady(CodeHighlighter.init.bind(CodeHighlighter));
|
||||
|
||||
var old = window.onload;
|
||||
|
||||
if (typeof window.onload != 'function') {
|
||||
window.onload = function() { CodeHighlighter.init() };
|
||||
} else {
|
||||
window.onload = function() {
|
||||
old();
|
||||
CodeHighlighter.init();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// only set the event when the first style is added
|
||||
if (this.styleSets.length==1) setEvent();
|
||||
}
|
||||
|
||||
CodeHighlighter.init = function() {
|
||||
if (!document.getElementsByTagName) return;
|
||||
if ("a".replace(/a/, function() {return "b"}) != "b") return; // throw out Safari versions that don't support replace function
|
||||
// throw out older browsers
|
||||
|
||||
var codeEls = document.getElementsByTagName("CODE");
|
||||
// collect array of all pre elements
|
||||
codeEls.filter = function(f) {
|
||||
var a = new Array;
|
||||
for (var i = 0; i < this.length; i++) if (f(this[i])) a[a.length] = this[i];
|
||||
return a;
|
||||
}
|
||||
|
||||
var rules = new Array;
|
||||
rules.toString = function() {
|
||||
// joins regexes into one big parallel regex
|
||||
var exps = new Array;
|
||||
for (var i = 0; i < this.length; i++) exps.push(this[i].exp);
|
||||
return exps.join("|");
|
||||
}
|
||||
|
||||
function addRule(className, rule) {
|
||||
// add a replace rule
|
||||
var exp = (typeof rule.exp != "string")?String(rule.exp).substr(1, String(rule.exp).length-2):rule.exp;
|
||||
// converts regex rules to strings and chops of the slashes
|
||||
rules.push({
|
||||
className : className,
|
||||
exp : "(" + exp + ")",
|
||||
length : (exp.match(/(^|[^\\])\([^?]/g) || "").length + 1, // number of subexps in rule
|
||||
replacement : rule.replacement || null
|
||||
});
|
||||
}
|
||||
|
||||
function parse(text, ignoreCase) {
|
||||
// main text parsing and replacement
|
||||
return text.replace(new RegExp(rules, (ignoreCase)?"gi":"g"), function() {
|
||||
var i = 0, j = 1, rule;
|
||||
while (rule = rules[i++]) {
|
||||
if (arguments[j]) {
|
||||
// if no custom replacement defined do the simple replacement
|
||||
if (!rule.replacement) return "<span class=\"" + rule.className + "\">" + arguments[0] + "</span>";
|
||||
else {
|
||||
// replace $0 with the className then do normal replaces
|
||||
var str = rule.replacement.replace("$0", rule.className);
|
||||
for (var k = 1; k <= rule.length - 1; k++) str = str.replace("$" + k, arguments[j + k]);
|
||||
return str;
|
||||
}
|
||||
} else j+= rule.length;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function highlightCode(styleSet) {
|
||||
// clear rules array
|
||||
var parsed;
|
||||
rules.length = 0;
|
||||
|
||||
// get stylable elements by filtering out all code elements without the correct className
|
||||
var stylableEls = codeEls.filter(function(item) {return (item.className.indexOf(styleSet.name)>=0)});
|
||||
|
||||
// add style rules to parser
|
||||
for (var className in styleSet.rules) addRule(className, styleSet.rules[className]);
|
||||
|
||||
|
||||
// replace for all elements
|
||||
for (var i = 0; i < stylableEls.length; i++) {
|
||||
// EVIL hack to fix IE whitespace badness if it's inside a <pre>
|
||||
if (/MSIE/.test(navigator.appVersion) && stylableEls[i].parentNode.nodeName == 'PRE') {
|
||||
stylableEls[i] = stylableEls[i].parentNode;
|
||||
|
||||
parsed = stylableEls[i].innerHTML.replace(/(<code[^>]*>)([^<]*)<\/code>/i, function() {
|
||||
return arguments[1] + parse(arguments[2], styleSet.ignoreCase) + "</code>"
|
||||
});
|
||||
parsed = parsed.replace(/\n( *)/g, function() {
|
||||
var spaces = "";
|
||||
for (var i = 0; i < arguments[1].length; i++) spaces+= " ";
|
||||
return "\n" + spaces;
|
||||
});
|
||||
parsed = parsed.replace(/\t/g, " ");
|
||||
parsed = parsed.replace(/\n(<\/\w+>)?/g, "<br />$1").replace(/<br \/>[\n\r\s]*<br \/>/g, "<p><br></p>");
|
||||
|
||||
} else parsed = parse(stylableEls[i].innerHTML, styleSet.ignoreCase);
|
||||
|
||||
stylableEls[i].innerHTML = parsed;
|
||||
}
|
||||
}
|
||||
|
||||
// run highlighter on all stylesets
|
||||
for (var i=0; i < this.styleSets.length; i++) {
|
||||
highlightCode(this.styleSets[i]);
|
||||
}
|
||||
};
|
||||
|
||||
CodeHighlighter.addStyle("css", {
|
||||
comment : {
|
||||
exp : /\/\*[^*]*\*+([^\/][^*]*\*+)*\//
|
||||
},
|
||||
keywords : {
|
||||
exp : /@\w[\w\s]*/
|
||||
},
|
||||
selectors : {
|
||||
exp : "([\\w-:\\[.#][^{};>]*)(?={)"
|
||||
},
|
||||
properties : {
|
||||
exp : "([\\w-]+)(?=\\s*:)"
|
||||
},
|
||||
units : {
|
||||
exp : /([0-9])(em|en|px|%|pt)\b/,
|
||||
replacement : "$1<span class=\"$0\">$2</span>"
|
||||
},
|
||||
urls : {
|
||||
exp : /url\([^\)]*\)/
|
||||
}
|
||||
});
|
||||
|
||||
CodeHighlighter.addStyle("html", {
|
||||
comment : {
|
||||
exp: /<!\s*(--([^-]|[\r\n]|-[^-])*--\s*)>/
|
||||
},
|
||||
tag : {
|
||||
exp: /(<\/?)([a-zA-Z]+\s?)/,
|
||||
replacement: "$1<span class=\"$0\">$2</span>"
|
||||
},
|
||||
string : {
|
||||
exp : /'[^']*'|"[^"]*"/
|
||||
},
|
||||
attribute : {
|
||||
exp: /\b([a-zA-Z-:]+)(=)/,
|
||||
replacement: "<span class=\"$0\">$1</span>$2"
|
||||
},
|
||||
doctype : {
|
||||
exp: /<!DOCTYPE([^&]|&[^g]|&g[^t])*>/
|
||||
}
|
||||
});
|
||||
|
||||
CodeHighlighter.addStyle("javascript",{
|
||||
comment : {
|
||||
exp : /(\/\/[^\n]*(\n|$))|(\/\*[^*]*\*+([^\/][^*]*\*+)*\/)/
|
||||
},
|
||||
brackets : {
|
||||
exp : /\(|\)/
|
||||
},
|
||||
regex : {
|
||||
exp : /\/(.*?)[g|s|m]?\/[;|\n]/
|
||||
},
|
||||
string : {
|
||||
exp : /'(?:\.|(\\\')|[^\''])*'|"(?:\.|(\\\")|[^\""])*"/
|
||||
},
|
||||
keywords : {
|
||||
exp : /\b(arguments|break|case|continue|default|delete|do|else|false|for|function|if|in|instanceof|new|null|return|switch|this|true|typeof|var|void|while|with)\b/
|
||||
},
|
||||
global : {
|
||||
exp : /\b(toString|valueOf|window|element|prototype|constructor|document|escape|unescape|parseInt|parseFloat|setTimeout|clearTimeout|setInterval|clearInterval|NaN|isNaN|Infinity|alert|prompt|confirm)\b/
|
||||
}
|
||||
});
|
||||
|
|
@ -0,0 +1,963 @@
|
|||
// Copyright (c) 2005-2007 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us)
|
||||
// (c) 2005-2007 Ivan Krstic (http://blogs.law.harvard.edu/ivan)
|
||||
// (c) 2005-2007 Jon Tirsen (http://www.tirsen.com)
|
||||
// Contributors:
|
||||
// Richard Livsey
|
||||
// Rahul Bhargava
|
||||
// Rob Wills
|
||||
//
|
||||
// script.aculo.us is freely distributable under the terms of an MIT-style license.
|
||||
// For details, see the script.aculo.us web site: http://script.aculo.us/
|
||||
|
||||
// Autocompleter.Base handles all the autocompletion functionality
|
||||
// that's independent of the data source for autocompletion. This
|
||||
// includes drawing the autocompletion menu, observing keyboard
|
||||
// and mouse events, and similar.
|
||||
//
|
||||
// Specific autocompleters need to provide, at the very least,
|
||||
// a getUpdatedChoices function that will be invoked every time
|
||||
// the text inside the monitored textbox changes. This method
|
||||
// should get the text for which to provide autocompletion by
|
||||
// invoking this.getToken(), NOT by directly accessing
|
||||
// this.element.value. This is to allow incremental tokenized
|
||||
// autocompletion. Specific auto-completion logic (AJAX, etc)
|
||||
// belongs in getUpdatedChoices.
|
||||
//
|
||||
// Tokenized incremental autocompletion is enabled automatically
|
||||
// when an autocompleter is instantiated with the 'tokens' option
|
||||
// in the options parameter, e.g.:
|
||||
// new Ajax.Autocompleter('id','upd', '/url/', { tokens: ',' });
|
||||
// will incrementally autocomplete with a comma as the token.
|
||||
// Additionally, ',' in the above example can be replaced with
|
||||
// a token array, e.g. { tokens: [',', '\n'] } which
|
||||
// enables autocompletion on multiple tokens. This is most
|
||||
// useful when one of the tokens is \n (a newline), as it
|
||||
// allows smart autocompletion after linebreaks.
|
||||
|
||||
if(typeof Effect == 'undefined')
|
||||
throw("controls.js requires including script.aculo.us' effects.js library");
|
||||
|
||||
var Autocompleter = { }
|
||||
Autocompleter.Base = Class.create({
|
||||
baseInitialize: function(element, update, options) {
|
||||
element = $(element)
|
||||
this.element = element;
|
||||
this.update = $(update);
|
||||
this.hasFocus = false;
|
||||
this.changed = false;
|
||||
this.active = false;
|
||||
this.index = 0;
|
||||
this.entryCount = 0;
|
||||
this.oldElementValue = this.element.value;
|
||||
|
||||
if(this.setOptions)
|
||||
this.setOptions(options);
|
||||
else
|
||||
this.options = options || { };
|
||||
|
||||
this.options.paramName = this.options.paramName || this.element.name;
|
||||
this.options.tokens = this.options.tokens || [];
|
||||
this.options.frequency = this.options.frequency || 0.4;
|
||||
this.options.minChars = this.options.minChars || 1;
|
||||
this.options.onShow = this.options.onShow ||
|
||||
function(element, update){
|
||||
if(!update.style.position || update.style.position=='absolute') {
|
||||
update.style.position = 'absolute';
|
||||
Position.clone(element, update, {
|
||||
setHeight: false,
|
||||
offsetTop: element.offsetHeight
|
||||
});
|
||||
}
|
||||
Effect.Appear(update,{duration:0.15});
|
||||
};
|
||||
this.options.onHide = this.options.onHide ||
|
||||
function(element, update){ new Effect.Fade(update,{duration:0.15}) };
|
||||
|
||||
if(typeof(this.options.tokens) == 'string')
|
||||
this.options.tokens = new Array(this.options.tokens);
|
||||
// Force carriage returns as token delimiters anyway
|
||||
if (!this.options.tokens.include('\n'))
|
||||
this.options.tokens.push('\n');
|
||||
|
||||
this.observer = null;
|
||||
|
||||
this.element.setAttribute('autocomplete','off');
|
||||
|
||||
Element.hide(this.update);
|
||||
|
||||
Event.observe(this.element, 'blur', this.onBlur.bindAsEventListener(this));
|
||||
Event.observe(this.element, 'keydown', this.onKeyPress.bindAsEventListener(this));
|
||||
},
|
||||
|
||||
show: function() {
|
||||
if(Element.getStyle(this.update, 'display')=='none') this.options.onShow(this.element, this.update);
|
||||
if(!this.iefix &&
|
||||
(Prototype.Browser.IE) &&
|
||||
(Element.getStyle(this.update, 'position')=='absolute')) {
|
||||
new Insertion.After(this.update,
|
||||
'<iframe id="' + this.update.id + '_iefix" '+
|
||||
'style="display:none;position:absolute;filter:progid:DXImageTransform.Microsoft.Alpha(opacity=0);" ' +
|
||||
'src="javascript:false;" frameborder="0" scrolling="no"></iframe>');
|
||||
this.iefix = $(this.update.id+'_iefix');
|
||||
}
|
||||
if(this.iefix) setTimeout(this.fixIEOverlapping.bind(this), 50);
|
||||
},
|
||||
|
||||
fixIEOverlapping: function() {
|
||||
Position.clone(this.update, this.iefix, {setTop:(!this.update.style.height)});
|
||||
this.iefix.style.zIndex = 1;
|
||||
this.update.style.zIndex = 2;
|
||||
Element.show(this.iefix);
|
||||
},
|
||||
|
||||
hide: function() {
|
||||
this.stopIndicator();
|
||||
if(Element.getStyle(this.update, 'display')!='none') this.options.onHide(this.element, this.update);
|
||||
if(this.iefix) Element.hide(this.iefix);
|
||||
},
|
||||
|
||||
startIndicator: function() {
|
||||
if(this.options.indicator) Element.show(this.options.indicator);
|
||||
},
|
||||
|
||||
stopIndicator: function() {
|
||||
if(this.options.indicator) Element.hide(this.options.indicator);
|
||||
},
|
||||
|
||||
onKeyPress: function(event) {
|
||||
if(this.active)
|
||||
switch(event.keyCode) {
|
||||
case Event.KEY_TAB:
|
||||
case Event.KEY_RETURN:
|
||||
this.selectEntry();
|
||||
Event.stop(event);
|
||||
case Event.KEY_ESC:
|
||||
this.hide();
|
||||
this.active = false;
|
||||
Event.stop(event);
|
||||
return;
|
||||
case Event.KEY_LEFT:
|
||||
case Event.KEY_RIGHT:
|
||||
return;
|
||||
case Event.KEY_UP:
|
||||
this.markPrevious();
|
||||
this.render();
|
||||
Event.stop(event);
|
||||
return;
|
||||
case Event.KEY_DOWN:
|
||||
this.markNext();
|
||||
this.render();
|
||||
Event.stop(event);
|
||||
return;
|
||||
}
|
||||
else
|
||||
if(event.keyCode==Event.KEY_TAB || event.keyCode==Event.KEY_RETURN ||
|
||||
(Prototype.Browser.WebKit > 0 && event.keyCode == 0)) return;
|
||||
|
||||
this.changed = true;
|
||||
this.hasFocus = true;
|
||||
|
||||
if(this.observer) clearTimeout(this.observer);
|
||||
this.observer =
|
||||
setTimeout(this.onObserverEvent.bind(this), this.options.frequency*1000);
|
||||
},
|
||||
|
||||
activate: function() {
|
||||
this.changed = false;
|
||||
this.hasFocus = true;
|
||||
this.getUpdatedChoices();
|
||||
},
|
||||
|
||||
onHover: function(event) {
|
||||
var element = Event.findElement(event, 'LI');
|
||||
if(this.index != element.autocompleteIndex)
|
||||
{
|
||||
this.index = element.autocompleteIndex;
|
||||
this.render();
|
||||
}
|
||||
Event.stop(event);
|
||||
},
|
||||
|
||||
onClick: function(event) {
|
||||
var element = Event.findElement(event, 'LI');
|
||||
this.index = element.autocompleteIndex;
|
||||
this.selectEntry();
|
||||
this.hide();
|
||||
},
|
||||
|
||||
onBlur: function(event) {
|
||||
// needed to make click events working
|
||||
setTimeout(this.hide.bind(this), 250);
|
||||
this.hasFocus = false;
|
||||
this.active = false;
|
||||
},
|
||||
|
||||
render: function() {
|
||||
if(this.entryCount > 0) {
|
||||
for (var i = 0; i < this.entryCount; i++)
|
||||
this.index==i ?
|
||||
Element.addClassName(this.getEntry(i),"selected") :
|
||||
Element.removeClassName(this.getEntry(i),"selected");
|
||||
if(this.hasFocus) {
|
||||
this.show();
|
||||
this.active = true;
|
||||
}
|
||||
} else {
|
||||
this.active = false;
|
||||
this.hide();
|
||||
}
|
||||
},
|
||||
|
||||
markPrevious: function() {
|
||||
if(this.index > 0) this.index--
|
||||
else this.index = this.entryCount-1;
|
||||
this.getEntry(this.index).scrollIntoView(true);
|
||||
},
|
||||
|
||||
markNext: function() {
|
||||
if(this.index < this.entryCount-1) this.index++
|
||||
else this.index = 0;
|
||||
this.getEntry(this.index).scrollIntoView(false);
|
||||
},
|
||||
|
||||
getEntry: function(index) {
|
||||
return this.update.firstChild.childNodes[index];
|
||||
},
|
||||
|
||||
getCurrentEntry: function() {
|
||||
return this.getEntry(this.index);
|
||||
},
|
||||
|
||||
selectEntry: function() {
|
||||
this.active = false;
|
||||
this.updateElement(this.getCurrentEntry());
|
||||
},
|
||||
|
||||
updateElement: function(selectedElement) {
|
||||
if (this.options.updateElement) {
|
||||
this.options.updateElement(selectedElement);
|
||||
return;
|
||||
}
|
||||
var value = '';
|
||||
if (this.options.select) {
|
||||
var nodes = $(selectedElement).select('.' + this.options.select) || [];
|
||||
if(nodes.length>0) value = Element.collectTextNodes(nodes[0], this.options.select);
|
||||
} else
|
||||
value = Element.collectTextNodesIgnoreClass(selectedElement, 'informal');
|
||||
|
||||
var bounds = this.getTokenBounds();
|
||||
if (bounds[0] != -1) {
|
||||
var newValue = this.element.value.substr(0, bounds[0]);
|
||||
var whitespace = this.element.value.substr(bounds[0]).match(/^\s+/);
|
||||
if (whitespace)
|
||||
newValue += whitespace[0];
|
||||
this.element.value = newValue + value + this.element.value.substr(bounds[1]);
|
||||
} else {
|
||||
this.element.value = value;
|
||||
}
|
||||
this.oldElementValue = this.element.value;
|
||||
this.element.focus();
|
||||
|
||||
if (this.options.afterUpdateElement)
|
||||
this.options.afterUpdateElement(this.element, selectedElement);
|
||||
},
|
||||
|
||||
updateChoices: function(choices) {
|
||||
if(!this.changed && this.hasFocus) {
|
||||
this.update.innerHTML = choices;
|
||||
Element.cleanWhitespace(this.update);
|
||||
Element.cleanWhitespace(this.update.down());
|
||||
|
||||
if(this.update.firstChild && this.update.down().childNodes) {
|
||||
this.entryCount =
|
||||
this.update.down().childNodes.length;
|
||||
for (var i = 0; i < this.entryCount; i++) {
|
||||
var entry = this.getEntry(i);
|
||||
entry.autocompleteIndex = i;
|
||||
this.addObservers(entry);
|
||||
}
|
||||
} else {
|
||||
this.entryCount = 0;
|
||||
}
|
||||
|
||||
this.stopIndicator();
|
||||
this.index = 0;
|
||||
|
||||
if(this.entryCount==1 && this.options.autoSelect) {
|
||||
this.selectEntry();
|
||||
this.hide();
|
||||
} else {
|
||||
this.render();
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
addObservers: function(element) {
|
||||
Event.observe(element, "mouseover", this.onHover.bindAsEventListener(this));
|
||||
Event.observe(element, "click", this.onClick.bindAsEventListener(this));
|
||||
},
|
||||
|
||||
onObserverEvent: function() {
|
||||
this.changed = false;
|
||||
this.tokenBounds = null;
|
||||
if(this.getToken().length>=this.options.minChars) {
|
||||
this.getUpdatedChoices();
|
||||
} else {
|
||||
this.active = false;
|
||||
this.hide();
|
||||
}
|
||||
this.oldElementValue = this.element.value;
|
||||
},
|
||||
|
||||
getToken: function() {
|
||||
var bounds = this.getTokenBounds();
|
||||
return this.element.value.substring(bounds[0], bounds[1]).strip();
|
||||
},
|
||||
|
||||
getTokenBounds: function() {
|
||||
if (null != this.tokenBounds) return this.tokenBounds;
|
||||
var value = this.element.value;
|
||||
if (value.strip().empty()) return [-1, 0];
|
||||
var diff = arguments.callee.getFirstDifferencePos(value, this.oldElementValue);
|
||||
var offset = (diff == this.oldElementValue.length ? 1 : 0);
|
||||
var prevTokenPos = -1, nextTokenPos = value.length;
|
||||
var tp;
|
||||
for (var index = 0, l = this.options.tokens.length; index < l; ++index) {
|
||||
tp = value.lastIndexOf(this.options.tokens[index], diff + offset - 1);
|
||||
if (tp > prevTokenPos) prevTokenPos = tp;
|
||||
tp = value.indexOf(this.options.tokens[index], diff + offset);
|
||||
if (-1 != tp && tp < nextTokenPos) nextTokenPos = tp;
|
||||
}
|
||||
return (this.tokenBounds = [prevTokenPos + 1, nextTokenPos]);
|
||||
}
|
||||
});
|
||||
|
||||
Autocompleter.Base.prototype.getTokenBounds.getFirstDifferencePos = function(newS, oldS) {
|
||||
var boundary = Math.min(newS.length, oldS.length);
|
||||
for (var index = 0; index < boundary; ++index)
|
||||
if (newS[index] != oldS[index])
|
||||
return index;
|
||||
return boundary;
|
||||
};
|
||||
|
||||
Ajax.Autocompleter = Class.create(Autocompleter.Base, {
|
||||
initialize: function(element, update, url, options) {
|
||||
this.baseInitialize(element, update, options);
|
||||
this.options.asynchronous = true;
|
||||
this.options.onComplete = this.onComplete.bind(this);
|
||||
this.options.defaultParams = this.options.parameters || null;
|
||||
this.url = url;
|
||||
},
|
||||
|
||||
getUpdatedChoices: function() {
|
||||
this.startIndicator();
|
||||
|
||||
var entry = encodeURIComponent(this.options.paramName) + '=' +
|
||||
encodeURIComponent(this.getToken());
|
||||
|
||||
this.options.parameters = this.options.callback ?
|
||||
this.options.callback(this.element, entry) : entry;
|
||||
|
||||
if(this.options.defaultParams)
|
||||
this.options.parameters += '&' + this.options.defaultParams;
|
||||
|
||||
new Ajax.Request(this.url, this.options);
|
||||
},
|
||||
|
||||
onComplete: function(request) {
|
||||
this.updateChoices(request.responseText);
|
||||
}
|
||||
});
|
||||
|
||||
// The local array autocompleter. Used when you'd prefer to
|
||||
// inject an array of autocompletion options into the page, rather
|
||||
// than sending out Ajax queries, which can be quite slow sometimes.
|
||||
//
|
||||
// The constructor takes four parameters. The first two are, as usual,
|
||||
// the id of the monitored textbox, and id of the autocompletion menu.
|
||||
// The third is the array you want to autocomplete from, and the fourth
|
||||
// is the options block.
|
||||
//
|
||||
// Extra local autocompletion options:
|
||||
// - choices - How many autocompletion choices to offer
|
||||
//
|
||||
// - partialSearch - If false, the autocompleter will match entered
|
||||
// text only at the beginning of strings in the
|
||||
// autocomplete array. Defaults to true, which will
|
||||
// match text at the beginning of any *word* in the
|
||||
// strings in the autocomplete array. If you want to
|
||||
// search anywhere in the string, additionally set
|
||||
// the option fullSearch to true (default: off).
|
||||
//
|
||||
// - fullSsearch - Search anywhere in autocomplete array strings.
|
||||
//
|
||||
// - partialChars - How many characters to enter before triggering
|
||||
// a partial match (unlike minChars, which defines
|
||||
// how many characters are required to do any match
|
||||
// at all). Defaults to 2.
|
||||
//
|
||||
// - ignoreCase - Whether to ignore case when autocompleting.
|
||||
// Defaults to true.
|
||||
//
|
||||
// It's possible to pass in a custom function as the 'selector'
|
||||
// option, if you prefer to write your own autocompletion logic.
|
||||
// In that case, the other options above will not apply unless
|
||||
// you support them.
|
||||
|
||||
Autocompleter.Local = Class.create(Autocompleter.Base, {
|
||||
initialize: function(element, update, array, options) {
|
||||
this.baseInitialize(element, update, options);
|
||||
this.options.array = array;
|
||||
},
|
||||
|
||||
getUpdatedChoices: function() {
|
||||
this.updateChoices(this.options.selector(this));
|
||||
},
|
||||
|
||||
setOptions: function(options) {
|
||||
this.options = Object.extend({
|
||||
choices: 10,
|
||||
partialSearch: true,
|
||||
partialChars: 2,
|
||||
ignoreCase: true,
|
||||
fullSearch: false,
|
||||
selector: function(instance) {
|
||||
var ret = []; // Beginning matches
|
||||
var partial = []; // Inside matches
|
||||
var entry = instance.getToken();
|
||||
var count = 0;
|
||||
|
||||
for (var i = 0; i < instance.options.array.length &&
|
||||
ret.length < instance.options.choices ; i++) {
|
||||
|
||||
var elem = instance.options.array[i];
|
||||
var foundPos = instance.options.ignoreCase ?
|
||||
elem.toLowerCase().indexOf(entry.toLowerCase()) :
|
||||
elem.indexOf(entry);
|
||||
|
||||
while (foundPos != -1) {
|
||||
if (foundPos == 0 && elem.length != entry.length) {
|
||||
ret.push("<li><strong>" + elem.substr(0, entry.length) + "</strong>" +
|
||||
elem.substr(entry.length) + "</li>");
|
||||
break;
|
||||
} else if (entry.length >= instance.options.partialChars &&
|
||||
instance.options.partialSearch && foundPos != -1) {
|
||||
if (instance.options.fullSearch || /\s/.test(elem.substr(foundPos-1,1))) {
|
||||
partial.push("<li>" + elem.substr(0, foundPos) + "<strong>" +
|
||||
elem.substr(foundPos, entry.length) + "</strong>" + elem.substr(
|
||||
foundPos + entry.length) + "</li>");
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
foundPos = instance.options.ignoreCase ?
|
||||
elem.toLowerCase().indexOf(entry.toLowerCase(), foundPos + 1) :
|
||||
elem.indexOf(entry, foundPos + 1);
|
||||
|
||||
}
|
||||
}
|
||||
if (partial.length)
|
||||
ret = ret.concat(partial.slice(0, instance.options.choices - ret.length))
|
||||
return "<ul>" + ret.join('') + "</ul>";
|
||||
}
|
||||
}, options || { });
|
||||
}
|
||||
});
|
||||
|
||||
// AJAX in-place editor and collection editor
|
||||
// Full rewrite by Christophe Porteneuve <tdd@tddsworld.com> (April 2007).
|
||||
|
||||
// Use this if you notice weird scrolling problems on some browsers,
|
||||
// the DOM might be a bit confused when this gets called so do this
|
||||
// waits 1 ms (with setTimeout) until it does the activation
|
||||
Field.scrollFreeActivate = function(field) {
|
||||
setTimeout(function() {
|
||||
Field.activate(field);
|
||||
}, 1);
|
||||
}
|
||||
|
||||
Ajax.InPlaceEditor = Class.create({
|
||||
initialize: function(element, url, options) {
|
||||
this.url = url;
|
||||
this.element = element = $(element);
|
||||
this.prepareOptions();
|
||||
this._controls = { };
|
||||
arguments.callee.dealWithDeprecatedOptions(options); // DEPRECATION LAYER!!!
|
||||
Object.extend(this.options, options || { });
|
||||
if (!this.options.formId && this.element.id) {
|
||||
this.options.formId = this.element.id + '-inplaceeditor';
|
||||
if ($(this.options.formId))
|
||||
this.options.formId = '';
|
||||
}
|
||||
if (this.options.externalControl)
|
||||
this.options.externalControl = $(this.options.externalControl);
|
||||
if (!this.options.externalControl)
|
||||
this.options.externalControlOnly = false;
|
||||
this._originalBackground = this.element.getStyle('background-color') || 'transparent';
|
||||
this.element.title = this.options.clickToEditText;
|
||||
this._boundCancelHandler = this.handleFormCancellation.bind(this);
|
||||
this._boundComplete = (this.options.onComplete || Prototype.emptyFunction).bind(this);
|
||||
this._boundFailureHandler = this.handleAJAXFailure.bind(this);
|
||||
this._boundSubmitHandler = this.handleFormSubmission.bind(this);
|
||||
this._boundWrapperHandler = this.wrapUp.bind(this);
|
||||
this.registerListeners();
|
||||
},
|
||||
checkForEscapeOrReturn: function(e) {
|
||||
if (!this._editing || e.ctrlKey || e.altKey || e.shiftKey) return;
|
||||
if (Event.KEY_ESC == e.keyCode)
|
||||
this.handleFormCancellation(e);
|
||||
else if (Event.KEY_RETURN == e.keyCode)
|
||||
this.handleFormSubmission(e);
|
||||
},
|
||||
createControl: function(mode, handler, extraClasses) {
|
||||
var control = this.options[mode + 'Control'];
|
||||
var text = this.options[mode + 'Text'];
|
||||
if ('button' == control) {
|
||||
var btn = document.createElement('input');
|
||||
btn.type = 'submit';
|
||||
btn.value = text;
|
||||
btn.className = 'editor_' + mode + '_button';
|
||||
if ('cancel' == mode)
|
||||
btn.onclick = this._boundCancelHandler;
|
||||
this._form.appendChild(btn);
|
||||
this._controls[mode] = btn;
|
||||
} else if ('link' == control) {
|
||||
var link = document.createElement('a');
|
||||
link.href = '#';
|
||||
link.appendChild(document.createTextNode(text));
|
||||
link.onclick = 'cancel' == mode ? this._boundCancelHandler : this._boundSubmitHandler;
|
||||
link.className = 'editor_' + mode + '_link';
|
||||
if (extraClasses)
|
||||
link.className += ' ' + extraClasses;
|
||||
this._form.appendChild(link);
|
||||
this._controls[mode] = link;
|
||||
}
|
||||
},
|
||||
createEditField: function() {
|
||||
var text = (this.options.loadTextURL ? this.options.loadingText : this.getText());
|
||||
var fld;
|
||||
if (1 >= this.options.rows && !/\r|\n/.test(this.getText())) {
|
||||
fld = document.createElement('input');
|
||||
fld.type = 'text';
|
||||
var size = this.options.size || this.options.cols || 0;
|
||||
if (0 < size) fld.size = size;
|
||||
} else {
|
||||
fld = document.createElement('textarea');
|
||||
fld.rows = (1 >= this.options.rows ? this.options.autoRows : this.options.rows);
|
||||
fld.cols = this.options.cols || 40;
|
||||
}
|
||||
fld.name = this.options.paramName;
|
||||
fld.value = text; // No HTML breaks conversion anymore
|
||||
fld.className = 'editor_field';
|
||||
if (this.options.submitOnBlur)
|
||||
fld.onblur = this._boundSubmitHandler;
|
||||
this._controls.editor = fld;
|
||||
if (this.options.loadTextURL)
|
||||
this.loadExternalText();
|
||||
this._form.appendChild(this._controls.editor);
|
||||
},
|
||||
createForm: function() {
|
||||
var ipe = this;
|
||||
function addText(mode, condition) {
|
||||
var text = ipe.options['text' + mode + 'Controls'];
|
||||
if (!text || condition === false) return;
|
||||
ipe._form.appendChild(document.createTextNode(text));
|
||||
};
|
||||
this._form = $(document.createElement('form'));
|
||||
this._form.id = this.options.formId;
|
||||
this._form.addClassName(this.options.formClassName);
|
||||
this._form.onsubmit = this._boundSubmitHandler;
|
||||
this.createEditField();
|
||||
if ('textarea' == this._controls.editor.tagName.toLowerCase())
|
||||
this._form.appendChild(document.createElement('br'));
|
||||
if (this.options.onFormCustomization)
|
||||
this.options.onFormCustomization(this, this._form);
|
||||
addText('Before', this.options.okControl || this.options.cancelControl);
|
||||
this.createControl('ok', this._boundSubmitHandler);
|
||||
addText('Between', this.options.okControl && this.options.cancelControl);
|
||||
this.createControl('cancel', this._boundCancelHandler, 'editor_cancel');
|
||||
addText('After', this.options.okControl || this.options.cancelControl);
|
||||
},
|
||||
destroy: function() {
|
||||
if (this._oldInnerHTML)
|
||||
this.element.innerHTML = this._oldInnerHTML;
|
||||
this.leaveEditMode();
|
||||
this.unregisterListeners();
|
||||
},
|
||||
enterEditMode: function(e) {
|
||||
if (this._saving || this._editing) return;
|
||||
this._editing = true;
|
||||
this.triggerCallback('onEnterEditMode');
|
||||
if (this.options.externalControl)
|
||||
this.options.externalControl.hide();
|
||||
this.element.hide();
|
||||
this.createForm();
|
||||
this.element.parentNode.insertBefore(this._form, this.element);
|
||||
if (!this.options.loadTextURL)
|
||||
this.postProcessEditField();
|
||||
if (e) Event.stop(e);
|
||||
},
|
||||
enterHover: function(e) {
|
||||
if (this.options.hoverClassName)
|
||||
this.element.addClassName(this.options.hoverClassName);
|
||||
if (this._saving) return;
|
||||
this.triggerCallback('onEnterHover');
|
||||
},
|
||||
getText: function() {
|
||||
return this.element.innerHTML;
|
||||
},
|
||||
handleAJAXFailure: function(transport) {
|
||||
this.triggerCallback('onFailure', transport);
|
||||
if (this._oldInnerHTML) {
|
||||
this.element.innerHTML = this._oldInnerHTML;
|
||||
this._oldInnerHTML = null;
|
||||
}
|
||||
},
|
||||
handleFormCancellation: function(e) {
|
||||
this.wrapUp();
|
||||
if (e) Event.stop(e);
|
||||
},
|
||||
handleFormSubmission: function(e) {
|
||||
var form = this._form;
|
||||
var value = $F(this._controls.editor);
|
||||
this.prepareSubmission();
|
||||
var params = this.options.callback(form, value) || '';
|
||||
if (Object.isString(params))
|
||||
params = params.toQueryParams();
|
||||
params.editorId = this.element.id;
|
||||
if (this.options.htmlResponse) {
|
||||
var options = Object.extend({ evalScripts: true }, this.options.ajaxOptions);
|
||||
Object.extend(options, {
|
||||
parameters: params,
|
||||
onComplete: this._boundWrapperHandler,
|
||||
onFailure: this._boundFailureHandler
|
||||
});
|
||||
new Ajax.Updater({ success: this.element }, this.url, options);
|
||||
} else {
|
||||
var options = Object.extend({ method: 'get' }, this.options.ajaxOptions);
|
||||
Object.extend(options, {
|
||||
parameters: params,
|
||||
onComplete: this._boundWrapperHandler,
|
||||
onFailure: this._boundFailureHandler
|
||||
});
|
||||
new Ajax.Request(this.url, options);
|
||||
}
|
||||
if (e) Event.stop(e);
|
||||
},
|
||||
leaveEditMode: function() {
|
||||
this.element.removeClassName(this.options.savingClassName);
|
||||
this.removeForm();
|
||||
this.leaveHover();
|
||||
this.element.style.backgroundColor = this._originalBackground;
|
||||
this.element.show();
|
||||
if (this.options.externalControl)
|
||||
this.options.externalControl.show();
|
||||
this._saving = false;
|
||||
this._editing = false;
|
||||
this._oldInnerHTML = null;
|
||||
this.triggerCallback('onLeaveEditMode');
|
||||
},
|
||||
leaveHover: function(e) {
|
||||
if (this.options.hoverClassName)
|
||||
this.element.removeClassName(this.options.hoverClassName);
|
||||
if (this._saving) return;
|
||||
this.triggerCallback('onLeaveHover');
|
||||
},
|
||||
loadExternalText: function() {
|
||||
this._form.addClassName(this.options.loadingClassName);
|
||||
this._controls.editor.disabled = true;
|
||||
var options = Object.extend({ method: 'get' }, this.options.ajaxOptions);
|
||||
Object.extend(options, {
|
||||
parameters: 'editorId=' + encodeURIComponent(this.element.id),
|
||||
onComplete: Prototype.emptyFunction,
|
||||
onSuccess: function(transport) {
|
||||
this._form.removeClassName(this.options.loadingClassName);
|
||||
var text = transport.responseText;
|
||||
if (this.options.stripLoadedTextTags)
|
||||
text = text.stripTags();
|
||||
this._controls.editor.value = text;
|
||||
this._controls.editor.disabled = false;
|
||||
this.postProcessEditField();
|
||||
}.bind(this),
|
||||
onFailure: this._boundFailureHandler
|
||||
});
|
||||
new Ajax.Request(this.options.loadTextURL, options);
|
||||
},
|
||||
postProcessEditField: function() {
|
||||
var fpc = this.options.fieldPostCreation;
|
||||
if (fpc)
|
||||
$(this._controls.editor)['focus' == fpc ? 'focus' : 'activate']();
|
||||
},
|
||||
prepareOptions: function() {
|
||||
this.options = Object.clone(Ajax.InPlaceEditor.DefaultOptions);
|
||||
Object.extend(this.options, Ajax.InPlaceEditor.DefaultCallbacks);
|
||||
[this._extraDefaultOptions].flatten().compact().each(function(defs) {
|
||||
Object.extend(this.options, defs);
|
||||
}.bind(this));
|
||||
},
|
||||
prepareSubmission: function() {
|
||||
this._saving = true;
|
||||
this.removeForm();
|
||||
this.leaveHover();
|
||||
this.showSaving();
|
||||
},
|
||||
registerListeners: function() {
|
||||
this._listeners = { };
|
||||
var listener;
|
||||
$H(Ajax.InPlaceEditor.Listeners).each(function(pair) {
|
||||
listener = this[pair.value].bind(this);
|
||||
this._listeners[pair.key] = listener;
|
||||
if (!this.options.externalControlOnly)
|
||||
this.element.observe(pair.key, listener);
|
||||
if (this.options.externalControl)
|
||||
this.options.externalControl.observe(pair.key, listener);
|
||||
}.bind(this));
|
||||
},
|
||||
removeForm: function() {
|
||||
if (!this._form) return;
|
||||
this._form.remove();
|
||||
this._form = null;
|
||||
this._controls = { };
|
||||
},
|
||||
showSaving: function() {
|
||||
this._oldInnerHTML = this.element.innerHTML;
|
||||
this.element.innerHTML = this.options.savingText;
|
||||
this.element.addClassName(this.options.savingClassName);
|
||||
this.element.style.backgroundColor = this._originalBackground;
|
||||
this.element.show();
|
||||
},
|
||||
triggerCallback: function(cbName, arg) {
|
||||
if ('function' == typeof this.options[cbName]) {
|
||||
this.options[cbName](this, arg);
|
||||
}
|
||||
},
|
||||
unregisterListeners: function() {
|
||||
$H(this._listeners).each(function(pair) {
|
||||
if (!this.options.externalControlOnly)
|
||||
this.element.stopObserving(pair.key, pair.value);
|
||||
if (this.options.externalControl)
|
||||
this.options.externalControl.stopObserving(pair.key, pair.value);
|
||||
}.bind(this));
|
||||
},
|
||||
wrapUp: function(transport) {
|
||||
this.leaveEditMode();
|
||||
// Can't use triggerCallback due to backward compatibility: requires
|
||||
// binding + direct element
|
||||
this._boundComplete(transport, this.element);
|
||||
}
|
||||
});
|
||||
|
||||
Object.extend(Ajax.InPlaceEditor.prototype, {
|
||||
dispose: Ajax.InPlaceEditor.prototype.destroy
|
||||
});
|
||||
|
||||
Ajax.InPlaceCollectionEditor = Class.create(Ajax.InPlaceEditor, {
|
||||
initialize: function($super, element, url, options) {
|
||||
this._extraDefaultOptions = Ajax.InPlaceCollectionEditor.DefaultOptions;
|
||||
$super(element, url, options);
|
||||
},
|
||||
|
||||
createEditField: function() {
|
||||
var list = document.createElement('select');
|
||||
list.name = this.options.paramName;
|
||||
list.size = 1;
|
||||
this._controls.editor = list;
|
||||
this._collection = this.options.collection || [];
|
||||
if (this.options.loadCollectionURL)
|
||||
this.loadCollection();
|
||||
else
|
||||
this.checkForExternalText();
|
||||
this._form.appendChild(this._controls.editor);
|
||||
},
|
||||
|
||||
loadCollection: function() {
|
||||
this._form.addClassName(this.options.loadingClassName);
|
||||
this.showLoadingText(this.options.loadingCollectionText);
|
||||
var options = Object.extend({ method: 'get' }, this.options.ajaxOptions);
|
||||
Object.extend(options, {
|
||||
parameters: 'editorId=' + encodeURIComponent(this.element.id),
|
||||
onComplete: Prototype.emptyFunction,
|
||||
onSuccess: function(transport) {
|
||||
var js = transport.responseText.strip();
|
||||
if (!/^\[.*\]$/.test(js)) // TODO: improve sanity check
|
||||
throw 'Server returned an invalid collection representation.';
|
||||
this._collection = eval(js);
|
||||
this.checkForExternalText();
|
||||
}.bind(this),
|
||||
onFailure: this.onFailure
|
||||
});
|
||||
new Ajax.Request(this.options.loadCollectionURL, options);
|
||||
},
|
||||
|
||||
showLoadingText: function(text) {
|
||||
this._controls.editor.disabled = true;
|
||||
var tempOption = this._controls.editor.firstChild;
|
||||
if (!tempOption) {
|
||||
tempOption = document.createElement('option');
|
||||
tempOption.value = '';
|
||||
this._controls.editor.appendChild(tempOption);
|
||||
tempOption.selected = true;
|
||||
}
|
||||
tempOption.update((text || '').stripScripts().stripTags());
|
||||
},
|
||||
|
||||
checkForExternalText: function() {
|
||||
this._text = this.getText();
|
||||
if (this.options.loadTextURL)
|
||||
this.loadExternalText();
|
||||
else
|
||||
this.buildOptionList();
|
||||
},
|
||||
|
||||
loadExternalText: function() {
|
||||
this.showLoadingText(this.options.loadingText);
|
||||
var options = Object.extend({ method: 'get' }, this.options.ajaxOptions);
|
||||
Object.extend(options, {
|
||||
parameters: 'editorId=' + encodeURIComponent(this.element.id),
|
||||
onComplete: Prototype.emptyFunction,
|
||||
onSuccess: function(transport) {
|
||||
this._text = transport.responseText.strip();
|
||||
this.buildOptionList();
|
||||
}.bind(this),
|
||||
onFailure: this.onFailure
|
||||
});
|
||||
new Ajax.Request(this.options.loadTextURL, options);
|
||||
},
|
||||
|
||||
buildOptionList: function() {
|
||||
this._form.removeClassName(this.options.loadingClassName);
|
||||
this._collection = this._collection.map(function(entry) {
|
||||
return 2 === entry.length ? entry : [entry, entry].flatten();
|
||||
});
|
||||
var marker = ('value' in this.options) ? this.options.value : this._text;
|
||||
var textFound = this._collection.any(function(entry) {
|
||||
return entry[0] == marker;
|
||||
}.bind(this));
|
||||
this._controls.editor.update('');
|
||||
var option;
|
||||
this._collection.each(function(entry, index) {
|
||||
option = document.createElement('option');
|
||||
option.value = entry[0];
|
||||
option.selected = textFound ? entry[0] == marker : 0 == index;
|
||||
option.appendChild(document.createTextNode(entry[1]));
|
||||
this._controls.editor.appendChild(option);
|
||||
}.bind(this));
|
||||
this._controls.editor.disabled = false;
|
||||
Field.scrollFreeActivate(this._controls.editor);
|
||||
}
|
||||
});
|
||||
|
||||
//**** DEPRECATION LAYER FOR InPlace[Collection]Editor! ****
|
||||
//**** This only exists for a while, in order to let ****
|
||||
//**** users adapt to the new API. Read up on the new ****
|
||||
//**** API and convert your code to it ASAP! ****
|
||||
|
||||
Ajax.InPlaceEditor.prototype.initialize.dealWithDeprecatedOptions = function(options) {
|
||||
if (!options) return;
|
||||
function fallback(name, expr) {
|
||||
if (name in options || expr === undefined) return;
|
||||
options[name] = expr;
|
||||
};
|
||||
fallback('cancelControl', (options.cancelLink ? 'link' : (options.cancelButton ? 'button' :
|
||||
options.cancelLink == options.cancelButton == false ? false : undefined)));
|
||||
fallback('okControl', (options.okLink ? 'link' : (options.okButton ? 'button' :
|
||||
options.okLink == options.okButton == false ? false : undefined)));
|
||||
fallback('highlightColor', options.highlightcolor);
|
||||
fallback('highlightEndColor', options.highlightendcolor);
|
||||
};
|
||||
|
||||
Object.extend(Ajax.InPlaceEditor, {
|
||||
DefaultOptions: {
|
||||
ajaxOptions: { },
|
||||
autoRows: 3, // Use when multi-line w/ rows == 1
|
||||
cancelControl: 'link', // 'link'|'button'|false
|
||||
cancelText: 'cancel',
|
||||
clickToEditText: 'Click to edit',
|
||||
externalControl: null, // id|elt
|
||||
externalControlOnly: false,
|
||||
fieldPostCreation: 'activate', // 'activate'|'focus'|false
|
||||
formClassName: 'inplaceeditor-form',
|
||||
formId: null, // id|elt
|
||||
highlightColor: '#ffff99',
|
||||
highlightEndColor: '#ffffff',
|
||||
hoverClassName: '',
|
||||
htmlResponse: true,
|
||||
loadingClassName: 'inplaceeditor-loading',
|
||||
loadingText: 'Loading...',
|
||||
okControl: 'button', // 'link'|'button'|false
|
||||
okText: 'ok',
|
||||
paramName: 'value',
|
||||
rows: 1, // If 1 and multi-line, uses autoRows
|
||||
savingClassName: 'inplaceeditor-saving',
|
||||
savingText: 'Saving...',
|
||||
size: 0,
|
||||
stripLoadedTextTags: false,
|
||||
submitOnBlur: false,
|
||||
textAfterControls: '',
|
||||
textBeforeControls: '',
|
||||
textBetweenControls: ''
|
||||
},
|
||||
DefaultCallbacks: {
|
||||
callback: function(form) {
|
||||
return Form.serialize(form);
|
||||
},
|
||||
onComplete: function(transport, element) {
|
||||
// For backward compatibility, this one is bound to the IPE, and passes
|
||||
// the element directly. It was too often customized, so we don't break it.
|
||||
new Effect.Highlight(element, {
|
||||
startcolor: this.options.highlightColor, keepBackgroundImage: true });
|
||||
},
|
||||
onEnterEditMode: null,
|
||||
onEnterHover: function(ipe) {
|
||||
ipe.element.style.backgroundColor = ipe.options.highlightColor;
|
||||
if (ipe._effect)
|
||||
ipe._effect.cancel();
|
||||
},
|
||||
onFailure: function(transport, ipe) {
|
||||
alert('Error communication with the server: ' + transport.responseText.stripTags());
|
||||
},
|
||||
onFormCustomization: null, // Takes the IPE and its generated form, after editor, before controls.
|
||||
onLeaveEditMode: null,
|
||||
onLeaveHover: function(ipe) {
|
||||
ipe._effect = new Effect.Highlight(ipe.element, {
|
||||
startcolor: ipe.options.highlightColor, endcolor: ipe.options.highlightEndColor,
|
||||
restorecolor: ipe._originalBackground, keepBackgroundImage: true
|
||||
});
|
||||
}
|
||||
},
|
||||
Listeners: {
|
||||
click: 'enterEditMode',
|
||||
keydown: 'checkForEscapeOrReturn',
|
||||
mouseover: 'enterHover',
|
||||
mouseout: 'leaveHover'
|
||||
}
|
||||
});
|
||||
|
||||
Ajax.InPlaceCollectionEditor.DefaultOptions = {
|
||||
loadingCollectionText: 'Loading options...'
|
||||
};
|
||||
|
||||
// Delayed observer, like Form.Element.Observer,
|
||||
// but waits for delay after last key input
|
||||
// Ideal for live-search fields
|
||||
|
||||
Form.Element.DelayedObserver = Class.create({
|
||||
initialize: function(element, delay, callback) {
|
||||
this.delay = delay || 0.5;
|
||||
this.element = $(element);
|
||||
this.callback = callback;
|
||||
this.timer = null;
|
||||
this.lastValue = $F(this.element);
|
||||
Event.observe(this.element,'keyup',this.delayedListener.bindAsEventListener(this));
|
||||
},
|
||||
delayedListener: function(event) {
|
||||
if(this.lastValue == $F(this.element)) return;
|
||||
if(this.timer) clearTimeout(this.timer);
|
||||
this.timer = setTimeout(this.onTimerEvent.bind(this), this.delay * 1000);
|
||||
this.lastValue = $F(this.element);
|
||||
},
|
||||
onTimerEvent: function() {
|
||||
this.timer = null;
|
||||
this.callback(this.element, $F(this.element));
|
||||
}
|
||||
});
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,402 @@
|
|||
/*
|
||||
* API STYLES
|
||||
*/
|
||||
|
||||
|
||||
/* tag styles */
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
code {
|
||||
font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", monospace;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
|
||||
/* masthead */
|
||||
div#masthead {
|
||||
background: url(../images/header-stripe-small.png) repeat-x top left;
|
||||
height: 76px;
|
||||
}
|
||||
|
||||
div#masthead div#masthead_content {
|
||||
margin: 0 auto;
|
||||
width: 835px;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
div#masthead h1#logo {
|
||||
background: url(../images/header-logo-small.png) no-repeat 0 1px;
|
||||
width: 118px;
|
||||
height: 76px;
|
||||
position: relative;
|
||||
left: 60px;
|
||||
}
|
||||
|
||||
/* footer */
|
||||
div#footer {
|
||||
width: 960px;
|
||||
margin: 0 auto;
|
||||
}
|
||||
|
||||
div.about {
|
||||
margin-top: 20px;
|
||||
padding-top: 20px;
|
||||
width: 835px;
|
||||
margin-left: 120px;
|
||||
border-top: 1px solid #aaa;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
div.about a,
|
||||
div.about a:link {
|
||||
color: #aaa;
|
||||
text-decoration: underline;
|
||||
border: 0;
|
||||
}
|
||||
|
||||
|
||||
.page-title span.type {
|
||||
display: block;
|
||||
text-transform: uppercase;
|
||||
font-size: 14px;
|
||||
color: #aaa;
|
||||
letter-spacing: 0;
|
||||
}
|
||||
|
||||
h2.page-title {
|
||||
margin-top: 0;
|
||||
line-height: 100%;
|
||||
}
|
||||
|
||||
ul.breadcrumbs {
|
||||
margin-left: 120px;
|
||||
}
|
||||
|
||||
ul.breadcrumbs li {
|
||||
float: left;
|
||||
list-style-type: none;
|
||||
margin-right: 10px;
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
|
||||
|
||||
ul.method-list {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ul.method-list li {
|
||||
margin-top: 0;
|
||||
float: left;
|
||||
margin-right: 5px;
|
||||
margin-left: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
ul.method-list li a,
|
||||
ul.method-list li a:link {
|
||||
text-decoration: none;
|
||||
border: 0;
|
||||
}
|
||||
|
||||
ul.method-details-list {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ul.method-details-list li.method-description {
|
||||
margin-top: 0;
|
||||
margin-bottom: 3.0em;
|
||||
margin-left: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
ul.method-details-list li h4 {
|
||||
margin: 0 0 0.6em;
|
||||
line-height: 90%;
|
||||
}
|
||||
|
||||
ul.method-details-list li pre {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ul.method-details-list li pre code {
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
ul.method-details-list li code {
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
ul.argument-list {
|
||||
margin-top: -5px;
|
||||
list-style-type: disc;
|
||||
margin-left: 20px;
|
||||
}
|
||||
|
||||
ul.argument-list li {
|
||||
list-style-type: disc;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
ul.argument-list li code {
|
||||
font-size: 11px;
|
||||
}
|
||||
|
||||
ul.section-list {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ul.section-list li {
|
||||
margin-top: 0;
|
||||
margin-left: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
ul.section-list li h4 {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
|
||||
/* Aliases */
|
||||
|
||||
.alias,
|
||||
.related-to {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.alias code,
|
||||
.related-to code {
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* Section icons */
|
||||
|
||||
.page-content .section .section-title h3 {
|
||||
padding-right: 24px;
|
||||
background-position: right 0;
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
.section-constructor .section-title h3 {
|
||||
background-image: url(../images/constructor.png);
|
||||
}
|
||||
|
||||
.section-method-list .section-title h3,
|
||||
.section-klass_methods .section-title h3,
|
||||
.section-instance_methods .section-title h3 {
|
||||
background-image: url(../images/method.png);
|
||||
}
|
||||
|
||||
.section-mixins .section-title h3 {
|
||||
background-image: url(../images/mixin.png);
|
||||
}
|
||||
|
||||
.section-classes .section-title h3 {
|
||||
background-image: url(../images/class.png);
|
||||
}
|
||||
|
||||
.section-namespaces .section-title h3 {
|
||||
background-image: url(../images/namespace.png);
|
||||
}
|
||||
|
||||
.section-sections .section-title h3 {
|
||||
background-image: url(../images/section.png);
|
||||
}
|
||||
|
||||
.section-utilities .section-title h3 {
|
||||
background-image: url(../images/utility.png);
|
||||
}
|
||||
|
||||
.section-description .section-title h3 {
|
||||
background-image: url(../images/description.png);
|
||||
}
|
||||
|
||||
/* search box */
|
||||
|
||||
.search-results {
|
||||
position: absolute;
|
||||
background-color: #fff;
|
||||
height: 200px;
|
||||
width: 233px;
|
||||
overflow: auto;
|
||||
overflow-y: scroll;
|
||||
margin: 7px -11px 0;
|
||||
border: 1px solid #999;
|
||||
}
|
||||
|
||||
|
||||
/* search result types */
|
||||
|
||||
.menu-item a,
|
||||
.menu-item a:link {
|
||||
display: block;
|
||||
padding: 3px 10px 3px 28px;
|
||||
background-position: 6px 50%;
|
||||
background-repeat: no-repeat;
|
||||
text-align: left;
|
||||
text-decoration: none;
|
||||
color: #333;
|
||||
border-top: 1px solid transparent;
|
||||
border-bottom: 1px solid transparent;
|
||||
|
||||
}
|
||||
|
||||
.menu-item a:hover,
|
||||
.menu-item.highlighted a {
|
||||
border-top: 1px solid #69f;
|
||||
border-bottom: 1px solid #69f;
|
||||
background-color: #f0f0ff;
|
||||
}
|
||||
|
||||
|
||||
.menu-item a.section {
|
||||
font-weight: bold;
|
||||
background-image: url(../images/section.png);
|
||||
}
|
||||
|
||||
.menu-item a.class_method,
|
||||
.menu-item a.instance_method {
|
||||
background-image: url(../images/method.png);
|
||||
}
|
||||
|
||||
.menu-item a.class {
|
||||
background-image: url(../images/class.png);
|
||||
}
|
||||
|
||||
.menu-item a.constructor {
|
||||
background-image: url(../images/constructor.png);
|
||||
}
|
||||
|
||||
.menu-item a.class_property,
|
||||
.menu-item a.instance_property {
|
||||
background-image: url(../images/property.png);
|
||||
}
|
||||
|
||||
.menu-item a.namespace {
|
||||
background-image: url(../images/namespace.png);
|
||||
}
|
||||
|
||||
.menu-item a.utility {
|
||||
background-image: url(../images/utility.png);
|
||||
}
|
||||
|
||||
|
||||
/* halo around selected method */
|
||||
|
||||
.highlighter {
|
||||
border: 3px solid #69f;
|
||||
z-index: -1;
|
||||
}
|
||||
|
||||
/* MENU */
|
||||
|
||||
div#menu {
|
||||
width: 960px;
|
||||
margin: 0 auto;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
#menu .api-box h2 a,
|
||||
#menu .search-box {
|
||||
width: 213px;
|
||||
height: 25px;
|
||||
line-height: 25px;
|
||||
padding: 5px 10px;
|
||||
margin-right: 5px;
|
||||
text-align: center;
|
||||
float: right;
|
||||
}
|
||||
|
||||
#menu .api-box {
|
||||
}
|
||||
|
||||
#menu .api-box h2 a {
|
||||
font-size: 14px;
|
||||
font-weight: normal;
|
||||
font-family: Verdana, sans-serif;
|
||||
display: block;
|
||||
background-color: #cde0fb;
|
||||
border: 1px solid #669;
|
||||
border-top: 0;
|
||||
text-decoration: none;
|
||||
color: #222;
|
||||
}
|
||||
|
||||
#menu .api-box .menu-items {
|
||||
position: absolute;
|
||||
background-color: #fff;
|
||||
height: 200px;
|
||||
width: 233px;
|
||||
overflow: auto;
|
||||
overflow-y: scroll;
|
||||
top: 35px;
|
||||
border: 1px solid #999;
|
||||
right: 5px;
|
||||
}
|
||||
|
||||
#menu .api-box ul,
|
||||
#menu .api-box li {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
#menu .api-box .menu-item a {
|
||||
}
|
||||
|
||||
#menu .search-box {
|
||||
background-color: #cee8c3;
|
||||
border: 1px solid #696;
|
||||
border-top: 0;
|
||||
}
|
||||
|
||||
#menu .search-box input {
|
||||
width: 150px;
|
||||
padding: 3px 6px;
|
||||
margin-top: 2px;
|
||||
border: 1px solid #999;
|
||||
border-radius: 10px;
|
||||
-webkit-border-radius: 10px;
|
||||
-moz-border-radius: 10px;
|
||||
}
|
||||
|
||||
|
||||
/* notes */
|
||||
|
||||
p.note,
|
||||
p.alias,
|
||||
p.related-to {
|
||||
font-size: 11px;
|
||||
line-height: 14px;
|
||||
padding: 5px 5px 5px 60px;
|
||||
background-repeat: no-repeat;
|
||||
background-position: 20px 50%;
|
||||
border: 1px solid #000;
|
||||
}
|
||||
|
||||
p.note {
|
||||
background-color: #f0f0f4;
|
||||
background-image: url(../images/information.png);
|
||||
border-color: #69c;
|
||||
}
|
||||
|
||||
p.alias {
|
||||
background-color: #fff6de;
|
||||
background-image: url(../images/alias.png);
|
||||
border-color: #cc9;
|
||||
}
|
||||
|
||||
p.related-to {
|
||||
background-color: #f4f0f4;
|
||||
background-image: url(../images/related_to.png);
|
||||
border-color: #c9c;
|
||||
}
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,416 @@
|
|||
/* The "section" class implicitly needs a clearfix; adding it here for convenience. */
|
||||
|
||||
.clearfix:after,
|
||||
.section:after {
|
||||
content: ".";
|
||||
display: block;
|
||||
clear: both;
|
||||
visibility: hidden;
|
||||
line-height: 0;
|
||||
height: 0;
|
||||
}
|
||||
|
||||
.clearfix, .section {
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
html[xmlns] .clearfix,
|
||||
html[xmlns] .section {
|
||||
display: block;
|
||||
}
|
||||
|
||||
* html .clearfix,
|
||||
* html .section {
|
||||
height: 1%;
|
||||
}
|
||||
|
||||
span.replaced { visibility: hidden; }
|
||||
span.hidden { display: none; }
|
||||
|
||||
|
||||
body {
|
||||
font-family: Verdana, sans-serif;
|
||||
font-size: 82.5%;
|
||||
line-height: 1.5em;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
body * {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
|
||||
}
|
||||
|
||||
h4 {
|
||||
font-size: 15px;
|
||||
color: #444;
|
||||
margin: 0 0 0.4em;
|
||||
}
|
||||
|
||||
h5 {
|
||||
font-size: 14px;
|
||||
color: #222;
|
||||
margin: 0 0 0.4em;
|
||||
}
|
||||
|
||||
h6 {
|
||||
font-size: 13px;
|
||||
color: #000;
|
||||
margin: 0 0 0.4em;
|
||||
}
|
||||
|
||||
a img {
|
||||
border: 0;
|
||||
}
|
||||
|
||||
ul, li {
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
ol, ul {
|
||||
margin: 0 0 15px;
|
||||
}
|
||||
|
||||
#page a.img,
|
||||
#page a.img:link,
|
||||
#page a.img:visited {
|
||||
border: none;
|
||||
}
|
||||
|
||||
/* Link bar */
|
||||
|
||||
div#links {
|
||||
margin: 0 auto;
|
||||
width: 835px;
|
||||
padding: 16px 0;
|
||||
height: 16px;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
div#links_wrapper {
|
||||
background: #fff;
|
||||
}
|
||||
|
||||
div#links li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div#links li a {
|
||||
color: #666;
|
||||
}
|
||||
|
||||
div#links li.selected a {
|
||||
color: #000;
|
||||
font-weight: bold;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
ul#internal_links {
|
||||
float: left;
|
||||
}
|
||||
|
||||
ul#internal_links li {
|
||||
margin-right: 25px;
|
||||
}
|
||||
|
||||
ul#external_links {
|
||||
float: right;
|
||||
}
|
||||
|
||||
ul#external_links li {
|
||||
margin-left: 25px;
|
||||
padding-left: 21px;
|
||||
}
|
||||
|
||||
li#scripty_link {
|
||||
background: url(http://prototype.conio.net/new/images/link-logo-scripty.png) no-repeat center left;
|
||||
}
|
||||
|
||||
li#rails_link {
|
||||
background: url(http://prototype.conio.net/new/images/link-logo-rails.png) no-repeat center left;
|
||||
}
|
||||
|
||||
|
||||
|
||||
p a, p a:link,
|
||||
h1 a, h1 a:link,
|
||||
h2 a, h2 a:link,
|
||||
h3 a, h3 a:link,
|
||||
h4 a, h4 a:link,
|
||||
h5 a, h5 a:link,
|
||||
h6 a, h6 a:link {
|
||||
color: #036;
|
||||
border-bottom: 1px solid #036;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
p a:visited {
|
||||
border-bottom: 1px solid #666;
|
||||
}
|
||||
|
||||
code {
|
||||
font-family: "Panic Sans", "Bitstream Vera Sans Mono", Monaco, Consolas, Andale Mono, monospace;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
p code,
|
||||
li code {
|
||||
background-color: #f0f0f0;
|
||||
border: 1px solid #ccc;
|
||||
border-radius: 3px;
|
||||
-webkit-border-radius: 3px;
|
||||
padding: 0 3px;
|
||||
}
|
||||
|
||||
pre code {
|
||||
background-color: transparent;
|
||||
border: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
|
||||
#page {
|
||||
margin: 0 auto;
|
||||
padding-bottom: 100px; /* FIXME: Temporary as pages are built */
|
||||
}
|
||||
|
||||
|
||||
/* top */
|
||||
|
||||
.related-links {
|
||||
width: 835px;
|
||||
font-size: 0.9em;
|
||||
margin: 0 auto 10px;
|
||||
padding: 10px 0 0;
|
||||
}
|
||||
|
||||
.related-links a {
|
||||
color: #000;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.related-links ul {
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
.related-links ul.internal {
|
||||
float: left;
|
||||
width: 355px;
|
||||
}
|
||||
|
||||
.related-links ul.internal li {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.related-links ul.external {
|
||||
float: right;
|
||||
width: 295px;
|
||||
}
|
||||
|
||||
.related-links li {
|
||||
float: left;
|
||||
padding: 0 15px;
|
||||
width: 85px;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
.related-links li.last {
|
||||
margin-right: 0;
|
||||
}
|
||||
|
||||
.related-links ul.external li.scripty {
|
||||
padding: 0 8px 0 22px;
|
||||
background: url(../images/icon-scripty.png) no-repeat;
|
||||
margin-right: 65px;
|
||||
}
|
||||
|
||||
.related-links ul.external li.rails {
|
||||
padding: 0 8px 0 22px;
|
||||
background: url(../images/icon-rails.png) no-repeat;
|
||||
}
|
||||
|
||||
|
||||
.banner {
|
||||
height: 152px;
|
||||
padding: 1px 0;
|
||||
background: url(../images/header-stripe.png) repeat-x;
|
||||
}
|
||||
|
||||
.banner-content {
|
||||
width: 835px;
|
||||
margin: 0 auto;
|
||||
}
|
||||
|
||||
.banner h1 {
|
||||
width: 236px;
|
||||
height: 150px;
|
||||
background: url(../images/header-logo.png) no-repeat;
|
||||
}
|
||||
|
||||
.banner h1 span {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.banner-small {
|
||||
height: 75px;
|
||||
padding: 1px 0;
|
||||
background: url(../images/header-stripe-small.png) repeat-x;
|
||||
}
|
||||
|
||||
.banner-small h1 {
|
||||
width: 118px;
|
||||
height: 75px;
|
||||
background: url(../images/header-logo-small.png) no-repeat;
|
||||
margin-left: 60px;
|
||||
}
|
||||
|
||||
.banner-small h1 span {
|
||||
display: none;
|
||||
}
|
||||
|
||||
|
||||
/* PAGE CONTENT */
|
||||
|
||||
.page-content {
|
||||
width: 955px;
|
||||
margin: 30px auto 0;
|
||||
}
|
||||
|
||||
.page-content .page-title {
|
||||
margin-left: 120px;
|
||||
margin-bottom: 15px;
|
||||
font-size: 27px;
|
||||
letter-spacing: -1px;
|
||||
color: #444;
|
||||
}
|
||||
|
||||
.page-content .page-introduction {
|
||||
margin-left: 120px;
|
||||
font-size: 15px;
|
||||
margin-bottom: 25px;
|
||||
}
|
||||
|
||||
.page-content .page-introduction p {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
|
||||
.page-content .section {
|
||||
width: 955px;
|
||||
margin: 10px 0 20px;
|
||||
}
|
||||
|
||||
.page-content .section .section-title {
|
||||
width: 110px;
|
||||
margin-right: 10px;
|
||||
padding-right: 0;
|
||||
float: left;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
.page-content .section .section-title h3 {
|
||||
color: #999;
|
||||
font-size: 14px;
|
||||
line-height: 110%;
|
||||
padding-right: 10px;
|
||||
padding-bottom: 5px;
|
||||
}
|
||||
|
||||
.page-content .section .section-content {
|
||||
width: 835px;
|
||||
float: left;
|
||||
}
|
||||
|
||||
.page-content a,
|
||||
.page-content a:link {
|
||||
color: #036;
|
||||
border-bottom: 1px solid #036;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.page-content a:visited {
|
||||
border-bottom: 1px solid #bbb;
|
||||
}
|
||||
|
||||
.page-content ul,
|
||||
.page-content ol {
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
.page-content li {
|
||||
margin: 5px 0 8px 20px;
|
||||
list-style-type: disc;
|
||||
}
|
||||
|
||||
.page-content p {
|
||||
margin: 0 0 0.8em;
|
||||
}
|
||||
|
||||
.page-content pre {
|
||||
color: #333;
|
||||
background-color: #f0f0ff;
|
||||
border: 1px solid #dde;
|
||||
padding: 3px 5px;
|
||||
margin: 0 0 1em;
|
||||
}
|
||||
|
||||
.page-content .two-column {
|
||||
|
||||
}
|
||||
|
||||
.page-content .two-column-left,
|
||||
.page-content .two-column-right {
|
||||
width: 475px;
|
||||
margin-right: 5px;
|
||||
float: left;
|
||||
}
|
||||
|
||||
.page-content .two-column-right {
|
||||
margin-right: 0;
|
||||
}
|
||||
|
||||
.page-content .two-column .section {
|
||||
width: 475px;
|
||||
}
|
||||
|
||||
.page-content .two-column .section-content {
|
||||
width: 345px;
|
||||
padding-right: 10px;
|
||||
}
|
||||
|
||||
|
||||
|
||||
.smallcaps {
|
||||
font-size: 0.85em;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 1px;
|
||||
}
|
||||
|
||||
|
||||
/* MASTHEAD */
|
||||
|
||||
div#masthead {
|
||||
margin-top: 50px;
|
||||
background: url(../images/header-stripe-small.png) repeat-x top left;
|
||||
height: 76px;
|
||||
}
|
||||
|
||||
div#masthead div#masthead_content {
|
||||
margin: 0 auto;
|
||||
width: 835px;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
div#masthead h1#logo {
|
||||
background: url(../images/header-logo-small.png) no-repeat 0 1px;
|
||||
width: 118px;
|
||||
height: 76px;
|
||||
position: relative;
|
||||
left: 60px;
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
body.grid {
|
||||
width: 955px;
|
||||
margin: auto;
|
||||
}
|
||||
|
||||
body.grid div#page {
|
||||
overflow: hidden;
|
||||
background: url(../images/grid.png);
|
||||
}
|
||||
|
||||
body.grid div#page * {
|
||||
opacity: .9;
|
||||
}
|
||||
|
|
@ -0,0 +1,116 @@
|
|||
/* See license.txt for terms of usage */
|
||||
|
||||
.firebugHighlight {
|
||||
z-index: 2147483647;
|
||||
position: absolute;
|
||||
background-color: #3875d7;
|
||||
}
|
||||
|
||||
.firebugLayoutBoxParent {
|
||||
z-index: 2147483647;
|
||||
position: absolute;
|
||||
border-right: 1px dashed #BBBBBB;
|
||||
border-bottom: 1px dashed #BBBBBB;
|
||||
}
|
||||
|
||||
.firebugRulerH {
|
||||
position: absolute;
|
||||
top: -15px;
|
||||
left: 0;
|
||||
width: 100%;
|
||||
height: 14px;
|
||||
background: url(chrome://firebug/skin/rulerH.png) repeat-x;
|
||||
border-top: 1px solid #BBBBBB;
|
||||
border-right: 1px dashed #BBBBBB;
|
||||
border-bottom: 1px solid #000000;
|
||||
}
|
||||
|
||||
.firebugRulerV {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
left: -15px;
|
||||
width: 14px;
|
||||
height: 100%;
|
||||
background: url(chrome://firebug/skin/rulerV.png) repeat-y;
|
||||
border-left: 1px solid #BBBBBB;
|
||||
border-right: 1px solid #000000;
|
||||
border-bottom: 1px dashed #BBBBBB;
|
||||
}
|
||||
|
||||
.overflowRulerX > .firebugRulerV {
|
||||
left: 0;
|
||||
}
|
||||
|
||||
.overflowRulerY > .firebugRulerH {
|
||||
top: 0;
|
||||
}
|
||||
|
||||
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
.firebugLayoutBoxOffset {
|
||||
z-index: 2147483647;
|
||||
position: absolute;
|
||||
opacity: 0.8;
|
||||
}
|
||||
|
||||
.firebugLayoutBoxMargin {
|
||||
background-color: #EDFF64;
|
||||
}
|
||||
|
||||
.firebugLayoutBoxBorder {
|
||||
background-color: #666666;
|
||||
}
|
||||
|
||||
.firebugLayoutBoxPadding {
|
||||
background-color: SlateBlue;
|
||||
}
|
||||
|
||||
.firebugLayoutBoxContent {
|
||||
background-color: SkyBlue;
|
||||
}
|
||||
|
||||
/*.firebugHighlightGroup .firebugLayoutBox {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.firebugHighlightBox {
|
||||
background-color: Blue !important;
|
||||
}*/
|
||||
|
||||
.firebugLayoutLine {
|
||||
z-index: 2147483647;
|
||||
background-color: #000000;
|
||||
opacity: 0.4;
|
||||
}
|
||||
|
||||
.firebugLayoutLineLeft,
|
||||
.firebugLayoutLineRight {
|
||||
position: fixed;
|
||||
width: 1px;
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
.firebugLayoutLineTop,
|
||||
.firebugLayoutLineBottom {
|
||||
position: absolute;
|
||||
width: 100%;
|
||||
height: 1px;
|
||||
}
|
||||
|
||||
.firebugLayoutLineTop {
|
||||
margin-top: -1px;
|
||||
border-top: 1px solid #999999;
|
||||
}
|
||||
|
||||
.firebugLayoutLineRight {
|
||||
border-right: 1px solid #999999;
|
||||
}
|
||||
|
||||
.firebugLayoutLineBottom {
|
||||
border-bottom: 1px solid #999999;
|
||||
}
|
||||
|
||||
.firebugLayoutLineLeft {
|
||||
margin-left: -1px;
|
||||
border-left: 1px solid #999999;
|
||||
}
|
||||
|
|
@ -0,0 +1,443 @@
|
|||
/* @group Tags */
|
||||
|
||||
body {
|
||||
font-family: Verdana, sans-serif;
|
||||
}
|
||||
|
||||
form {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #036;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
p a {
|
||||
border-bottom: 1px solid #999;
|
||||
padding: 0 1px;
|
||||
}
|
||||
|
||||
p a:hover {
|
||||
background-color: #036;
|
||||
color: #fff;
|
||||
border-bottom: 1px solid #036;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
code {
|
||||
font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", monospace;
|
||||
font-size: 11px;
|
||||
}
|
||||
|
||||
|
||||
/* @end */
|
||||
|
||||
/* @group Masthead */
|
||||
|
||||
div#masthead {
|
||||
background: url(../images/header-stripe-small.png) repeat-x top left;
|
||||
height: 76px;
|
||||
}
|
||||
|
||||
div#masthead div#masthead_content {
|
||||
margin: 0 auto;
|
||||
width: 835px;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
div#masthead h1#logo {
|
||||
background: url(../images/header-logo-small.png) no-repeat 0 1px;
|
||||
width: 118px;
|
||||
height: 76px;
|
||||
position: relative;
|
||||
left: 60px;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* @end */
|
||||
|
||||
/* @group Main */
|
||||
|
||||
#main {
|
||||
width: 840px;
|
||||
margin: 20px auto;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
#main h2 {
|
||||
color: #444;
|
||||
font-size: 22px;
|
||||
padding-left: 69px;
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
#main h2 span {
|
||||
color: #ccc;
|
||||
display: block;
|
||||
text-transform: uppercase;
|
||||
font-size: 13px;
|
||||
margin-bottom: -10px;
|
||||
padding-left: 2px;
|
||||
}
|
||||
|
||||
#main h2 a {
|
||||
color: #444;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
#main h2 a:hover {
|
||||
color: #222;
|
||||
border-bottom: 1px solid #999;
|
||||
}
|
||||
|
||||
#main h4, h5, h6 {
|
||||
padding-left: 4px;
|
||||
}
|
||||
|
||||
#main li h4,
|
||||
#main li h5,
|
||||
#main li h6 {
|
||||
padding-left: 0;
|
||||
}
|
||||
|
||||
#main h4.inherited {
|
||||
color: #888 !important;
|
||||
}
|
||||
|
||||
|
||||
#main .section {
|
||||
overflow: hidden;
|
||||
padding-left: 65px;
|
||||
padding-bottom: 0;
|
||||
margin: 5px 0 0;
|
||||
}
|
||||
|
||||
#main .section h3 {
|
||||
position: absolute;
|
||||
left: -85px;
|
||||
width: 110px;
|
||||
text-align: right;
|
||||
font-size: 13px;
|
||||
padding-top: 3px;
|
||||
color: #999;
|
||||
line-height: 100%;
|
||||
min-height: 30px;
|
||||
}
|
||||
|
||||
#main .section h4 {
|
||||
font-size: 15px;
|
||||
color: #444;
|
||||
margin: 0 0 0.3em;
|
||||
}
|
||||
|
||||
#main .section h4.inherited {
|
||||
color: #888;
|
||||
}
|
||||
|
||||
#main .section h4.inherited a {
|
||||
color: #49B;
|
||||
}
|
||||
|
||||
#main p {
|
||||
margin: 0 0 1.1em;
|
||||
}
|
||||
|
||||
#main pre {
|
||||
background-color: #000;
|
||||
color: #fff;
|
||||
padding: 5px 10px;
|
||||
margin: 0 0 5px;
|
||||
}
|
||||
|
||||
#main pre.syntax {
|
||||
background-color: #f5f5f5;
|
||||
color: #000;
|
||||
padding: 3px 5px;
|
||||
}
|
||||
|
||||
#main .section p.purpose {
|
||||
background-color: #CDE0FB;
|
||||
padding: 3px 5px;
|
||||
}
|
||||
|
||||
#main .section p {
|
||||
padding: 0 5px;
|
||||
}
|
||||
|
||||
#main ul, #main ol {
|
||||
padding-left: 5px;
|
||||
margin: 0 0 10px;
|
||||
}
|
||||
|
||||
#main ul, #main ul li {
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
|
||||
#main #excerpt p {
|
||||
color: #000;
|
||||
border-left: 3px solid #bbb;
|
||||
padding: 0;
|
||||
margin-left: -10px;
|
||||
font-size: 94%;
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
#main .meta {
|
||||
position: absolute;
|
||||
width: 108px;
|
||||
left: -60px;
|
||||
text-align: right;
|
||||
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||
font-size: 14px;
|
||||
font-weight: bold;
|
||||
color: #888;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* @end */
|
||||
|
||||
/* @group Method List */
|
||||
|
||||
ul.method-list li {
|
||||
display: inline;
|
||||
border-top: 1px solid #ccc;
|
||||
}
|
||||
|
||||
ul.method-list li a {
|
||||
background-color: #eee;
|
||||
padding: 2px 3px;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
ul.method-list li a:hover {
|
||||
background-color: #ddd;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* @end */
|
||||
|
||||
/* @group Menu */
|
||||
|
||||
#menu {
|
||||
width: 840px;
|
||||
margin: 0 auto;
|
||||
position: relative;
|
||||
height: 25px;
|
||||
}
|
||||
|
||||
#menu div {
|
||||
width: 234px;
|
||||
float: right;
|
||||
margin: 0 3px;
|
||||
}
|
||||
|
||||
#menu div.search-box {
|
||||
width: 222px;
|
||||
background-color: #cee8c3;
|
||||
font-size: 13px;
|
||||
height: 25px;
|
||||
line-height: 25px;
|
||||
padding: 2px 6px;
|
||||
}
|
||||
|
||||
#menu div.search-box label {
|
||||
color: #555;
|
||||
}
|
||||
|
||||
#menu div.search-box input {
|
||||
border: 1px solid #bbb;
|
||||
padding: 2px;
|
||||
width: 163px;
|
||||
}
|
||||
|
||||
|
||||
#menu h2 {
|
||||
font-size: 13px;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
#menu h2 a {
|
||||
height: 25px;
|
||||
line-height: 25px;
|
||||
display: block;
|
||||
text-align: center;
|
||||
background-color: #CDE0FB;
|
||||
font-family: Verdana, sans-serif;
|
||||
padding: 2px 6px;
|
||||
}
|
||||
|
||||
#menu h2 a:hover {
|
||||
background-color: #a4c8fb;
|
||||
}
|
||||
|
||||
#menu #api_menu,
|
||||
#menu #search_results {
|
||||
border: 1px solid #ddd;
|
||||
background: #fff;
|
||||
position: absolute;
|
||||
width: 232px;
|
||||
top: 26px;
|
||||
z-index: 1500;
|
||||
max-height: 200px;
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
#menu #api_menu {
|
||||
right: 3px;
|
||||
}
|
||||
|
||||
#menu #search_results {
|
||||
right: 243px;
|
||||
}
|
||||
|
||||
|
||||
#menu .menu-items li {
|
||||
background-color: #fff;
|
||||
}
|
||||
|
||||
#menu .menu-items li a {
|
||||
display: block;
|
||||
color: #333;
|
||||
background-color: #fff;
|
||||
padding: 2px 6px;
|
||||
border-top: 1px solid #fff;
|
||||
border-bottom: 1px solid #fff;
|
||||
}
|
||||
|
||||
#menu .menu-items li a:hover,
|
||||
#menu .menu-items li.highlighted a {
|
||||
background-color: #CDE0FB;
|
||||
border-top-color: #a4c8fb;
|
||||
border-bottom-color: #a4c8fb;
|
||||
}
|
||||
|
||||
|
||||
#menu .menu-items ul {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
#menu .menu-items li a {
|
||||
background-repeat: no-repeat;
|
||||
background-position: 6px 3px;
|
||||
padding: 3px 5px 3px 30px;
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
#menu .menu-items li a.class {
|
||||
background-image: url(../images/class.png);
|
||||
}
|
||||
|
||||
#menu .menu-items li a.namespace {
|
||||
background-image: url(../images/namespace.png);
|
||||
}
|
||||
|
||||
#menu .menu-items li a.mixin {
|
||||
background-image: url(../images/mixin.png);
|
||||
}
|
||||
|
||||
#menu .menu-items li a.section {
|
||||
text-transform: uppercase;
|
||||
color: #777;
|
||||
background-image: url(../images/section.png);
|
||||
}
|
||||
|
||||
#menu .menu-items li a.class_method,
|
||||
#menu .menu-items li a.instance_method,
|
||||
#menu .menu-items li a.utility {
|
||||
background-image: url(../images/method.png);
|
||||
}
|
||||
|
||||
#menu .menu-items li a.class_property,
|
||||
#menu .menu-items li a.instance_property {
|
||||
background-image: url(../images/property.png);
|
||||
}
|
||||
|
||||
#menu .menu-items li a.constructor {
|
||||
background-image: url(../images/constructor.png);
|
||||
}
|
||||
|
||||
#menu .menu-items li a.constant {
|
||||
background-image: url(../images/constant.png);
|
||||
}
|
||||
|
||||
|
||||
/* @end */
|
||||
|
||||
/* @group Section Headings (H3s) */
|
||||
|
||||
.section h3 {
|
||||
padding-right: 25px;
|
||||
background-repeat: no-repeat;
|
||||
background-position: right 4px;
|
||||
}
|
||||
|
||||
.section-superclass h3 {
|
||||
background-image: url(../images/class.png);
|
||||
}
|
||||
|
||||
.section-method-list h3,
|
||||
.section-instance_methods h3,
|
||||
.section-klass_methods h3 {
|
||||
background-image: url(../images/method.png);
|
||||
}
|
||||
|
||||
.section-klass_properties h3,
|
||||
.section-instance_properties h3 {
|
||||
background-image: url(../images/property.png);
|
||||
}
|
||||
|
||||
.section-constructor h3 {
|
||||
background-image: url(../images/constructor.png);
|
||||
}
|
||||
|
||||
.section-constants h3 {
|
||||
background-image: url(../images/constant.png);
|
||||
}
|
||||
|
||||
.section-mixins h3 {
|
||||
background-image: url(../images/mixin.png);
|
||||
}
|
||||
|
||||
|
||||
/* @end */
|
||||
|
||||
|
||||
|
||||
/* @group Method Details List */
|
||||
|
||||
ul.method-details-list li {
|
||||
border: 2px solid #fff;
|
||||
}
|
||||
|
||||
ul.method-details-list li.highlighted {
|
||||
border: 2px solid #CDE0FB;
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
|
||||
/* floating menu */
|
||||
|
||||
#menu.fixed {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
z-index: 1000;
|
||||
left: 232px;
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,244 @@
|
|||
|
||||
|
||||
/* Masthead */
|
||||
|
||||
div#masthead {
|
||||
background: url(http://prototype.conio.net/new/images/header-stripe.png) repeat-x top left;
|
||||
height: 152px;
|
||||
}
|
||||
|
||||
div#masthead div#masthead_content {
|
||||
margin: 0 auto;
|
||||
width: 835px;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
div#masthead h1#logo {
|
||||
background: url(http://prototype.conio.net/new/images/header-logo.png) no-repeat 0 1px;
|
||||
width: 236px;
|
||||
height: 152px;
|
||||
}
|
||||
|
||||
div#masthead div#pitch {
|
||||
position: absolute;
|
||||
background: url(http://prototype.conio.net/new/images/header-copy.png) no-repeat 0 1px;
|
||||
top: 0;
|
||||
left: 300px;
|
||||
width: 535px;
|
||||
height: 152px;
|
||||
}
|
||||
|
||||
div#masthead h1#logo *,
|
||||
div#masthead div#pitch * {
|
||||
display: none;
|
||||
}
|
||||
|
||||
|
||||
/* Buttons */
|
||||
|
||||
div#buttons, div#more {
|
||||
overflow: hidden;
|
||||
width: 840px;
|
||||
margin: -1px auto 0 auto;
|
||||
padding: 0 0 0 5px;
|
||||
}
|
||||
|
||||
div#more {
|
||||
margin-top: 35px;
|
||||
}
|
||||
|
||||
div#buttons li {
|
||||
display: block;
|
||||
float: left;
|
||||
border-top: 1px solid #929fb3;
|
||||
margin: 0 5px 0 0;
|
||||
width: 175px;
|
||||
height: 100px;
|
||||
}
|
||||
|
||||
div#more li {
|
||||
height: 50px;
|
||||
}
|
||||
|
||||
div#buttons li a {
|
||||
display: block;
|
||||
position: relative;
|
||||
width: 175px;
|
||||
height: 100px;
|
||||
text-decoration: none;
|
||||
background: #cde0fb no-repeat center 30px;
|
||||
}
|
||||
|
||||
div#buttons li a:hover {
|
||||
background-color: #a4c8fb;
|
||||
}
|
||||
|
||||
div#buttons li a span.title {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div#buttons li a span.description {
|
||||
position: absolute;
|
||||
display: block;
|
||||
width: 175px;
|
||||
top: 55px;
|
||||
text-align: center;
|
||||
color: #666;
|
||||
}
|
||||
|
||||
div#more li a span.title {
|
||||
position: absolute;
|
||||
display: block;
|
||||
width: 175px;
|
||||
top: 15px;
|
||||
text-align: center;
|
||||
color: #666;
|
||||
}
|
||||
|
||||
div#buttons li a:hover span.description {
|
||||
color: #333;
|
||||
}
|
||||
|
||||
div#buttons li#download_button {
|
||||
width: 295px;
|
||||
}
|
||||
|
||||
div#buttons li#download_button a,
|
||||
div#buttons li#download_button a span.description {
|
||||
width: 295px;
|
||||
}
|
||||
|
||||
div#buttons li#download_button a {
|
||||
background-color: #cee8c3;
|
||||
background-image: url(http://prototype.conio.net/new/images/button-download.png);
|
||||
}
|
||||
|
||||
div#buttons li#download_button a:hover {
|
||||
background-color: #a4e289;
|
||||
}
|
||||
|
||||
div#buttons li#learn_button a {
|
||||
background-image: url(http://prototype.conio.net/new/images/button-learn.png);
|
||||
}
|
||||
|
||||
div#buttons li#discuss_button a {
|
||||
background-image: url(http://prototype.conio.net/new/images/button-discuss.png);
|
||||
}
|
||||
|
||||
div#buttons li#contribute_button a {
|
||||
background-image: url(http://prototype.conio.net/new/images/button-contribute.png);
|
||||
}
|
||||
|
||||
div#more {
|
||||
position: relative;
|
||||
height: 400px;
|
||||
margin: 15px 60px;
|
||||
color: #444;
|
||||
}
|
||||
|
||||
div#more .column {
|
||||
display: block;
|
||||
float: left;
|
||||
margin: 0 5px 0 0;
|
||||
padding-left: 5px;
|
||||
min-height: 300px;
|
||||
}
|
||||
|
||||
div#more h3 {
|
||||
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||
letter-spacing: -1px;
|
||||
font-weight: bold;
|
||||
color: #444;
|
||||
font-size: 18px;
|
||||
margin: 0 0 5px;
|
||||
}
|
||||
|
||||
.column {
|
||||
width: 175px;
|
||||
}
|
||||
|
||||
.wide-column {
|
||||
width: 295px;
|
||||
}
|
||||
|
||||
.medium-column {
|
||||
width: 235px;
|
||||
}
|
||||
|
||||
.main-column {
|
||||
width: 530px;
|
||||
}
|
||||
|
||||
.sidebar-column {
|
||||
width: 290px;
|
||||
}
|
||||
|
||||
div#more {
|
||||
width: 840px;
|
||||
margin: 25px auto 0;
|
||||
}
|
||||
|
||||
/*#buttons_wrapper {
|
||||
background-color: #0E4FAF;
|
||||
}
|
||||
|
||||
#page {
|
||||
background-color: #292929;
|
||||
}
|
||||
*/
|
||||
|
||||
div#more div.main-column p {
|
||||
font-size: 16px;
|
||||
margin-right: 10px;
|
||||
}
|
||||
|
||||
div#more h3.tagline {
|
||||
height: 23px;
|
||||
background: url(../images/tagline.png) no-repeat top left;
|
||||
width: 530px;
|
||||
}
|
||||
|
||||
div#more h3.tagline span { display: none; }
|
||||
|
||||
.view-master {
|
||||
text-align: center;
|
||||
font-family: Verdana;
|
||||
color: #ccc;
|
||||
font-size: 18px;
|
||||
padding: 35px 0;
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
.using-prototype {
|
||||
border-top: 2px solid #ddd;
|
||||
border-bottom: 2px solid #ddd;
|
||||
margin: 25px 10px 10px 0;
|
||||
padding: 5px 0;
|
||||
}
|
||||
|
||||
.sidebar-column h4 {
|
||||
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||
font-size: 14px;
|
||||
font-weight: bold;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.sidebar-column p {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
ol, ol li {
|
||||
list-style-type: decimal;
|
||||
line-height: 160%;
|
||||
}
|
||||
|
||||
ol li {
|
||||
margin: 0 0 2px;
|
||||
}
|
||||
|
||||
ol, ul {
|
||||
margin: 0 0 15px;
|
||||
padding-left: 0;
|
||||
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,150 @@
|
|||
module PDoc
|
||||
module Generators
|
||||
module Html
|
||||
module Helpers
|
||||
module BaseHelper
|
||||
def content_tag(tag_name, content, attributes = {})
|
||||
"<#{tag_name}#{attributes_to_html(attributes)}>#{content}</#{tag_name}>"
|
||||
end
|
||||
|
||||
def img_tag(filename, attributes = {})
|
||||
attributes.merge! :src => "#{path_prefix}images/#{filename}"
|
||||
tag(:img, attributes)
|
||||
end
|
||||
|
||||
def tag(tag_name, attributes = {})
|
||||
"<#{tag_name}#{attributes_to_html(attributes)} />"
|
||||
end
|
||||
|
||||
def link_to(name, path, attributes={})
|
||||
content_tag(:a, name, attributes.merge(:href => path))
|
||||
end
|
||||
|
||||
def htmlize(markdown)
|
||||
BlueCloth.new(markdown).to_html
|
||||
end
|
||||
|
||||
def javascript_include_tag(*names)
|
||||
names.map do |name|
|
||||
attributes = {
|
||||
:src => "#{path_prefix}javascripts/#{name}.js",
|
||||
:type => "text/javascript",
|
||||
:charset => "utf-8"
|
||||
}
|
||||
content_tag(:script, "", attributes)
|
||||
end.join("\n")
|
||||
end
|
||||
|
||||
def stylesheet_link_tag(*names)
|
||||
names.map do |name|
|
||||
attributes = {
|
||||
:href => "#{path_prefix}stylesheets/#{name}.css",
|
||||
:type => "text/css",
|
||||
:media => "screen, projection",
|
||||
:charset => "utf-8",
|
||||
:rel => "stylesheet"
|
||||
}
|
||||
tag(:link, attributes)
|
||||
end.join("\n")
|
||||
end
|
||||
|
||||
private
|
||||
def attributes_to_html(attributes)
|
||||
attributes.map { |k, v| v ? " #{k}=\"#{v}\"" : "" }.join
|
||||
end
|
||||
end
|
||||
|
||||
module LinkHelper
|
||||
def path_prefix
|
||||
"../" * depth
|
||||
end
|
||||
|
||||
def path_to(obj)
|
||||
path = path_prefix << [obj.section.name].concat(obj.namespace_string.downcase.split('.')).join("/")
|
||||
has_own_page?(obj) ? "#{path}/#{obj.id.downcase}.html" : "#{path}.html##{dom_id(obj)}"
|
||||
end
|
||||
|
||||
def auto_link(obj, short = true, attributes = {})
|
||||
obj = root.find_by_name(obj) || obj if obj.is_a?(String)
|
||||
return nil if obj.nil?
|
||||
return obj if obj.is_a?(String)
|
||||
name = short ? obj.name : obj.full_name
|
||||
link_to(name, path_to(obj), { :title => "#{obj.full_name} (#{obj.type})" }.merge(attributes))
|
||||
end
|
||||
|
||||
def auto_link_code(obj, short = true, attributes = {})
|
||||
return "<code>#{auto_link(obj, short, attributes)}</code>"
|
||||
end
|
||||
|
||||
def auto_link_content(content)
|
||||
content.gsub(/\[\[([a-zA-Z$\.#]+)(?:\s+([^\]]+))?\]\]/) do |m|
|
||||
if doc_instance = root.find_by_name($1)
|
||||
$2 ? link_to($2, path_to(doc_instance)) :
|
||||
auto_link_code(doc_instance, false)
|
||||
else
|
||||
$1
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def dom_id(obj)
|
||||
"#{obj.id}-#{obj.type.gsub(/\s+/, '_')}"
|
||||
end
|
||||
|
||||
private
|
||||
def has_own_page?(obj)
|
||||
obj.is_a?(Documentation::Namespace) || obj.is_a?(Documentation::Utility)
|
||||
end
|
||||
end
|
||||
|
||||
module CodeHelper
|
||||
def method_synopsis(object)
|
||||
if (object.methodized?)
|
||||
return <<-EOS
|
||||
<pre class="syntax"><code class="ebnf">#{ object.signature } -> #{ auto_link(object.returns, false) }
|
||||
#{ object.generic_signature } -> #{ auto_link(object.returns, false) }</code></pre>
|
||||
EOS
|
||||
end
|
||||
|
||||
<<-EOS
|
||||
<pre class="syntax"><code class="ebnf">#{ object.signature } -> #{ auto_link(object.returns, false) }</code></pre>
|
||||
EOS
|
||||
end
|
||||
end
|
||||
|
||||
module MenuHelper
|
||||
def menu(obj)
|
||||
class_names = menu_class_name(obj)
|
||||
html = <<-EOS
|
||||
<div class='menu-item'>
|
||||
#{auto_link(obj, false, :class => class_names_for(obj))}
|
||||
</div>
|
||||
EOS
|
||||
unless obj.children.empty?
|
||||
html << content_tag(:ul, obj.children.map { |n|menu(n) }.join("\n"))
|
||||
end
|
||||
content_tag(:li, html, :class => class_names)
|
||||
end
|
||||
|
||||
def menu_class_name(obj)
|
||||
if !doc_instance
|
||||
nil
|
||||
elsif obj == doc_instance
|
||||
"current"
|
||||
elsif obj.descendants.include?(doc_instance)
|
||||
"current-parent"
|
||||
else
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
def class_names_for(obj)
|
||||
classes = [obj.type.gsub(/\s+/, '-')]
|
||||
classes << "deprecated" if obj.deprecated?
|
||||
classes.join(" ")
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
<% @title = "Home" %>
|
||||
|
||||
<h2 class="page-title">Prototype API</h2>
|
||||
|
||||
<div class="page-introduction">
|
||||
<p>Welcome to the Prototype API Documentation.</p>
|
||||
</div> <!-- .section -->
|
||||
|
||||
|
||||
<div class="section section-sections">
|
||||
<div class="section-title">
|
||||
<h3>Sections</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<ul class="section-list">
|
||||
<% @root.sections.each do |section| %>
|
||||
<li>
|
||||
<h4><%= auto_link(section.name) %></h4>
|
||||
<p><%= section.short_description %></p>
|
||||
</li>
|
||||
<% end %>
|
||||
</ul>
|
||||
</div> <!-- .section-content -->
|
||||
</div> <!-- .section clearfix -->
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
if (!window.PDoc) window.PDoc = {};
|
||||
PDoc.elements = {
|
||||
<%= @root.map { |e, i|
|
||||
"'#{e.full_name}': { 'name': '#{e.full_name}', 'type': '#{e.type}', 'path': '#{path_to(e)}' }" }.join(",\n")
|
||||
%>
|
||||
};
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Prototype API documentation | <%= @title %></title>
|
||||
<meta name="generator" content="PDoc" />
|
||||
|
||||
<%= javascript_include_tag "prototype", "effects", "controls" %>
|
||||
<%= javascript_include_tag "application", "code_highlighter" %>
|
||||
|
||||
<%= javascript_include_tag "item_index" %>
|
||||
|
||||
|
||||
<%= stylesheet_link_tag "grid", "highlighter", "core", "api" %>
|
||||
|
||||
<script type="text/javascript">PDoc.pathPrefix = '<%= path_prefix %>';</script>
|
||||
</head>
|
||||
<body class="">
|
||||
<div id="page">
|
||||
|
||||
<div id="masthead">
|
||||
<div id="masthead_content">
|
||||
<h1 onclick="with (document.body) className = className ? '' : 'grid'" id="logo"><span class="replaced">Prototype JavaScript framework</span></h1>
|
||||
</div> <!-- #masthead_content -->
|
||||
</div> <!-- #masthead -->
|
||||
|
||||
<div id="menu" class="clearfix">
|
||||
<div class="api-box">
|
||||
<h2><a href="#" id="api_menu_button">Menu ↓</a></h2>
|
||||
|
||||
<ul id="api_menu" class="menu-items" style="display: none">
|
||||
<% @root.sections.each do |section| %>
|
||||
<%= menu(section) %>
|
||||
<% end %>
|
||||
</ul>
|
||||
</div> <!-- .api-box -->
|
||||
|
||||
<div class="search-box">
|
||||
<form>
|
||||
<label><span class="hidden">Search </span><input type="text" id="search" size="20" /></label>
|
||||
</form>
|
||||
<ul id="search_results" class="search-results menu-items" style="display:none"></ul>
|
||||
</div> <!-- .search-box -->
|
||||
|
||||
</div> <!-- #menu -->
|
||||
|
||||
<div id="main" class="page-content">
|
||||
|
||||
<%= @content_for_layout %>
|
||||
|
||||
</div> <!-- #main -->
|
||||
|
||||
<div id="footer">
|
||||
|
||||
<div class="about">
|
||||
<p>Generated by <a href="http://pdoc.org">PDoc</a>. Uses <a href="http://famfamfam.com/lab/icons/silk/" title="famfamfam.com: Silk Icons">Silk Icons</a>.</p>
|
||||
</div> <!-- .about -->
|
||||
|
||||
|
||||
</div> <!-- #footer -->
|
||||
|
||||
</div> <!-- #page -->
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,157 @@
|
|||
<% d = @doc_instance %>
|
||||
|
||||
<% @title = "#{d.full_name} (#{d.type})" %>
|
||||
|
||||
<%= include "partials/breadcrumbs", :object => d %>
|
||||
|
||||
<h2 class="page-title <%= class_names_for(d) %>">
|
||||
<span class="type"><%= d.type %> </span><%= d.full_name %>
|
||||
</h2>
|
||||
|
||||
<% # Does it have a description? %>
|
||||
|
||||
<% if d.description %>
|
||||
<div class="section section-description">
|
||||
|
||||
<div class="section-title">
|
||||
<h3>Description</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<%= htmlize(d.description) %>
|
||||
</div> <!-- .section-content -->
|
||||
|
||||
</div> <!--.section -->
|
||||
<% end %>
|
||||
|
||||
<% # Is it a CLASS? %>
|
||||
<% if @doc_instance.is_a?(Documentation::Klass) %>
|
||||
|
||||
<% if @doc_instance.superklass %>
|
||||
<div class="section section-superclass">
|
||||
<div class="section-title">
|
||||
<h3>Superclass</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<p><%= auto_link_code(d.superklass, false) %></p>
|
||||
</div> <!-- .section-content -->
|
||||
</div> <!-- .section -->
|
||||
<% end %>
|
||||
|
||||
<% unless @doc_instance.subklasses.empty? %>
|
||||
<div class="section section-subclasses">
|
||||
<div class="section-title">
|
||||
<h3>Subclasses</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<p><%= d.subklasses.map { |s| auto_link_code(s, false) }.join(', ') %></p>
|
||||
</div> <!-- .section-content -->
|
||||
</div> <!-- .section -->
|
||||
<% end %>
|
||||
|
||||
<% end %>
|
||||
|
||||
<% # Does it have MIXINS? %>
|
||||
<% unless @doc_instance.mixins.empty? %>
|
||||
<div class="section section-mixins">
|
||||
<div class="section-title">
|
||||
<h3>Includes</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<p><%= d.mixins.map { |m| auto_link_code(m, false) }.join(', ') %></p>
|
||||
</div> <!-- .section-content -->
|
||||
</div> <!-- .section -->
|
||||
<% end %>
|
||||
|
||||
<% # Are there related utilities? %>
|
||||
<% unless @doc_instance.related_utilities.empty? %>
|
||||
<div class="section section-utilities">
|
||||
<div class="section-title">
|
||||
<h3>Related utilities</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<p><%= d.related_utilities.map { |u| auto_link_code(u, false) }.join(', ') %></p>
|
||||
</div> <!-- .section-content -->
|
||||
</div> <!-- .section -->
|
||||
<% end %>
|
||||
|
||||
<% # List its methods. %>
|
||||
<% unless d.all_methods.empty? && d.mixins.empty? %>
|
||||
<div class="section section-method-list">
|
||||
<div class="section-title">
|
||||
<h3>Methods</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<ul class="method-list">
|
||||
<% d.all_methods.each do |method| %>
|
||||
<li><%= auto_link_code(method, true, :class => class_names_for(method)) %></li>
|
||||
<% end %>
|
||||
</ul>
|
||||
|
||||
<% unless @doc_instance.mixins.empty? %>
|
||||
<% d.mixins.each do |mixin| %>
|
||||
<h4 class="inherited">Inherited from <%= auto_link(mixin) %></h4>
|
||||
<ul class="method-list">
|
||||
<% mixin.all_methods.each do |method| %>
|
||||
<li><%= auto_link_code(method, true, :class => class_names_for(method)) %></li>
|
||||
<% end %>
|
||||
</ul>
|
||||
<% end %>
|
||||
<% end %>
|
||||
|
||||
|
||||
</div> <!-- .section-content -->
|
||||
|
||||
</div> <!-- .section -->
|
||||
<% end %>
|
||||
|
||||
<% if d.is_a?(Documentation::Klass) && d.constructor %>
|
||||
<div class="section section-constructor">
|
||||
<div class="section-title">
|
||||
<h3>Constructor</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<pre id="<%= dom_id(d.constructor) %>" class="syntax"><code><%= d.constructor.ebnf_expressions.join("\n").strip %></code></pre>
|
||||
|
||||
<p><%= htmlize(d.constructor.description) %></p>
|
||||
|
||||
</div> <!-- .section-content -->
|
||||
|
||||
</div> <!-- .section -->
|
||||
<% end %>
|
||||
|
||||
|
||||
<%
|
||||
types = {
|
||||
:constants => "Constants",
|
||||
:klass_methods => "Class methods",
|
||||
:klass_properties => "Class properties",
|
||||
:instance_methods => "Instance methods",
|
||||
:instance_properties => "Instance properties"
|
||||
}
|
||||
%>
|
||||
|
||||
<% types.each do |method, title| %>
|
||||
<% methods = d.send(method) %>
|
||||
<% unless methods.empty? %>
|
||||
<div class="section section-<%= method.to_s %>">
|
||||
|
||||
<div class="section-title">
|
||||
<h3><%= title %></h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<ul class="method-details-list">
|
||||
<%= include "partials/short_description", :collection => methods %>
|
||||
</ul>
|
||||
|
||||
</div> <!-- .section-content -->
|
||||
</div> <!-- .section -->
|
||||
<% end %>
|
||||
<% end %>
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
<ul class="breadcrumbs clearfix">
|
||||
<li><a href="<%= path_prefix %>index.html">Home</a> →</li>
|
||||
<% unless object.is_a?(Documentation::Section) %>
|
||||
<li><a href="<%= path_to(object.section) %>"><%= object.section.name %></a> →</li>
|
||||
<% end %>
|
||||
</ul>
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
<li class="method-description">
|
||||
<h4 id="<%= dom_id(object) %>"><%= object.name %></h4>
|
||||
|
||||
<% if object.is_a?(Documentation::Method) %>
|
||||
<%= method_synopsis(object) %>
|
||||
<% unless object.arguments.empty? %>
|
||||
<ul class="argument-list">
|
||||
<% object.arguments.each do |arg| %>
|
||||
<li>
|
||||
<code><%= arg.name %></code>
|
||||
<% unless arg.types.empty? %>
|
||||
(<%= arg.types.map { |t| auto_link_code(t, false) }.join(' | ') %>)
|
||||
<% end %>
|
||||
<%= ' – ' + arg.description unless arg.description.empty? %>
|
||||
</li>
|
||||
<% end %>
|
||||
</ul> <!-- .argument-list -->
|
||||
<% end %>
|
||||
<% end %>
|
||||
|
||||
<!-- <pre><code><%= object.class.to_s %></code></pre> -->
|
||||
<!-- <pre><code><%= object.methods.join("\n") %></code></pre> -->
|
||||
|
||||
<%= htmlize(object.description) %>
|
||||
|
||||
<% # Does it have an alias? %>
|
||||
<% unless object.aliases.empty? %>
|
||||
<p class="alias aliases">Aliased as: <%= object.aliases.map { |a| auto_link_code(a, false) }.join(', ') %></p>
|
||||
<% end %>
|
||||
|
||||
<% # Is it an alias of something else? %>
|
||||
<% if object.alias? %>
|
||||
<p class="alias alias-of">Alias of: <%= auto_link_code(object.alias_of, false) %></p>
|
||||
<% end %>
|
||||
|
||||
<% # Is it related to something? %>
|
||||
<% if object.is_a?(Documentation::Utility) && object.related_to %>
|
||||
<p class="related-to">Related to:
|
||||
<%= auto_link_code(object.related_to, false) %></p>
|
||||
<% end %>
|
||||
|
||||
|
||||
<% # Is it methodized? %>
|
||||
<% if object.is_a?(Documentation::Method) && object.methodized? %>
|
||||
<p class="note">This method can be called <em>either</em> as an instance method <em>or</em> as a generic method. If calling as a generic, pass the instance in as the first argument.</p>
|
||||
<% end %>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
<% @title = "#{@doc_instance.full_name} section" %>
|
||||
<% section = @doc_instance %>
|
||||
|
||||
<%= include "partials/breadcrumbs", :object => section %>
|
||||
|
||||
<h2 class="page-title">
|
||||
<span class="type">Section </span><%= section.name %>
|
||||
</h2>
|
||||
|
||||
<div class="section section-description">
|
||||
|
||||
<div class="section-title">
|
||||
<h3>Description</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<%= htmlize(section.description) %>
|
||||
</div> <!-- .section-content -->
|
||||
|
||||
</div> <!--.section -->
|
||||
|
||||
<% # Iterate over the items in this section. %>
|
||||
|
||||
<% utilities = section.utilities %>
|
||||
<% unless utilities.empty? %>
|
||||
|
||||
<div class="section section-utilities">
|
||||
<div class="section-title">
|
||||
<h3>Utilities</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<ul class="method-list">
|
||||
<% utilities.each do |utility| %>
|
||||
<li><%= auto_link_code(utility) %></li>
|
||||
<% end %>
|
||||
</ul>
|
||||
</div> <!-- .section-content -->
|
||||
</div> <!-- .section -->
|
||||
|
||||
<% end %>
|
||||
|
||||
<% namespaces = section.namespaces %>
|
||||
<% unless namespaces.empty? %>
|
||||
|
||||
<div class="section section-namespaces">
|
||||
<div class="section-title">
|
||||
<h3>Namespaces</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<ul class="method-list">
|
||||
<% namespaces.each do |namespace| %>
|
||||
<li><%= auto_link_code(namespace) %></li>
|
||||
<% end %>
|
||||
</ul>
|
||||
</div> <!-- .section-content -->
|
||||
</div> <!-- .section -->
|
||||
|
||||
<% end %>
|
||||
|
||||
<% klasses = section.klasses %>
|
||||
<% unless klasses.empty? %>
|
||||
|
||||
<div class="section section-classes">
|
||||
|
||||
<div class="section-title">
|
||||
<h3>Classes</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<ul class="method-details-list">
|
||||
<% klasses.each do |klass| %>
|
||||
<li class="method-description">
|
||||
<h4>
|
||||
<a href="<%= path_to(klass) %>"><%= klass.full_name %></a>
|
||||
</h4>
|
||||
|
||||
<% unless klass.short_description.nil? %>
|
||||
<p><%= htmlize(klass.short_description) %></p>
|
||||
<% end %>
|
||||
|
||||
</li>
|
||||
<% end %>
|
||||
</ul>
|
||||
</div> <!-- .section-content -->
|
||||
|
||||
</div> <!--.section -->
|
||||
|
||||
<% end %>
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
<% d = @doc_instance %>
|
||||
|
||||
<% @title = "#{@doc_instance.full_name} utility" %>
|
||||
|
||||
<%= include "partials/breadcrumbs", :object => d %>
|
||||
|
||||
<h2 class="page-title">
|
||||
<span class="type">utility </span><%= @doc_instance.name %>
|
||||
</h2>
|
||||
|
||||
<div class="section">
|
||||
<div class="section-title">
|
||||
<h3>Description</h3>
|
||||
</div> <!-- .section-title -->
|
||||
|
||||
<div class="section-content">
|
||||
<ul class="method-details-list">
|
||||
<%= include "partials/short_description", :collection => [@doc_instance] %>
|
||||
</ul>
|
||||
</div> <!-- .section-content -->
|
||||
</div> <!-- .section -->
|
||||
Loading…
Reference in New Issue