Background

This issue is part of the task to update the hook_help texts of the Drupal 8 modules:
#1908570: [meta] Update or create hook_help() texts for D8 core modules

Tasks

  • Review / write the hook_help text according to help guidelines
  • Refactor the enabled field modules list, using annotation-based discovery.

Related Issues

Files: 
CommentFileSizeAuthor
#6 field-update-hook_help-2091319-6.patch2.39 KBcyberdog
PASSED: [[SimpleTest]]: [MySQL] 58,589 pass(es).
[ View ]

Comments

There is a suggestion for what to put in this help text on
#2030569-23: [policy] Decide how to refer to "entities" and "bundles" in D8 UI

All of the specific field modules are now expecting something like this to be in the Field module help, so we'd better do something like this. :)

Although... this suggestion is a bit out of date, since we now want to put an introduction to entities in the Entity module instead and link there.

Assigned:Unassigned» cyberdog

Assigned:cyberdog» Unassigned

This field_help() has some logic to display a list of enabled field modules. Currently it looks for hook_field_info implementations, but these are being removed as part of #2014671: [META] Convert all field types to plugins.

If we want to keep this list of related modules, we'll need to refactor this to use annotation-based discovery.

Issue tags:+d8help

adding tags, updated issue summary

StatusFileSize
new2.39 KB
PASSED: [[SimpleTest]]: [MySQL] 58,589 pass(es).
[ View ]

Basic correction of listed core field sub-modules, Modules > Extend

Status:Active» Needs review

Looks like links were not upgraded to the latest and greatest checkout https://drupal.org/node/632280 for more information on this.

Note that the hook_field_info() to Plugin refactoring mentioned by @andrewmacpherson ni #4 is handled in #2099261: field_help() no longer lists field_type/widget modules and can throw undefined index notice..

Status:Needs review» Needs work

The help for this module needs some more editing beyond the latest patch above.

This help is becoming more necessary -- we are now or will be soon referring to this module from the Entity help (#2091403: Create hook_help for Entity module), the Field UI help (#2091321: Update hook_help for Field UI module), and all the individual field module help (listed on #1908570: [meta] Update or create hook_help() texts for D8 core modules). All of these are expecting this module to describe what fields are... but I think the existing About text is doing a pretty good job of it now.

Anyway, some things that need to be updated:

a) We should link to the Entity module help for more information about entities, right in or after the first sentence of About where it says that fields can be defined for entity types.

b) As noted above, we need to change the formatting of links within the text. The guidelines are at
https://drupal.org/node/632280#url-note

c) I don't think we should try and list all of the existing core field modules, as is done (or attempted, or at least implied) in the Enabling field types "Uses" bullet point. This list is hard to maintain, and is bound to get outdated. How about just saying something like:

Core includes field modules for many types of data, such as the general-purpose Text and File field modules, and the narrower-purpose Email, Telephone, and Image modules. In addition, there are several modules that provide input widgets for other field modules, such as the Options module.

(and each of these should be links to the respective help for the module).

Issue summary:View changes

Updated summary to include related issues; added enabled-modules-list task

The patch doesn't apply anymore.
error: patch failed: core/modules/field/field.module:119
But since it needs rework anyway, I take the previous work and the comments up together.

Issue summary:View changes

I was working on #2090525: Update hook_help for menu module and found out under the (admin/help/field) under Uses paragraph, one of the list doesn't not have link for the ( Datetime ).

Thanks for pointing that out! I see that too. On admin/help/field, the Datetime field is included in the list of fields, but it isn't a link.

However, the reason is not actually a bug in the Field module -- the reason is that the Datetime module currently does not have a help page, so there is nothing to link to. That is a separate issue:
#2091397: Create hook_help for Datetime module

So, we do not have to worry about that right now. The Field module is working correctly -- displaying all the available fields, and making them links to the module help page if the module has a help page defined.