[open-ils-commits] [GIT] Evergreen ILS branch master updated. d05f212f16f14030b2dff053c55f47acd97fc491

[Evergreen Git]

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, master has been updated
       via  d05f212f16f14030b2dff053c55f47acd97fc491 (commit)
      from  8ca036bb9c680ca42d3f9e88ad324d009ed1556d (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 d05f212f16f14030b2dff053c55f47acd97fc491
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date:   Tue Apr 10 09:07:55 2018 -0700

    Docs: updating marc_export options documentation
    
    Signed-off-by: Jane Sandberg <sandbej at linnbenton.edu>

diff --git a/docs/development/support_scripts.adoc b/docs/development/support_scripts.adoc
index f0addfe..239bf42 100644
--- a/docs/development/support_scripts.adoc
+++ b/docs/development/support_scripts.adoc
@@ -101,31 +101,61 @@ cat /home/opensrf/records.txt | ./marc_export --store -i -c /openils/conf/opensr
 
 [NOTE]
 ====================
-`marc_export` was updated in Evergreen 2.6 and now does not output progress
-as it executes.
+`marc_export` does not output progress as it executes.
 ====================
 
-[NOTE]
-====================
-You can use the `--since` option to export records modified after a
-certain date and time.
-====================
+Options
+^^^^^^^
+
+The *marc_export* support script includes several options.  You can find a complete list
+by running `./marc_export -h`.  A few key options are also listed below:
+
+--descendants and --library
++++++++++++++++++++++++++++
+
+The `marc_export` script has two related options, `--descendants` and
+`--library`.  Both options take one argument of an organizational unit
+
+The `--library` option will export records with holdings at the specified
+organizational unit only.  By default, this only includes physical holdings,
+not electronic ones (also known as located URIs).
+
+The `descendants` option works much like the `--library` option
+except that it is aware of the org. tree and will export records with
+holdings at the specified organizational unit and all of its descendants.
+This is handy if you want to export the records for all of the branches
+of a system.  You can do that by specifying this option and the system's
+shortname, instead of specifying multiple `--library` options for each branch.
+
+Both the `--library` and `--descendants` options can be repeated.
+All of the specified org. units and their descendants will be included
+in the output.  You can also combine `--library` and `--descendants`
+options when necessary.
+
+--since
++++++++
+
+You can use the `--since` option to export records modified after a certain date and time.
+
+--store
++++++++
 
-[NOTE]
-====================
 By default, marc_export will use the reporter storage service, which should
 work in most cases. But if you have a separate reporter database and you
 know you want to talk directly to your main production database, then you
 can set the `--store` option to `cstore` or `storage`. 
-====================
-
-[NOTE]
-====================
-For more information, run marc_export with the -h option:
-
- ./marc_export -h
-====================
 
+--uris
+++++++
+The `--uris` option (short form: `-u`) allows you to  export records with
+located URIs (i.e. electronic resources).  When used by itself, it will export
+only records that have located URIs.  When used in conjunction with `--items`,
+it will add records with located URIs but no items/copies to the output. 
+If combined with a `--library` or `--descendants` option, this option will
+limit its output to those records with URIs at the designated libraries.  The
+best way to use this option is in combination with the `--items` and one of the
+`--library` or `--descendants` options to export *all* of a library's
+holdings both physical and electronic.
 
 
 Importing Authority Records from Command Line

-----------------------------------------------------------------------

Summary of changes:
 docs/development/support_scripts.adoc |   64 ++++++++++++++++++++++++---------
 1 files changed, 47 insertions(+), 17 deletions(-)


hooks/post-receive
-- 
Evergreen ILS