[Koha] Screenshots internationalization for the manual (and acceptance tests?)

[Jonathan Druart]

Hi Caroline,

I am suggesting to write a (BDD) syntax to help everybody to write these
steps.
You would be able to generate the screenshots and test locally if the steps
are correct.

The syntax would look like the two examples I gave, like:
Scenario: Take a screenshot for FineNotifyAtCheckin
Given I have set the syspref FineNotifyAtCheckin to 1
And I checked an item out to a patron
And I added a fine of 5 to the patron
And I checked the item in
Then I take a screenshot of the element with the class "dialog alert"

You will not need the help of a developer to know if it does what you
expected.

Of course I know it is a big job to generate such steps for every
screenshot, but I think it is the way to go to get up-to-date (and
translated) screenshots in the long term.

I have already did the job for the image "marc21_basic_setup.png" (see the
links at the bottom of my original email) and there are no numbers or
circles. It cannot be automated.

Thanks for your answer.

Jonathan

On Mon, 26 Feb 2018 at 13:44 Caroline Cyr-La-Rose <
caroline.cyr-la-rose at inlibro.com> wrote:

> Hi Jonathan,
>
> I'm not sure I understand everything in your email. Let me know if I'm
> understanding this right. What you are asking is if we (the
> non-technical ppl) would be willing to write up "steps" for each of the
> 1300+ screenshots in the manual so that developers can translate those
> into code to automate the screenshot-taking and deploy it across all
> manuals and all languages.
>
> Do we have enough developers in the community to do that? I don't want
> to speak for the whole documentation team, but I think that if we do it
> little by little (when we review a section or sub-section for example),
> it is feasible. It might take a couple of years to go through the 1300+
> pictures, though. And we would need to have a way to know which
> screenshot has been automated and which is still manual (ideally,
> directly in the manual, maybe with a comment?).
>
> When we want to add a screenshot, let's say for a new feature, how does
> the workflow go? Do we take a manual screenshot first and write up the
> steps? Or just write the steps and wait for the developer to take the
> screenshot?
>
> What about when we want to add squares or circles to point out a
> specific button (do we do that in the manual?) or add numbers like in
> this example you sent :
>
> http://download.koha-community.org/manual/wip_screenshots/en/html/_images/marc21_basic_setup.png
> ?
>
> I hope this helps your reflection
>
> Caroline Cyr La Rose, M.L.I.S.
> Head of training and support, inLibro
>
> _______________________________________________
> Koha mailing list  http://koha-community.org
> Koha at lists.katipo.co.nz
> https://lists.katipo.co.nz/mailman/listinfo/koha
>