Bug 29638 - [DOCS] Framework default value for year is not <<YEAR>> but is <<YYYY>>
Summary: [DOCS] Framework default value for year is not <<YEAR>> but is <<YYYY>>
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 21.05
Hardware: All All
: P5 - low minor
Assignee: David Nind
QA Contact:
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-12-03 19:51 UTC by Courtenay Johnson
Modified: 2022-12-12 21:25 UTC (History)
3 users (show)

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

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Courtenay Johnson 2021-12-03 19:51:11 UTC 
The online manual description of the Framework default value field incorrectly describes the special values associated with date. It mentions <<YEAR>>,<<MM>>, AND <<DD>>. The ones for month and day work, but not the one for year.

This documentation is misleading. After looking at the additem.pl if found out why the <<YEAR>> did not work. It should be <<YYYY>> which does work as expected.
Comment 1 Fridolin Somers 2021-12-04 07:05:41 UTC 
The manual is managed in GitLab https://gitlab.com/koha-community/koha-manual.

I've opened a new issue with your text :
https://gitlab.com/koha-community/koha-manual/-/issues/27

Best regards,
Comment 2 Katrin Fischer 2021-12-06 00:13:04 UTC 
(In reply to Fridolin Somers from comment #1)
> The manual is managed in GitLab
> https://gitlab.com/koha-community/koha-manual.
> 
> I've opened a new issue with your text :
> https://gitlab.com/koha-community/koha-manual/-/issues/27
> 
> Best regards,

Hi Fridolin, the documentation team agreed on using Bugzilla a while ago. So I think we don't need to file on gitlab separately.
Comment 3 David Nind 2021-12-06 00:50:04 UTC 
(In reply to Katrin Fischer from comment #2)

> Hi Fridolin, the documentation team agreed on using Bugzilla a while ago. So
> I think we don't need to file on gitlab separately.

Thanks Katrin. I was about to add a comment and make the manual change...
Comment 4 David Nind 2021-12-06 05:48:08 UTC 
A change was required for these versions of the manual: 20.05, 20.11, 21.05, 21.11 and master.

I've made the change - the change should be live once the regeneration is finished for all versions. (20.05 required manual back porting - all others were able to be "Cherry picked".)

Commit: https://gitlab.com/koha-community/koha-manual/-/commit/c126d5a000a7ad62a1e03e6ef904c0f6c5de9a64

Thanks Courtenay for identifying and raising the issue!
Comment 5 Katrin Fischer 2021-12-06 08:19:57 UTC 
(In reply to David Nind from comment #3)
> (In reply to Katrin Fischer from comment #2)
> 
> > Hi Fridolin, the documentation team agreed on using Bugzilla a while ago. So
> > I think we don't need to file on gitlab separately.
> 
> Thanks Katrin. I was about to add a comment and make the manual change...

I added you and Caroline in case I had missed another workflow change :)
Comment 6 Fridolin Somers 2021-12-06 20:38:00 UTC 
(In reply to Katrin Fischer from comment #2)
> Hi Fridolin, the documentation team agreed on using Bugzilla a while ago. So
> I think we don't need to file on gitlab separately.

Ah OK Sorry, I see we use Component=Documentation.
Thanks Katrin and David ;)