From 754792fa8609f26573dc581b8dbbe05546e78074 Mon Sep 17 00:00:00 2001 From: sjy Date: Mon, 27 Aug 2012 00:46:40 +0800 Subject: [PATCH] Menu now floats at the bottom and includes current pinpoint citation where applicable. Set viewport width for iOS. Minor changes: - removed cruft (austlii.init, prune functions) - use uniform url prefix for css and jquery plugins (no longer hardcoded to splintax.ucc) - refactor and cleanup everything, but especially scroll handler --- TODO | 3 - austlii.css | 37 +++++----- austlii.js | 202 ++++++++++++++++++++++++++++++---------------------- 3 files changed, 134 insertions(+), 108 deletions(-) delete mode 100644 TODO diff --git a/TODO b/TODO deleted file mode 100644 index 51564f6..0000000 --- a/TODO +++ /dev/null @@ -1,3 +0,0 @@ -judge exp breaks on -http://www.austlii.edu.au/au/cases/cth/HCA/2012/19.html -http://www.austlii.edu.au/au/cases/cth/HCA/2004/37.html diff --git a/austlii.css b/austlii.css index a9e0f8e..881ff33 100644 --- a/austlii.css +++ b/austlii.css @@ -1,24 +1,25 @@ -/* restyle austlii */ -body { +/* austlii content is wrapped in a container and restyled */ +#container { max-width: 40em; margin: 0 auto; font-family: Georgia; - padding: 2em; - border-left: 1px #ccc solid; - border-right: 1px #ccc solid; + padding: 0; } +#container h1 {border-bottom: 1px black solid;} +#container ol li {text-align: justify;} +#container a.section {font-weight: bold;} -h1 {border-bottom: 1px black solid;} - -ol li {text-align: justify;} - - -/* austlii.js special features */ -.citation {font-size: 150%; font-weight: bold;} - -#menu {position: fixed; top: 2em; left: 0; padding: 1em; width: 10em;} -#menu ol {list-style-type: none; padding: 0;} -#menu ol li {text-align: left; margin-bottom: 0.5em;} +/* floating menu added by austlii.js */ +#menu { + position: fixed; bottom: 0; left: 5px; right: 5px; + padding: 0.5em; + text-align: center; font-size: 75%; + background: #fff; border: 1px #ccc solid; border-top: none; + box-shadow: 2px -2px 2px #ccc; +} +#menu h2 {margin: 0.2em; font-size: 100%;} +#menu ol {list-style-type: none; padding: 0; margin: 0;} +#menu ol li {margin-bottom: 0.5em; display: inline; margin: 0;} #menu ol li a.current {font-weight: bold;} - -a.judge {font-weight: bold;} +#menu ol li .spacer {margin: 0 0.5em;} +#menu img {float: left; height: 3em;} diff --git a/austlii.js b/austlii.js index 1908d47..51cc54f 100644 --- a/austlii.js +++ b/austlii.js @@ -1,8 +1,9 @@ /* austlii.js - * Bookmarklet to add annotation tools to AustLII cases. - * Invoke with: + * Author: Scott Young + * Bookmarklet to add annotation tools to AustLII cases. Invoke with: * javascript:var d=document;var s=d.createElement("script");s.src="http://splintax.ucc.asn.au/austlii/austlii.js";s.type="text/javascript";d.getElementsByTagName('head').item(0).appendChild(s); */ +// create a namespace for this tool window.austlii = { VERSION: '0.1', load: function(url, cb) { @@ -17,107 +18,126 @@ window.austlii = { s.rel = "stylesheet"; s.type = "text/css"; s.href = url; document.getElementsByTagName('head').item(0).appendChild(s); return; }, - init: function() { - if (window.location.host.slice(-14) != "austlii.edu.au" || - window.location.pathname.slice(0,10) != "/au/cases/" || - window.location.pathname.slice(-5) != ".html") - console.log("You're not looking at a case on AustLII."); - else - austlii.main(); - }, - prune: function() { - // Remove all but the newest script tag containing the queries passed in as arguments. - for (var i = 0; i < arguments.length; i++) { - var $els = $("head script[src*="+arguments[i]+"]"); - var toRemove = $els.slice(0,-1); - if (toRemove.length > 0) { - toRemove.remove(); - console.log("Removed "+toRemove.length+" stale scripts matching '"+arguments[i]+"'..."); - } - } - }, + url: function(relative_path) { + // return url relative to the source of this file, eg. http://splintax.ucc.asn.au/austlii/ + var prefix = $('script[src$="austlii.js"]').attr('src').replace(/austlii\.js/, ""); + return prefix + relative_path; + } }; +// Initialises once jQuery is loaded. austlii.main = function() { + austlii.style(austlii.url("austlii.css")); // inject css + // set viewport width so iPad doesn't zoom out + $("head").append(''); + $("a").slice(10,16).css({"margin-right": "1em"}); // space out "Database Search", ... links - // grab austlii.css from the same directory as this JavaScript - var cssUrl = $('script[src$="austlii.js"]').attr('src').replace(/austlii\.js/, "austlii.css"); - austlii.style(cssUrl); + austlii.markup(); + austlii.menu(); + $(window).scroll(austlii.scrollHandler).scroll(); - austlii.cleanup(); - austlii.addMarkup(); - austlii.paintMenu(); + // enable smooth scrolling on anchors + // TODO: doing this synchronously makes for slow injection on mobile browsers + austlii.load(austlii.url("jquery.scrollTo-1.4.2-min.js"), function() { + austlii.load(austlii.url("jquery.localscroll-1.2.7-min.js"), function() { + $.localScroll({duration: '200'}); + }); + }); -}; + // TODO: user annotations + $("#trigger-highlight").click(austlii.highlight); +} -austlii.cleanup = function() { - // remove text nodes ([] surrounding "Download", etc) - // var textNodes = $("body").contents().filter(function(){return this.nodeType == 3;}).remove(); - // remove unnecessary
s +// Cleans up page and adds semantic markup. +austlii.markup = function() { + // remove cruft $("br").remove(); -}; - -austlii.addMarkup = function() { + $('img[alt="AustLII"]').detach().prependTo("body"); + $("table").remove(); - // add back to top around header - $("h1").eq(1).wrap(''); - - // highlight case title - $("center i").first().parent().addClass("citation"); + $("h1").wrap(''); // add back-to-top + $('a[name="fn1"]').addClass("section"); // mark beginning of footnotes // find and markup judges - // var judgeExp = /([A-Zc]+\s)([A-Zc,\s]+\sC?JJ?\.)/g; - var judgeExp = /([A-Z]{3})((?:[A-Z\s,]| )+C?J?J\.)/g - var replacementText = document.body.innerHTML.replace(judgeExp, '$1$2'); + var judgeExp = /([A-Zc]{3})((?:[A-Z\s,]| )+C?J?J\.)/g + /* This regex is confusing and I keep breaking it. Remember: + * [A-Zc] is used to match McHUGH J. + * Since we're matching innerHTML   is not part of \s. + * The first 3 characters are captured, hopefully because they are ASCII non-whitespace + * suitable for use in the . */ + var replacementText = document.body.innerHTML.replace(judgeExp, '$1$2'); document.body.innerHTML = replacementText; - }; -austlii.paintMenu = function() { - - // create menu - var $menu = $(''); - $("body").append($menu); - - // add fixed link to headnote - $("#menu ol").append('
  • Headnote
    • ') +// Updates responsive menu whenever the page is scrolled. +austlii.scrollHandler = function() { + var currentPosition = $(window).scrollTop() + $(window).height()/2; + + var $anchors = $("#container a.section"); + var $links = $("#menu ol li a"); + var $pars = $("#container ol li").not("ol ol li"); + + // remove existing section highlight and citation + $links.removeClass("current"); + $("#menu .pinpoint").remove(); + + // find the current document section + var $anchor = $anchors.filter(function(){ + // is this anchor above the fold? + return currentPosition > $(this).offset().top; + }).last(); // current section = last anchor above fold + // highlight the link to the current document section + $links.filter('[href="#' + $anchor.attr("name") + '"]').addClass("current"); + + // check whether we're in the judgment body + if ( currentPosition > $pars.first().offset().top && + currentPosition < $pars.last().offset().top ) { + // we are, so find the current paragraph and add a pinpoint citation + var $par = $pars.filter(function(){ + // is this paragraph above the fold? + return currentPosition > $(this).offset().top; + }).last(); // current paragraph = last paragraph above fold + if ( $par.val() != 0 ) { // don't add unofficial paragraph citations on old cases + // TODO: make it work anyway, but add a warning? + var $pinpoint = $(' at ['+ $par.val() +']'); + $("#menu a.current").after($pinpoint); // add citation + } + } +}; - // add jumplinks for each judge - $("a.judge").each(function(){ - var $li = $('
  • ' + $(this).html() + '
    • '); - $("#menu ol").append($li); +// Create the responsive menu. +austlii.menu = function() { + // wrap the source body content in a container + $("body").children().wrapAll('
    '); + + // create and prepend menu to the page + var $menu = $(''); + $('

    '+ $("h2").first().html() +'

    ').prependTo($menu); // add header + $('img[alt="AustLII"]').detach().prependTo($menu); + $menu.prependTo("body"); + + // create and insert links in the menu + var $links = $('
      '); + // headnote + $links.append('
    1. Headnote·
      2. ') + // judgments + var $judges = $("a.section").slice(1,-1); + $judges.each(function(i){ + var li = '
    2. ' + $(this).html().slice(0,-1) + ''; + if ( i < $judges.length ) + li += '·' + li += '
      3. '; + $links.append(li); }); - - // add fixed link to footnotes - $("#menu ol").append('
    3. Footnotes
      4. '); + // footnotes + $links.append('
    4. Footnotes
      5. '); + $menu.append($links); // add annotation features //$menu.append($('Highlight')); - - // enable smooth scrolling on anchors - austlii.load("http://splintax.ucc.asn.au/austlii/jquery.scrollTo-1.4.2-min.js", function() { - austlii.load("http://splintax.ucc.asn.au/austlii/jquery.localscroll-1.2.7-min.js", function() { - $.localScroll({duration: '200'}); - }); - }); - - // update current judge on scroll - $(window).scroll(function() { - $("#menu ol li a").each(function(){ - // if the relevant link appearsmore than half way down the page - var $anchor = $('a[name="'+$(this).attr("href").slice(1)+'"]'); - if ($(window).scrollTop() + $(window).height()/2 > $anchor.offset().top) { - austlii.$currentSection = $(this); - } - }); - $("#menu ol li a").not(austlii.$currentSection).removeClass("current"); - austlii.$currentSection.addClass("current"); - }); $(window).scroll(); // and run it once - - $("#trigger-highlight").click(austlii.highlight); - }; +// FIXME Highlight the current selection. austlii.highlight = function(event) { event.preventDefault(); var sel = document.getSelection(); @@ -140,9 +160,17 @@ austlii.highlight = function(event) { else {console.log("You haven't highlighted anything.")} }; -if (document.getElementsByTagName("script").length == 1) { - console.log("Loaded austlii.js v"+austlii.VERSION+"."); - austlii.load('http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js', austlii.init); -} else { - alert("austlii.js will not run when there are other scripts on the page."); +// don't run on other sites +if (window.location.host.slice(-14) != "austlii.edu.au" || + window.location.pathname.slice(0,10) != "/au/cases/" || + window.location.pathname.slice(-5) != ".html") + console.error("You're not looking at a case on AustLII."); + +else if (document.getElementsByTagName("script").length > 1) + console.error("austlii.js will not run when there are other scripts on the page."); + +else { + console.log("Loaded austlii.js."); + // load jQuery and initialise the bookmarklet + austlii.load('http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js', austlii.main); } -- 2.20.1