summaryrefslogtreecommitdiff
path: root/docs/_static/doctools.js
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_static/doctools.js')
-rw-r--r--docs/_static/doctools.js202
1 files changed, 161 insertions, 41 deletions
diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js
index be4bdc8..b915584 100644
--- a/docs/_static/doctools.js
+++ b/docs/_static/doctools.js
@@ -94,55 +94,29 @@ jQuery.fn.highlightText = function(text, className) {
var Documentation = {
init : function() {
+ /* this.addContextElements(); -- now done statically */
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initModIndex();
- },
-
- /**
- * i18n support
- */
- TRANSLATIONS : {},
- PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
- LOCALE : 'unknown',
-
- // gettext and ngettext don't access this so that the functions
- // can savely bound to a different name (_ = Documentation.gettext)
- gettext : function(string) {
- var translated = Documentation.TRANSLATIONS[string];
- if (typeof translated == 'undefined')
- return string;
- return (typeof translated == 'string') ? translated : translated[0];
- },
-
- ngettext : function(singular, plural, n) {
- var translated = Documentation.TRANSLATIONS[singular];
- if (typeof translated == 'undefined')
- return (n == 1) ? singular : plural;
- return translated[Documentation.PLURALEXPR(n)];
- },
-
- addTranslations : function(catalog) {
- for (var key in catalog.messages)
- this.TRANSLATIONS[key] = catalog.messages[key];
- this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
- this.LOCALE = catalog.locale;
+ this.initComments();
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
- $('div[@id] > :header:first').each(function() {
- $('<a class="headerlink">\u00B6</a>').
- attr('href', '#' + this.id).
- attr('title', _('Permalink to this headline')).
- appendTo(this);
- });
+ for (var i = 1; i <= 6; i++) {
+ $('h' + i + '[@id]').each(function() {
+ $('<a class="headerlink">\u00B6</a>').
+ attr('href', '#' + this.id).
+ attr('title', 'Permalink to this headline').
+ appendTo(this);
+ });
+ }
$('dt[@id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
- attr('title', _('Permalink to this definition')).
+ attr('title', 'Permalink to this definition').
appendTo(this);
});
},
@@ -171,7 +145,7 @@ var Documentation = {
});
}, 10);
$('<li class="highlight-link"><a href="javascript:Documentation.' +
- 'hideSearchWords()">' + _('Hide Search Matches') + '</a></li>')
+ 'hideSearchWords()">Hide Search Matches</a></li>')
.appendTo($('.sidebar .this-page-menu'));
}
},
@@ -195,6 +169,37 @@ var Documentation = {
},
/**
+ * init the inline comments
+ */
+ initComments : function() {
+ $('.inlinecomments div.actions').each(function() {
+ this.innerHTML += ' | ';
+ $(this).append($('<a href="#">hide comments</a>').click(function() {
+ $(this).parent().parent().toggle();
+ return false;
+ }));
+ });
+ $('.inlinecomments .comments').hide();
+ $('.inlinecomments a.bubble').each(function() {
+ $(this).click($(this).is('.emptybubble') ? function() {
+ var params = $.getQueryParameters(this.href);
+ Documentation.newComment(params.target[0]);
+ return false;
+ } : function() {
+ $('.comments', $(this).parent().parent()[0]).toggle();
+ return false;
+ });
+ });
+ $('#comments div.actions a.newcomment').click(function() {
+ Documentation.newComment();
+ return false;
+ });
+ if (document.location.hash.match(/^#comment-/))
+ $('.inlinecomments .comments ' + document.location.hash)
+ .parent().toggle();
+ },
+
+ /**
* helper function to hide the search marks again
*/
hideSearchWords : function() {
@@ -203,6 +208,22 @@ var Documentation = {
},
/**
+ * show the comment window for a certain id or the whole page.
+ */
+ newComment : function(id) {
+ Documentation.CommentWindow.openFor(id || '');
+ },
+
+ /**
+ * write a new comment from within a comment view box
+ */
+ newCommentFromBox : function(link) {
+ var params = $.getQueryParameters(link.href);
+ $(link).parent().parent().fadeOut('slow');
+ this.newComment(params.target);
+ },
+
+ /**
* make the url absolute
*/
makeURL : function(relativeURL) {
@@ -221,11 +242,110 @@ var Documentation = {
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
- }
+ },
+
+ /**
+ * class that represents the comment window
+ */
+ CommentWindow : (function() {
+ var openWindows = {};
+
+ var Window = function(sectionID) {
+ this.url = Documentation.makeURL('@comments/' + Documentation.getCurrentURL()
+ + '/?target=' + $.urlencode(sectionID) + '&mode=ajax');
+ this.sectionID = sectionID;
+
+ this.root = $('<div class="commentwindow"></div>');
+ this.root.appendTo($('body'));
+ this.title = $('<h3>New Comment</h3>').appendTo(this.root);
+ this.body = $('<div class="form">please wait...</div>').appendTo(this.root);
+ this.resizeHandle = $('<div class="resizehandle"></div>').appendTo(this.root);
+
+ this.root.Draggable({
+ handle: this.title[0]
+ });
+
+ this.root.css({
+ left: window.innerWidth / 2 - $(this.root).width() / 2,
+ top: window.scrollY + (window.innerHeight / 2 - 150)
+ });
+ this.root.fadeIn('slow');
+ this.updateView();
+ };
+
+ Window.prototype.updateView = function(data) {
+ var self = this;
+ function update(data) {
+ if (data.posted) {
+ document.location.hash = '#comment-' + data.commentID;
+ document.location.reload();
+ }
+ else {
+ self.body.html(data.body);
+ $('div.actions', self.body).append($('<input>')
+ .attr('type', 'button')
+ .attr('value', 'Close')
+ .click(function() { self.close(); })
+ );
+ $('div.actions input[@name="preview"]')
+ .attr('type', 'button')
+ .click(function() { self.submitForm($('form', self.body)[0], true); });
+ $('form', self.body).bind("submit", function() {
+ self.submitForm(this);
+ return false;
+ });
+
+ if (data.error) {
+ self.root.Highlight(1000, '#aadee1');
+ $('div.error', self.root).slideDown(500);
+ }
+ }
+ }
+
+ if (typeof data == 'undefined')
+ $.getJSON(this.url, function(json) { update(json); });
+ else
+ $.ajax({
+ url: this.url,
+ type: 'POST',
+ dataType: 'json',
+ data: data,
+ success: function(json) { update(json); }
+ });
+ }
+
+ Window.prototype.getFormValue = function(name) {
+ return $('*[@name="' + name + '"]', this.body)[0].value;
+ }
+
+ Window.prototype.submitForm = function(form, previewMode) {
+ this.updateView({
+ author: form.author.value,
+ author_mail: form.author_mail.value,
+ title: form.title.value,
+ comment_body: form.comment_body.value,
+ preview: previewMode ? 'yes' : ''
+ });
+ }
+
+ Window.prototype.close = function() {
+ var self = this;
+ delete openWindows[this.sectionID];
+ this.root.fadeOut('slow', function() {
+ self.root.remove();
+ });
+ }
+
+ Window.openFor = function(sectionID) {
+ if (sectionID in openWindows)
+ return openWindows[sectionID];
+ return new Window(sectionID);
+ }
+
+ return Window;
+ })()
};
-// quick alias for translations
-_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();