243 lines
15 KiB
HTML
Executable File
243 lines
15 KiB
HTML
Executable File
---
|
|
title: Scroll layout
|
|
keywords: json, scrolling, scrollto, jquery plugin
|
|
tags: [special_layouts]
|
|
last_updated: November 30, 2015
|
|
summary: "This page demonstrates how you the integration of a script called ScrollTo, which is used here to link definitions of a JSON code sample to a list of definitions for that particular term. The scenario here is that the JSON blocks are really long, with extensive nesting and subnesting, which makes it difficult for tables below the JSON to adequately explain the term in a usable way."
|
|
permalink: mydoc_scroll.html
|
|
sidebar: mydoc_sidebar
|
|
folder: mydoc
|
|
---
|
|
|
|
{% if site.output == "pdf" %}
|
|
{{site.data.alerts.note}} The content on this page doesn't display well on PDF, but I included it anyway so you could see the problems this layout poses if you're including it in PDF. {{site.data.alerts.end}}
|
|
{% endif %}
|
|
|
|
{% if site.output == "web" %}
|
|
<script src="js/jquery.scrollTo.min.js"></script>
|
|
<!-- local scroll must come after scrollTo, because localScroll is based on scrollTo, which is based on jQuery -->
|
|
<script src="js/jquery.localScroll.min.js"></script>
|
|
|
|
<script>
|
|
|
|
$( document ).ready(function() {
|
|
$('#small-box-links').localScroll({
|
|
target:'#definition-box-container',
|
|
showSpeed: 1000,
|
|
hash: true,
|
|
easing: 'swing',
|
|
onAfter:function(){
|
|
$("#definition-box-container div a").addClass("active");
|
|
$("#definition-box-container div a").removeClass("active");
|
|
$("#definition-box-container div").removeClass("active");
|
|
$(window.location.hash).addClass("active");
|
|
}
|
|
});
|
|
|
|
|
|
});
|
|
</script>
|
|
|
|
<!-- documentation for localScroll function: http://flesler.blogspot.com/2007/10/jquerylocalscroll-10.html -->
|
|
<style type="text/css">
|
|
|
|
#definition-box-container {
|
|
border: 0px solid #dedede;
|
|
border-radius: 4px;
|
|
max-height: 500px;
|
|
overflow: scroll;
|
|
padding-left:5px;
|
|
border-radius:5px;
|
|
}
|
|
|
|
#json-box-container {
|
|
|
|
border: 1px solid #dedede;
|
|
border-radius: 4px;
|
|
max-height:500px;
|
|
overflow: scroll;
|
|
}
|
|
|
|
#small-box-links {
|
|
float: left;
|
|
}
|
|
|
|
#definition-box-container .active {
|
|
background-color: #FFFBCC;
|
|
}
|
|
|
|
div#definition-box-container div {
|
|
padding: 10px;
|
|
}
|
|
|
|
@media (min-height: 700px) {
|
|
#json-box-container {
|
|
max-height:500px;
|
|
}
|
|
#definition-box-container {
|
|
max-height: 500px;
|
|
}
|
|
}
|
|
|
|
@media (min-height: 800px) {
|
|
#json-box-container {
|
|
max-height:600px;
|
|
}
|
|
#definition-box-container {
|
|
max-height: 600px;
|
|
}
|
|
}
|
|
|
|
@media (min-height: 900px) {
|
|
#json-box-container {
|
|
max-height:700px;
|
|
}
|
|
#definition-box-container {
|
|
max-height: 700px;
|
|
}
|
|
}
|
|
|
|
@media (min-height: 1000px) {
|
|
#json-box-container {
|
|
max-height:800px;
|
|
}
|
|
#definition-box-container {
|
|
max-height: 800px;
|
|
}
|
|
}
|
|
|
|
@media (min-height: 1100px) {
|
|
#json-box-container {
|
|
max-height:900px;
|
|
}
|
|
#definition-box-container {
|
|
max-height: 900px;
|
|
}
|
|
}
|
|
|
|
|
|
</style>
|
|
|
|
|
|
<div class="container">
|
|
<div class="row">
|
|
|
|
<div id="small-box-links">
|
|
|
|
<div class="col-md-6">
|
|
<div id="json-box-container">
|
|
<pre>
|
|
{
|
|
<a href="#apples">"apples"</a>: "red fruit at the store",
|
|
<a href="#bananas">"bananas"</a>: "yellow bananas in a bunch",
|
|
<a href="#carrots">"carrots"</a>: "orange vegetables that grow in the ground",
|
|
<a href="#dingbats">"dingbats"</a>: "a type of character symbol on a computer",
|
|
<a href="#eggs">"eggs"</a>: "chickens lay them, and people eat them",
|
|
<a href="#falafel">"falafel"</a>: "a Mediterranean sandwich consisting of lots of different stuff i don't know much about",
|
|
<a href="#giraffe">"giraffe"</a>: "tall animal, has purple tongue",
|
|
<a href="#hippo">"hippo"</a>: "surprisingly dangerous amphibian",
|
|
<a href="#igloo">"igloo"</a>: "an ice shelter made by eskimos",
|
|
<a href="#jeep">"jeep</a>: "the only car that starts with a j",
|
|
<a href="#kilt">"kilt"</a>: "something worn by scottish people, not a dress",
|
|
<a href="#lamp">"lamp"</a>: "you use it to read by your bedside at night"
|
|
<a href="#manifold">"manifold"</a>: "an intake mechanism on a car, like a valve, i think",
|
|
<a href="#octopus">"octopus"</a>: "eight tentacles, shoots ink, lives in dark caves, very mysterious",
|
|
<a href="#paranoia">"paranoia"</a>: "the constant feeling that others are out to get you, conspiring against your success",
|
|
<a href="#qui">"qui"</a>: "a life force that runs through your body",
|
|
<a href="#radical">"radical"</a>: "someone who opposes the status quo in major ways",
|
|
<a href="#silly">"silly"</a>: "how I feel writing this dummy copy",
|
|
<a href="#taffy">"taffy"</a>: "the sweets children like the most and dentists hate the worst",
|
|
<a href="#umbrella">"umbrella"</a>: "an invention that has not had any advancements in 200 years",
|
|
<a href="#vampire">"vampire"</a>: "a paranormal figure that is surprisingly in vogue despite its basic nature",
|
|
<a href="#washington">"washington"</a>: "the place where tom was born",
|
|
<a href="#xylophone">"xylophone"</a>: "some kind of pinging instrument used to sound chime-like notes",
|
|
<a href="#yahoo">"yahoo"</a>: "an expression of exuberance, said under breath when something works right",
|
|
<a href="#zeta">"zeta"</a>: "the way british people pronounce z",
|
|
<a href="#alpha">"alpha"</a>: "the original letter of the alphabet, which has since come to mean the first. however, i think the original symbol of alpha is actually an ox. it is somewhat of a mystery to linquists as to the exact origin of the letter alpha, but it basically represents the dawn of the alphabet, which proved to be a huge step forward for human thought and expression.",
|
|
<a href="#beta">"beta"</a>: "the period of time when something is finished but undergoing testing by a group of people.",
|
|
<a href="#cappa">"cappa"</a>: "how italians refer to their baseball caps",
|
|
<a href="#dunno">"dunno"</a>: "informal expression for 'don't know'"
|
|
}
|
|
|
|
</pre>
|
|
|
|
</div><!-- end json-box-container-->
|
|
</div> <!-- end col-md-6-->
|
|
|
|
<div class="col-md-3">
|
|
|
|
<div id="definition-box-container">
|
|
|
|
|
|
<div id="apples"><h5>apples</h5>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer magna massa, euismod sed rutrum at, ullamcorper quis tellus. Vestibulum erat purus, aliquet sit amet pellentesque eget, tempus at ante. Nulla justo nisi, elementum nec nisi eget, consectetur varius tortor. </div>
|
|
|
|
<div id="bananas"><h5>bananas</h5>Curabitur quis nibh sed eros viverra tempus et quis lorem. Nulla convallis sit amet risus vitae rutrum. Nulla at faucibus lectus. Pellentesque tortor nisl, interdum ac quam non, egestas congue massa. Vestibulum non porttitor lacus. Nam tincidunt arcu lectus. Donec eget ornare neque, hendrerit ornare lectus. In ac pretium odio.</div>
|
|
|
|
<div id="carrots"><h5>carrots</h5>Vivamus pulvinar vestibulum pharetra. Vivamus vitae diam iaculis, posuere mi sed, dignissim massa. Nunc vitae aliquet urna. Proin sed pulvinar ex. Maecenas nisl lorem, rutrum sit amet hendrerit sed, posuere at odio. Sed consectetur semper tristique. Vivamus finibus varius felis at convallis. Fusce in dictum nunc.</div>
|
|
|
|
<div id="dingbats"><h5>dingbats</h5>Curabitur feugiat lorem eget elit ullamcorper tincidunt. In euismod diam aliquet tortor fermentum tempor. Fusce quam felis, commodo viverra orci vitae, scelerisque aliquet risus. </div>
|
|
|
|
<div id="eggs"><h5>eggs</h5>Duis est nunc, fringilla eu ligula et, varius dignissim dui. Vivamus in tellus vitae ipsum vehicula fermentum at congue tellus. Suspendisse fermentum, magna vitae aliquet sodales, tellus nisi rutrum arcu, vitae auctor dolor quam ac tellus. Cras posuere augue erat, in sagittis quam lacinia id.</div>
|
|
|
|
<div id="falafel"><h5>falafel</h5>Praesent auctor a enim non lacinia. Integer sodales aliquet mi vel dapibus. Donec consequat justo eget nisi lacinia, eu sodales ligula molestie. Sed sapien nulla, rhoncus at elementum a, </div>
|
|
|
|
<div id="giraffe"><h5>giraffe</h5>Nullam venenatis at lectus sed pharetra. Sed hendrerit ligula lectus, non pellentesque diam faucibus sit amet. Aliquam dictum hendrerit pellentesque. Cras eu nisl sagittis, faucibus velit sit amet, sagittis odio. Donec vulputate ex vitae purus</div>
|
|
|
|
<div id="hippo"><h5>hippo</h5>Cras nec pretium nulla. Suspendisse tempus tortor vel venenatis pulvinar. Integer varius tempor enim fringilla tincidunt. Phasellus magna turpis, auctor vitae elit eget, fringilla pellentesque est. Phasellus ut porta risus. Curabitur iaculis sapien sed venenatis auctor. Integer eu orci at lectus eleifend auctor id rutrum urna.</div>
|
|
|
|
<div id="igloo"><h5>igloo</h5>Suspendisse tempus tortor vel venenatis pulvinar. Integer varius tempor enim fringilla tincidunt. Phasellus magna turpis, auctor vitae elit eget, fringilla pellentesque est. Phasellus ut porta risus. </div>
|
|
|
|
<div id="jeep"><h5>jeep</h5>Nulla vitae metus rutrum, condimentum orci nec, maximus est. Aenean sit amet ante nec elit dignissim faucibus eget quis quam. </div>
|
|
|
|
<div id="kilt"><h5>kilt</h5>Morbi maximus, erat vel rhoncus sagittis, dolor purus dignissim ante, sit amet pharetra ex justo vitae ipsum. Nulla consequat interdum neque</div>
|
|
|
|
<div id="lamp"><h5>lamp</h5>Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Mauris aliquam dapibus blandit. Donec porta, enim hendrerit venenatis vulputate, orci diam lacinia nibh, faucibus rutrum dolor dui ut quam.</div>
|
|
|
|
<div id="manifold"><h5>manifold</h5>Donec finibus massa vel nisi ullamcorper, vitae ornare enim euismod. Aliquam auctor quam erat. Duis interdum rutrum orci, ac interdum urna pharetra eget.</div>
|
|
|
|
<div id="octopus"><h5>octopus</h5>Nulla id egestas enim. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse potenti. Curabitur eu lobortis ligula.</div>
|
|
|
|
<div id="paranoia"><h5>paranoia</h5>Aenean hendrerit mauris ipsum, non laoreet ipsum luctus vel. Curabitur tristique auctor elit ut pulvinar. Quisque arcu arcu, condimentum aliquam sodales nec, dignissim nec justo. Nunc tristique sem felis, pharetra euismod lorem volutpat sed. Ut porttitor metus sit amet elit rhoncus semper.</div>
|
|
|
|
<div id="qui"><h5>qui</h5>Quisque rhoncus cursus felis vel elementum. Vestibulum dignissim molestie tortor nec facilisis. Praesent a nibh condimentum, porta nulla egestas, auctor eros</div>
|
|
|
|
<div id="radical"><h5>radical</h5>Etiam hendrerit interdum tellus, at aliquet sapien egestas in. Aenean eu urna nisl. Cras vitae risus pharetra, elementum mauris nec, auctor lectus. Fusce pellentesque venenatis dictum. Proin at augue at mauris finibus semper ultricies sed eros.</div>
|
|
|
|
<div id="silly"><h5>silly</h5>Praesent pulvinar consequat posuere. Morbi egestas rhoncus felis, id fermentum metus lobortis in. Vestibulum nibh orci, euismod eget vestibulum nec, vehicula vitae tortor. Aenean ullamcorper enim nunc, eu auctor ligula auctor eget.</div>
|
|
|
|
<div id="taffy"><h5>taffy</h5>Etiam et arcu vel lacus aliquet lobortis in in massa. Nunc non mollis elit. Aenean accumsan orci quis risus aliquam, non gravida nulla molestie. Mauris pharetra libero et magna aliquam aliquam. Integer quis luctus dolor. </div>
|
|
|
|
<div id="umbrella"><h5>umbrella</h5>Fusce molestie finibus malesuada. Nullam ac egestas quam, id venenatis ligula. Pellentesque pulvinar elit et vestibulum fringilla. Cras volutpat sed quam ornare scelerisque. Vivamus volutpat ante pretium scelerisque tempus. Etiam venenatis tempor nisl dignissim sollicitudin. Curabitur ac risus vitae dolor pretium posuere vel vitae diam. Donec in odio arcu.</div>
|
|
|
|
<div id="vampire"><h5>vampire</h5>Vestibulum pretium condimentum commodo. Integer placerat leo non ipsum ultrices, ac convallis elit varius. Vestibulum ultricies, justo eu rutrum molestie, quam arcu euismod sapien, vel gravida ipsum nulla eget erat. </div>
|
|
|
|
<div id="washington"><h5>washington</h5>Nunc ac quam eu risus dictum sodales. Nam ac risus iaculis, aliquet sem eu, mollis mauris. Curabitur pretium facilisis orci ut lacinia. Sed fermentum leo a odio blandit rutrum. Phasellus at nibh vel odio interdum vulputate ac eget urna. Nam eu arcu dapibus, sodales ligula nec, volutpat ipsum. Suspendisse auctor tellus vitae libero euismod venenatis. </div>
|
|
|
|
<div id="xylophone"><h5>xylophone</h5>Sed molestie lobortis ante sit amet hendrerit. Sed pharetra nisi sed interdum pulvinar. Nunc efficitur erat non aliquam mattis. Sed id nisl mattis lacus vehicula volutpat vitae vel massa. Curabitur interdum velit odio, vitae sollicitudin nunc rutrum non. </div>
|
|
|
|
<div id="yahoo"><h5>yahoo</h5>Nunc commodo consectetur scelerisque. Proin fermentum ligula ac quam finibus tincidunt. Aenean venenatis nisi et semper semper. Nunc sodales velit ipsum, ac pellentesque augue placerat eu.</div>
|
|
|
|
<div id="zeta"><h5>zeta</h5>Nullam ac suscipit odio. Curabitur viverra arcu ut egestas sollicitudin. Fusce sodales varius lectus ut tristique. Etiam eget nunc ornare, aliquet tortor eget, consequat mauris. Integer sit amet fermentum augue. </div>
|
|
|
|
<div id="alpha"><h5>alpha</h5>Praesent nec neque ac tellus sodales eleifend nec vel ipsum. Cras et semper risus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Integer mattis leo nisl, a tincidunt lectus tristique eget. Donec finibus lobortis viverra. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Vivamus egestas pulvinar odio non vehicula. Morbi malesuada leo eget nisl sagittis aliquet.</div>
|
|
|
|
|
|
<div id="beta"><h5>beta</h5>Mauris a libero vel enim pharetra interdum non a quam. Sed tincidunt ut elit sed dignissim. Suspendisse vitae tellus dapibus, fermentum lacus ac, fermentum lacus. Nam ante odio, fringilla ac elementum a, mollis sed tellus.</div>
|
|
|
|
<div id="cappa"><h5>cappa</h5>Nam molestie semper nulla et molestie. Ut facilisis, ipsum sed convallis posuere, mi mauris bibendum erat, nec egestas ipsum est nec dolor. </div>
|
|
|
|
<div id="dunno"><h5>dunno</h5>Etiam et metus congue, commodo libero et, accumsan sem. Aliquam erat volutpat. Quisque tincidunt, tortor non blandit ullamcorper, orci mauris dignissim augue, eget vehicula nulla justo sed dolor. Nunc ac urna quis nisi maximus pharetra in a mauris. Proin metus mi, venenatis vitae tristique sed, fermentum at purus. Aliquam erat volutpat. Maecenas efficitur sodales nibh, ac hendrerit felis facilisis et. Interdum et malesuada fames ac ante ipsum primis in faucibus.</div>
|
|
|
|
|
|
</div> <!-- end definition-box-container -->
|
|
</div> <!-- end col-md-3-->
|
|
</div> <!-- end small-box-links -->
|
|
</div> <!-- end row -->
|
|
</div> <!-- end container -->
|
|
|
|
|
|
{{site.data.alerts.note}} This was mostly an experiment to see if there was a better way to document a long JSON code example. I haven't actually used this approach in my own documentation.{{site.data.alerts.end}}
|
|
|
|
{% endif %}
|
|
|