static search with proper look-and-feel #91

sydb · 2024-10-29T15:04:28Z

No description provided.

* Separate out compression of generated site into new target so that I do not have to wait for ZIPping every time I test * Update help output to match * Fix typo in topnavigation

* mostly documentation updated, but also * made "help" the default target * rename the *.NOT files back

This commit adds the University of Victoria Endings Project Static Search codebase, version 1.4.5, with no mods. Thus this version of DHQ requires ant-contrib be installed on the local machine in order to build the "generateSearchable" target.

…tever dir hold the staticSearch version you want to use

Only working task so far is to generate a preview version of a given article.

Some of the parameters defined in template_article.xsl already had fallback values in imported stylesheets. head.xsl can take an optional $assets-path.

The XSLT now passes parameters onto template_article.xsl, and generates a mapping between source and static article directories. Fix bug in head.xsl: when multiple <title>s are provided, only the first is used.

The resulting build file is hard to read, but would hopefully make the Ant tasks usable on Windows machines.

Since the xmlresolver JAR needs to be loaded when Ant starts up, the new target tests for the required Java class and, if it's not available, provides instructions for running Ant with the JAR. The new task is a dependency for the targets which use Saxon HE.

Files are copied into the static site directory and static HTML is wrapped in DHQ trappings.

When restored, `generateSite` will try to find a derived build file "article-mapper.xml" which maps article directories from their source to the expected web directories.

The new task is intended to create a standalone HTML preview of an article, which can be sent to the article's author(s) for proofing.

Default Ant task is back to 'previewArticle'

To reduce confusion and duplication, "toDir.base" now refers to the path to the "dhq-static" directory, which contains a directory of static files AND the derived Ant file AND the compressed ZIP. "toDir.static" refers more specifically to the directory of static files within toDir.base. Also, added an XSL message to show progress through the TOC.

…works EXCEPT that we have not generated the individual volume/issue index pages yet.

I had a conversation with Martin a few weeks ago and learned that "raw" is the generally accepted scoring algorithm and (to my surprise) "tf-idf" is considered somewhat experimental. Also decided to just leave JSON indentation on during development. We probably want to turnit off in production, so files are smaller.

site generation branch (which has just gotten the latest from main, itself)

These files often shadow the actual HTML files we want to index (I think because they are one level above the desired files with the same name), and even when they do not shadow the desired file, these preview files are files we do not want to index. So delete them first.

* Show only 5 (not 12) hits. * Use the word “hits” instead of “Score” to describe how many hits. * Because the above improvement required a change _in the staticSearch/ code itself, add a new README file to document what change needs to be made each time a new version of UVEPSS is installed.

Starting point for advanced search page. This page undergoes processing by DHQ and staticSearch XSLT to generate user-facing advanced search page.

Add links to ssHighlight.js

…, & I fixed by hand)

@joelsjlee

* new recommendation code from @joelsjlee * tweaks to dhq2html we made this morning and maybe other stuff, at least, in theory.

Add some additional styling to search features.

difficult manual merges (to build.xml and common/xslt/head.xsl).

Including not loading staticSearch highlighting Javascript when in proofing mode

1) Update to v. 1.4.9 of staticSearch 2) No longer use symlink and numbered version directory 3) Change a few keywords from capitalized to lower-case.

sydb · 2024-11-12T03:32:31Z

I have done a bunch of ad hoc testing of the generateSearchable output, but then run the following methodical tests on this branch.

Cloned the repo, called it ./dhq-journal_ssg/.
Made a copy, called it ./dhq-journal_jaw/.
In ./dhq-journal_ssg/ checked out the static_site_generation branch.
In ./dhq-journal_jaw/ checked out the jawalsh_uvepss_01 branch.
Each of the following commands was issued in each of the two directories.
ant -lib common/lib/saxon -Darticle.id=000334 previewArticle
- The output from ant is essentially identical
- The HTML files differ in CSS, fields, and the search button
ant -lib common/lib/saxon -Ddo.proofing.full=false makeInternalPreview
- The output from ant is essentially identical
- Not surprisingly all the HTML files in dhq-static_???/dhq-proofing/editorial/ are different, but it looks like the vast majority of differences are in ID values.
- I guess not surprisingly, all the .xhtml and .xml files are the same.
ant -lib common/lib/saxon -Ddo.proofing.full=true makeInternalPreview
- The output from ant is mostly identical, but
  - the msg from target zipArticleXml is different, and
  - the generateSite target created an (empty) directory at ./dhq-journal/dhq in the jawalsh_uvepss_01 but not the static_site_generation branch.
- Of the nearly 6,000 output files, fewer than 1,000 are different
  - I took a quick scan of the differences in one case: seemed to be almost all CSS, fields, & ID values
ant -lib common/lib/saxon generateIssues
- The output from ant is essentially identical
- I spot-checked one of the 180 HTML files that differ, the differences again seemed to be almost all CSS, fields, & ID values
ant -lib common/lib/saxon generateSite
- The output from ant is mostly identical, but
  - the msg from target zipArticleXml is different
- I spot-checked one of the 902 HTML files that differ, the differences again seemed to be almost all CSS, fields, & ID values

sydb and others added 30 commits February 19, 2024 09:11

Add search capability, take 3, step 1:

3d03f57

* Separate out compression of generated site into new target so that I do not have to wait for ZIPping every time I test * Update help output to match * Fix typo in topnavigation

Add UVEPSS metadata to HTML head elements

16b60d3

bug fix: forgot namespace decls.

7e1f681

Basically working UVEPSS version with some extant problems

e0f1a2d

Build file tweaks:

918afff

* mostly documentation updated, but also * made "help" the default target * rename the *.NOT files back

put IDs on all output HTML elements

6abcd61

Add StaticSearch:

c5c2c36

This commit adds the University of Victoria Endings Project Static Search codebase, version 1.4.5, with no mods. Thus this version of DHQ requires ant-contrib be installed on the local machine in order to build the "generateSearchable" target.

Use just "satticSearch", expecting that that will be symlinked to wha…

3efe28d

…tever dir hold the staticSearch version you want to use

Add Saxon HE processor JAR (v11.5)

d987b1d

Create Apache Ant buildfile.

3234d2d

Only working task so far is to generate a preview version of a given article.

Alter XSLT to be run outside Cocoon.

45ca0e1

Some of the parameters defined in template_article.xsl already had fallback values in imported stylesheets. head.xsl can take an optional $assets-path.

Add Saxon HE licenses

273658c

Add "compressStatic" task and stub for generating HTML articles

c3e92c5

Add XSLT to parse the TOC and generate static HTML for articles

f532482

Run generate_static_articles.xsl using the Ant buildfile.

7ec0720

The XSLT now passes parameters onto template_article.xsl, and generates a mapping between source and static article directories. Fix bug in head.xsl: when multiple <title>s are provided, only the first is used.

Small tweaks, mostly to comments

0804b28

Use file separator Ant property for OS-agnostic processing.

b0de402

The resulting build file is hard to read, but would hopefully make the Ant tasks usable on Windows machines.

Add missing xmlresolver and jline JARs

cc47c49

Build out "generateSite" task.

66cbb3f

Files are copied into the static site directory and static HTML is wrapped in DHQ trappings.

Comment out call to external Ant build file.

862de6e

When restored, `generateSite` will try to find a derived build file "article-mapper.xml" which maps article directories from their source to the expected web directories.

With @amclark42 start developing real ANT output

ec9b734

Add "zipPreviewArticle" task to the Ant build file.

de9e871

The new task is intended to create a standalone HTML preview of an article, which can be sent to the article's author(s) for proofing.

Tweak name of ZIP file

75595a7

Small edits to comments.

0ca52a3

Default Ant task is back to 'previewArticle'

Fix paths when generating static article HTML

4958882

With Ash make minor fixes to static site generation such that it now …

1e0394c

…works EXCEPT that we have not generated the individual volume/issue index pages yet.

Add $doProofing parameter to get around TOC check on articles.

1a5a90f

With @amclark42, generate individual issue indices.

b8d4f8f

sydb and others added 25 commits April 3, 2024 14:22

remove a snippet of debugging code

6b7f8fb

Grab latest from the static

38c347f

site generation branch (which has just gotten the latest from main, itself)

changes to comments

afd9536

latest from static_site_generation, itself recently merged from main

de5b94d

Update .gitignore

e22d322

Update from UVEPSS 1.4.5 to 1.4.7

8beb473

I am not at all sure ...

72e5c41

Create search.html

dfdd940

Starting point for advanced search page. This page undergoes processing by DHQ and staticSearch XSLT to generate user-facing advanced search page.

Update head.xsl

cde2d99

Add links to ssHighlight.js

Delete obsolete code.

46330b2

Add process to generate dhq-flavored advanced search page.

1f256e5

complete prev merge (that had a conflict in dhq2html, which Joel, Ash…

40edcf2

…, & I fixed by hand)

Merge in static site, which includes:

9de15d9

* new recommendation code from @joelsjlee * tweaks to dhq2html we made this morning and maybe other stuff, at least, in theory.

Newest and bestest from static site generation (my base) branch

164efcc

finish merge post manual fix

33bef26

Switch name of output search page to just “search.html”.

cc270d8

Begin implementing search box in topnavigation menu.

31432a5

merge latestest work from Syd's search branch into John's search branch

ff6c7f7

Update dhq_screen.css

40c300e

Add some additional styling to search features.

Update topnavigation.xsl

7969745

Concluding merge after two seroiusly

fbd1449

difficult manual merges (to build.xml and common/xslt/head.xsl).

finish merging sydb_uvepss_03 into jawalsh_uvepss_01

5bb55d9

sydb requested a review from amclark42 October 29, 2024 15:05

sydb and others added 3 commits November 5, 2024 11:23

Finished with manual merge:

091e56b

Including not loading staticSearch highlighting Javascript when in proofing mode

Fix lowercase

0efeafe

staticSearch changes:

2d7e667

1) Update to v. 1.4.9 of staticSearch 2) No longer use symlink and numbered version directory 3) Change a few keywords from capitalized to lower-case.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

static search with proper look-and-feel #91

static search with proper look-and-feel #91

sydb commented Oct 29, 2024

sydb commented Nov 12, 2024

static search with proper look-and-feel #91

Are you sure you want to change the base?

static search with proper look-and-feel #91

Conversation

sydb commented Oct 29, 2024

sydb commented Nov 12, 2024