X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fwhitepaper.markdown;h=334cc2c4b89acde0445cad2e0e68c620e2fd0e67;hb=707529a09e5f8c51f3fdb17f6c72b8b6c9ccab24;hp=1921c31aa94a351725a15dd73af0c35ae82e810c;hpb=cf1d2c2bbca1b778dad39bcee7259bd91fb21ffe;p=mkws-moved-to-github.git diff --git a/tools/htdocs/whitepaper.markdown b/tools/htdocs/whitepaper.markdown index 1921c31..334cc2c 100644 --- a/tools/htdocs/whitepaper.markdown +++ b/tools/htdocs/whitepaper.markdown @@ -1,6 +1,6 @@ % Embedded metasearching with the MasterKey Widget Set % Mike Taylor -% 26 July 2013 +% July-September 2013 Introduction @@ -191,30 +191,54 @@ containers. The structures used by the widget-set are described in the reference guide below. -Message of the day ------------------- +Refinements +----------- - \ - \ +### Message of the day -Responsive design ------------------ +Some applications might like to open with content in the area that +will subsequently be filled with result-records -- a message of the +day, a welcome message or a help page. This can be done by placing an +`mkwsMOTDContainer` division on the page next to `mkwsResults` or +`mkwsRecords`. The contents of this element are initially displayed, +but will be hidden when a search is made. - responsive_design: true - responsive_design_width: 500 -
-
+### Responsive design -Popup results with jQuery UI ----------------------------- +Metasearching applications may need to appear differently on +small-screened mobile devices, or change their appearance when +screen-width changes (as when a small device is rotated). To achieve +this, MKWS supports responsive design which will move the termlists to +the bottom on narrow screens and to the sidebar on wide screens. + +To turn on this behaviour, set the `responsive_design` configuration +element to `true`, and `responsive_design_width` to the desired +threshhold width in pixels. For example: + + + +If individual result-related components are in use in place of the +all-in-one mkwsResults, then the redesigned application needs to +specify the locations where the termlists should appear in both +cases. In this case, wrap the wide-screen `mkwsTermlists` element in a +`mkwsTermlistContainer1` element; and provide an +`mkwsTermlistContainer2` element in the place where the narrow-screen +termlists should appear. + + +### Popup results with jQuery UI TODO -Authentication and target configuration ---------------------------------------- +### Authentication and target configuration TODO