Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

small fixes #3

Open
wants to merge 3 commits into from

1 participant

Jing Dong
Jing Dong

Hi,
I have made some small fixes for your current release, mainly related to HTML validation.

- removed a few unmatched tags
- replace the paragraph

with

so that the W3C validates the index.html
Have you found solution for fixing the issue raised in the issue tracker? What I found was that I am able to run the HTML version in Google Chrome using HTTP  protocol instead of FILE. 

Hope this helps. 

Cheers,
J

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
2  css/main.css
View
@@ -299,7 +299,7 @@ body {
font-size: 1.3em;
line-height: 16px;
}
-.entry div.longdesc p { margin-bottom: 1em; }
+.entry div.longdesc .section { margin-bottom: 1em; }
.entry div.longdesc ol {
list-style: decimal;
margin: 0 50px 16px 50px;
2  css/main.min.css
View
@@ -1,4 +1,4 @@
/* http://meyerweb.com/eric/tools/css/reset/ */
html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,font,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td{margin:0;padding:0;border:0;outline:0;font-size:100%;vertical-align:baseline;background:transparent}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:'';content:none}:focus{outline:0}ins{text-decoration:none}del{text-decoration:line-through}table{border-collapse:collapse;border-spacing:0}
-html{font-size:16px}body{ font-size:62.5%; font-family:"Helvetica Neue",Arial,sans-serif; color:#333; background:white; overflow:hidden}#loader{ background:url(../images/loader.gif) no-repeat center center; width:100%; height:100%; min-height:300px}#feedback-overlay{ background:rgba(0,0,0,0.6); position:fixed; top:0; left:0; display:none; z-index:13}#feedback-overlay a{ color:white; font-size:1.4em; text-decoration:none; position:absolute; top:30px}#feedback-overlay a:hover{text-decoration:underline}#feedback-window{ position:fixed; top:50px; width:920px; background:white; display:none; z-index:23}#feedback-window iframe{ width:100%; height:100%}#topnav{ position:absolute; top:5px; right:30px}#topnav li{float:left}#topnav li a{ background:#ffec86; padding:5px 10px 7px 10px; color:#333; font-size:1.1em; text-decoration:none}#topnav li a:hover{ background:#ffe25f; color:black}#topnav li #home{ border-right:1px solid #cfba5a; border-radius-bottomleft:5px; -moz-border-radius-bottomleft:5px; -webkit-border-bottom-left-radius:5px}#topnav li #feedback{ border-left:1px solid white; border-radius-bottomright:5px; -moz-border-radius-bottomright:5px; -webkit-border-bottom-right-radius:5px}.item li.sub{background:white}.item li.sub a{ text-decoration:none; color:#333}.item li.sub a span{ background:none; margin:0; padding:5px 0 0 25px; display:block}.item li.sub a span .highlight{text-decoration:underline}.item li.sub a span.desc{ color:#aaa; font-size:0.8em; width:30000px; overflow:hidden; padding:4px 0 5px 25px; min-height:12px}.item li.sub a span.desc .highlight{ text-decoration:none; font-weight:normal}.item li.sub:hover{background:#dfdfdf}.item li.odd{background:#edf3fe}.item li.selected{background:#3875d7}.item li.selected span{color:white}.item li.selected:hover{background:#0069c1}#navigation{ float:left; width:20%; overflow:hidden; font-size:1.3em}#navigation #search{ padding:4px; background:#e8e8e8; border-bottom:1px solid #ddd; border-right:1px solid #aaa}#navigation #static-list{ overflow:auto; overflow-x:hidden; border-right:1px solid #aaa}#navigation #static-list li.category{border-bottom:1px solid #ddd}#navigation #static-list li.category span{ background:url(../images/arrow.png) 0 0 no-repeat #eee; padding:7px 0 7px 25px; display:block; cursor:pointer}#navigation #static-list li.category ul{display:none}#navigation #static-list li.category:hover span{background-position:0 -27px}#navigation #static-list li.open span{background-position:0 -54px}#navigation #static-list li.open:hover span{background-position:0 -54px}#navigation #static-list li.cat-selected span{background-position:0 -27px}#navigation #static-list li.sub{background:white}#navigation #static-list li.sub a{ text-decoration:none; color:#333}#navigation #static-list li.sub a span{ background:none; margin:0; padding:5px 0 0 25px; display:block}#navigation #static-list li.sub a span .highlight{text-decoration:underline}#navigation #static-list li.sub a span.desc{ color:#aaa; font-size:0.8em; width:30000px; overflow:hidden; padding:4px 0 5px 25px; min-height:12px}#navigation #static-list li.sub a span.desc .highlight{ text-decoration:none; font-weight:normal}#navigation #static-list li.sub:hover{background:#dfdfdf}#navigation #static-list li.odd{background:#edf3fe}#navigation #static-list li.selected{background:#3875d7}#navigation #static-list li.selected span{color:white}#navigation #static-list li.selected:hover{background:#0069c1}#navigation #results{ border-right:1px solid #aaa; display:none; overflow-x:hidden}#navigation #results li.sub{background:white}#navigation #results li.sub a{ text-decoration:none; color:#333}#navigation #results li.sub a span{ background:none; margin:0; padding:5px 0 0 25px; display:block}#navigation #results li.sub a span .highlight{text-decoration:underline}#navigation #results li.sub a span.desc{ color:#aaa; font-size:0.8em; width:30000px; overflow:hidden; padding:4px 0 5px 25px; min-height:12px}#navigation #results li.sub a span.desc .highlight{ text-decoration:none; font-weight:normal}#navigation #results li.sub:hover{background:#dfdfdf}#navigation #results li.odd{background:#edf3fe}#navigation #results li.selected{background:#3875d7}#navigation #results li.selected span{color:white}#navigation #results li.selected:hover{background:#0069c1}#content{ float:left; width:80%; overflow:auto}#content h1{ font-size:1.8em; font-weight:normal}#content h3{ font-size:1.8em; font-weight:normal}#content a{ color:#00f; text-decoration:none}#content a:hover{ background:#ffec86; color:#444}.entry-title{ background:#ecf3fe; padding:15px 30px 10px 20px}.entry-title .entry-meta{display:none}.toc{ background:#ecf3fe; font-size:1.1em; padding:0 30px 10px 30px; line-height:14px}.toc legend{display:none}.entry{padding:20px 40px 20px 40px}.entry h2{ margin-bottom:10px; padding-bottom:8px; border-bottom:1px solid #333}.entry h2 span.name{font-size:2em}.entry h2 span.returns{ color:#666; font-size:1.1em; padding-left:12px}.entry h3{padding:14px 0 14px 0}.entry h4.name{display:none}.entry pre{ background:#fffce8; padding:10px; line-height:16px; margin:0 10px 20px 10px; font-family:'Courier New','Terminal',monospace; font-size:12px}.entry p.desc{ font-size:1.3em; background:#eee; border:1px dotted #ccc; padding:6px; margin-bottom:10px}.entry p.desc strong{display:none}.entry .signatures{ font-size:1.3em; background:#ebf3fe; margin-bottom:30px}.entry .signatures li .arguement{ position:relative; padding:10px 0 10px 200px; line-height:16px}.entry .signatures li .arguement strong{ display:block; position:absolute; left:10px; top:10px}.entry .signatures li .arguement-odd{background:#dfedff}.entry .signatures li .options{ margin:0 20px 0 20px; border:1px solid #bfdcff; padding:20px}.entry .signatures li .options h5{ color:#143e6f; border-bottom:1px dotted #bfdcff; padding-bottom:4px; margin-bottom:5px}.entry .signatures li .options h5 span{padding-left:20px}.entry .signatures li .options .default-value{padding:5px 20px 5px 20px}.entry .signatures li .options p{ line-height:16px; padding:0 20px 1em 20px}.entry .signatures li .options ul{ list-style:disc; padding:0 20px 16px 80px}.entry .signatures li .options ul li{ margin-bottom:14px; line-height:16px}.entry div.longdesc{ font-size:1.3em; line-height:16px}.entry div.longdesc p{margin-bottom:1em}.entry div.longdesc ol{ list-style:decimal; margin:0 50px 16px 50px; padding:10px 10px 10px 40px; background:#fafafa}.entry div.longdesc ol li{margin-bottom:8px}.entry div.longdesc h4{padding:1em 0 1em 0}.entry div.longdesc p.image{ text-align:center; border:2px solid #eee; padding:5px}.entry div.longdesc p.image img{vertical-align:top}.entry .entry-examples{font-size:1.3em}.entry .entry-examples h4{margin-bottom:1em}.entry .entry-examples pre{border:1px dotted #ffe0bb}.entry .entry-examples .code-demo{ border:2px solid #ffe0bb; padding:2px; margin:0 10px 30px 10px}
+html{font-size:16px}body{ font-size:62.5%; font-family:"Helvetica Neue",Arial,sans-serif; color:#333; background:white; overflow:hidden}#loader{ background:url(../images/loader.gif) no-repeat center center; width:100%; height:100%; min-height:300px}#feedback-overlay{ background:rgba(0,0,0,0.6); position:fixed; top:0; left:0; display:none; z-index:13}#feedback-overlay a{ color:white; font-size:1.4em; text-decoration:none; position:absolute; top:30px}#feedback-overlay a:hover{text-decoration:underline}#feedback-window{ position:fixed; top:50px; width:920px; background:white; display:none; z-index:23}#feedback-window iframe{ width:100%; height:100%}#topnav{ position:absolute; top:5px; right:30px}#topnav li{float:left}#topnav li a{ background:#ffec86; padding:5px 10px 7px 10px; color:#333; font-size:1.1em; text-decoration:none}#topnav li a:hover{ background:#ffe25f; color:black}#topnav li #home{ border-right:1px solid #cfba5a; border-radius-bottomleft:5px; -moz-border-radius-bottomleft:5px; -webkit-border-bottom-left-radius:5px}#topnav li #feedback{ border-left:1px solid white; border-radius-bottomright:5px; -moz-border-radius-bottomright:5px; -webkit-border-bottom-right-radius:5px}.item li.sub{background:white}.item li.sub a{ text-decoration:none; color:#333}.item li.sub a span{ background:none; margin:0; padding:5px 0 0 25px; display:block}.item li.sub a span .highlight{text-decoration:underline}.item li.sub a span.desc{ color:#aaa; font-size:0.8em; width:30000px; overflow:hidden; padding:4px 0 5px 25px; min-height:12px}.item li.sub a span.desc .highlight{ text-decoration:none; font-weight:normal}.item li.sub:hover{background:#dfdfdf}.item li.odd{background:#edf3fe}.item li.selected{background:#3875d7}.item li.selected span{color:white}.item li.selected:hover{background:#0069c1}#navigation{ float:left; width:20%; overflow:hidden; font-size:1.3em}#navigation #search{ padding:4px; background:#e8e8e8; border-bottom:1px solid #ddd; border-right:1px solid #aaa}#navigation #static-list{ overflow:auto; overflow-x:hidden; border-right:1px solid #aaa}#navigation #static-list li.category{border-bottom:1px solid #ddd}#navigation #static-list li.category span{ background:url(../images/arrow.png) 0 0 no-repeat #eee; padding:7px 0 7px 25px; display:block; cursor:pointer}#navigation #static-list li.category ul{display:none}#navigation #static-list li.category:hover span{background-position:0 -27px}#navigation #static-list li.open span{background-position:0 -54px}#navigation #static-list li.open:hover span{background-position:0 -54px}#navigation #static-list li.cat-selected span{background-position:0 -27px}#navigation #static-list li.sub{background:white}#navigation #static-list li.sub a{ text-decoration:none; color:#333}#navigation #static-list li.sub a span{ background:none; margin:0; padding:5px 0 0 25px; display:block}#navigation #static-list li.sub a span .highlight{text-decoration:underline}#navigation #static-list li.sub a span.desc{ color:#aaa; font-size:0.8em; width:30000px; overflow:hidden; padding:4px 0 5px 25px; min-height:12px}#navigation #static-list li.sub a span.desc .highlight{ text-decoration:none; font-weight:normal}#navigation #static-list li.sub:hover{background:#dfdfdf}#navigation #static-list li.odd{background:#edf3fe}#navigation #static-list li.selected{background:#3875d7}#navigation #static-list li.selected span{color:white}#navigation #static-list li.selected:hover{background:#0069c1}#navigation #results{ border-right:1px solid #aaa; display:none; overflow-x:hidden}#navigation #results li.sub{background:white}#navigation #results li.sub a{ text-decoration:none; color:#333}#navigation #results li.sub a span{ background:none; margin:0; padding:5px 0 0 25px; display:block}#navigation #results li.sub a span .highlight{text-decoration:underline}#navigation #results li.sub a span.desc{ color:#aaa; font-size:0.8em; width:30000px; overflow:hidden; padding:4px 0 5px 25px; min-height:12px}#navigation #results li.sub a span.desc .highlight{ text-decoration:none; font-weight:normal}#navigation #results li.sub:hover{background:#dfdfdf}#navigation #results li.odd{background:#edf3fe}#navigation #results li.selected{background:#3875d7}#navigation #results li.selected span{color:white}#navigation #results li.selected:hover{background:#0069c1}#content{ float:left; width:80%; overflow:auto}#content h1{ font-size:1.8em; font-weight:normal}#content h3{ font-size:1.8em; font-weight:normal}#content a{ color:#00f; text-decoration:none}#content a:hover{ background:#ffec86; color:#444}.entry-title{ background:#ecf3fe; padding:15px 30px 10px 20px}.entry-title .entry-meta{display:none}.toc{ background:#ecf3fe; font-size:1.1em; padding:0 30px 10px 30px; line-height:14px}.toc legend{display:none}.entry{padding:20px 40px 20px 40px}.entry h2{ margin-bottom:10px; padding-bottom:8px; border-bottom:1px solid #333}.entry h2 span.name{font-size:2em}.entry h2 span.returns{ color:#666; font-size:1.1em; padding-left:12px}.entry h3{padding:14px 0 14px 0}.entry h4.name{display:none}.entry pre{ background:#fffce8; padding:10px; line-height:16px; margin:0 10px 20px 10px; font-family:'Courier New','Terminal',monospace; font-size:12px}.entry p.desc{ font-size:1.3em; background:#eee; border:1px dotted #ccc; padding:6px; margin-bottom:10px}.entry p.desc strong{display:none}.entry .signatures{ font-size:1.3em; background:#ebf3fe; margin-bottom:30px}.entry .signatures li .arguement{ position:relative; padding:10px 0 10px 200px; line-height:16px}.entry .signatures li .arguement strong{ display:block; position:absolute; left:10px; top:10px}.entry .signatures li .arguement-odd{background:#dfedff}.entry .signatures li .options{ margin:0 20px 0 20px; border:1px solid #bfdcff; padding:20px}.entry .signatures li .options h5{ color:#143e6f; border-bottom:1px dotted #bfdcff; padding-bottom:4px; margin-bottom:5px}.entry .signatures li .options h5 span{padding-left:20px}.entry .signatures li .options .default-value{padding:5px 20px 5px 20px}.entry .signatures li .options p{ line-height:16px; padding:0 20px 1em 20px}.entry .signatures li .options ul{ list-style:disc; padding:0 20px 16px 80px}.entry .signatures li .options ul li{ margin-bottom:14px; line-height:16px}.entry div.longdesc{ font-size:1.3em; line-height:16px}.entry div.longdesc .section{margin-bottom:1em}.entry div.longdesc ol{ list-style:decimal; margin:0 50px 16px 50px; padding:10px 10px 10px 40px; background:#fafafa}.entry div.longdesc ol li{margin-bottom:8px}.entry div.longdesc h4{padding:1em 0 1em 0}.entry div.longdesc p.image{ text-align:center; border:2px solid #eee; padding:5px}.entry div.longdesc p.image img{vertical-align:top}.entry .entry-examples{font-size:1.3em}.entry .entry-examples h4{margin-bottom:1em}.entry .entry-examples pre{border:1px dotted #ffe0bb}.entry .entry-examples .code-demo{ border:2px solid #ffe0bb; padding:2px; margin:0 10px 30px 10px}
65 index.html
View
@@ -27,104 +27,105 @@
<div class="entry">
<h2><span class="name">Why another jQuery Documentation?</span><span class="returns">Solving your own problems is so much fun.</span></h2>
<div class="longdesc">
- <p>
+ <div class="section">
There are numerous alternative jQuery documentations out there, such as <a href="http://api.jquery.com/browser/">jQuery API Browser</a>,
<a href="http://remysharp.com/jquery-api/">jQuery API</a>, <a href="http://api.jquery.com/visual/">Visual jQuery</a> and another
<a href="http://view.jquery.com/trunk/tools/api-browser/">jQuery API Browser</a>. They are all out of date. The latest
<a href="http://api.jquery.com/">official documentation</a> has been <a href="http://jquery14.com/day-09/jquery-api-key-navigation">released</a>
in the <a href="http://jquery14.com/">14 days of jQuery</a>. Why the heck another one?
- </p>
- <p>
+ </div>
+ <div class="section">
The jQuery documentation is great, very complete, nicely written and with a lot of examples and demos. The only thing that bugs me is the
way we have to find the right documentation for what we search for. Try to search for the <code>.is()</code> function for example. Over 100 matches
before the actual function I am looking for?!<i>*)</i> And it is a fixed layout which means even on my big screen I have to scroll all the way down and have
to scan for it. There have to be a better way, obviously.
- </p>
- <p>
+ </div>
+ <div class="section">
The alternative <a href="http://rubyonrails.org/">Rails</a> documentation <a href="http://railsapi.com/">Rails API</a> is my favorite documentation
for my favorite server-side tool. Unfortunately my favorite client-side tool did not have such a fast and slick documentation. Inspired by
the Rails API and desperate for a better navigation I coded one myself. Of course with jQuery!
- </p>
- <p>
+ </div>
+ <div class="section">
Just to make it clear, I only coded the navigation and re-styled the documentation. The content is the same as in the
<a href="http://api.jquery.com/">official documentation</a> and all credits belong to the jQuery team. Keep up the great work!
- </p>
- <p>
+ </div>
+ <div class="section">
<i>*) Edit: it is the first search result when you enter it with brackets.</i>
- </p>
+ </div>
</div>
</div>
<div class="entry">
<h2><span class="name">jQAPI offline version</span><span class="returns">Documentation for the road.</span></h2>
<div class="longdesc">
- <p><a href="jqapi-latest.zip">Download HTML Version</a>. Documentation for jQuery version 1.4.2 - 1.6MB - 07/11/10</a></p>
- <p><a href="http://github.com/downloads/erikzaadi/jqapi/jQAPI-1.4.2.air?v=11072010">Download AIR Version</a>. Documentation for jQuery version 1.4.2 - 1.5MB - 07/11/10</p>
+ <div class="section"><a href="jqapi-latest.zip">Download HTML Version</a>. Documentation for jQuery version 1.4.2 - 1.6MB - 07/11/10</div>
+ <div class="section"><a href="http://github.com/downloads/erikzaadi/jqapi/jQAPI-1.4.2.air?v=11072010">Download AIR Version</a>. Documentation for jQuery version 1.4.2 - 1.5MB - 07/11/10</div>
</div>
</div>
<div class="entry">
<h2><span class="name">Keyboard Usage</span><span class="returns">Speed it up.</span></h2>
<div class="longdesc">
- <p>
+ <div class="section">
The keys are working if the search field has focus or your mouse cursor is in the navigation area. ESC key is global.
-<pre><code>UP - Previous category / Previous item
+ <pre>
+ <code>UP - Previous category / Previous item
DOWN - Next category / Next item
ENTER - Open category / Load selected item
-ESC - Clear search field and set focus</code></pre>
- </p>
+ESC - Clear search field and set focus</code>
+ </pre>
+ </div>
</div>
</div>
<div class="entry">
<h2><span class="name">Credits</span><span class="returns">And props.</span></h2>
<div class="longdesc">
- <p>
+ <div class="section">
<a href="http://jquery.com">jQuery</a>, <a href="http://api.jquery.com/">jQuery documentation</a>,
<a href="http://railsapi.com/">Rails API</a>,
<a href="http://devthought.com/blog/client-side/2009/04/javascript-regexp-based-highlighting-function-for-mootools-and-jquery/">Highlight Plugin</a>,
- <a href="http://benalman.com/">'Cowboy' Ben Alman</a>: <a href="http://benalman.com/projects/jquery-bbq-plugin/">BBQ Plugin</a> /
- <a href="http://benalman.com/projects/jquery-dotimeout-plugin/">doTimeout Plugin</a> / Feedback,
+ <a href="http://benalman.com/">'Cowboy' Ben Alman</a>: <a href="http://benalman.com/projects/jquery-bbq-plugin/">BBQ Plugin</a> &#48;
+ <a href="http://benalman.com/projects/jquery-dotimeout-plugin/">doTimeout Plugin</a> &#48; Feedback,
<a href="http://yayquery.com/">yayQuery</a>,
<a href="http://technikwuerze.de/podcast/technikwuerze163/">Technikwuerze</a>,
<a href="http://erikzaadi.com/">Erik Zaadi</a>: building the AIR app,
<a href="http://search.twitter.com/search?q=jqapi">Tweople for spreding the word and their feedback</a>, Beer. To be continued (hopefully).
- </p>
+ </div>
</div>
</div>
<div class="entry">
<h2><span class="name">Help</span><span class="returns">If you want something done right, do it yourself.</span></h2>
<div class="longdesc">
- <p>
+ <div class="section">
Any idea and feedback to make this a better navigation for the documentation is very welcome.
Please use the <a href="http://jqapi.uservoice.com/forums/39654" id="feedback-trigger">feedback forum</a>.
- </p>
- <p>
+ </div>
+ <div class="section">
This project is open source and hosted at Github: <a href="http://github.com/mustardamus/jqapi">http://github.com/mustardamus/jqapi</a>.
- Feel free to implement or extend the features you want. Just send a fork request, if your code changes makes the site better I am happy
- to deploy it and give you credit.
- </p>
+ Feel free to implement or extend the features you want. Just send a fork request, if your code changes makes the site better I am happy to deploy it and give you credit.
+ </div>
</div>
</div>
<div class="entry">
<h2><span class="name">To Do</span><span class="returns">What is still on the list.</span></h2>
<div class="longdesc">
- <p>
+ <div class="section">
<ol>
<li>Fix links to other pages.</li>
<li>Make a page for the different return types and fix the links.</li>
<li>Auto scroll the navigation when keys are used.</li>
</ol>
- </p>
+ </div>
</div>
</div>
<div class="entry">
<h2><span class="name">Changelog</span><span class="returns">jQAPI history.</span></h2>
<div class="longdesc">
- <p>
+ <div class="section">
<pre><code>[07/11/10] Updated to jQuery 1.4.2, BBQ 1.2.1, doTimeout 1.0
[03/20/10] Refactored code.
Replaced feedback badge with a normal link.
@@ -138,17 +139,17 @@
History is working.
[01/31/10] Complete rewrite with Ajax magic, better keyboard support and faster search.
[01/29/10] Released hacked together version with good ol' iframes. (<a href="http://github.com/mustardamus/jquery-api-self">repo</a>)</code></pre>
- </p>
+ </div>
</div>
</div>
<div class="entry">
<h2><span class="name">Contact</span><span class="returns">Aka 'I haven't found another place to stick all the links I want you to go to'.</span></h2>
<div class="longdesc">
- <p>
+ <div class="section">
Coded by <a href="http://mustardamus.com">Sebastian Senf</a> (<a href="http://twitter.com/mustardamus">@mustardamus</a>) -
<a href="http://usejquery.com">Use jQuery</a> Community Showcase and Blog (<a href="http://twitter.com/usejquery">@usejquery</a>)
- </p>
+ </div>
</div>
</div>
</div>
BIN  jqapi-latest.zip
View
Binary file not shown
Something went wrong with that request. Please try again.