Merge remote-tracking branch 'origin/master' into wosch
authorWolfram Schneider <wosch@indexdata.dk>
Fri, 23 Aug 2013 09:19:44 +0000 (11:19 +0200)
committerWolfram Schneider <wosch@indexdata.dk>
Fri, 23 Aug 2013 09:19:44 +0000 (11:19 +0200)
Conflicts:
examples/htdocs/index-wolfram.html

examples/htdocs/index-full.html
examples/htdocs/index-lowlevel.html
examples/htdocs/index-mike.html
examples/htdocs/index-mobile.html
examples/htdocs/index-popup.html
examples/htdocs/index-wolfram.html
tools/apache2/mkws-live
tools/htdocs/README.markdown
tools/htdocs/mkws.js
tools/htdocs/whitepaper.markdown

index 0168239..45d6b7d 100644 (file)
@@ -11,7 +11,6 @@
                lang: "da",
                debug: 1,
                use_service_proxy: true,
-               switch_menu: true,
                lang_menu: true,
                sort_default: "relevance",
                query_width: 50,
index 15a453a..4b04393 100644 (file)
@@ -3,9 +3,6 @@
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>MKWS demo: low-level subcomponents</title>
     <link rel="stylesheet" type="text/css" href="http://mkws.indexdata.com/mkwsStyle.css" />
-    <script type="text/javascript">
-      var mkws_config = { switch_menu: true };
-    </script>
     <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
     <style type="text/css">
       #mkwsTermlists div.facet {
index 0a8bb12..a2776c1 100644 (file)
@@ -7,7 +7,6 @@
       var mkws_config = {
        responsive_design: true,
        responsive_design_width: 600,
-       switch_menu: true,
         service_proxy_auth: "/service-proxy-auth-mike"
       };
     </script>
@@ -16,7 +15,7 @@
     <script type="text/javascript" src="http://x.mkws.indexdata.com/mkws.js"></script>
   </head>
   <body>
-    <div id="mkwsSwitch"></div><!-- optional, must be enabled by switch_menu:true  -->
+    <div id="mkwsSwitch"></div><!-- optional -->
     <div id="mkwsLang"></div><!-- optional -->
     <div id="mkwsSearch"></div><!-- MANDATORY -->
     <div id="mkwsResults"></div><!-- MANDATORY but components may be used -->
index cd5aad9..45a735d 100644 (file)
@@ -11,7 +11,6 @@
                lang: "da",
                debug: 1,
                use_service_proxy: true,
-               switch_menu: false,
                lang_menu: true,
                lang_display: ["da", "en"],
                sort_default: "relevance",
@@ -27,7 +26,6 @@
     <script type="text/javascript" src="http://mkws.indexdata.com/mkws.js"></script>
   </head>
   <body>
-    <div id="mkwsSwitch"></div>
     <div id="mkwsLang"></div>
     <div id="mkwsSearch"></div>
     <div id="mkwsResults"></div>
index 2b9f239..8ec75fe 100644 (file)
@@ -10,7 +10,6 @@
       mkws_config = {
         service_proxy_url : "/service-proxy/",
         service_proxy_auth : "/service-proxy-auth/",
-       switch_menu: false,
        lang_menu: false,
        perpage_default: 10,
        query_width: 50
index fccb853..545a09d 100644 (file)
@@ -7,8 +7,7 @@
     <link rel="stylesheet" type="text/css" href="../../tools/htdocs/mkwsStyle.css" />
     <script type="text/javascript">
       var mkws_config = {
-         switch_menu: false,
-         /*
+       /*
          service_proxy_url : "/service-proxy/",
          service_proxy_auth : "/service-proxy-auth/",
          */
@@ -32,7 +31,6 @@
     <table width="100%" border="0">
       <tr>
         <td>
-          <div id="mkwsSwitch"></div>
           <div id="mkwsLang"></div>
           <div id="mkwsSearch"></div>
         </td>
index 64215c2..914b1d8 100644 (file)
     RewriteLogLevel 1
     RewriteLog /var/log/apache2/mkws-rewrite.log 
     RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=demo&password=demo [P] # [NE,P]
-    RewriteRule /service-proxy/%3F /service-proxy/? [P] # [NE,P]
+
+    # The following rule allows the server to accept service-proxy
+    # requests that begin with an escaped "%3F" rather than a literal
+    # "?". This is useful, as requests generated by ProxyPass
+    # elsewhere always have the leading "?" escaped for some reason.
+    RewriteRule /service-proxy/\?(.*) /service-proxy/?$1 [P] # [NE,P]
 
     Header set Access-Control-Allow-Credentials true
 
index b6ce2d3..8359f74 100644 (file)
@@ -61,7 +61,6 @@ possible options:
        <script type="text/javascript">
            var mkws_config = {
                use_service_proxy: true,    /* true, flase: use service proxy instead pazpar2 */
-               switch_menu: true,          /* true, false: show/hide Records|Targets menu */
                lang_menu: true,            /* true, false: show/hide language menu */
                sort_menu: true,            /* true, false: show/hide sort menu */
                perpage_menu: true,         /* true, false: show/hide perpage menu */
index d5eb267..484773e 100644 (file)
@@ -524,7 +524,6 @@ function mkws_html_all(config) {
        sort_default: "relevance",
        perpage_default: 20,
        query_width: 50,
-       switch_menu: false,     /* show/hide Records|Targets menu */
        lang_menu: true,        /* show/hide language menu */
        sort_menu: true,        /* show/hide sort menu */
        perpage_menu: true,     /* show/hide perpage menu */
@@ -672,11 +671,6 @@ function mkws_html_switch(config) {
        No information available yet.\
       </div>');
     $("#mkwsTargets").css("display", "none");
-
-    if (!config.switch_menu) {
-       debug("disable switch menu");
-        $("#mkwsSwitch").css("display", "none");
-    }
 }
 
 function mkws_html_sort(config) {
index 6998d08..5f0724c 100644 (file)
@@ -55,19 +55,85 @@ The following is a complete MKWS-based searching application:
         <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
       </head>
       <body>
-        <div id="mkwsSwitch"></div>
-        <div id="mkwsLang"></div>
         <div id="mkwsSearch"></div>
         <div id="mkwsResults"></div>
-        <div id="mkwsTargets"></div>
-        <div id="mkwsStat"></div>
       </body>
     </html>
 
+Go ahead, try it! You don't even need a web-server. Just copy and
+paste this HTML into a file on your computer -- `/tmp/magic.html`,
+say -- and point your web-browser at it:
+`file:///tmp/magic.html`. Just like that, you have working
+metasearching.
+
+
+Explanation
+-----------
+
+If you know any HTML, the structure of the file will be familar to
+you: the `<html>` element at the top level contains a `<head>` and a
+`<body>`. In addition to whatever else you might want to put on your
+page, you can add MKWS elements.
+
+These fall into two categories. First, the prerequisites in the HTML
+header, which are loaded from the tool site mkws.indexdata.com:
+
+* `mkws-complete.js`
+  contains all the JavaScript needed by the widget-set.
+
+* `mkwsStyle.css`
+  provides the default CSS styling 
+
+Second, the `<div>` elements with special IDs that begin `mkws` can be
+provided. These are filled in by the MKWS code, and provide the
+components of the searching UI. The very simple application above has
+only two such components: a search box and a results area. But more
+are supported. The main `<div>`s are:
+
+* `mkwsSearch` -- provides the search box and button.
+
+* `mkwsResults` -- provides the results area, including a list of
+  brief records (which open out into full versions when clicked),
+  paging for large results sets, facets for refining a search, sorting
+  facilities, etc.
+
+* `mkwsLang` -- provides links to switch between one of several
+   different UI languages. By default, English, Danish and German are
+   provided.
+
+* `mkwsSwitch` --
+
+* `mkwsTargets` --
+* `mkwsStat` --
+
+### different HTML structure
+
 More sophisticated applications will not simply place the `<div>`s
 together, but position them carefully within an existing page
 framework -- such as a Drupal template, an OPAC or a SharePoint page.
 
+Breaking up mkwsResults
+
+### configuration object
+
+resposive resize
+
+### overriding styles
+
+### use jQuery popup
+
+### Authentication setups
+
+Configuring targets
+
+### Reference
+
+Configuration object
+
+jQuery plugin invocation
+
+The structure of the HTML generated by the MKWS widgets
+
 - - -
 
 Copyright (C) 2013 by IndexData ApS, <http://www.indexdata.com>