Bug 20565 - Clearer documentation of date, branches, itemtypes and categorycode parameters in 'Create report from SQL' help page.
Summary: Clearer documentation of date, branches, itemtypes and categorycode parameter...
Status: RESOLVED MOVED
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: master
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Bugs List
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-04-11 15:04 UTC by Barton Chittenden
Modified: 2020-11-17 20:06 UTC (History)
2 users (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Barton Chittenden 2018-04-11 15:04:15 UTC
I write a lot of reports, and I can never remember whether to use

   <<foo|branches>>

or

   <<foo|branchcode>>

for instance. These *are* documented in the help page, but it would be helpful if they were in a tabular form, e.g.

+-----------------+--------------------------------------------------+-----------------------------+
| parameter       | what user sees                                   | what gets inserted in query |
+-----------------+--------------------------------------------------+-----------------------------+
| date            | date picker                                      | validly formatted date      |
| branches        | drop down of branch names                        | branch code                 |            
| itemtypes       | drop down of item type names                     | item type                   |
| categorycode    | drop down of patron category descriptions        | borrower ctegory code       | 
| (anything else) | drop down of auth-value descriptions in category | authorized value            |
+-----------------+--------------------------------------------------+-----------------------------+

This would be easier to find on the help page.
Comment 1 Katrin Fischer 2018-04-11 21:58:11 UTC
We are in the process of removing hte local help files, see bug 19817. Marking this for the manual.
Comment 3 Barton Chittenden 2018-10-05 22:50:55 UTC
(In reply to Caroline Cyr La Rose from comment #2)
> I've added the table to the manual.
> 
> https://gitlab.com/koha-community/koha-manual/merge_requests/177/
> diffs?commit_id=82f5773c993eda040e1b70d091f7170b3be20b64

Very nice!