[open-ils-commits] [GIT] Evergreen ILS branch rel_3_0 updated. 2e1fd6c8e3354e504ba830d6c02f94a8c87fe50d
Evergreen Git
git at git.evergreen-ils.org
Wed Nov 8 12:04:29 EST 2017
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Evergreen ILS".
The branch, rel_3_0 has been updated
via 2e1fd6c8e3354e504ba830d6c02f94a8c87fe50d (commit)
via cc7f12d51ce534ea03998804dcbb49582869873f (commit)
from f6798096d00440661d752865efb357ad4457efa0 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 2e1fd6c8e3354e504ba830d6c02f94a8c87fe50d
Author: Remington Steed <rjs7 at calvin.edu>
Date: Wed Nov 8 11:57:16 2017 -0500
Docs: Improve adoc list syntax in badges section
This commit fixes some minor formatting issues with the numbered list,
and improves readability of the AsciiDoc file.
Signed-off-by: Remington Steed <rjs7 at calvin.edu>
diff --git a/docs/admin/popularity_badges_web_client.adoc b/docs/admin/popularity_badges_web_client.adoc
index cdc0146..785c2db 100644
--- a/docs/admin/popularity_badges_web_client.adoc
+++ b/docs/admin/popularity_badges_web_client.adoc
@@ -35,50 +35,51 @@ The following popularity badge parameters are available for configuration:
To create a new Statistical Popularity Badge:
-1. Go to *Administration->Local Administration->Statistical Popularity Badges*.
-2. Click on *Actions->Add badge*.
-3. Fill out the following fields as needed to create the badge:
-
+. Go to *Administration->Local Administration->Statistical Popularity Badges*.
+. Click on *Actions->Add badge*.
+. Fill out the following fields as needed to create the badge:
++
NOTE: only Name, Scope, Weight, Recalculation Interval, Importance Interval, and Discard Value Count are required
-* *Name:* Library assigned name for badge. Each name must be unique. The name will show up in the OPAC record display. For example: Most Requested Holds for Books-Last 6 Months. Required field.
+ * *Name:* Library assigned name for badge. Each name must be unique. The name will show up in the OPAC record display. For example: Most Requested Holds for Books-Last 6 Months. Required field.
+
+ * *Description*: Further information to provide context to staff about the badge.
-* *Description*: Further information to provide context to staff about the badge.
+ * *Scope:* Defines the owning organization unit of the badge. Badges will be applied to search result sorting when the Scope is equal to, or an ancestor, of the search location. For example, a branch specific search will include badges where the Scope is the branch, the system, and the consortium. A consortium level search, will include only badges where the Scope is set to the consortium. Item specific badges will apply only to records that have items owned at or below the Scope. Required field.
-* *Scope:* Defines the owning organization unit of the badge. Badges will be applied to search result sorting when the Scope is equal to, or an ancestor, of the search location. For example, a branch specific search will include badges where the Scope is the branch, the system, and the consortium. A consortium level search, will include only badges where the Scope is set to the consortium. Item specific badges will apply only to records that have items owned at or below the Scope. Required field.
+ * *Weight:* Can be used to indicate that a particular badge is more important than the other badges that the record might earn. The weight value serves as a multiplier of the badge rating. Required field with a default value of 1.
-* *Weight:* Can be used to indicate that a particular badge is more important than the other badges that the record might earn. The weight value serves as a multiplier of the badge rating. Required field with a default value of 1.
+ * *Age Horizon:* Indicates the time frame during which events should be included for calculating the badge. For example, a popularity badge for Most Circulated Items in the Past Two Years would have an Age Horizon of '2 years'. The Age Horizon should be entered as a number followed by 'day(s)', 'month(s)', 'year(s)', such as '6 months' or '2 years'. Use with temporal popularity (TP) badges only.
-* *Age Horizon:* Indicates the time frame during which events should be included for calculating the badge. For example, a popularity badge for Most Circulated Items in the Past Two Years would have an Age Horizon of '2 years'. The Age Horizon should be entered as a number followed by 'day(s)', 'month(s)', 'year(s)', such as '6 months' or '2 years'. Use with temporal popularity (TP) badges only.
+ * *Importance Horizon:* Used in conjunction with Age Horizon, this allows more recent events to be considered more important than older events. A value of zero means that all events included by the Age Horizon will be considered of equal importance. With an Age Horizon of 2 years, an Importance Horizon of '6 months' means that events, such as checkouts, that occurred within the past 6 months will be considered more important than the circulations that occurred earlier within the Age Horizon.
-* *Importance Horizon:* Used in conjunction with Age Horizon, this allows more recent events to be considered more important than older events. A value of zero means that all events included by the Age Horizon will be considered of equal importance. With an Age Horizon of 2 years, an Importance Horizon of '6 months' means that events, such as checkouts, that occurred within the past 6 months will be considered more important than the circulations that occurred earlier within the Age Horizon.
+ * *Importance Interval:* Can be used to further divide up the timeframe defined by the Importance Horizon. For example, if the Importance Interval is '1 month, Evergreen will combine all of the events within that month for adjustment by the Importance Scale (see below). The Importance Interval should be entered as a number followed by 'day(s)', 'week(s)', 'month(s)', 'year(s)', such as '6 months' or '2 years'. Required field.
-* *Importance Interval:* Can be used to further divide up the timeframe defined by the Importance Horizon. For example, if the Importance Interval is '1 month, Evergreen will combine all of the events within that month for adjustment by the Importance Scale (see below). The Importance Interval should be entered as a number followed by 'day(s)', 'week(s)', 'month(s)', 'year(s)', such as '6 months' or '2 years'. Required field.
+ * *Importance Scale:* The Importance Scale can be used to assign additional importance to events that occurred within the most recent Importance Interval. For example, if the Importance Horizon is '6 months' and the Importance Interval is '1 month', the Importance Scale can be set to '6' to indicate that events that happened within the last month will count 6 times, events that happened 2 months ago will count 5 times, etc. The Importance Scale should be entered as a number followed by 'day(s)', 'week(s)', 'month(s)', 'year(s)', such as '6 months' or '2 years'.
-* *Importance Scale:* The Importance Scale can be used to assign additional importance to events that occurred within the most recent Importance Interval. For example, if the Importance Horizon is '6 months' and the Importance Interval is '1 month', the Importance Scale can be set to '6' to indicate that events that happened within the last month will count 6 times, events that happened 2 months ago will count 5 times, etc. The Importance Scale should be entered as a number followed by 'day(s)', 'week(s)', 'month(s)', 'year(s)', such as '6 months' or '2 years'.
+ * *Percentile:* Can be used to assign a badge to only the records that score above a certain percentile. For example, it can be used indicate that you only want to assign the badge to records in the top 5% of results by setting the field to '95'. To optimize the popularity badges, percentile should be set between 95-99 to assign a badge to the top 5%-1% of records.
-* *Percentile:* Can be used to assign a badge to only the records that score above a certain percentile. For example, it can be used indicate that you only want to assign the badge to records in the top 5% of results by setting the field to '95'. To optimize the popularity badges, percentile should be set between 95-99 to assign a badge to the top 5%-1% of records.
+ * *Attribute Filter:* Can be used to assign a badge to records that contain a specific Record Attribute. Currently this field can be configured by running a report (see note below) to obtain the JSON data that identifies the Record Attribute. The JSON data from the report output can be copied and pasted into this field. A new interface for creating Composite Record Attributes will be implemented with future development of the web client.
+ ** To run a report to obtain JSON data for the Attribute Filter, use SVF Record Attribute Coded Value Map as the template Source. For Displayed Fields, add Code, ID, and/or Description from the Source; also display the Definition field from the Composite Definition linked table. This field will display the JSON data in the report output. Filter on the Definition from the Composite Definition liked table and set the Operator to 'Is not NULL'.
-* *Attribute Filter:* Can be used to assign a badge to records that contain a specific Record Attribute. Currently this field can be configured by running a report (see note below) to obtain the JSON data that identifies the Record Attribute. The JSON data from the report output can be copied and pasted into this field. A new interface for creating Composite Record Attributes will be implemented with future development of the web client.
-** To run a report to obtain JSON data for the Attribute Filter, use SVF Record Attribute Coded Value Map as the template Source. For Displayed Fields, add Code, ID, and/or Description from the Source; also display the Definition field from the Composite Definition linked table. This field will display the JSON data in the report output. Filter on the Definition from the Composite Definition liked table and set the Operator to 'Is not NULL'.
+ * *Circ Mod Filter:* Apply the badge only to items with a specific circulation modifier. Applies only to item related badges as opposed to "bib record age" badges, for example.
-* *Circ Mod Filter:* Apply the badge only to items with a specific circulation modifier. Applies only to item related badges as opposed to "bib record age" badges, for example.
+ * *Bib Source Filter:* Apply the badge only to bibliographic records with a specific source.
-* *Bib Source Filter:* Apply the badge only to bibliographic records with a specific source.
+ * *Location Group Filter:* Apply the badge only to items that are part of the specified Copy Location Group. Applies only to item related badges.
-* *Location Group Filter:* Apply the badge only to items that are part of the specified Copy Location Group. Applies only to item related badges.
+ * *Recalculation Interval:* Indicates how often the popularity value of the badge should be recalculated for bibliographic records that have earned the badge. Recalculation is controlled by a cron job. Required field with a default value of 1 month.
-* *Recalculation Interval:* Indicates how often the popularity value of the badge should be recalculated for bibliographic records that have earned the badge. Recalculation is controlled by a cron job. Required field with a default value of 1 month.
+ * *Fixed Rating:* Can be used to set a fixed popularity value for all records that earn the badge. For example, the Fixed Rating can be set to 5 to indicate that records earning the badge should always be considered extremely popular.
-* *Fixed Rating:* Can be used to set a fixed popularity value for all records that earn the badge. For example, the Fixed Rating can be set to 5 to indicate that records earning the badge should always be considered extremely popular.
+ * *Discard Value Count:* Can be used to prevent certain records from earning the badge to make Percentile more accurate by discarding titles that are below the value indicated. For example, if the badge looks at the circulation count over the past 6 months, Discard Value Count can be used to eliminate records that had too few circulations to be considered "popular". If you want to discard records that only had 1-3 circulations over the past 6 months, the Discard Value Count can be set to '3'. Required field with a default value of 0.
-* *Discard Value Count:* Can be used to prevent certain records from earning the badge to make Percentile more accurate by discarding titles that are below the value indicated. For example, if the badge looks at the circulation count over the past 6 months, Discard Value Count can be used to eliminate records that had too few circulations to be considered "popular". If you want to discard records that only had 1-3 circulations over the past 6 months, the Discard Value Count can be set to '3'. Required field with a default value of 0.
+ * *Last Refresh Time:* Displays the last time the badge was recalculated based on the Recalculation Interval.
-* *Last Refresh Time:* Displays the last time the badge was recalculated based on the Recalculation Interval.
+ * *Popularity Parameter:* Types of TP and PIT factors described above that can be used to create badges to assign popularity to bibliographic records.
-* *Popularity Parameter:* Types of TP and PIT factors described above that can be used to create badges to assign popularity to bibliographic records.
+. Click *OK* to save the badge.
-4. Click *OK* to save the badge.
New Global Flags
~~~~~~~~~~~~~~~~
commit cc7f12d51ce534ea03998804dcbb49582869873f
Author: Remington Steed <rjs7 at calvin.edu>
Date: Wed Nov 8 11:56:42 2017 -0500
Docs: Fix two AsciiDoc syntax warnings
A recent commit removed a docs file and integrated the content into the
3.0 release notes and the ebook_api.adoc file. This commit cleans up
two small problems left over from that commit:
- Remove the reference to the deleted file
- Fix the warning block syntax in ebook_api.adoc
Signed-off-by: Remington Steed <rjs7 at calvin.edu>
diff --git a/docs/admin/ebook_api.adoc b/docs/admin/ebook_api.adoc
index 21ae611..2431121 100644
--- a/docs/admin/ebook_api.adoc
+++ b/docs/admin/ebook_api.adoc
@@ -15,11 +15,9 @@ interface will include information about that user's checkouts and holds for
supported vendors.
[WARNING]
---
The ability to check out and place holds on ebook titles is an experimental
feature in 3.0. It is not recommended for production use without careful
testing.
---
For API integration to work, you need to request API access from the
vendor and configure your Evergreen system according to the instructions
diff --git a/docs/root_opac.adoc b/docs/root_opac.adoc
index 4e65075..d5e2bf7 100644
--- a/docs/root_opac.adoc
+++ b/docs/root_opac.adoc
@@ -45,8 +45,6 @@ include::opac/linked_libraries.adoc[]
:leveloffset: -1
-include::opac/ebook_transactions.adoc[]
-
include::opac/kids_opac.adoc[]
include::opac/opensearch.adoc[]
-----------------------------------------------------------------------
Summary of changes:
docs/admin/ebook_api.adoc | 2 -
docs/admin/popularity_badges_web_client.adoc | 49 +++++++++++++------------
docs/root_opac.adoc | 2 -
3 files changed, 25 insertions(+), 28 deletions(-)
hooks/post-receive
--
Evergreen ILS
More information about the open-ils-commits
mailing list