Version 2.2.0 (codename `bitter-shadow`)

mMm Harnesses

All the goodness that is required to build an SEO friendly search engine, powered by Synapticloop Panl and Apache Solr.

• New Features

  • Changed the docker image to include all datasets
  • Pushed the docker impage to docker hub - this is a testing image only
  • Added in --no-prompt option to generator to accept in-built defaults
  • Added in a help command line argument (which is not particularly needed)

• Bug Fixes

  • Fixed decoding of UTF-8 LPSE codes
  • Fixed bug with the query operand being passed through the URL not being
    picked up.

• Code Changes

  • Updated the usage text to be context specific, made the look and feel of
    the output a little clearer
  • Updated both the panl.properties file and
    <panl_collection_url>.panl.properties template files and merged them with
    the associated sample files.
  • No longer request the unique key from Solr as a facet field unless it is
    specifically requested in the Panl LPSE URL path (this reduces the
    payload that is returned from Solr)
  • Added panl.lpse.ignore replacement key in the template to
    automatically add in the Solr uniqueKey field.
  • Minor error outputting formatting changes

• Documentation Update

  • Rewrote documentation to be a little clearer and removed extraneous
    information
  • Added in missed panl.uniquekey.<lpse_code> to the documentation

!! The included PDF contains over **600** pages of documentation for every part of the Panl server. !!

Version 2.1.0 (codename `hidden-summer`)

Internal Niceties and Wanted Functionality

All the goodness that is required to build an SEO friendly search engine, powered by Synapticloop Panl and Apache Solr.

• New Features

  • Added in is_multivalue JSON key to the active facets
  • Added in panl.extra.<lpse_code> to add a JSON object keyed on extra to
    the returned active and available facets.
  • Added in panl.server.extra to add a JSON object keyed on extra to
    the server with every response.
  • Added in panl.collection.extra to add a JSON object keyed on extra to
    every returned response for the collection (this will overwrite any
    duplicate keys in the server response above).
  • Added panl.remove.solr.json.keys which will removed duplicated information
    and un-needed information in the returned Solr response.
  • Added panl.lpse.facetorder to the Panl response object so that the
    ordering may be different from the LPSE URL order.
  • Added 'More Like This' Solr functionality, including handler and
    additional properties:
    • panl.mlt.enable (default is 'false')
    • panl.mlt.handler (default is '/mlt')
    • panl.mlt.fields (no default)
  • Added property solr.numrows.morelikethis to the collection (default is 5)
  • Ensured that duplicate collections are not registered and that Panl
    collections are not
  • Added indexdesc as a sorting option so that the facets can be sorted
    by index (ascending is the default) and now descending.
  • Updated generator to:
    • Include the uniquekey property for the correct Solr field
    • Updated the commenting for Solr fields that are analysed with a
      warning that it probably shouldn't be a facet.
    • Instead of using LPSE codes for the panl.lpse.order,
      panl.lpse.facetorder, panl.lpse.ignore, the Solr field name can be
      used which makes it easier to understand the ordering and ignore codes.
  • Added in a docker build for testing

• Bug Fixes

  • Fixed generator where it would leave an empty (and ignored) property of
    panl.lpse.fields in the properties file
  • Fixed bug where BOOLEAN facets were allowed to have multiple values - which
    it shouldn't.
  • Fixed passing through the LPSE code for the passthrough parameter if there
    wasn't a passthrough value sent through.
  • Fixed bug with 'extra' JSON object not correctly overriding parent object
  • Fixed connection reset when attempting to get the SolrJ client - now
    returns a 503 status message
  • Removed unregistered fields that weren't defined in the field list

• Code Changes

  • Fixed output formatting for explanation of tokens
  • Refactored constants into single place

• Documentation Update

  • Added in documentation for new features
  • Larger documentation update for:
    • 'More Like This' functionality
    • Panl Cookbook
  • Added in new keys and descriptions
  • Spelling and grammar updates
  • Added in more detail for the TODO tags

!! The included PDF contains over 600 pages of documentation for every part of the Panl server. !!

Version 2.0.0 (codename `billowing-feather`)

This is a MAJOR functionality release for Solr Panl

All the goodness that is required to build an SEO friendly search engine, powered by Synapticloop Panl and Apache Solr.

---

IMPORTANT: This is a breaking change for the LPSE URL path part, and JSON Response Object

---

• Breaking Changes

  • [BREAKING CHANGE] Changed range facets LPSE codes from w-w to w- and w+w to w+ (i.e. removed the trailing LPSE code)

• New Features

  • Added in lookahead query handler for Solr Panl including Panl results viewer lookahead
  • Added in OR SEPARATOR facets so that OR facets can be separated with a string and only have one LPSE code.
  • Added in solr.numrows.maximum property so that this will always be the limit to the number of results returned, this will default to
    solr.numrows.default
  • Added in BOOLEAN checkbox functionality
  • Ability to select specific search fields added.
  • Added panl.unless.<lpse_code> fields
  • 'Fixed' the keyword search for multiple words so that they use the defined q.op parameter for both default and Specific Solr Search Fields.

• Bug fixes

  • Bug where Panl client will always look for the 'q' parameter for the query, changed to ensure that the correct configured panl.form.query.respondto is used instead
  • Always reset the page to 1 if there is a panl.form.query.respondto URL parameter
  • (Maybe this was a feature?) Updated Single Page search to allow multiple selections for Facets which are multivalued (as opposed to OR Facets)
  • Fixed where a single value LPSE code for a RANGE facet was the first
    selected item, and other selections would erroneously add an infix designator.
  • Fixed the URL path encoding
  • Fixed bug in lookahead handler with not properly encoding queries

• Code Changes

  • Fixed the overriding query respond to parameter
  • Added in Testing for the Panl Generator and refactored how it is being done.
  • Refactored PanlFields for the generator to output better comments and helpful information rather than more comments than necessary
  • General code cleanup and refactorings
  • Updated the look and feel for the Panl Simple Results Viewer Web App ( including images)
  • Modularised the JavaScript for common functions.

• Documentation update

  • Added in keyword search integration and 'search within results' integration notes
  • Changed the panl.form.query.respondto documentation to point to search rather than the previously defined q to reduce confusion
  • General spelling and grammatical mistake updates
  • Addition of new functionality and configuration properties pushing the book to be over 500 pages.

Version 1.2.0 (codename `needy-phantom`)

Code Update

• Bug fixes

  • Fixed JavScript in Single Page Search results in-built web app to take into account range facets
  • Fixed serving in-built panl testing URLs when run from the script

• Code changes

  • Retrieval of more facets functionality added:
    • Added in facet_limit JSON key for retrieving more facet results
    • Added in handler for retrieving more facets for a specific search field
  • Better output for testing URLs
  • Added Always on OR facets and panl.or.always.<lpse_code> property
  • Moved log4j out of the jar file so that user's con configure their own logging

• Breaking Changes - (which is OK as nobody is using it at the moment :) )

  • Changed the single page search URL binding from /panl-configuration/ to /panl-single-page/ as it makes more sense

• Documentation update

  • General spelling and grammatical mistake updates
  • Update to new functionality and configuration properties
  • Added in the pagination returned JSON Object implementation details
  • Added in URLs bound by the Panl server in the Appendices

Version 1.1.1 (codename `grizzled-pebble`)

Bug Fixes

• Fixed 'OR' facet before and after URL values in the JSON response where a range facet has already been selected

Code cleanup

• Updated explanation for DATE Range and RANGE facets

Version 1.1.0 (codename `broad-firefly`)

Code Update

• Added in empty FieldSet to return no documents
• Added in Single Search Page functionality
• Update Mechanical Pencils
  • Added in hierarchy for the Pencil Model example
• Dynamic range functionality - pulling actual values for the facet
• Suppress facet values for ranges, so that the user may only select from the range UI, and the individual range facet values do not appear

Documentation update

• New documentation for additional features and functionality
• Fixed general spelling and grammar errors
• Updated mechanical pencils introductory dataset explanations
• Added in documentation for Fields
• Panl cookbook

Version 1.0.0 (codename `bright-wildflower`)

Initial release of Synapticloop Panl.

Select the version that matches your Solr version - e.g. solr-panl-9 is designed to integrate with Apache Solr version 9.x.x

The book is included in the release package, howvere you may download a copy from here.