Panl: index - Getting Started with Panl by synapticloop

Getting Started With Panl

A rather pleasing companion to the Apache® Solr® Faceted Search Engine

_____________

Author: Synapticloop - Version 2.2.0 (Release 1)

This book will rapidly get you up and running with a fully featured, SEO-friendly, keyword searchable, faceted search engine with an in-built, example search page to test it all out.

(Note: The latest release of this book can always be found here: https://github.com/synapticloop/panl/tree/main/src/book, and the online version here: https://synapticloop.github.io/panl/)

WHY?

Because...

/Caran d'Ache/true/Black/bDW/

looks so much nicer than...

q=*:*&facet.mincount=1&rows=10&facet.field=lead_size_indicator&facet.fie
ld=grip_material&facet.field=colours&facet.field=nib_shape&facet.field=d
iameter&facet.field=cap_shape&facet.field=brand&facet.field=mechanism_ty
pe&facet.field=length&facet.field=hardness_indicator&facet.field=grip_ty
pe&facet.field=cap_material&facet.field=lead_grade_indicator&facet.field
=tubing_material&facet.field=in_built_sharpener&facet.field=disassemble&
facet.field=category&facet.field=body_shape&facet.field=clip_material&fa
cet.field=mechanism_material&facet.field=lead_length&facet.field=body_ma
terial&facet.field=in_built_eraser&facet.field=grip_shape&facet.field=re
lative_weight&facet.field=name&facet.field=nib_material&facet.field=weig
ht&facet.field=variants&facet=true&fq=brand:"Caran+d'Ache"&fq=disassembl
e:"true"&fq=colours:"Black"&q.op=AND

TL;DR

If you are looking to get the quickest start on understanding how a Panl server is configured and up and running, then...

GETTING UP TO SPEED

Start with the Quick Start - The 5 Steps section to get the Solr and Panl servers up and running and browse the Panl Results Viewer.

http://localhost:8181/panl-results-viewer/mechanical-pencils/default/

Can't wait, or just need to see what it is all about? See the Quick Preview - Running Docker section.
UNDERSTAND

The Solr Fundamentals and Panl Fundamentals section introduces you to the concepts that lay the foundations for the rest of the book. Once you have a good understanding of the configuration and functionality, then there are two example walkthroughs:

A FULL EXAMPLE
Work through the The Bookstore Walkthrough section to gain a deeper understanding of the complete process, from schema design, indexing, and configuration of both Panl and Solr.
PROGRAMMATIC INDEXING
Work through the Filesystem Indexing And Searching Walkthrough chapter to understand how to programmatically index files and commit them to Solr.

INTEGRATE

Use your existing Solr installation and dataset to set up Panl with Integrating An Existing Solr Schema.
REFERENCE

Need help understanding the options? See the Panl Configuration part.
UPGRADE

See the Upgrading Your Panl Server Version section.

QUICK TIP

Tip: Documentation for this book can also be read online, see:

https://synapticloop.github.io/panl/

or, to download the copy of this book for the Panl version that you are using, see:

https://github.com/synapticloop/panl/releases/

Corrections and updates to this book, when done, will always be reflected online and the main GitHub branch - see:

https://github.com/synapticloop/panl/blob/main/src/dist/book/Getting%20Started%20With%20Synapticloop%20Panl.pdf

~ ~ ~ * ~ ~ ~

MECHANICAL PENCIL DATA: The data used in this book is based on 2mm mechanical pencil data hand curated by the author. The data and associated Solr search results utilised in this book references manufacturers of writing instruments, specifically 2mm mechanical pencils and is used for informational purposes. The manufacturer's name, the name of the pencil (and/or model number) may be a trademark and/or is copyright of the manufacturer.

IMAGES, APPLICATIONS, AND SITE REFERENCES: Screenshots of applications and external websites are included in this book, they remain the copyright of the original owner and do not infer any association with, or endorsement of, Synapticloop, and/or vice versa.

Additional datasets may have information that is copyright or trademarked to the respective owners.

IMPORTANT: Whilst the project is released under the very liberal MIT licence, the sample mechanical data remains under the copyright of Synapticloop, and may not be used for commercial purposes.

A NOTE ON URL ENCODINGS: Within this book if you are using the Firefox browser then the address bar will automatically decode any URL encoded space characters ('%20') - other browsers will keep the encoding in the address bar. Within this book, the majority of example URLs will not show the %20 encoding, however the associated href in the link will include these encodings.

Synapticloop :: Panl

Welcome to the Panl Book

A Note On Page Generation

View this project on github