Custom field description #758

cproensa · 2016-04-17T14:25:44Z

Add description text attribute for custom field definition, and show this description on labels for form inputs.

Fixes #03433

atrol · 2016-04-17T15:12:26Z

No time for a deeper look or testing, but looks good at first sight.
What I don't like that much is, that we get one more thing which can't be localised, but that's another story.

Missing documentation, e.g. https://www.mantisbt.org/docs/master/en-US/Admin_Guide/html-desktop/#admin.pages.manage.customfields
https://www.mantisbt.org/docs/master/en-US/Admin_Guide/html-desktop/#admin.customize.customfields.definitions

cproensa · 2016-04-17T19:36:15Z

No time for a deeper look or testing, but looks good at first sight.
What I don't like that much is, that we get one more thing which can't be localised, but that's another story.

i agree. I had opened #0020305 to open discuss possible solutions.

cproensa · 2016-04-17T23:24:31Z

Missing documentation

Actually, current documentation for CF was quite outdated.
I had a revision and clean-up, and added the specific for this PR

vboctor · 2016-04-17T23:48:36Z

admin/schema.php

@@ -865,6 +865,10 @@
 # Enable gravatar plugin if avatars are enabled
 $g_upgrade[205] = array( 'UpdateFunction', 'gravatar_plugin', array() );

+# Add description field to custom field definition
+$g_upgrade[206] = array( 'AddColumnSQL', array( db_get_table( 'custom_field' ), "
+	description					XL		NULL DEFAULT NULL" ) );


Do we want to support long descriptions here? Should we use a one line for description? That would reflect on the db schema and UI.

Why not default to empty string rather than null?

vboctor · 2016-04-17T23:53:24Z

@cproensa I haven't revised the documentation, but the rest looks ok. Thanks for refreshing the documentation.

single line vs. multi-line? and field time in schema
null vs empty string in schema

@dregad it would be good to review the schema to make sure no issues there.

cproensa · 2016-04-18T00:27:57Z

single line vs. multi-line?

I see the use case for multi-line. Usually you wont need more that 2 or 3 lines, but the option is ther if needed.
Notice how i made the textarea 2 rows height, to encourage a short description :)

field type: long vs varchar vs xxx
null vs empty string in schema

I'm neutral on that. I replicated the description field from project table

vboctor · 2016-04-21T07:02:20Z

👍 -- I'll leave it to @dregad to comment on the schema. I personally prefer empty over null.

dregad · 2016-05-15T16:35:33Z

In terms of UI consistency, I'm wondering why the CF's description is sometimes displayed, and sometimes not.

Currently, it's shown when

Reporting a new issue
Changing status to Resolved or Closed

It's missing when

displaying an issue (view.php)
updating an issue (bug_update_page.php)
mass-updating the custom field (bug_actiongroup_page.php)

Haven't had time to review the doc yet.

cproensa · 2016-05-15T22:02:11Z

For the missing description:

displaying an issue (view.php)
updating an issue (bug_update_page.php)

The table based layout is not easy to accommodate the description in those pages.

mass-updating the custom field (bug_actiongroup_page.php)

That can be done with the current layout. I will review this.

cproensa · 2016-05-16T16:43:34Z

mass-updating the custom field (bug_actiongroup_page.php)

@dregad, updated the actiongroup page.
and rebased to current head

cproensa · 2016-05-27T12:06:35Z

I found the use case for custom fields that may have some restrictions, like min/max lenght, or regexp.
Where it's desirable to explain the valid syntax before the user submits the form (otherwise, getting an error after submit, and the risk of losing inputted data).

Using this description to explain the field restrictions can be a solution.

Add management for custom fields description attribute

Add custom field description text of form input labels

Whitespace and minor formatting changes

Revision for Custom Fields documentation, up to v1.3.0-rc1 - Remove duplicate information across different sections - Remove obsolete information - Add new functionality for current version

Add documentation for new custom field attribute 'description'.

Do not print HTML markup for Custom Fields description on labels, if the description is empty.

cproensa · 2016-08-17T23:52:27Z

null vs empty string in schema

changed to default '' instead of null
rebased to current master-1.3.x
however, this PR is submitted against master (before changing version to 2)
should i resubmit to proper mantis-1.3.x?

cproensa · 2019-02-21T23:23:35Z

outdated & no progress

cproensa force-pushed the cf_description branch from fa42fed to 7811c0a Compare April 17, 2016 23:22

vboctor reviewed Apr 17, 2016
View reviewed changes

cproensa force-pushed the cf_description branch from 542965d to 72a202b Compare May 16, 2016 16:42

cproensa added 8 commits August 18, 2016 01:42

Create custom field db column for description

bedc7a6

Custom field configuration manage description

58836e6

Add management for custom fields description attribute

Show custom fields description on form inputs

5ca140f

Add custom field description text of form input labels

Add custom field description to soap api

9e8c94c

Custom fields documentation, fix formatting

94320f4

Whitespace and minor formatting changes

Custom fields documentation update

968d4d6

Revision for Custom Fields documentation, up to v1.3.0-rc1 - Remove duplicate information across different sections - Remove obsolete information - Add new functionality for current version

Custom fields documentation for description field

ae6b14b

Add documentation for new custom field attribute 'description'.

Check if custom field description is empty

9ca6f2b

Do not print HTML markup for Custom Fields description on labels, if the description is empty.

cproensa force-pushed the cf_description branch from 5c80864 to 9ca6f2b Compare August 17, 2016 23:49

vboctor assigned cproensa Apr 24, 2017

cproensa closed this Feb 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom field description #758

Custom field description #758

cproensa commented Apr 17, 2016

atrol commented Apr 17, 2016

cproensa commented Apr 17, 2016

cproensa commented Apr 17, 2016 •

edited

vboctor Apr 17, 2016

vboctor Apr 17, 2016

vboctor commented Apr 17, 2016

cproensa commented Apr 18, 2016

vboctor commented Apr 21, 2016

dregad commented May 15, 2016

cproensa commented May 15, 2016

cproensa commented May 16, 2016

cproensa commented May 27, 2016

cproensa commented Aug 17, 2016

cproensa commented Feb 21, 2019

Custom field description #758

Custom field description #758

Conversation

cproensa commented Apr 17, 2016

atrol commented Apr 17, 2016

cproensa commented Apr 17, 2016

cproensa commented Apr 17, 2016 • edited

vboctor Apr 17, 2016

Choose a reason for hiding this comment

vboctor Apr 17, 2016

Choose a reason for hiding this comment

vboctor commented Apr 17, 2016

cproensa commented Apr 18, 2016

vboctor commented Apr 21, 2016

dregad commented May 15, 2016

cproensa commented May 15, 2016

cproensa commented May 16, 2016

cproensa commented May 27, 2016

cproensa commented Aug 17, 2016

cproensa commented Feb 21, 2019

cproensa commented Apr 17, 2016 •

edited