X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=46f507c4bc9b0f9baf52653c56f2ab556d63f964;hb=fc6dc0499a3e9911e516ce1345e2293616bb4234;hp=2ccc9beec14dd0156a22e671483c178beea7cd15;hpb=4416bf8226923c047630fa0f5e219ed96fe72f01;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 2ccc9be..46f507c 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -150,7 +150,8 @@ To see all of these working together, just put them all into the HTML
The full set of supported widgets is described in the -reference guide below. +reference guide +[below](#widgets). Widget team ----------- @@ -637,6 +638,96 @@ attribute as follows: Reference guide =============== +Widgets +------- + +The following widgets are provided in the core set. (Others can be +added: see the [MKWS developers' guide](mkws-developer.html).) + +---- +Name Description +---- ----------- +`auth-name` Initially empty, it updates itself to shows the name + of the library that the application is logged in as + when authentication is complete. + +`builder` A button which, when pressed, analyses the current + settings of the team that it is a part of, and + generates the HTML for an auto-searching element + that will replicate the present search. This HTML is + displayed in an alert box: it is intended that this + widget be subclassed to store the generated widget + definitions in more useful places. + +`button` x + +`categories` x + +`config` x + +`console-builder` Like the `builder` widget, but emits the generated + HTML on the JavaScript console. This exists to + provide an example of how to subclass the `builder` + widget. + +`cover-art` x + +`details` x + +`done` x + +`facet` x + +`google-image` x + +`images` x + +`lang` x + +`log` x + +`lolcat` x + +`motd-container` x + +`motd` x + +`navi` x + +`pager` x + +`per-page` x + +`progress` x + +`query` x + +`ranking` x + +`record` x + +`records` x + +`reference` x + +`results` x + +`search-form` x + +`search` x + +`sort` x + +`stat` x + +`switch` x + +`targets` x + +`termlists` x +---- + + Configuration object --------------------