LP#1424815: adjust release notes
authorGalen Charlton <gmc@equinoxinitiative.org>
Mon, 15 Mar 2021 21:37:19 +0000 (17:37 -0400)
committerGalen Charlton <gmc@equinoxinitiative.org>
Mon, 15 Mar 2021 21:37:19 +0000 (17:37 -0400)
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

docs/RELEASE_NOTES_NEXT/OPAC/read-more-feature.adoc

index 9acb82f..4e52751 100644 (file)
@@ -1,31 +1,42 @@
-Configurable Read More Accordion for OPAC Search and Record View\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-Read More Button\r
-++++++++++++++++\r
-OPAC record Fields now truncate themselves based on a configurable amount of characters.\r
-The full field may be displayed upon hitting a (Read More) link, which will then toggle\r
-into a (Read Less) link to re-truncate the field.\r
-\r
-Configuration\r
-+++++++++++++\r
-Open-ILS/src/templates/opac/parts/config.tt2 Contains two new configuration variables:\r
-truncate_contents(default: 1) and contents_truncate_length(default: 50). Setting\r
-truncate_contents to 0 will disable the read more functionality.\r
-The variable contents_truncate_length corresponds to the amount of characters to display\r
-before truncating the text. If contents_truncate_length is removed, it will default to 100.\r
-Additional configuration for note fields can be made in\r
-Open-ILS/src/templates/opac/parts/record/contents.tt2, allowing a trunc_length variable for\r
-each individual type of note, which will override contents_truncate_length for that specific\r
-type of note.\r
-\r
-\r
-Adding Read More Functionality to further fields\r
-++++++++++++++++++++++++++++++++++++++++++++++++\r
-To add Read More functionality to any additional fields, you may use the macro\r
-accordion(), defined in misc_util.tt2. It can take three variables: str,\r
-trunc_length, and element. str corresponds to the string you want to apply it to,\r
-trunc_length(optional) will override contents_truncate_length if supplied, and\r
-element(optional) provides an alternative HTML element to look at for the truncation\r
-process(useful in situations such as the Authors and Cast fields, where each field is\r
-processed individually, but needs to be treated as a single field).
\ No newline at end of file
+Configurable Read More Accordion for OPAC Search and Record View (TPAC)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Read More Button
+++++++++++++++++
+Public catalog record fields (in the TPAC skin only) now truncate
+themselves based on a configurable amount of characters.  The full
+field may be displayed upon hitting a (Read More) link, which will
+then toggle into a (Read Less) link to re-truncate the field.
+
+Configuration
++++++++++++++
+`Open-ILS/src/templates/opac/parts/config.tt2` contains two new
+configuration variables:
+
+
+* `truncate_contents` (default: 1)
+* `contents_truncate_length` (default: 50).
+
+Setting `truncate_contents` to 0 will disable the read more
+functionality.  The variable `contents_truncate_length` corresponds
+to the amount of characters to display before truncating the text.
+If `contents_truncate_length` is removed, it will default to 100.
+
+Additional configuration for note fields can be made in
+`Open-ILS/src/templates/opac/parts/record/contents.tt2`, allowing a
+`trunc_length` variable for each individual type of note, which will
+override `contents_truncate_length` for that specific
+type of note.
+
+
+Adding Read More Functionality to further fields
+++++++++++++++++++++++++++++++++++++++++++++++++
+To add Read More functionality to any additional fields, you may use
+the macro `accordion()`, defined in `misc_util.tt2`. It can take three
+variables: `str`, `trunc_length`, and `element`. `str` corresponds to
+the string you want to apply it to, `trunc_length` (optional) will
+override `contents_truncate_length` if supplied, and `element`
+(optional) provides an alternative HTML element to look at for the
+truncation process (useful in situations such as the Authors and Cast
+fields, where each field is processed individually, but needs to be
+treated as a single field).