X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=429e8ce69a1e1ada5b153a6306f46e98ec3373ce;hb=9a18fee5262c0f2e21861574e29bc4f3f44ea687;hp=b0107be3e3a17fedc91196fd4f1c38727f5dc91f;hpb=14d966a2067904a74bf57896d754211c26f87669;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index b0107be..429e8ce 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -542,7 +542,7 @@ its own User Access record. When credential-based authentication is in use (username and password), it's necessary to pass these credentials into the Service -Proxy when establishing the session. This is done +Proxy when establishing the session. This is done by providing the `sp_auth_credentials` configuration setting as a string containing the username and password separated by a slash: @@ -865,7 +865,7 @@ facet_max_* facet int Specifies how many terms a facets _team_ array *Note 1* Ordered list of names of facets to display. -lang _team_ string Two-letter ISO code of the default language to display the UI in. Supported +lang _team_ string The code of the default language to display the UI in. Supported language codes are `en` = English, `de` = German, `da` = Danish, and whatever additional languages are configured using `language_*` entries (see below). @@ -1100,37 +1100,55 @@ in the specified language. For example: } The following strings occurring in the UI can be translated: -`Displaying`, -`Next`, -`Prev`, -`Records`, -`Search`, -`Sort by`, -`Targets`, -`Facets`, -`and show`, -`found`, -`of`, -`per page` -and -`to`. + +* `Search complete: found` +* `records` +* `Displaying` +* `to` +* `of` +* `found` +* `Prev` +* `Next` +* `Sort by` +* `and show` +* `per page` +* `Search` +* `Active clients` +* `Retrieved records` +* `Records` +* `Targets` +* `Target ID` +* `Hits` +* `Diags` +* `Records` +* `State` In addition, facet names can be translated: -`Authors`, -`Sources` -and -`Subjects`. + +* `Authors` +* `Sources` +* `Subjects` + +and whatever field captions are defined by `facet_caption_*` settings. + +And sort-orders: + +* `relevance` +* `title` +* `newest` +* `oldest` + +and whatever sort-orders are defined by the `sort_options` setting. Finally, the names of fields in the full-record display can be translated. These include, but may not be limited to: -`Author`, -`Date`, -`Location`, -`Subject` -and -`Title`. - +* `Title` +* `Date` +* `Author` +* `Links` +* `Subject` +* `Locations` jQuery UI popup invocation -------------------------- @@ -1172,7 +1190,7 @@ popup_autoOpen string 1 Open popup window on load. Valid val ---- -You can have more than one mkws-popup widgets on a page. Please use a different +You can have more than one mkws-popup widgets on a page. Please use a different popup_button value to address the right ones. The structure of the HTML generated by the MKWS widgets @@ -1190,18 +1208,18 @@ and .CLASS indicates an instance of a class. #mkwsSwitch a* - + #mkwsLang ( a | span )* - + #mkwsSearch form input#mkwsQuery type=text input#mkwsButton type=submit - + #mkwsBlanket (no contents -- used only for masking) - + #mkwsResults table tbody @@ -1239,7 +1257,7 @@ and .CLASS indicates an instance of a class. tbody tr* td* - + #mkwsStat span.head span.clients