X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;ds=sidebyside;f=doc%2Fmkws-manual.markdown;h=f6dc7ae99e58f9c669529c80bc566a4fc0b5d874;hb=4fd29d268689e90626029cf74498ddd18c5b2296;hp=5e7b617ec030a52a2a7c6d5edbea93a303c227c4;hpb=0ec7faad75a434d3605553285c8bdd1521fd1d78;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 5e7b617..f6dc7ae 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 ----------- @@ -266,7 +267,7 @@ etc., customised layouts may wish to treat each of these components separately. In this case, `mkws-results` can be omitted, and the following lower-level widgets provided instead: -* `mkws-termlists` -- provides the facets +* `mkws-facets` -- provides the facets * `mkws-ranking` -- provides the options for how records are sorted and how many are included on each page of results. @@ -646,73 +647,196 @@ added: see the [MKWS developers' guide](mkws-developer.html).) ---- Name Description ---- ----------- -`auth-name` x - -`builder` x - -`button` x - -`categories` x - -`config` x - -`console-builder` x - -`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 +`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` The search button. Usually generated a `search` + widget. + +`categories` Obtains from the Service Proxy a list of the target + categories associated with the library in use, and + displays them in a drop-down list. When a category + is selected, searches are limited to the targets + that are part of that category. + +`config` This widget has no functionality of its own, but its + configuration is copied up into its team, allowing + it to affect other widgets in the team. This is the + only way to set configuration items at the team + level. + +`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` Displays cover art for a book by searching in + Amazon. Often used with an `autosearch` attribute to + indicate what book to display. For example, + `` + displays cover art for _All Yesterdays: Unique and + Speculative Views of Dinosaurs and Other Prehistoric + Animals_. + For this widget to work, a library that includes the + AmazonBooks target must be used. For example, the + "DEMO AmazonBooks for MKWS" account, which can be + selected with `sp_auth_credentials="mkws-amazon/mkws"`. + +`details` This widget is generated by the toolkit itself to + hold the full details of records that are initially + listed in summary form. + +`done` Initially empty, this widget is set to display + "Search complete: found _n_ records" when all + targets have completed their work, either returning + a hit-count or an error. The message displayed can + be changed by overriding the `done` template using + `