โค้ดเบสนี้พัฒนาโดย Joey Takeda และ Martin Holmes มอบเครื่องมือที่กำหนดค่าได้และปรับแต่งได้ ซึ่งคุณสามารถชี้ไปที่คอลเลกชั่นเอกสาร XHTML5 และสร้างหน้าการค้นหาที่ไม่ต้องใช้ส่วนประกอบฝั่งเซิร์ฟเวอร์แบ็กเอนด์ โดยจะสร้างดัชนีแบบก้านของข้อความในเอกสารทั้งหมด พร้อมด้วยหน้าการค้นหา HTML รวมถึงคุณลักษณะการค้นหาแบบประกอบตามแท็ก <meta>
ในคอลเล็กชันเอกสาร หน้าค้นหาใช้ JavaScript ล้วนๆ เพื่อสืบค้นดัชนี ซึ่งเป็นคอลเลกชันขนาดใหญ่ของไฟล์ JSON ขนาดเล็ก เพื่อให้การค้นหาเว็บไซต์ขนาดเล็กถึงขนาดกลางรวดเร็วและซับซ้อน การค้นหาไม่จำเป็นต้องใช้โค้ดฝั่งเซิร์ฟเวอร์เลย
รหัสรุ่นใช้ XSLT3 และฟังก์ชันการค้นหาคือ JavaScript การใช้งาน Porter2 Stemmer ใน XSLT และ JavaScript เป็นส่วนหนึ่งของแพ็คเกจ หน้าการค้นหาสดที่ใช้โค้ดนี้มีการใช้งานอยู่แล้วในเว็บไซต์ Mapping KEATS'S PROGRESS , The Map of Early Modern London และ The Winnifred Eaton Archive
สาขาเริ่มต้นของ repo นี้คือสาขา dev; สาขาหลักใช้สำหรับการเปิดตัว การเผยแพร่อย่างเป็นทางการเริ่มต้นในต้นปี 2020 และสาขาหลักจะแสดงแท็ก Release ล่าสุดเสมอ ดังนั้นคุณจึงสามารถปักหมุดโปรเจ็กต์ของคุณเองให้เป็นต้นแบบหรือแท็ก Release ที่เฉพาะเจาะจงได้ เพื่อหลีกเลี่ยงการเปลี่ยนแปลงลักษณะการทำงานที่ไม่คาดคิดเนื่องจากการเปลี่ยนแปลงฐานโค้ด สำหรับการทดสอบเพื่อเตรียมพร้อมสำหรับการเปลี่ยนแปลงที่กำลังจะเกิดขึ้น คุณสามารถใช้สาขา dev การเผยแพร่จะถูกเก็บถาวรบน Zenodo ด้วย:
สามารถดูเอกสารฉบับเต็มได้ในไฟล์ docs/staticSearch.html เอกสารที่สามารถค้นหาได้สด (สร้างโดยใช้ staticSearch) สำหรับรุ่นล่าสุดสามารถพบได้ที่ไซต์การสิ้นสุดโครงการ
กรุณารายงานปัญหาทั้งหมดที่คุณพบเป็นตั๋วใน repo
รหัสนี้ได้รับอนุญาตภายใต้ทั้ง MPL และ BSD