Docs: Web Client Print / Receipt Templates

Bug #1642023 reported by Terran McCanna on 2016-11-15
22
This bug affects 4 people
Affects Status Importance Assigned to Milestone
Evergreen
Medium
Lynn Floyd

Bug Description

The Print Templates interface in the web client has changed significantly from the xul client's Receipt Template Editor.

Library staff will need documentation explaining the new format as well as how to determine what data / fields are available (since it is no longer using the macros staff are used to).

Lynn Floyd (lfloyd) wrote :

Well, as I am presenting on this at the conference, i will be working on these.

Lynn Floyd (lfloyd) wrote :

Here is the first set of docs, for the receipt template in the web client.

Lynn Floyd (lfloyd) wrote :
Lynn Floyd (lfloyd) wrote :
Changed in evergreen:
status: New → In Progress
assignee: nobody → Lynn Floyd (lfloyd)
Remington Steed (rjs7) wrote :

(Email from Terran McCanna, to docs list, on 2017-08-14, subject "Web Client Print Templates")

Hi DIG,

I have been fleshing out documentation for the new print templates (starting with what Lynn Floyd wrote up already - thanks!) in preparation for our next upgrade and web client soft rollout on Labor Day. If any of this is useful to you, please feel free to incorporate it, as I won't have time to put it into the correct format to submit to DIG anytime soon.

General formatting:

https://pines.georgialibraries.org/dokuwiki/doku.php?id=circ:workstations:receipts

Field/tag/macro/whatever-we're-calling-it-now Reference List:

https://pines.georgialibraries.org/dokuwiki/doku.php?id=circ:workstations:receipt-content

(I have a few bug reports in for other pieces of data that I think would be useful to have access to on various print templates, but to the best of my knowledge, everything listed here works.)

Terran McCanna

Remington Steed (rjs7) wrote :

I subsequently replied to the docs email list, and here's the summary:

It looks like we should be able to use a conversion tool to move from DokuWiki syntax to AsciiDoc:

https://github.com/DidierSpaier/convtags

I grabbed the DokuWiki syntax for Terran's two pages, and below are the before and after links for easy comparison. Both Gists need review before being added to the docs repository.

Print Templates:

https://pines.georgialibraries.org/dokuwiki/doku.php?id=circ:workstations:receipts&do=edit

https://gist.github.com/remocrevo/c6349a5ac35510905c6b581ff8de1e1a

Receipt Content Reference:

https://pines.georgialibraries.org/dokuwiki/doku.php?id=circ:workstations:receipt-content&do=edit

https://gist.github.com/remocrevo/ed46d6886e9f0ca08f787af32b9956c6

KNOWN ISSUES:

- We need to review Lynn's files posted on this bug and consider combining them with this content from Terran's wiki.

- The "Print Templates" file is old, and the wiki page has been updating since. Run the conversion again on the latest wiki file.

- The "Print Templates" file is missing the screenshot from the original.

- The "Print Templates" file has a link to the "Receipt Content Reference" file that needs updating.

- The "Print Templates" file links to a few PDFs on the PINES wiki. Consider adding them to the docs repository, or removing the links.

Remington Steed (rjs7) on 2018-01-25
Changed in evergreen:
status: In Progress → Triaged
importance: Undecided → Medium
assignee: Lynn Floyd (lfloyd) → nobody
Lynn Floyd (lfloyd) on 2018-03-01
Changed in evergreen:
assignee: nobody → Lynn Floyd (lfloyd)
Remington Steed (rjs7) wrote :

Note that many people have shared examples of hold slips they use. It may be worth including some of them in the docs. Here's a link to search the email lists for "hold slip":

https://georgialibraries.markmail.org/search/?q=hold+slip

Remington Steed (rjs7) wrote :

I pushed Lynn's contribution to master, 3.1 and 3.0. Here it is on master:

http://docs.evergreen-ils.org/dev/_receipt_template_editor.html

I'll leave this bug open, because I think this docs chapter would still benefit from the ideas I posted in comments #6 and #7.

Changed in evergreen:
assignee: Lynn Floyd (lfloyd) → nobody
Robert J Jackson (rjackson) wrote :

Can someone please add capture_time to the google doc? I am attaching a screen capture of the highlighted row needing added for holds shelf receipt template.

Robert J Jackson (rjackson) wrote :

Sorry last comment was for a different LP bug :(

Lynn Floyd (lfloyd) wrote :

I added the information on the content Reference in the following Pull Request
https://github.com/evergreen-library-system/Evergreen/pull/85

If you are looking for examples I have made a git repository here to examples
I'm going to look at adding examples to this repository, and the find a way to migrate this in to the actual docs.
https://github.com/alynn26/Evergreen-Receipts

Changed in evergreen:
assignee: nobody → Lynn Floyd (lfloyd)
Lynn Floyd (lfloyd) wrote :

Came back to this, added a branch here: https://git.evergreen-ils.org/?p=working/Evergreen.git;a=commit;h=73ef509ade2d944341282c4461df0c30f8e4afd2.
This branch adds a lot of the database references to the Documentation.

Now on to working on adding in examples.

tags: added: pullrequest
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers