help text and link for form labels #138

[kevinpapst]

Description

Fixes #138 by adding methods to:

• add a help icon with a link to a docu chapter for a form
• add a help icon with a link to a docu chapter for a single form label

Added docu about formats that can be entered in the duration field - the link is in the edit timesheet form next to the title (the ? icon).

Symfony supports "help" text out-of-the-box with the recently executed upgrade to 4.1 for single fields and I checked it => will be displayed.

[simonschaufi]

Where are the tooltips? I didn't find them.

[kevinpapst]

I can‘t remember the status of the branch. But I won‘t merge it anyways, as I am working on updating to Symfony 4.1 in #160 which will bring „help“ labels out of the box.

[simonschaufi]

do we want to include docheader everywhere or not?

[kevinpapst]

no, the documentation link will only be displayed where it has an value.

[simonschaufi]

I think you misunderstood me. I mean the code documentation above the method.

[kevinpapst]

Yes I did indeed ;-) I'll update the PR later, thanks for the check!
We need to improve the Scrutinizer and phpcs style checks, see #158 to find such stuff automatically.

[kevinpapst]

added the phpdoc

[kevinpapst]

Okay, the branch is done. You can test if you want.
Right now there is no field that has a "help text", so simply edit e.g. the file src/Form/TimesheetEditForm.php and replace

            ->add('description', TextareaType::class, [
                'label' => 'label.description',
                'required' => false,
            ])

with

            ->add('description', TextareaType::class, [
                'help' => 'some random information',
                'label' => 'label.description',
                'required' => false,
            ])

to see it.

This form has also the new "link to docu icon" besides the form title.

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.