Requirements

Enter Project Requirements Here

Optional Dependencies

Enter Project Optional Dependencies Here

Notable Features

Enter Notable Features Here

Browser Support

Enter Browser Support Here

Getting Started

Custom Download

Note: All of the plugin files are in the src directory (this includes both the JavaScript and CSS files). If you want to see an example page with all of the files included, look in the demos directory.

CSS

Enter CSS Instructions Here

		  	
 * Author: @gregfranko
 */

/* The Table of Contents container element */
#toc {
    width: 20%;
    max-height: 90%;
    overflow: auto;
    position: fixed;
    border: 0px solid #ccc;
    webkit-border-radius: 6px;
    moz-border-radius: 6px;
    border-radius: 6px;
}

/* The Table of Contents is composed of multiple nested unordered lists.  These styles remove the default styling of an unordered list because it is ugly. */
#toc ul, #toc li {
    list-style: none;
    margin: 0;
    padding: 0;
    border: none;
    line-height: 30px;
}

		  
          

JavaScript

Enter JavaScript Instructions Here

          
		  
;(function () {

  var
    object = typeof window != 'undefined' ? window : exports,
    chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=',
    INVALID_CHARACTER_ERR = (function () {
      // fabricate a suitable error object
      try { document.createElement('$'); }
      catch (error) { return error; }}());

  // encoder
  // [https://gist.github.com/999166] by [https://github.com/nignag]
  object.btoa || (
  object.btoa = function (input) {
    for (
      // initialize result and counter
      var block, charCode, idx = 0, map = chars, output = '';
      // if the next input index does not exist:
      //   change the mapping table to "="
      //   check if d has no fractional digits
      input.charAt(idx | 0) || (map = '=', idx % 1);
      // "8 - idx % 1 * 8" generates the sequence 2, 4, 6, 8
      output += map.charAt(63 & block >> 8 - idx % 1 * 8)
    ) {
      charCode = input.charCodeAt(idx += 3/4);
      if (charCode > 0xFF) throw INVALID_CHARACTER_ERR;
      block = block << 8 | charCode;
    }
    return output;
  });

  // decoder
  // [https://gist.github.com/1020396] by [https://github.com/atk]
  object.atob || (
  object.atob = function (input) {
    input = input.replace(/=+$/, '')
    if (input.length % 4 == 1) throw INVALID_CHARACTER_ERR;
    for (
      // initialize result and counters
      var bc = 0, bs, buffer, idx = 0, output = '';
      // get next character
      buffer = input.charAt(idx++);
      // character found in table? initialize bit storage and add its ascii value;
      ~buffer && (bs = bc % 4 ? bs * 64 + buffer : buffer,
        // and if not first of each 4 characters,
        // convert the first 8 bits to one ascii character
        bc++ % 4) ? output += String.fromCharCode(255 & bs >> (-2 * bc & 6)) : 0
    ) {
      // try to find character in table (0-63, not found => -1)
      buffer = chars.indexOf(buffer);
    }
    return output;
  });

}());

		  
          

Options

Enter Options Instructions Here

Options

Name	Type	Default	Parameters
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here
Option Name	Enter Option Type Here	Enter Option Default Here	Enter Option Parameters Here

Contributing

Take care to maintain the existing coding style. Add Enter Unit Testing Framework unit tests for any new or changed functionality. Lint and test your code using Enter Build Tool Here.

After you have verified your code, send a pull request to the Enter Project Name Here develop branch. After you send a pull request, you will hear back from me shortly after I review your code. You’ll find source code in the src subdirectory!

Extending

If you find that you need a feature that Enter Project Name Here does not currently support, either let me know via the Github issue tracker, or fork the project and and easily extend Enter Project Name Here!

Copyright

Copyright © 2013 Greg Franko