diff --git a/.gitignore b/.gitignore index 71de489..f5be1c6 100644 --- a/.gitignore +++ b/.gitignore @@ -3,5 +3,3 @@ *# .#* *~ -frontend/logs/ -spiral.db diff --git a/MIT-LICENSE b/MIT-LICENSE new file mode 100644 index 0000000..9c2bf88 --- /dev/null +++ b/MIT-LICENSE @@ -0,0 +1,20 @@ +Copyright (c) 2011 Elf M. Sternberg + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README b/README new file mode 100644 index 0000000..954fcb6 --- /dev/null +++ b/README @@ -0,0 +1,58 @@ +Sitedarts are content-within-a-page links laid out along the right +side of the viewport, spaced proportionately to their target anchor +positions within the document. They are meant to give users a visual +indicator of where they are within long, scrolling documents, and to +encourage exploration below the fold. The content of a dart is +informed by ... entries. + +Sitedarts was inspired by book darts (www.bookdarts.com), hammered +copper pointers that I regularly use in my notebooks to keep track of +stuff. I wanted a page-side view of my anchors and headers since I +develop code for e-book readers. + +## Installation + +Sitedarts uses jquery (1.3.2 or better required) and jquery.easing. +Both are provided in this download. It's just Javascript, otherwise. +Use as directed. + +## Copyright + +Sitedarts is copyright (c) 2011 Elf M. Sternberg. Included libraries +are covered by their respective copyright holders, and are used with +permission of the licenses included. See the MIT-LICENSE file for +the license on sitedarts.js itself. + +## To Do + +Provide an alternative text on hover. Provide a mechanism for +describing the alternative text. Provide a way that the +anchor can inform the visual content of the dart. + +Provide themes for dart types (metal, glass, plain, colorful, drab). + +Fix the arbitrariness of the layout: ensure that the bottom of the +bottom dart, and the top of the top dart, are within the viewport. + +Allow the darts to be on the left, or even across the top and bottom +of the viewport. + +Guarantee easing to the target even when the target mark is well +within the viewport at the bottom of the document. + +Set a highlight class on the dart corresponding to the anchor the user +is "within." This is a nebulous concept. If two or more anchors are +visible on the screen, keep the lower one highlighted if it was the +last one chosen. (cf. Eugene Jarvis' "The way a program looks smart +is it doesn't do anything stupid.") + +Allow sitedarts to work within an arbitrary container pair, rather +than $(window) and $(document). + +Allow configuration to narrow the viewport. + +## Stretch goal + +Provide an alternative text search input box and decorate the sitedart +layout with links to searched-for terms. On hover, provide some +context. diff --git a/index.html b/index.html index 945b737..876de88 100644 --- a/index.html +++ b/index.html @@ -2,8 +2,9 @@ Sample - - + + +