Skip to content

Commit

Permalink
[Docs] Fixing links that are referenced in the docs
Browse files Browse the repository at this point in the history
Fixing acq_edi reference
managing old image files
Image files in adoc
updating processing action triggers topic line
more link fixes for actiontrigger.adoc
image file syntax
fixing reporter create templates.adoc link
fixing navigating grids link
fixing invoice_payment_method link
acq search link fix
image link syntax
updating paths for images in record buckets page
more image path corrections
adding extension to output_error.png

Signed-off-by: Jane Sandberg <sandbergja@gmail.com>
  • Loading branch information
gmontimantis authored and sandbergja committed Nov 23, 2024
1 parent af231ee commit 0b4561a
Show file tree
Hide file tree
Showing 16 changed files with 27 additions and 26 deletions.
6 changes: 3 additions & 3 deletions docs/modules/acquisitions/pages/invoices.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The summary section contains the following fields, some for entry and other whic
* _Receive Method_ (required) - Select a receive method. The system will default to _Paper_.
* _Receiver_ (required) - The receiver defaults to the branch at which your workstation is registered. You can change the receiver by selecting a different org unit.
*_Invoice Type_ (optional) - This is a free text field.
* _Payment Method_ (optional) - Select a payment method. Payment methods are set in xref:acquisitions_admin.adoc#_invoice_payment_method[Acquisitions Administration].
* _Payment Method_ (optional) - Select a payment method. Payment methods are set in xref:admin:acquisitions_admin.adoc#invoice_payment_method[Acquisitions Administration].
* _Payment Auth_ (optional) - This is a free text field.
* _Note_ (optional) - This is a free text field.
* _Invoice Date_ (required) - This default as the date that you create the invoice. You can change the date by clicking in the field or using the calendar picker.
Expand Down Expand Up @@ -219,7 +219,7 @@ You can use the link invoice feature to link an existing invoice to a purchase o

Evergreen can receive electronic invoices from providers. To access an electronic invoice, you must:

. Configure EDI for your provider. See the xref:acquisitions_admin.adoc#acq_edi[Acquisitions Administration documentation] for more information.
. Configure EDI for your provider. See the xref:admin:acquisitions_admin.adoc#acq_edi[Acquisitions Administration documentation] for more information.
. Evergreen will receive invoices electronically from the provider.
. Navigate to _Acquisitions_ -> Invoices_ to view a list of open invoices, or use the _General Search_ to retrieve invoices. Click the hyperlinked invoice ID in the _Vendor Invoice ID_ field to view the invoice.

Expand All @@ -236,7 +236,7 @@ image::invoices/invoices_search.png[Open Invoice Search]
+
image::invoices/invoices_from_po.png[View Invoices from PO]
+
. To view invoices by searching specific invoice fields, see the section on xref:acquisitons_search.adoc[Acquisitions General Search].
. To view invoices by searching specific invoice fields, see the section on xref:acquisitions:acquisitions_search.adoc[Acquisitions General Search].
. To view invoices for a line item, see the section above on xref:invoices.adoc#create_invoice_for_li[line item invoices].

[[receive_from_invoice]]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/acquisitions/pages/selection_lists_po.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ image::selection_lists_po/acq_mark_ready_for_selector.png[Action: Mark Ready for
. You will be presented with a confirmation dialog. Choose *Confirm* to mark the line items as Selector Ready or choose *Cancel* to exit without marking line items as Selector Ready.
. The marked line item(s) will be highlighted pink, and their status will change to Selector-Ready.
+
image::selection_lists_po/acq_selector_ready.png,[Selector Ready Line Item]
image::selection_lists_po/acq_selector_ready.png[Selector Ready Line Item]
+
. Once a Selector has reviewed the line items, they can either send them to a purchase order (see following section) or navigate to *Actions -> Mark Selected Line Items as Ready for Order* as an intermediate step.
+
Expand Down
1 change: 1 addition & 0 deletions docs/modules/admin/pages/acquisitions_admin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -703,6 +703,7 @@ Prorate-> if you want to prorate the charge across funds.

. Click _Save_.

[[invoice_payment_method]]
=== Invoice payment method ===

The invoice payment method allows you to predefine the type(s) of invoices and
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/admin/pages/actiontriggers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ Validators set the validation test to be preformed to determine whether the acti

You may also create, edit and delete Validators. Just remember that their must be an associated subroutine in the Reactor.pm Perl module.

[#processing_action_triggers]
[[processing_action_triggers]]
== Processing Action Triggers ==

To run action triggers, an Evergreen administrator will need to run the trigger processing script. This should be set up as a cron job to run periodically. To run the script, use this command:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 11 additions & 11 deletions docs/modules/cataloging/pages/record_buckets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Record buckets are containers for bibliographic records. Once records are in a b
[[record_buckets_interface]]
== Record Buckets Interface ==

image::cataloging/record_buckets/buckets_interface.png[Buckets interface]
image::record_buckets/buckets_interface.png[Buckets interface]

The Angular version of the record buckets interface features a header with a _New Buckets_ button beside it.

Expand Down Expand Up @@ -66,26 +66,26 @@ Actions in this interface include:
* _Share Bucket_ - this opens a modal which will allow you to share the bucket with specific users and/or organizational units. You can separately add users with view-only permissions and users with view and edit permissions. All buckets shared with an organizational unit will be editable by those with bucket editing privileges at that location
** To add a user, navigate to either the _Users with View Permissions_ or _Users with Edit Permission_ tab. You will see a list of the current users with whom the bucket is shared.
+
image::cataloging/record_buckets/bucket_sharing.png[Current share members]
image::record_buckets/bucket_sharing.png[Current share members]
+
** Select _Add Users_ which will open a user search modal. Search for users and select one or several users with the checkbox. Use the _Select_ button to add these users to your share list. You may only share buckets with staff users.
+
image::cataloging/record_buckets/patron_search_share.png[Searching & adding new share members]
image::record_buckets/patron_search_share.png[Searching & adding new share members]
+
** Do not use the _Add to Bucket_ action, as in this context that is to add users to xref:circulation:user_buckets.adoc[User Buckets].
** You will see your share list updated with the new share users. To complete your updates, select _Update Bucket Sharing_.
+
image::cataloging/record_buckets/update_sharing.png[Updating bucket sharing]
image::record_buckets/update_sharing.png[Updating bucket sharing]
+
** To remove a user, navigate to either the _Users with View Permissions_ or _Users with Edit Permission_ tab. You will see a list of the current users with whom the bucket is shared. Select one or several users from the list.
** Select _Remove Users_ and the user will be removed from the share list.
+
image::cataloging/record_buckets/remove_share.png[Remove user from sharing]
image::record_buckets/remove_share.png[Remove user from sharing]
+
** To complete your updates, select _Update Bucket Sharing_.
** To share a bucket with all staff members of an organizational unit, select the _Libraries_ tab in the sharing modal. Select one or several organizational units from the tree. You will need to select or remove organizational units individually - shares do not inherit.
+
image::cataloging/record_buckets/library_share.png[Share with libraries]
image::record_buckets/library_share.png[Share with libraries]
+
** To complete your updates, select _Update Bucket Sharing_.
* _Transfer Bucket Ownership_ - this opens a modal which will prompt you to enter a barcode, or search for a user, to transfer bucket ownership. Depending on your permissions, once you transfer a bucket you may lose editing or viewing privileges for that bucket. Administrators can transfer buckets for other users, even if the administrator doesn't directly own the bucket.
Expand Down Expand Up @@ -123,7 +123,7 @@ There are two ways to add records via the record bucket interface:

The _Upload Records_ action is available in the Actions menu. Choose a bucket by selecting its checkbox, and then navigate to the actions menu and select _Upload Records_. When selected, this will open a modal:

image::cataloging/record_buckets/upload_to_bucket.png[Upload Records to bucket]
image::record_buckets/upload_to_bucket.png[Upload Records to bucket]

From here, you can select whether you want to upload _Bib IDs_ or _TCNs_. You can select a file from your computer using the _Choose file_ button. You can also, as shown in the screenshot above, paste values into the text box in this modal. You should have 1 value per line.

Expand Down Expand Up @@ -211,7 +211,7 @@ Note that you can select both options on a single report.

TIP: If you are running a recurring report and wish to have a single bucket that collects the report's output each time the recurring report is run, you will need to have an existing bucket to point the output to. Each run of the report will append new output to the bucket.

image::cataloging/record_buckets/report_output_to_bucket.png[Bucket output options in the Reports interface]
image::record_buckets/report_output_to_bucket.png[Bucket output options in the Reports interface]

[[add_records_from_catalog]]
=== From Catalog Search ===
Expand All @@ -220,11 +220,11 @@ You can add records to buckets directly from the staff catalog search results, o

There is a buckets subtab to the left of the catalog search results, which will show your favorites as well as your recently-viewed buckets in two collapsable accordions. Each set displays the bucket name, any organizational unit sharing in place, the bucket owner and organizational unit, and the count of records in the bucket. If you hover over the record count, and have selected records in the results list, you will see an option to add those records to a bucket.

image::cataloging/record_buckets/staffcat_favorites.png[Buckets subtab in staff catalog showing favorite buckets and recently viewed buckets]
image::record_buckets/staffcat_favorites.png[Buckets subtab in staff catalog showing favorite buckets and recently viewed buckets]

Additionally, you can add a record directly to a bucket from its place in the search results lists. There is a button on the lower right of each result that says _Add to Bucket_. Select this button to see a list of your favorite buckets and recently viewed buckets. Select a bucket from this list to add a record to your bucket.

image::cataloging/record_buckets/search_results.png[Add a record to a bucket from an individual member of the search results list]
image::record_buckets/search_results.png[Add a record to a bucket from an individual member of the search results list]

NOTE: once you navigate into a bucket from the staff catalog, there is no shortcut back to your search results and you will need to use the back button to return to search results.

Expand All @@ -233,7 +233,7 @@ NOTE: once you navigate into a bucket from the staff catalog, there is no shortc

To access an individual bucket, click on its title in the main buckets interface. This will take you to the _Bibs in a Bucket_ view, where you can see all members of the record bucket and perform actions on them. This grid has filters and sort options available on each column, and as with other grids you can save your grid view.

image::cataloging/record_buckets/bibs_in_a_bucket.png[Individual record bucket view]
image::record_buckets/bibs_in_a_bucket.png[Individual record bucket view]

This interface has several actions avaiable, some via buttons and some via the actions menu.

Expand Down
8 changes: 4 additions & 4 deletions docs/modules/cataloging/pages/z39.50_search_enhancements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ From this interface, you can rank the quality of incoming search results accordi

. Rank the quality of the records from Z39.50 sources by adding quality metrics for the match set. Click *MARC Tag and Subfield*, and enter the 901z tag and subfield, specify the Z39.50 source, and enter a quality metric. Source quality increases as the numeric quality increases.

image::media/Locate_Z39_50_Matches4.jpg[Locate_Z39.50_Matches4]
image::z3950/Locate_Z39_50_Matches4.jpg[Locate_Z39.50_Matches4]



Expand Down Expand Up @@ -88,15 +88,15 @@ Two new settings control the Z39.50 search enhancements.

. Click *Perform Search*.

image::media/Locate_Z39_50_Matches1.jpg[Locate_Z39.50_Matches1]
image::z3950/Locate_Z39_50_Matches1.jpg[Locate_Z39.50_Matches1]

. Status information will appear, including the number of records in the bucket that were searched, the matches that were found, and the progress of the search. When the search is complete, click *Open Queue*.

image::media/Locate_Z39_50_Matches2.jpg[Locate_Z39.50_Matches2]
image::z3950/Locate_Z39_50_Matches2.jpg[Locate_Z39.50_Matches2]

. The Vandelay Queue will display. Matching records are identified in the *Matches* column. From this interface, import records according to your normal procedure. It is suggested that to merge the incoming records with the catalog records, you should choose an option to import the records. Next, select either merge option from the drop down menu, click *Merge on Best Match*, and then click *Import*.

image::media/Locate_Z39_50_Matches3.jpg[Locate_Z39.50_Matches3]
image::z3950/Locate_Z39_50_Matches3.jpg[Locate_Z39.50_Matches3]

. The records from the Z39.50 search will merge with the catalog records. NOTE: A new column has been added to this interface to identify the Z39.50 source. When records are imported to the Vandelay queue via a record bucket, Evergreen tags the Z39.50 source and enters the data into the $901z.

2 changes: 1 addition & 1 deletion docs/modules/development/pages/support_scripts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ to more thorough documentation, if available.
-- Groups together event output for already processed events. Useful for
creating files that contain data from a group of events. Such as a CSV
file with all the overdue data for one day.
* xref:admin:actiontriggers_process.adoc#processing_action_triggers[action_trigger_runner.pl]
* xref:admin:actiontriggers.adoc#processing_action_triggers[action_trigger_runner.pl]
-- Useful for creating events for specified hooks and running pending events
* authority_authority_linker.pl
-- Links reference headings in authority records to main entry headings
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/installation/pages/server_installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_tri
------------------------------------------------------------------------------

For more information about configuring and running action triggers, see
xref:admin:actiontriggers_process.adoc#processing_action_triggers[Notifications / Action Triggers].
xref:admin:actiontriggers.adoc#processing_action_triggers[Notifications / Action Triggers].

[[creating_the_evergreen_database]]
== Creating the Evergreen database ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -468,7 +468,7 @@ how many items are available in all branches.

image::using_the_public_access_catalog/branch_search.jpg[branch search]

image::using_the_public_access_catalog/search_result_quantity.jpg[search result quantity]
image::using_the_public_access_catalog/search_results_quantity.jpg[search result quantity]

You may also click the _Show More Details_ link at the top of the results page,
next to the _Limit to available items_ check box, to view each search result's
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/reports/pages/reporter_create_templates.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ If the path for one of your display fields or filters is incorrect, you will get
an error instead of the expected report output. Sometimes the error text will
give you a clue about what isn't working.
image::reporter_create_templates/output_error["Screenshot from the Outputs folder. A line is selected. In the Output column, where you would normally see HTML and CSV button links, it says Error running report. The cursor is hovering over the Error text column to show the full error text. The text begins 'DBD::Pg::st execute failed: ERROR'."]
image::reporter_create_templates/output_error.png["Screenshot from the Outputs folder. A line is selected. In the Output column, where you would normally see HTML and CSV button links, it says Error running report. The cursor is hovering over the Error text column to show the full error text. The text begins 'DBD::Pg::st execute failed: ERROR'."]
You can modify your template and try again.
=====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ these tables link to each other via other tables such as the circulation table
The connections between tables are called joins. Evergreen uses a default join
when creating report templates which is usually what you need for a template.
When working with data that can be null (have no value), you may want to use
xref:reports:reporter_create_template.adoc#report_nullability[nullability],
xref:reports:reporter_create_templates.adoc#report_nullability[nullability],
which allows you to create an inner join on your selected table.

When you create a template, you are writing a SQL (structured query language)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Some grids allow you to perform actions on items selected in the grid.

To perform actions, you must first select items in the grid. Select items by checking the checkbox on the left side of the item's row. You may select all items on the current page of a grid by checking the checkbox at the top of the grid.

IMPORTANT: Selecting the checkbox at the top of the grid will only select items on the current page. To select more items, you may navigate to other pages and make additional selections, or change the number of rows that appear on each page. See xref:staff_catalog/bibliographic_records.adoc#navigating_grids[Navigating Grids].
IMPORTANT: Selecting the checkbox at the top of the grid will only select items on the current page. To select more items, you may navigate to other pages and make additional selections, or change the number of rows that appear on each page. See xref:staff_catalog:bibliographic_records.adoc#navigating_grids[Navigating Grids].

Then select the _Actions for Selected Rows_ button and choose an action.

Expand Down

0 comments on commit 0b4561a

Please sign in to comment.