diff options
| -rw-r--r-- | docs/development/assets.rst | 9 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | htdocs/README.rst | 123 |
3 files changed, 133 insertions, 0 deletions
diff --git a/docs/development/assets.rst b/docs/development/assets.rst new file mode 100644 index 0000000..533d8aa --- /dev/null +++ b/docs/development/assets.rst @@ -0,0 +1,9 @@ +Static Assets +============= + +Patchwork relies on a number of third-party JavaScript libraries. These, along +with their supporting assets and the Patchwork-only libraries and assets, are +described below. + +.. include:: ../../htdocs/README.rst + :start-line: 6 diff --git a/docs/index.rst b/docs/index.rst index 5a7bcda..6fd7590 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -50,6 +50,7 @@ of community projects. development/installation development/releasing development/api + development/assets .. _api-docs: diff --git a/htdocs/README.rst b/htdocs/README.rst new file mode 100644 index 0000000..513fb24 --- /dev/null +++ b/htdocs/README.rst @@ -0,0 +1,123 @@ +Static Assets +============= + +This directory contains the static assets used by Patchwork. Many of these are +third-party, though there are some are custom assets in there. + +.. _css: + +css +--- + +``bootstrap.min.css`` + + CSS for the `Bootstrap` library. + + Refer to the :ref:`js` section below for more information on `Bootstrap`. + +``selectize.bootstrap3.css`` + + CSS for the `Selectize` library. + + Refer to the :ref:`js` section below for more information on `Selectize`. + +``style.css`` + + Custom, Patchwork styling. Mostly a collection of overrides for default + Bootstrap styles. + + Part of Patchwork. + +.. _fonts: + +fonts +----- + +``glyphicons-halflings-regular.*`` + + Library of precisely prepared monochromatic icons and symbols, created with + an emphasis to simplicity and easy orientation. Provided as part of the + Bootstrap library. + + These are in multiple formats to support different browsers/environments. + Refer to the :ref:`js` section below for more information on Bootstrap. + +.. _js: + +js +-- + +``bootstrap.js`` + + The most popular HTML, CSS, and JavaScript framework for developing + responsive, mobile first projects on the web. + + This is used for the main UI of Patchwork. + + :Website: https://getbootstrap.com/ + :GitHub: https://github.com/twbs/bootstrap/ + :Version: 3.2.0 + +``bundle.js`` + + Utility functions for bundle patch list manipulation (re-ordering patches, + etc.) + + Part of Patchwork. + +``jquery.js`` + + jQuery is a fast, small, and feature-rich JavaScript library. It makes things + like HTML document traversal and manipulation, event handling, animation, and + Ajax much simpler with an easy-to-use API that works across a multitude of + browsers. With a combination of versatility and extensibility, jQuery has + changed the way that millions of people write JavaScript. + + This is used across Patchwork, including by the likes of ``bundle.js``, as + well as by the various plugins below. + + :Website: https://jquery.com/ + :GitHub: https://github.com/jquery/jquery + :Version: 1.10.1 + +``jquery.checkboxes.js`` + + A jQuery plugin that gives you nice powers over your checkboxes. + + This is used to allow shift-select of checkboxes on the patch list page. + + :Website: http://rmariuzzo.github.io/checkboxes.js + :GitHub: https://github.com/rmariuzzo/checkboxes.js + :Version: 1.0.6 + +``jquery.stickytableheaders.js`` + + A jQuery plugin that makes large tables more usable by having the table + header stick to the top of the screen when scrolling. + + This is used to ensure the heads on the patch list page stay at the top as we + scroll. + + :GitHub: https://github.com/jmosbech/StickyTableHeaders + :Version: 0.1.19 + +``jquery.tablednd.js`` + + jQuery plug-in to drag and drop rows in HTML tables. + + This is used by the bundle patch list to allow us to control the order of the + patches in said bundle. + + :Website: http://www.isocra.com/2008/02/table-drag-and-drop-jquery-plugin/ + :GitHub: jQuery plug-in to drag and drop rows in HTML tables + :Version: ??? + +``selectize.min.js`` + + Selectize is the hybrid of a ``textbox`` and ``<select>`` box. It's jQuery + based and it has autocomplete and native-feeling keyboard navigation; useful + for tagging, contact lists, etc. + + :Website: https://selectize.github.io/selectize.js/ + :GitHub: https://github.com/selectize/selectize.js + :Version: 0.11.2 |