Releases: slsfi/digital_edition_web
Releases · slsfi/digital_edition_web
v2.3.2
This release holds a minor update to the field names referenced in the elasticsearch indices.
Changes:
- The subject, location and tag indices need to have the following fields: sort_by_name, ev_o_deleted, ev_c_deleted, publication_deleted.
v2.3.1
Changes:
- Improvements to person-, place- and tag-search and their filter. Places can now be filtered by city, if set in the database/elastic index.
- The number of records to fetch in each batch in place- and tag-search can now be set in config with LocationSearch.InitialLoadNumber and TagSearch.InitialLoadNumber.
- In the occurrence modal for locations the city, region and country fields can be hidden using the config setting Occurrences.hideCityRegionCountry (boolean).
- The text types searchable on the elastic-search page can be set in the config with ElasticSearch.types (array of strings with type abbreviations).
- New translations required: Filter.countries, Filter.bornBetween, Filter.activeFilters, BasicActions.ShowMore, BasicActions.ScrollToTop.
- The table-of-contents service has been made non-singleton again and the activeTocOrder variable moved to the text service since the TOC caused a cyclic reference error in Firefox otherwise.
- Fixed translations (like BC) not always loading in tooltip service.
- Results when searching in work-search are sorted alphabetically rather than by score.
v2.3.0
Changes:
- Fixes and improvements to the elastic search page. The revised search has new requirements for the elastic index. See https://github.com/slsfi/digital_edition_search/blob/master/elasticsearch/mappings_examples/mappings-for-new-index.txt for an example of the index mappings and https://github.com/slsfi/digital_edition_search/blob/master/logstash/pipeline_examples/logstash_topelius.conf for an example of how to ingest data using logstash. The search is performed on two fields in the index: text_title and text_data. Options for facets are set in config-sample.json for each project.
- Improved method of highlighting search matches when navigating to texts from search results. Self-closing html-tags are now ignored.
- Fixed tag search not filtering out deleted tags.
v2.2.2
Changes:
- Fixed javascript events not always finding correct targets due to hidden page elements in the DOM (mainly when coming to a page from elastic or simple search).
- Fixed alphabetical sorting of collection and publication names in occurrence results.
- Improvements to exception handling when opening print-friendly versions of read texts.
- Refactoring: added service for common functions and moved recurrent functions there. Also moved other functions to services where appropriate.
- Made table-of-contents-service singleton and moved activeTocOrder variable there from text-service.
- Added check to see if epub-file exists in the epub-component. New translation to show if epub-file can't be found: Epub.FileNotFound.
- Added option to show epubs in digital editions lists. To enable, set show.epubsInDigitalEditionList to true in config-sample.json. To display the epub cover in the digital editions list, add the file path to AvailableEpubs.<epubName>.cover in config-sample.json.
- Minor improvements to person-, place-, tag- and work-search pages.
- Minor css fixes.
v2.2.1
This is a patch release with a few minor fixes.
Changes:
- Fixed issue with current text not highlighted/displayed properly in the left menu and text-changer if publication chapter not correctly parsed from url.
- Fixed issue with the button for downloading texts being visible in the secondary toolbar despite all formats being disabled in the config-file.
- Improved the method of scrolling current TOC item into view in the left menu when (re)loading the read-view.
v2.2.0
This release brings many bug fixes, especially to the navigation using the left menu, and some new features, of which one requires the backend-API to be updated if you wish to use it.
New feature requiring backend-API update
- Functionality for downloading introductions, read texts and comments in xml or plain text format, and for opening them in print-friendly html-format. Instructions for how to set this up in your project can be found in the documentation. The functionality for opening the texts in print-friendly html-format doesn't require new API-support, but downloading does. digital_edition_api supports downloading from this commit forward: https://github.com/slsfi/digital_edition_api/tree/09eda8f970c0062714f17c71e90559089702b4d8
Other major new features
- Added new page for forewords to collections. The foreword-page is located between the title page and the introduction (if present) and behaves the same way as the title page. The xml-files are read from the xml/fore/ folder in your project's files-repository. The filenames must be named <collectionId>_fore_<lang>_ext.xml and <collectionId>_fore_<lang>_int.xml, similarly to the title page xml-files. Requires a new xslt-stylesheet, foreword.xsl, in the xslt-folder. Enable in config: "HasForeword": true.
- Added new column to the read-view: legend. The contents of the column are read from markdown-files in the md/<lang>/13/ folders in your project's files-repository. To use the same md-file for all publications in all collections in your project, name the file 00.md. To use a specific md-file for a specific publication, create a subfolder with <collectionId> as name and in there a file named <publicationId>.md. To use a specific md-file for all publications in a specific collection, create a subfolder with <collectionId> as name and 00.md as filename. A combination of these is possible, meaning if a specific md-file doesn't exist for a publication, the 00.md file for the collection will be used, and lacking that, the general 00.md file in the md/<lang>/13/ folder will be used for the column content. A button for opening the legend-column is displayed in the manuscripts- and variations-column if showOpenLegendButton.manuscripts and showOpenLegendButton.variations is set to true in the config. The column is made available through config: displayTypesToggles.legend.
- The previous-/current-/next-text navigation in the secondary toolbar has been extended to the cover, title, foreword and introduction pages.
Minor new features, feature tweaks and bug fixes
- Refactored language change events: fixes page content not reloading with new translation after language change.
- Changed how collections are opened from the left menu (page-single-edition not used as a go-between anymore).
- When navigating to a new TOC item in the read-view and the new item is just a different position in the already opened read-text (i.e. collectionId, publicationId and chapter stays the same), the read-view is not reloaded. Instead the position in the read-text is just scrolled into view and the url updated.
- Enabled opening illustrations from comments column.
- Button for enabling/disabling the TOC of introductions moved to secondary toolbar.
- Changed column options button icon to three vertical dots in the read view (so it isn't confused with the icon for the left menu).
- Harmonised top menu icon order on mobile/desktop.
- Added possibility to remove display options button from secondary toolbar through config (showDisplayOptionsButton with boolean suboptions: pageEpub, pageForeword, pageIntroduction, pageRead, pageTitle).
- Made collection title stick to top when scrolling the left menu.
- Adjusted and harmonised layout breakpoints for screen width.
- Fixed bugs in the left menu for collections (table-of-contents-accordion) and the previous-/current-/next-text navigation (text-changer) and improved their code.
- Fixed problems with sorting the TOC for collections.
- Fixed bug in comments template (correspondence metadata).
- Fixed publications with chapters not displaying facsimiles by priority in database.
- Fixed bold style for place name in tooltips.
- Various CSS fixes and adjustments.
Other changes
- Updated dependencies (hosted-git-info from 2.8.4 to 2.8.9, y18n from 3.2.1 to 3.2.2, websocket-extensions from 0.1.3 to 0.1.4, path-parse from 1.0.6 to 1.0.7).
v2.1.42
Changes:
- Various CSS fixes.
- Add support for linking to the same read text or commentary using only position id in xml. I.e. you can omitt collectionId, publicationId and possible chapterId in target-attributes in xml if the link refers to the same read text or commentary where it resides.
- Restructuring and restyling of the filter page for person- and tag-search. New translation required: Filter.title (e.g. "Filter").
v2.1.41
Changes:
- Various css fixes.
- Added home-button to top menu in mobile mode.
- Added possibility to include markdown text to person-search page (backend file: md/sv/12/02 - person search.md).
- Added possibility to include markdown text to place-search page (backend file: md/sv/12/03 - place search.md).
- Added possibility to include markdown text to tag-search page (backend file: md/sv/12/04 - tag search.md).
- Added possibility to include markdown text to work-search page (backend file: md/sv/12/05 - work search.md).
v2.1.40
Release notes have not been used for a good while, and a lot has been developed since the last release about a year ago. Only the most recent changes will be listed here.
The new config options, css custom properties and embedded fonts available since at least this version will be described in the wiki at https://github.com/slsfi/digital_edition_documentation/wiki in the near future.
Recent changes:
- The colors of the app and many more options can be customized through css custom properties in custom.css. NB! Some of the font stack css custom properties were recently renamed in order to use a better naming convention.
- Added possibility to include Markdown text to Elastic search page (back-end file: md/sv/12/01 - elastic search.md).
- The UI of the Elastic search page has been improved. Minor improvements also to the Search app page (a.k.a. simple search).
- Images in Content pages (About-section) can be aligned by appending
#align-left,#align-rightor#align-centerto the image src.
Navigation and Gallery improvements
- Improved the TOC sorting feature, now with a drop-down
- Improved the facsimile, manuscript and version selection, now with drop-down
- Added possibility to include Markdown text to Gallery pages (back-end files: md/sv/11/[media_collection_id].md)
NB! The tawk-to feature included in the index.html file might cause issues in Firefox. Currently advised to remove the feature per project.